You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: explore-analyze/dashboards/add-controls.md
+48-60Lines changed: 48 additions & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,9 +41,9 @@ To add interactive Options list and Range slider controls, create the controls,
41
41
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**.
42
42
4. In the **Field** list, select the field you want to filter on.
43
43
5. Under **Control type**, select whether the control should be an **Options list** or a **Range slider**.
44
-
::::{tip}
44
+
:::{tip}
45
45
Range sliders are for Number type fields only.
46
-
::::
46
+
:::
47
47
48
48
6. Define how you want the control to appear:
49
49
@@ -62,9 +62,9 @@ To add interactive Options list and Range slider controls, create the controls,
62
62
***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.
63
63
***Exact**: Show options that are a 100% match with the entered value.
64
64
65
-
::::{tip}
65
+
:::{tip}
66
66
The search is not case sensitive. For example, searching for `ios` would still retrieve `iOS` if that value exists.
67
-
::::
67
+
:::
68
68
69
69
***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.
70
70
@@ -82,9 +82,9 @@ To add interactive Options list and Range slider controls, create the controls,
82
82
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**.
83
83
4. In the **Field** list, select the field you want to filter on.
84
84
5. Under **Control type**, select whether the control should be an **Options list** or a **Range slider**.
85
-
::::{tip}
85
+
:::{tip}
86
86
Range sliders are for Number type fields only.
87
-
::::
87
+
:::
88
88
89
89
6. Define how you want the control to appear:
90
90
@@ -103,9 +103,9 @@ To add interactive Options list and Range slider controls, create the controls,
103
103
***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.
104
104
***Exact**: Show options that are a 100% match with the entered value.
105
105
106
-
::::{tip}
106
+
:::{tip}
107
107
The search is not case sensitive. For example, searching for `ios` would still retrieve `iOS` if that value exists.
108
-
::::
108
+
:::
109
109
110
110
***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.
111
111
@@ -138,26 +138,23 @@ You can add one interactive time slider control to a dashboard.
138
138
::::
139
139
:::::
140
140
141
-
## Add {{esql}} controls [add-esql-control]
141
+
## Add {{esql}} or variable controls [add-esql-control]
142
142
143
143
:::::{applies-switch}
144
144
::::{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.
149
146
150
147
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.
151
148
152
149
:::{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:
154
151
- values or fields that can be static or defined by a query
155
152
- functions {applies_to}`stack: ga 9.1`
156
153
:::
157
154
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.
161
158
162
159

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

212
209
::::
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}
247
211
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.
249
213
250
214
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.
251
215
252
216
:::{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:
254
218
- values or fields that can be static or defined by a query
255
219
- functions {applies_to}`stack: ga 9.1`
256
220
:::
257
221
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.
261
225
262
226

263
227
@@ -309,12 +273,12 @@ You can then insert it in any other {{esql}} visualization queries by typing the
309
273
```
310
274
311
275

276
+
::::
277
+
:::::
312
278
313
279
## 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
318
282
Several settings that apply to all controls of the same dashboard are available.
319
283
320
284
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.
335
299
* To remove all controls from the dashboard, select **Delete all**.
336
300
337
301
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
+
:::::
338
326
339
327
## Edit Options list and Range slider control settings [edit-controls]
0 commit comments