@controls reference
While it's possible to build controls using the Basic Editor, using the Advanced Editor is the only way to unlock the full flexibility of controls. This guide lists each property that can be used in the Advanced Editor, each possible value the properties can accept, and which @controls can recognize the properties and values.
There are two reference tables in this guide—the first lists properties for static controls (nothing happens when map readers click on these controls), and the second lists properties for interactive controls (map readers can interact with the map by clicking on these controls).
All values are unitless.
If you find a property or a value that's not documented here, let us know!
Jump to the reference for interactive controls.
Static controls
| Property | Description | Valid Values | Legend | Image | Label | Text | Title | SNA Dashboard |
|---|---|---|---|---|---|---|---|---|
| Defines background color of control |
| ||||||
| Defines color of control's text |
| ||||||
| Defines font family of control's text |
| ||||||
| Defines size of control's text |
| ||||||
| Defines style of control's text |
| ||||||
| Defines weight of control's text |
| ||||||
| Defines height of control |
| ||||||
| Defines space between the control and other controls on the map |
| ||||||
| Defines which metrics will be included in the dashboard |
| ||||||
| Defines opacity of the control |
| ||||||
| Defines space between the control's border and its contents |
| ||||||
| Defines the source of the image |
| ||||||
| Defines alignment of text within the control |
| ||||||
| Any plain text string. Markdown and some HTML allowed. |
| ||||||
| Defines width of control |
|
Interactive controls
| Property | Description | Valid Values | Filter | Showcase | Focus | Cluster | Tagged Timeline | View Toggle |
|---|---|---|---|---|---|---|---|---|
| Defines how the control is presented |
| ||||||
| Defines background color of control |
| ||||||
| Defines the field to filter, showcase, or cluster by |
| ||||||
| Defines color of control's text (labels, placeholders, and summaries only) |
| ||||||
| Defines which options should be selected by default |
| ||||||
| Allows you to remove field values from the available choices |
| ||||||
| Defines font family of control's text (labels, placeholders, and summaries only) |
| ||||||
| Defines size of control's text (labels, placeholders, and summaries only) |
| ||||||
| Defines style of control's text (labels, placeholders, and summaries only) |
| ||||||
| Defines weight of control's text (labels, placeholders, and summaries only) |
| ||||||
| Defines height of control |
| ||||||
| Adds a label above the control |
| ||||||
| Defines space between the control and other controls on the map |
| ||||||
| Controls how the selection is showcased. |
| ||||||
| Controls whether more than one option can be selected at a time |
| ||||||
| Allows you to explicitly define which field values should be included as available choices |
| ||||||
| Defines opacity of the control |
| ||||||
| Allows you to explicitly define which options should be included as available choices |
| ||||||
| Defines the level of connections you'd like to see (out 1: first-degree only, out 2: first- and second-degree, etc.) |
| ||||||
| Defines space between the control's border and its contents |
| ||||||
| The text to display when nothing is selected
(for |
| ||||||
| Defines the years that should be included |
| ||||||
| Summarizes the options that have been selected
(for |
| ||||||
| Defines which items will be affected by the control |
| ||||||
| Defines width of control |
|
Last updated