Class GroupWidgetDefinition

The group 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.

Hierarchy

  • GroupWidgetDefinition

Constructors

constructor

Properties

additionalProperties? backgroundColor? bannerImg? layoutType showTitle? title? titleAlign? type widgets

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional backgroundColor

backgroundColor?: string

Background color of the widget. Supported values are white, blue, purple, pink, orange, yellow, green, gray, vivid_blue, vivid_purple, vivid_pink, vivid_orange, vivid_yellow, vivid_green, and transparent.

Optional bannerImg

bannerImg?: string

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

layoutType

layoutType: WidgetLayoutType

Layout type of the group.

Optional showTitle

showTitle?: boolean

Whether to show the title or not.

Optional title

title?: string

Title of the widget.

Optional titleAlign

titleAlign?: WidgetTextAlign

How to align the text on the widget.

type

type: GroupWidgetDefinitionType

Type of the group widget.

widgets

widgets: Widget[]

List of widget groups.

Settings

Member Visibility

Theme

Generated using TypeDoc