Class WidgetConditionalFormat

Define a conditional format for the widget.

Hierarchy

  • WidgetConditionalFormat

Constructors

constructor

Properties

additionalProperties? comparator customBgColor? customFgColor? hideValue? imageUrl? metric? palette timeframe? value

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

comparator

comparator: WidgetComparator

Comparator to apply.

Optional customBgColor

customBgColor?: string

Color palette to apply to the background, same values available as palette.

Optional customFgColor

customFgColor?: string

Color palette to apply to the foreground, same values available as palette.

Optional hideValue

hideValue?: boolean

True hides values.

Optional imageUrl

imageUrl?: string

Displays an image as the background.

Optional metric

metric?: string

Metric from the request to correlate this conditional format with.

palette

palette: WidgetPalette

Color palette to apply.

Optional timeframe

timeframe?: string

Defines the displayed timeframe.

value

value: number

Value for the comparator.

Settings

Member Visibility

Theme

Generated using TypeDoc