Group Widget

The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible:

Setup

Choose a name for your group by using the cog icon in the upper right corner of your group.

API

This widget can be used with the Dashboards API. See the Dashboards API documentation for additional reference.

The dedicated widget JSON schema definition for the change widget is:

Expand All

Field

Type

Description

background_color

string

Background color of the group title.

banner_img

string

URL of image to display as a banner for the group.

layout_type [required]

enum

Layout type of the group. Allowed enum values: ordered

show_title

boolean

Whether to show the title or not.

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

type [required]

enum

Type of the group widget. Allowed enum values: group

widgets [required]

[object]

List of widget groups.

definition [required]

object <oneOf>

Definition of the widget.

id

int64

ID of the widget.

layout

object

The layout for a widget on a free or new dashboard layout dashboard.

height [required]

int64

The height of the widget. Should be a non-negative integer.

is_column_break

boolean

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.

width [required]

int64

The width of the widget. Should be a non-negative integer.

x [required]

int64

The position of the widget on the x (horizontal) axis. Should be a non-negative integer.

y [required]

int64

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:

Building Dashboards using JSONDOCUMENTATION more more