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
+32-24Lines changed: 32 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,14 +29,16 @@ There are three types of controls:
29
29
30
30

31
31
32
-
33
-
34
32
## Create and add Options list and Range slider controls [create-and-add-options-list-and-range-slider-controls]
35
33
36
34
To add interactive Options list and Range slider controls, create the controls, then add them to your dashboard.
37
35
38
36
1. Open or create a new dashboard.
39
-
2. In **Edit** mode, select **Controls** > **Add control** in the dashboard toolbar.
37
+
2. Add a control.
38
+
39
+
* {applies_to}`stack: ga 9.2` In **Edit** mode, select **Add** > **Controls** > **Control** in the toolbar.
40
+
* {applies_to}`stack: ga 9.0` In **Edit** mode, select **Controls** > **Add control** in the dashboard toolbar.
41
+
40
42
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**.
41
43
4. In the **Field** list, select the field you want to filter on.
42
44
5. Under **Control type**, select whether the control should be an **Options list** or a **Range slider**.
@@ -47,7 +49,7 @@ To add interactive Options list and Range slider controls, create the controls,
47
49
6. Define how you want the control to appear:
48
50
49
51
***Label**: Overwrite the default field name with a clearer and self-explanatory label.
50
-
***Minimum width**: How much horizontal space does the control occupies. The final width can vary depending on the other controls and their own width setting.
52
+
***Minimum width**: Specify how much horizontal space does the control should occupy. The final width can vary depending on the other controls and their own width setting.
51
53
***Expand width to fit available space**: Expand the width of the control to fit the available horizontal space on the dashboard.
52
54
53
55
7. Specify the additional settings:
@@ -59,36 +61,39 @@ To add interactive Options list and Range slider controls, create the controls,
59
61
60
62
***Prefix**: Show options that *start with* the entered value.
61
63
***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.
62
-
***Exact**: Show options that are a 100% match with the entered value.
64
+
***Exact**: Show options that are an *exact* match with the entered value.
63
65
64
66
::::{tip}
65
67
The search is not case sensitive. For example, searching for `ios` would still retrieve `iOS` if that value exists.
66
68
::::
67
69
68
-
***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
+
***Ignore timeout for results**: Delays the display of the list of values until 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.
69
71
70
-
* For Range sliders, set the step size. The step size determines the number of steps of the slider. The smaller the step size is, the more steps there is in the slider.
72
+
* For Range sliders, set the step size. The step size determines the slider's number of steps. The smaller a slider's step size, the more steps it has.
71
73
72
74
8. Select **Save and close**. The control can now be used.
73
75
9. Consider the position of the control if you have several controls active on the dashboard. Controls are applied from left to right, which can change the options available depending on their position when the [Chain controls](#configure-controls-settings) setting is enabled.
74
76
10. Save the dashboard.
75
77
76
-
77
78
## Add time slider controls [add-time-slider-controls]
78
79
79
80
You can add one interactive time slider control to a dashboard.
80
81
81
82
1. Open or create a new dashboard.
82
-
2. In **Edit** mode, select **Controls** > **Add time slider control**.
83
+
2. Add a time slider control.
84
+
85
+
* {applies_to}`stack: ga 9.2` In **Edit** mode, select **Add** > **Controls** > **Time slider control** in the toolbar.
86
+
* {applies_to}`stack: ga 9.0` In **Edit** mode, select **Controls** > **Add time slider control**.
87
+
83
88
3. The time slider control uses the time range from the global time filter. To change the time range in the time slider control, [change the global time filter](../query-filter/filtering.md).
84
89
4. Save the dashboard. The control can now be used.
85
90
86
91
87
-
## Add {{esql}} controls [add-esql-control]
88
-
```{applies_to}
89
-
stack: preview 9.0
90
-
serverless: preview
91
-
```
92
+
## Add variable controls [add-variable-control]
93
+
94
+
:::{note}
95
+
In versions `9.0` and `9.1`, variable controls are called {{esql}} controls.
96
+
:::
92
97
93
98
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.
94
99
@@ -100,21 +105,21 @@ Only **Options lists** are supported for {{esql}}-based controls. Options can be
100
105
- functions {applies_to}`stack: ga 9.1`
101
106
:::
102
107
103
-
1. Use one of the following options to start creating an {{esql}} control:
104
-
-**From the dashboard Controls menu**: In **Edit** mode, select **Controls** > **Add {{esql}} control** in the dashboard toolbar. {applies_to}`stack: ga 9.1`
105
-
-**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.
108
+
1. Use one of the following options to start creating a variable control:
109
+
- In **Edit** mode, select **Add** > **Controls** > **Variable control** in the toolbar.
110
+
-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.
106
111
107
112

108
113
109
114
2. A menu opens to let you configure the control. This is where you can specify:
110
115
111
116
* The type of the control.
112
-
* For controls with **Static values**, you select the options available in the controls by entering them manually or by using a dropdown listing available values.
113
-
* For controls with **Values from a query**, you write an {{esql}} query to populate the list of options.
117
+
* For controls with **Static values**, select the options available in the controls by entering them manually or by using a dropdown listing available values.
118
+
* For controls with **Values from a query**, write an {{esql}} query to populate the list of options.
114
119
* The name of the control. This name is used to reference the control in {{esql}} queries.
115
120
* Start the name with `?` if you want the options to be simple static values.
116
121
* Start the name with `??` if you want the options of the control to be fields or functions. {applies_to}`stack: ga 9.1`
117
-
*Values available to select for users with this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.
122
+
*The values users can select for this control. You can add multiple values from suggested fields, or type in custom values. If you selected **Values from a query**, you must instead write an {{esql}} query at this step.
118
123
* The label of the control. This is the label displayed for users viewing the dashboard for that control.
119
124
* The width of the control.
120
125
@@ -156,12 +161,15 @@ You can then insert it in any other {{esql}} visualization queries by typing the
156
161
157
162

158
163
159
-
160
164
## Configure the controls settings [configure-controls-settings]
161
165
162
-
Several settings that apply to all controls of the same dashboard are available.
166
+
Several settings apply to all controls that are part of a dashboard.
167
+
168
+
1. Configure the control settings.
169
+
170
+
* {applies_to}`stack: ga 9.2` In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar.
171
+
* {applies_to}`stack: ga 9.0` In **Edit** mode, select **Controls** > **Settings**.
163
172
164
-
1. In **Edit** mode, select **Controls** > **Settings**.
165
173
2. On the **Control settings** flyout, configure the following settings:
166
174
167
175
***Label position** — Specify where the control label appears.
@@ -197,5 +205,5 @@ Delete controls from your dashboard.
197
205
2. In the **Delete control?** window, select **Delete**.
198
206
199
207
:::{note}
200
-
If you delete an {{esql}} control that's used in an {{esql}} visualization, the visualization will break. You must edit the visualization query and remove or update the control reference.
208
+
If you delete an variable control that's used in an {{esql}} visualization, the visualization will break. You must edit the visualization query and remove or update the control reference.
Copy file name to clipboardExpand all lines: explore-analyze/visualize/esorql.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ You can then **Save** and add it to an existing or a new dashboard using the sav
45
45
When you edit the query and run it again, the visualization configuration persists as long as it is compatible with the query changes. Refer to [](#chart-config-persist) for more details.
46
46
:::
47
47
48
-
4. You can bind controls to your ES|QL visualizations in dashboards by creating [ES|QL controls](../dashboards/add-controls.md#add-esql-control).
48
+
4. You can bind controls to your ES|QL visualizations in dashboards by creating [ES|QL controls](../dashboards/add-controls.md#add-variable-control).
49
49
5. Select **Apply and close** to save the visualization to the dashboard.
50
50
51
51
### Customize the appearance of your {{esql}} visualization
0 commit comments