widgets Properties
The widgets key contains properties that determine the height and width of each widget, and where it’s placed on the dashboard layout. Because the Dashboard Designer uses a grid, you specify the properties in terms of rows and columns. For example, you specify the number of columns to determine the width of a widget.
| Property Name | Type | Details |
|---|---|---|
name | String | Internal name of the widget. This name is used to reference the widget in the dashboard JSON. Not included in the Dashboard Designer’s user interface. |
column | Integer | The column number where the widget starts. If this widget is included in a container, these properties are relative to the container widget. Included in the Dashboard Designer’s user interface. Value is determined based on the widget’s placement. |
row | Integer | The row number where the widget starts. Included in the Dashboard Designer’s user interface. Value is determined based on the widget’s placement. |
| colspan | Integer | The number of columns that a widget spans—the width of the widget. If the dashboard doesn’t have enough columns to accommodate the specified width, then columns are added to the dashboard. Included in the Dashboard Designer’s user interface. Value is determined based on the widget’s placement. |
| rowspan | Integer | The number of rows that a widget spans—the height of the widget. If the dashboard doesn’t have enough rows to accomodate the specified height, then rows are added. Included in the Dashboard Designer’s user interface. Value is determined based on the widget’s placement. |
widgetStyle | Array | Contains properties that set the border type, border color, and background color. Available for all widgets. Not included in the Dashboard Designer’s user interface. |
-
The
widgetStylekey contains properties that set the border type, border color, and background color of the widget. You can specify these attributes at two levels. To set the default for all dashboard widgets, use thewidgetStylefield undergridLayouts. To set a specific widget, use thewidgetStylefield underwidgets. This setting overrides the default settings for all widgets.