Configuring the Toolbar Widget

The Toolbar widget is a control that lets users set workspace-wide parameters and apply them to other widgets. You choose which controls appear in the toolbar (for example, vantage points, limit, metric, filter, or entity search). The values users select are sent to Data Store widgets and other widgets that are configured to accept those interaction types.

Note: The Toolbar widget may be available only in certain environments. If you do not see it in the widget picker, it may not be enabled for your configuration.

Opening the Toolbar widget configuration

  1. Enter edit mode on the workspace.

  2. Open the widget menu (ellipsis on the widget header).

  3. Click Configure.

The Toolbar configuration dialog opens with two steps: Visualization and Interactions.

Visualization step

On the Visualization step you:

  • Set the widget name.

  • Choose which controls appear in the toolbar.

  • Configure each control's label and default values.

Widget name

Set a name for the widget. The name appears in the widget header.

Controls

Select which controls to display in the toolbar. You can include any combination of the following:

  • Vantage Point: A multi-select list of vantage points (data sources). Users choose which vantage points supply data. The selection is sent to widgets that accept the data source interaction.

  • Limit: A numeric value (for example, top 10 or top 100). Users can change the value. The value is sent to widgets that accept the value interaction (often used as the top-by limit in Data Store widgets).

  • Metric: A single metric (for example, Throughput). Users pick one metric from a dropdown. The selection is sent to widgets that accept the metric interaction.

  • Metrics: Multiple metrics. Users select one or more metrics. The selection is sent to widgets that accept the metric interaction.

  • Filter: Filter conditions (for example, property filters on the data set). The filter is sent to widgets that accept the group interaction.

  • Auto-Complete: An entity search tied to a property (for example, User Device Name). Users type to search and pick a single entityClosed Things deployed in the customer environment that are needed to run the business, such as applications, devices, interfaces, and locations.. The selection is sent to widgets that accept the group interaction.

After you select the controls, configure the ones you added. Each control has a Label field so you can customize the text shown next to it in the toolbar (for example, Top, By, User Device, or Vantage Point).

Data set (for Metric, Metrics, Filter, and Auto-Complete)

If you include Metric, Metrics, Filter, or Auto-Complete, you must choose a workspace and a data set.

The workspace and data set define which metrics and properties are available for those controls. For example, if the data set is Device Resource Usage (Hourly), the metric list and filter options reflect that object type.

Vantage Point control

If you include the Vantage Point control, select which vantage points are available in the dropdown and set the label.

Users see only the vantage points you list. Optionally restrict the list so the toolbar applies only to a subset of data sources.

Limit control

If you include the Limit control, set the default value (for example, 10) and the label.

The value is typically used as the top N in downstream Data Store widgets. The allowed range is 1 through 1000.

Metric and Metrics controls

If you include Metric, choose the default metric from the dropdown (for example, Throughput).

If you include Metrics, choose the default set of metrics. The list of metrics comes from the data set you selected.

Filter control

If you include the Filter control, configure the default filter conditions using the filter bar.

Users can change the filter in the toolbar. The filter is passed to widgets that accept the group interaction.

Auto-Complete control

If you include the Auto-Complete control, choose the entity type (property) to search on (for example, User Device Name).

Users type to find an entity and select one. The selection is passed as a group filter to widgets that accept the group interaction.

Interactions step

On the Interactions step you configure which widgets receive the toolbar's values. The options shown depend on which controls you added.

For example:

  • If you added the Vantage Point control, you can choose which widgets receive the data source interaction.

  • If you added Limit, you can choose which widgets receive the value interaction.

  • If you added Metric or Metrics, you can choose which widgets receive the metric interaction.

  • If you added Filter or Auto-Complete, you can choose which widgets receive the group interaction.

Configure the same interaction types you would for a Data Store or other widget: select the target widgets for each type, and optionally enable Only show interaction data or Do not replace group by where applicable. For more on how interactions work, see Library Widget Interactivity.

View and Apply

On the workspace, the toolbar shows the controls you configured in a horizontal row. For Vantage Point and Metrics, users change the selection and then click Apply to send the new values to the connected widgets. For Limit, Metric, Filter, and Auto-Complete, changes are applied immediately when the user updates the control.