Embedded: Filter Display Settings

What is Filter Display Settings in Embedded dashboard

This Setting is used to override the default filters' value when your users view the dashboard via embed link.

How to config Filter Display in Embedded dashboard

General structure of Filter Display Settings

Holistics Filter Display Setting syntax includes: filter name, hidden, default value and modifier

filters = {
"filter_uname": {
"hidden": false,
"default_condition": {
"operator": "expected_operator",
"values": [
"expected_value"
],
"modifier": null
}
},
}

Filter name is to define which filter you want to override in the embedded dashboard. We have auto-generated the filter name in our sample code.

Default Value is the value you want to auto-apply in the embedded dashboard

Hidden has boolean type, by setting it to true, the filter will be hidden in the embedded dashboard (but the default value has already been applied). This option will make your dashboard nicer and cleaner.

Modifier (optional): only available for some of the operators in Date filter (for example, next, last X days/months/years.

Adding Filter Display Settings

Filter in Dashboard

Let's say you want your embedded dashboard by default to present data in the last 6 months, the Filter Display Setting will do the job

Filter value

To make your dashboard nicer, you can change the hidden property to true

The sample code shows below:

filters = {
"order_date": {
"hidden": true,
"default_condition": {
"operator": "matches",
"values": ["last 6 months"],
"modifier": null
}
},
}

Continue with the rest of your setup

After done setting up Filter Display, you can continue with other setups to embed the dashboard into your application. For more information, please refer to this doc