Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 179 additions & 1 deletion explore-analyze/dashboards/add-controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,10 @@ There are three types of controls:

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

__________________________
:::::{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.
Expand Down Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **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.
* **Minimum width**: Specify how much horizontal space the control should occupy. 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.


* **Prefix**: Show options that *start with* the entered value.
* **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.
* **Exact**: Show options that are a 100% match with the entered value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **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.


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

* **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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **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.


* 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.


8. Select **Save**. The control can now be used.
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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?

10. Save the dashboard.


## Add time slider controls [add-time-slider-controls]

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

1. Open or create a new dashboard.
2. In **Edit** mode, select **Add** > **Controls** > **Time slider control**.
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).
4. Save the dashboard. The control can now be used.


## Add variable controls [add-variable-control]

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.


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.

:::{note}
Only **Options lists** are supported for variable controls. Options can be:
- values or fields that can be static or defined by a query
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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

- functions {applies_to}`stack: ga 9.1`
Copy link
Contributor

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.

:::

1. Use one of the following options to start creating a variable control:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:

- In **Edit** mode, select **Add** > **Controls** > **Variable control** in the toolbar.
- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.


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

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

* The type of the control.
* 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.

* For controls with **Values from a query**, you write an {{esql}} query to populate the list of options.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.

* The name of the control. This name is used to reference the control in {{esql}} queries.
* Start the name with `?` if you want the options to be simple static values.
* Start the name with `??` if you want the options of the control to be fields or functions. {applies_to}`stack: ga 9.1`
* 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.

* The label of the control. This is the label displayed for users viewing the dashboard for that control.
* The width of the control.

![ESQL control settings](/explore-analyze/images/esql-visualization-control-settings.png "title =50%")

3. Save the control.

The panel closes and the control is added to the dashboard.
If you added it by starting from a query, the control is directly inserted in that query and you can continue editing it.

You can then insert it in any other {{esql}} visualization queries by typing the control's name.


**Examples**

* Integrate filtering into your {{esql}} experience

```esql
| WHERE field == ?value
```

* Fields in controls for dynamic group by

```esql
| STATS count=COUNT(*) BY ?field
```

* Variable time ranges? Bind function configuration settings to a control

```esql
| BUCKET(@timestamp, ?interval),
```

* Make the function itself dynamic

```esql
| STATS metric = ?function
```

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


## Configure the controls settings [configure-controls-settings]

Several settings that apply to all controls of the same dashboard are available.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.


1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar..
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar..
1. In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar.

2. On the **Control settings** flyout, configure the following settings:

* **Label position** — Specify where the control label appears.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **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?

* **Filtering** settings:

* **Apply global filters to controls** — Define whether controls should ignore or apply any filter specified in the main filter bar of the dashboard.
* **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.

* **Selections** settings:

* **Validate user selections** — When selected, any selected option that results in no data is ignored.
* **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.
* **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.

* To remove all controls from the dashboard, select **Delete all**.

3. Select **Save** to apply the changes.


## Edit Options list and Range slider control settings [edit-controls]

Change the settings for Options list and Range slider controls.

1. Hover over the control you want to edit, then select ![The Edit control icon that opens the Edit control flyout](/explore-analyze/images/kibana-dashboard_controlsEditControl_8.3.0.png "").
2. In the **Edit control** flyout, change the options, then select **Save**.


## Delete controls [remove-controls]

Delete controls from your dashboard.

1. Hover over the control you want to delete, then select ![The Remove control icon that removes the control from the dashboard](/explore-analyze/images/kibana-dashboard_controlsRemoveControl_8.3.0.png "").
2. In the **Delete control?** window, select **Delete**.

:::{note}
If you delete a 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.
:::

::::

:::::




Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading