# Filter

# type: filter

The Filter Element is used to display a single or multi-select Filter.

Filter-Element

Distinct Values Limit

The number of values shown by a Filter Elements is limited by the maximum number of distinct values that the ONE DATA server can compute. Every ONE DATA instance has a configuration property that defines the maximum number of distinct values that can be retrieved. The default value for this property is 120.

# Configuration Overview

{
  "id": "frtTableCountryFilter",
  "type": "filter",
  "source": "frt_testSource",
  "syncSets": [
    {
      "syncSetId": "test",
      "applyFilters": true,
      "publishFilters": true
    }
  ],
  "config": {
    "column": "Country",
    "label": "Land",
    "multiSelect": false,
    "noValueText": "No Country",
    "selectedFilter": ["China"],
    "columnType": "STRING"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# Properties

# id

Property: id

Type: string

Description: The unique ID of the Filter Element.

"id": "frtTableCountryFilter"
1

# source

Property: source

Type: string

Description: The ID of the Datasource to retrieve the data from.

"source": "frt_testSource"
1

# config

Property: config

Type: object

Description: The actual Filter configuration.

"config": {
        "column": "Country",
        "label": "Land",
        "wide": true | false     // Enlarge the width of the opened Dropdown to display longer values.
        "multiSelect": false,
        "selectedFilter": ["China"],
        "columnType": "STRING" | "DATETIME" | "DOUBLE" | "DECIMAL" | "INT",
        "noValueText": "Entry without value", // The value that will be added at the first position.
        "selectFirstByDefault": true | false, // Select the first value of a single select filter by default
        "autocomplete": true | false // Enable autocomplete-like search for single select values. Auto-enabled when distinct value limits are reached.
      }
{
1
2
3
4
5
6
7
8
9
10
11
12

# config for DatePicker

Property: config (DatePicker)

Type: object

Description: Filter configuration of the date-picker.

"config": {
  "column": "datetime",
  "rangeFilter": true,
  "columnType": "INT"
}
1
2
3
4
5