-
Notifications
You must be signed in to change notification settings - Fork 152
[Kibana]: Rename ES|QL controls to Variable controls #3334
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -29,8 +29,10 @@ There are three types of controls: | |||||
|
||||||
 | ||||||
|
||||||
__________________________ | ||||||
:::::{applies-switch} | ||||||
|
||||||
|
||||||
::::{applies-item} stack: ga 9.0 | ||||||
## Create and add Options list and Range slider controls [create-and-add-options-list-and-range-slider-controls] | ||||||
|
||||||
To add interactive Options list and Range slider controls, create the controls, then add them to your dashboard. | ||||||
|
@@ -199,3 +201,179 @@ Delete controls from your dashboard. | |||||
:::{note} | ||||||
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. | ||||||
::: | ||||||
|
||||||
:::: | ||||||
______________________________ | ||||||
::::{applies-item} stack: ga 9.2 | ||||||
## Create and add Options list and Range slider controls [create-and-add-options-list-and-range-slider-controls] | ||||||
|
||||||
To add interactive Options list and Range slider controls, create the controls, then add them to your dashboard. | ||||||
|
||||||
1. Open or create a new dashboard. | ||||||
2. In **Edit** mode, select **Add** > **Controls** > **Control** in the toolbar. | ||||||
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**. | ||||||
4. In the **Field** list, select the field you want to filter on. | ||||||
5. Under **Control type**, select whether the control should be an **Options list** or a **Range slider**. | ||||||
::::{tip} | ||||||
Range sliders are for Number type fields only. | ||||||
:::: | ||||||
|
||||||
6. Define how you want the control to appear: | ||||||
|
||||||
* **Label**: Overwrite the default field name with a clearer and self-explanatory label. | ||||||
* **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. | ||||||
* **Expand width to fit available space**: Expand the width of the control to fit the available horizontal space on the dashboard. | ||||||
|
||||||
7. Specify the additional settings: | ||||||
|
||||||
* For Options lists: | ||||||
|
||||||
* Define whether users can select multiple values to filter with the control, or only one. | ||||||
* For Options list controls on *string* and *IP address* type fields, you can define how the control’s embedded search should behave: | ||||||
|
* For Options list controls on *string* and *IP address* type fields, you can define how the control’s embedded search should behave: | |
* For controls on *string* and *IP address* type fields, define how the control’s embedded search should behave: |
IIUC this whole list is about options lists so we don't need to specify again here. Removed "you can" to match the previous bullet.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* **Exact**: Show options that are a 100% match with the entered value. | |
* **Exact**: Show options that are an **exact** match with the entered value. |
This would be similar to the previous two bullet points.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* **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. | |
* **Ignore timeout for results:** Delays display of the list of values until it is fully loaded. This 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. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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. | |
* 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. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
9. Consider the position of the control if you have several controls active on the dashboard. When the [Chain controls](#configure-controls-settings) setting is enabled, controls are applied from left to right, which can change the available options based on their position. |
It wasn't clear if the left-to-right behavior was only applicable when chain controls is enabled. But I think that's the case, right?
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
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. |
Might consider putting the third sentence ("Variable controls act...") or some version of it earlier in this paragraph, it seems like a good introductory sentence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- values or fields that can be static or defined by a query | |
- values or fields (static, or defined by a query) |
Just another option with fewer words
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've seen the applies to labels coming first, at the beginning of the line. I like that better so the user knows whether the thing applies to them before they read it.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Use one of the following options to start creating a variable control: | |
1. To start creating a variable control, do one of the following: |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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. | |
- On the **Create variable control** flyout, while editing your {{esql}} visualization's query, use the autocomplete menu when it suggests adding a control, or type `?` in the query to open it manually. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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. | |
* For controls with **Static values**, select the options by entering them manually or by using the dropdown that lists available values. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* For controls with **Values from a query**, you write an {{esql}} query to populate the list of options. | |
* For controls with **Values from a query**, write an {{esql}} query to populate the list of options. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* 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. | |
* 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. |
More similar to other bullet points this way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Several settings that apply to all controls of the same dashboard are available. | |
Several settings apply to all controls that are part of a dashboard. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar.. | |
1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* **Label position** — Specify where the control label appears. | |
* **Label position**: Specify where the control label appears. |
Maybe : here since the next bullet uses it too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.