diff --git a/docs/dashboards.md b/docs/dashboards.md index 4a62e0ad..47d29c84 100644 --- a/docs/dashboards.md +++ b/docs/dashboards.md @@ -15,6 +15,7 @@ * [Overrides](#overrides) * [`.md` files](#md-files) * [Markdown header arguments](#markdown-header-arguments) + * [`.filter.json` file(s)](#filterjson-files) * [`dashboard.yml` file](#dashboardyml-file) * [Using as library](#using-as-library) * [Configuration precedence](#configuration-precedence) @@ -247,29 +248,27 @@ The following text tile arguments are supported: [[back to top](#dashboards-as-code)] -## `.filter.json` files +## `.filter.json` file(s) -The filter files contain filter definition for filters linked to multiple widgets. The filter is applied to all widget that have the given column. The schema is defined as follows: +A filter file contains a filter definition for filters linked to multiple widgets. The filter is applied to all widget +that have the given column. The schema is defined as follows: | Flag | Description | Type | Optional | |---------------|----------------------------------------------------|------------|----------| -| column | The columns the filter is applied. | str. | No* | -| columns | The columns the filter is applied. | list[str] | No* | +| columns | The columns the filter is applied. | list[str] | No | | type | The filter type, by default multi-select drop down | str | Yes | | title | The filter title | str | Yes | | description | The filter description | str | Yes | | order | The widget order | str | Yes | | id | The widget id | str | Yes | -> *column and columns are exclusive, one is required. - An example filter would be: ```json { - "column": "Country", + "columns": ["Country"], "title": "Countries", - "description": "Filter which countries are vizualized" + "description": "Filter which countries are visualized" } ```