Filter Element

type = "filter"

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


Properties

Property
Type
Description
Example Value
id
string
The unique id of the filter Element.
"frtTableCountryFilter"
source
string
The id of the Datasource to take the data from.
"frt_testSource"
syncSetsarrayGo to the SyncSets article
  "syncSets": [
    {
      "syncSetId": "test",
      "applyFilters": true,
      "publishFilters": true
    }
  ]
configobject

The actual filter config.

You can set the multiSelect to true or false and with the "selectedFilter" you can preselect one or more (if it is an multiSelect filter) filters.


  "config": {
    "column": "Country",
    "label": "Land",
    "wide": true,
    // Enlarge the with of the opened Dropdown 
    // to display longer values
    "multiSelect": false,
    "selectedFilter": ["China"],
    "columnType": "STRING"
    // other possible column types:
    // "DATETIME", "DOUBLE", "DECIMAL". "INT"
    "noValueText": "Entry withou value" 
    // Will be added at the first position
  }
config
(Date

Picker)
object
Filter config for the date picker
  "config": {
    "column": "datetime",
    "rangeFilter": true,
    "columnType": "DATETIME"
  }


Example

    {
      "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"
      }
    },