Table Filter
Table filter is a gh-element that allows you to filter items by the value of a specific field. The filtered items are displayed in the linked elements.
In general, a filter is a button that opens a side menu. There, the user can select the field by which the filtering will be performed and the type of filter. The number of added filters will be indicated on the filter button.
Note that you can apply multiple filters to items at once. But only one type of filter is applied to one field.
After applying the filters, only the items that match the filters will remain in the linked element.
Functional Characteristics
The main purpose of this element is to filter items in several elements that display them. Those gh-elements are Table, Calendar, and Cards. Use it to find the items you need.
Element Options
Filter element has two types of settings. The first one is standard for all elements. The second one is a quite interesting table.
Field Settings
Besides standard options like Field Name and Name Space, filter has a few other settings.
Name | Description |
---|---|
App for filter list | allows to select from which application fields for filtering will be taken; details... |
Bind to fields | allows to select for which elements the filter is applied; details... |
App For Filter List
The current setting allows you to select an application whose items will be filtered. Since items can be filtered only the values of the fields, the filter list consists of the fields of this application. That means here you have to select the source application for the current filter element.
Bind To Fields
This function binds the filter to different elements which are located in the same application. These are the elements that can display items. Namely, these are Table, Cards and Calendar.
By default they are taken from the application where the filter element is located
Filter List
This is the list of all fields of the application. Its options allows to configure which fields will be available for filtering.
Name | Description |
---|---|
Field | column with names of all elements in application; details... |
Show | allows set whether the field will be displayed in filter list; details... |
Field
This column contains names of all fields of the selected App For Filter List. They help you find a specific item and configure whether it is enabled for filtering.
Show
The current function determines whether the field will be enable in filter or not. That is, if this switch is turned off, the corresponding field will not be displayed to users and, accordingly, it will not be possible to filter by it.
So, this switchers are used to limit the filtering of items by certain fields.
Element Style
Despite of a variety of interpretations which are described below, all other options are standard. So about them you can read in Setting Overview.
Filtration
This gh-element filters out others but cannot be filtered.
Interpretation
Filter has three interpretation types, which differ only in appearance.
Default
The default interpretation allows filter to be displayed as an icon with the name next to it.
Icon with name under it
This interpretation is like a default one, but the name is under the icon.
Button
Allows to display filter element as a blue button with white icon and text on it.
Value Format
This element does not have any value.
Data Model
The data model of filter contains all values of its settings and interpretations.
{
"data_model":{
"app_id_bind_to": 27290,
"field_id_of_table": "625324",
"filter_settings": {
"fields_to_view": [{
"field_id": "625324",
"show": 0,
}]
},
"interpretation": []
}
}
Name | Type | Description |
---|---|---|
app_id_bind_to | number |
contains the ID of the application with which the filter is associated |
field_id_of_table | string |
contains ID of the table which is filtered |
filter_settings | object |
contains settings of the filter |
fields_to_view | array |
contains all fields of the application and whether they will be shown in the filter list or not |
field_id | string |
ID of the field from the previously selected application |
show | boolean |
shows whether the field be shown in the filter list |
interpretation | array |
contains all filter interpretations |