# Filter

**Category:** Control

**Version:** 1.0

**Last Updated:** April 7, 2026

**Author:** Any2Info

***

### Description

The Filter control is used to filter a dataset by applying a value-based condition on a specific column from a dataclip.

It functions by combining:

* A **header** (column) from the dataset
* A **value** provided by the control

The control applies this as a filter, allowing only matching data to pass through to connected controls.

The filter value can be provided in multiple ways:

* User input
* A mapped value
* A predefined user-related value (such as user ID or username)

Although the control is visually present on the dashboard, it is often configured as invisible when the value is not intended to be modified by the user.

***

### Configuration Options

| Setting       | Required | Description                                                                                                        |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| Input type    | Yes      | განს Defines how the filter value is provided. Supported types: **Input**, **Variable**, **UserId**, **Username**. |
| Default value | No       | The initial value of the filter when using input type.                                                             |
| Visible       | No       | Determines whether the control is shown on the dashboard.                                                          |

***

### Mappings

| Mapping       | Required | Description                                                                         |
| ------------- | -------- | ----------------------------------------------------------------------------------- |
| FilterHeaders | Yes      | Defines the column (header) on which the filter is applied.                         |
| FilterValue   | Yes\*    | Defines the value used for filtering. Typically required when using **Input** type. |

\* Required depending on the selected input type.

***

### Behavior

* The control applies a **single value filter** on a dataset column.
* Only one filter condition is supported per control.
* Multiple filters can be achieved by using multiple Filter controls.
* The filtered dataset is applied to **linked controls**.
* The control does not transform data itself but restricts the visible/usable dataset for connected controls.

***

### Events

| Event    | Description                                                              |
| -------- | ------------------------------------------------------------------------ |
| OnUpdate | Triggered when the filter value changes as a result of a mapping update. |

***

### Usage

Use the Filter control when you need to dynamically or statically restrict data shown in a dashboard.

Typical use cases include:

* Filtering data per user (e.g. UserId or Username)
* Applying fixed filters in the background (invisible control)
* Allowing user-driven filtering via input

***

### Tips & Best Practices

* Use **multiple Filter controls** to simulate multi-condition filtering.
* Set the control to **invisible** when using static or user-based filtering.
* Prefer **UserId or Username** for security-related filtering scenarios.
* Ensure the selected header contains compatible data with the filter value type.

***

### Changelog

| Version | Date          | Change                               |
| ------- | ------------- | ------------------------------------ |
| 1.0     | April 7, 2026 | Initial documentation version added. |