Common Widget Configuration¶
The widget editing dialog typically includes Basic Information, Data Fields, Chart Style, and Time Settings. Available panels and fields depend on the widget.
Basic Information¶
Field |
Description |
Conditions and Limitations |
|---|---|---|
Title |
The title displayed for the widget on the canvas. It supports localized input. |
Usually limited to 50 characters. |
Description |
The information displayed when an application user hovers over the title. |
Usually limited to 500 characters. |
Show Title |
Controls whether the title is displayed in the upper-left corner of the widget. |
The widget content remains available when this option is disabled. |
Trend Analysis |
When enabled, opens the Charting Tool pop-up from widget data. |
Displayed only for widgets that support trend analysis; not supported by the Asset List widget. |
Pop-up Color |
Sets the color scheme of the Trend Analysis pop-up. |
Displayed only when Trend Analysis is enabled; not supported by the Asset List widget. |
Data Fields¶
Widgets that use standard data fields typically support the following fields:
Field |
Description |
Conditions and Limitations |
|---|---|---|
Name |
The displayed name of the data field in the widget. |
Supports localized input. |
Unit |
The display unit for the data field. |
Availability depends on the data type and widget. |
Convert Unit |
Automatically converts a value to an appropriate unit. |
Applies only to numeric units supported by the widget. |
Decimal Places |
Sets the number of decimal places shown for a value. |
The allowed range depends on the widget. |
Show Thousands Separator |
Separates numeric values by thousands. |
Applies only to numeric data. |
Asset Dimension Aggregation |
Defines the aggregation method when values are summarized across assets. |
Available options come from data-field metadata. Not every field supports sum, average, and formula; attribute data and some widgets might not use this setting. |
Note
In the current version, the configuration value for average aggregation has compatibility differences. If a project depends on average results, verify the actual aggregation method through query results or API requests in the target environment.
Widget Exceptions¶
Widget type |
Standard data fields |
Trend Analysis |
Time Settings |
|---|---|---|---|
Liquid Fill, Metric, Progress Bar, Ranking, and Pie Chart |
Supported; see the individual widget topic for quantity limits. |
Depends on the widget configuration. |
An independent Time Settings panel is usually not available. |
Time Series |
Supported. |
Depends on the widget configuration. |
A valid time range and granularity are required. |
Embedded Content, Action, and DTV Widgets |
Not used. |
Not applicable. |
Not applicable. |
Asset List |
Column data is configured by object type. |
Not supported. |
Standard widget Time Settings are not available. |
Special Widgets |
Include fixed built-in items; some allow additional fields. |
Depends on the widget configuration. |
Available for only some widgets. |
Save Validation¶
Before saving, the system validates the number of data fields, required URLs, time ranges and granularities, and numeric ranges. Validation rules differ by widget. For example, Time Series requires a valid time range and granularity, and the minimum value of Ranking cannot be greater than its maximum value.