Skip to content

Commit 4005dc5

Browse files
committed
Fix remaining sections
1 parent 510be7d commit 4005dc5

File tree

1 file changed

+48
-60
lines changed

1 file changed

+48
-60
lines changed

explore-analyze/dashboards/add-controls.md

Lines changed: 48 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ To add interactive Options list and Range slider controls, create the controls,
4141
3. On the **Create control** flyout, from the **Data view** dropdown, select the data view that contains the field you want to use for the **Control**.
4242
4. In the **Field** list, select the field you want to filter on.
4343
5. Under **Control type**, select whether the control should be an **Options list** or a **Range slider**.
44-
::::{tip}
44+
:::{tip}
4545
Range sliders are for Number type fields only.
46-
::::
46+
:::
4747

4848
6. Define how you want the control to appear:
4949

@@ -62,9 +62,9 @@ To add interactive Options list and Range slider controls, create the controls,
6262
* **Contains**: Show options that *contain* the entered value. This setting option is only available for *string* type fields. Results can take longer to show with this option.
6363
* **Exact**: Show options that are a 100% match with the entered value.
6464

65-
::::{tip}
65+
:::{tip}
6666
The search is not case sensitive. For example, searching for `ios` would still retrieve `iOS` if that value exists.
67-
::::
67+
:::
6868

6969
* **Ignore timeout for results** delays the display of the list of values to when it is fully loaded. This option is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.
7070

@@ -82,9 +82,9 @@ To add interactive Options list and Range slider controls, create the controls,
8282
3. On the **Create control** flyout, from the **Data view** dropdown, select the data view that contains the field you want to use for the **Control**.
8383
4. In the **Field** list, select the field you want to filter on.
8484
5. Under **Control type**, select whether the control should be an **Options list** or a **Range slider**.
85-
::::{tip}
85+
:::{tip}
8686
Range sliders are for Number type fields only.
87-
::::
87+
:::
8888

8989
6. Define how you want the control to appear:
9090

@@ -103,9 +103,9 @@ To add interactive Options list and Range slider controls, create the controls,
103103
* **Contains**: Show options that *contain* the entered value. This setting option is only available for *string* type fields. Results can take longer to show with this option.
104104
* **Exact**: Show options that are a 100% match with the entered value.
105105

106-
::::{tip}
106+
:::{tip}
107107
The search is not case sensitive. For example, searching for `ios` would still retrieve `iOS` if that value exists.
108-
::::
108+
:::
109109

110110
* **Ignore timeout for results** delays the display of the list of values to when it is fully loaded. This option is useful for large data sets, to avoid missing some available options in case they take longer to load and appear when using the control.
111111

@@ -138,26 +138,23 @@ You can add one interactive time slider control to a dashboard.
138138
::::
139139
:::::
140140

141-
## Add {{esql}} controls [add-esql-control]
141+
## Add {{esql}} or variable controls [add-esql-control]
142142

143143
:::::{applies-switch}
144144
::::{applies-item} stack: ga 9.2
145-
::::
146-
::::{applies-item} {stack: ga 9.0, serverless: preview}
147-
148-
You can bind controls to your {{esql}} visualizations in dashboards. When creating an {{esql}} visualization, the autocomplete suggestions prompt control insertion for field values, field names, function configuration, and function names. {{esql}} controls act as variables in your {{esql}} visualization queries.
145+
You can bind controls to your {{esql}} visualizations in dashboards. When creating an {{esql}} visualization, the autocomplete suggestions prompt control insertion for field values, field names, function configuration, and function names. Variable controls act as variables in your {{esql}} visualization queries.
149146

150147
This enables controls that only apply to specific panels in your dashboards, and exposes visualization configuration such as date histogram interval controls to dashboard users.
151148

152149
:::{note}
153-
Only **Options lists** are supported for {{esql}}-based controls. Options can be:
150+
Only **Options lists** are supported for variable controls. Options can be:
154151
- values or fields that can be static or defined by a query
155152
- functions {applies_to}`stack: ga 9.1`
156153
:::
157154

158-
1. Use one of the following options to start creating an {{esql}} control:
159-
- **From the dashboard Controls menu**: In **Edit** mode, select **Controls** > **Add {{esql}} control** in the dashboard toolbar. {applies_to}`stack: ga 9.1`
160-
- **From your {{esql}} visualization's query**: While editing your {{esql}} visualization's query, the autocomplete menu suggests adding a control when relevant or when typing `?` in the query.
155+
1. Use one of the following options to start creating a variable control:
156+
- In **Edit** mode, select **Add** > **Controls** > **Variable control** in the toolbar.
157+
- On the **Create variable control** flyout, while editing your {{esql}} visualization's query, the autocomplete menu suggests adding a control when relevant or when typing `?` in the query.
161158

162159
![ESQL query prompting to add a control](/explore-analyze/images/esql-visualization-control-suggestion.png)
163160

@@ -210,54 +207,21 @@ You can then insert it in any other {{esql}} visualization queries by typing the
210207

211208
![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif)
212209
::::
213-
:::::
214-
215-
## Configure the controls settings [configure-controls-settings]
216-
:::::{applies-switch}
217-
::::{applies-item} stack: ga 9.2
218-
::::
219-
::::{applies-item} stack: ga 9.0
220-
Several settings that apply to all controls of the same dashboard are available.
221-
222-
1. In **Edit** mode, select **Controls** > **Settings**.
223-
2. On the **Control settings** flyout, configure the following settings:
224-
225-
* **Label position** — Specify where the control label appears.
226-
* **Filtering** settings:
227-
228-
* **Apply global filters to controls** — Define whether controls should ignore or apply any filter specified in the main filter bar of the dashboard.
229-
* **Apply global time range to controls** — Define whether controls should ignore or apply the main time range specified for the dashboard. Note that [time slider controls](#add-time-slider-controls) rely on the global time range and don’t work properly when this option is disabled.
230-
231-
* **Selections** settings:
232-
233-
* **Validate user selections** — When selected, any selected option that results in no data is ignored.
234-
* **Chain controls** — When selected, controls are applied sequentially from left to right, and line by line. Any selected options in one control narrows the available options in the next control.
235-
* **Apply selections automatically** — The dashboard is updated dynamically when options are selected in controls. When this option is disabled, users first need to **Apply** their control selection before they are applied to the dashboard.
236-
237-
* To remove all controls from the dashboard, select **Delete all**.
238-
239-
3. Select **Save and close** to apply the changes.
240-
::::
241-
:::::
242-
243-
## Add variable controls [add-variable-control]
244-
```{applies_to}
245-
stack: ga 9.2
246-
```
210+
::::{applies-item} {stack: ga 9.0, serverless: preview}
247211

248-
You can bind controls to your {{esql}} visualizations in dashboards. When creating an {{esql}} visualization, the autocomplete suggestions prompt control insertion for field values, field names, function configuration, and function names. Variable controls act as variables in your {{esql}} visualization queries.
212+
You can bind controls to your {{esql}} visualizations in dashboards. When creating an {{esql}} visualization, the autocomplete suggestions prompt control insertion for field values, field names, function configuration, and function names. {{esql}} controls act as variables in your {{esql}} visualization queries.
249213

250214
This enables controls that only apply to specific panels in your dashboards, and exposes visualization configuration such as date histogram interval controls to dashboard users.
251215

252216
:::{note}
253-
Only **Options lists** are supported for variable controls. Options can be:
217+
Only **Options lists** are supported for {{esql}}-based controls. Options can be:
254218
- values or fields that can be static or defined by a query
255219
- functions {applies_to}`stack: ga 9.1`
256220
:::
257221

258-
1. Use one of the following options to start creating a variable control:
259-
- In **Edit** mode, select **Add** > **Controls** > **Variable control** in the toolbar.
260-
- On the **Create variable control** flyout, while editing your {{esql}} visualization's query, the autocomplete menu suggests adding a control when relevant or when typing `?` in the query.
222+
1. Use one of the following options to start creating an {{esql}} control:
223+
- **From the dashboard Controls menu**: In **Edit** mode, select **Controls** > **Add {{esql}} control** in the dashboard toolbar. {applies_to}`stack: ga 9.1`
224+
- **From your {{esql}} visualization's query**: While editing your {{esql}} visualization's query, the autocomplete menu suggests adding a control when relevant or when typing `?` in the query.
261225

262226
![ESQL query prompting to add a control](/explore-analyze/images/esql-visualization-control-suggestion.png)
263227

@@ -309,12 +273,12 @@ You can then insert it in any other {{esql}} visualization queries by typing the
309273
```
310274

311275
![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif)
276+
::::
277+
:::::
312278

313279
## Configure the controls settings [configure-controls-settings]
314-
```{applies_to}
315-
stack: ga 9.2
316-
```
317-
280+
:::::{applies-switch}
281+
::::{applies-item} stack: ga 9.2
318282
Several settings that apply to all controls of the same dashboard are available.
319283

320284
1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar..
@@ -335,6 +299,30 @@ Several settings that apply to all controls of the same dashboard are available.
335299
* To remove all controls from the dashboard, select **Delete all**.
336300

337301
3. Select **Save** to apply the changes.
302+
::::
303+
::::{applies-item} stack: ga 9.0
304+
Several settings that apply to all controls of the same dashboard are available.
305+
306+
1. In **Edit** mode, select **Controls** > **Settings**.
307+
2. On the **Control settings** flyout, configure the following settings:
308+
309+
* **Label position** — Specify where the control label appears.
310+
* **Filtering** settings:
311+
312+
* **Apply global filters to controls** — Define whether controls should ignore or apply any filter specified in the main filter bar of the dashboard.
313+
* **Apply global time range to controls** — Define whether controls should ignore or apply the main time range specified for the dashboard. Note that [time slider controls](#add-time-slider-controls) rely on the global time range and don’t work properly when this option is disabled.
314+
315+
* **Selections** settings:
316+
317+
* **Validate user selections** — When selected, any selected option that results in no data is ignored.
318+
* **Chain controls** — When selected, controls are applied sequentially from left to right, and line by line. Any selected options in one control narrows the available options in the next control.
319+
* **Apply selections automatically** — The dashboard is updated dynamically when options are selected in controls. When this option is disabled, users first need to **Apply** their control selection before they are applied to the dashboard.
320+
321+
* To remove all controls from the dashboard, select **Delete all**.
322+
323+
3. Select **Save and close** to apply the changes.
324+
::::
325+
:::::
338326

339327
## Edit Options list and Range slider control settings [edit-controls]
340328
:::::{applies-switch}

0 commit comments

Comments
 (0)