Overview
Screenboard widgets cannot be placed in groups.
The groups widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible. Use groups to organize the widgets on your dashboard.
Setup
- Add several widgets to your dashboard.
- Select multiple widgets with the click and drag feature, or press Shift and click.
- Click on the Group option.
- Click the pencil icon in the upper right corner of your group to choose a name and apply a style to your group.
API
Screenboard widgets cannot be placed in groups.
This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:
Expand All
Background color of the group title.
URL of image to display as a banner for the group.
Layout type of the group.
Allowed enum values: ordered
Whether to show the title or not.
default: true
How to align the text on the widget.
Allowed enum values: center,left,right
Type of the group widget.
Allowed enum values: group
default: group
The layout for a widget on a free or new dashboard layout dashboard.
The height of the widget. Should be a non-negative integer.
Whether the widget should be the first one on the second column in high density or not.
Note: Only for the new dashboard layout and only one widget in the dashboard should have this property set to true.
The width of the widget. Should be a non-negative integer.
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
{
"background_color": "string",
"banner_img": "string",
"layout_type": "ordered",
"show_title": false,
"title": "string",
"title_align": "string",
"type": "group",
"widgets": [
{
"definition": {
"requests": {
"fill": {
"q": "avg:system.cpu.user{*}"
}
},
"type": "hostmap"
},
"id": "integer",
"layout": {
"height": 0,
"is_column_break": false,
"width": 0,
"x": 0,
"y": 0
}
}
]
}
Further Reading
Additional helpful documentation, links, and articles:
