Skip to content

Commit 4966769

Browse files
alaudazzitheletterfflorent-leborgne
authored
[Kibana]: Rename ES|QL controls to Variable controls (#3334)
This PR: - Renames ES|QL controls to Variable controls - Resizes existing screenshots to show just the area in question without titles or menu bars that require maintenance over time. They are enough contextualized to remain helpful - Aligns the text with 9.2 UI **Note for the reviewers**: - I'm figuring out how to refresh animated GIFs like this one: `![Editing {{esql}} controls from a dashboard](https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blte42dfaa404bfc2d6/67d2e31e2e4dc59da190d78f/dashboard-esql-controls.gif`) - The [Applies switch](https://elastic.github.io/docs-builder/syntax/applies-switch/) mechanism is not working as expected Closes #3013 --------- Co-authored-by: Fabrizio Ferri Benedetti <[email protected]> Co-authored-by: florent-leborgne <[email protected]>
1 parent 97287c3 commit 4966769

File tree

5 files changed

+34
-26
lines changed

5 files changed

+34
-26
lines changed

explore-analyze/dashboards/add-controls.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,16 @@ There are three types of controls:
2929

3030
![Time slider control for the the Last 7 days](/explore-analyze/images/dashboard_timeslidercontrol_8.17.0.gif)
3131

32-
33-
3432
## Create and add Options list and Range slider controls [create-and-add-options-list-and-range-slider-controls]
3533

3634
To add interactive Options list and Range slider controls, create the controls, then add them to your dashboard.
3735

3836
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+
4042
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**.
4143
4. In the **Field** list, select the field you want to filter on.
4244
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,
4749
6. Define how you want the control to appear:
4850

4951
* **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.
5153
* **Expand width to fit available space**: Expand the width of the control to fit the available horizontal space on the dashboard.
5254

5355
7. Specify the additional settings:
@@ -59,36 +61,39 @@ To add interactive Options list and Range slider controls, create the controls,
5961

6062
* **Prefix**: Show options that *start with* the entered value.
6163
* **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.
6365

6466
::::{tip}
6567
The search is not case sensitive. For example, searching for `ios` would still retrieve `iOS` if that value exists.
6668
::::
6769

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.
6971

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.
7173

7274
8. Select **Save and close**. The control can now be used.
7375
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.
7476
10. Save the dashboard.
7577

76-
7778
## Add time slider controls [add-time-slider-controls]
7879

7980
You can add one interactive time slider control to a dashboard.
8081

8182
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+
8388
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).
8489
4. Save the dashboard. The control can now be used.
8590

8691

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+
:::
9297

9398
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.
9499

@@ -100,21 +105,21 @@ Only **Options lists** are supported for {{esql}}-based controls. Options can be
100105
- functions {applies_to}`stack: ga 9.1`
101106
:::
102107

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.
106111

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

109114
2. A menu opens to let you configure the control. This is where you can specify:
110115

111116
* 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.
114119
* The name of the control. This name is used to reference the control in {{esql}} queries.
115120
* Start the name with `?` if you want the options to be simple static values.
116121
* 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.
118123
* The label of the control. This is the label displayed for users viewing the dashboard for that control.
119124
* The width of the control.
120125

@@ -156,12 +161,15 @@ You can then insert it in any other {{esql}} visualization queries by typing the
156161

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

159-
160164
## Configure the controls settings [configure-controls-settings]
161165

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**.
163172

164-
1. In **Edit** mode, select **Controls** > **Settings**.
165173
2. On the **Control settings** flyout, configure the following settings:
166174

167175
* **Label position** — Specify where the control label appears.
@@ -197,5 +205,5 @@ Delete controls from your dashboard.
197205
2. In the **Delete control?** window, select **Delete**.
198206

199207
:::{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.
201209
:::
-14.9 KB
Loading
-126 KB
Loading

explore-analyze/query-filter/languages/esql-kibana.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ You can also edit the {{esql}} visualization from here. Click the options button
297297
:width: 50%
298298
:::
299299

300-
You can also [Add dashboard controls from your ES|QL visualization's query](/explore-analyze/dashboards/add-controls.md#add-esql-control)
300+
You can also [Add dashboard controls from your ES|QL visualization's query](/explore-analyze/dashboards/add-controls.md#add-variable-control)
301301

302302

303303
## Create an enrich policy [esql-kibana-enrich]

explore-analyze/visualize/esorql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can then **Save** and add it to an existing or a new dashboard using the sav
4545
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.
4646
:::
4747

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).
4949
5. Select **Apply and close** to save the visualization to the dashboard.
5050

5151
### Customize the appearance of your {{esql}} visualization

0 commit comments

Comments
 (0)