Class HeatMapWidgetDefinition

The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is.

Hierarchy

  • HeatMapWidgetDefinition

Constructors

constructor

Properties

additionalProperties? customLinks? events? legendSize? markers? requests showLegend? time? title? titleAlign? titleSize? type xaxis? yaxis?

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 customLinks

customLinks?: WidgetCustomLink[]

List of custom links.

Optional events

events?: WidgetEvent[]

List of widget events.

Optional legendSize

legendSize?: string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

Optional markers

markers?: WidgetMarker[]

List of markers.

requests

requests: [HeatMapWidgetRequest]

List of widget types.

Optional showLegend

showLegend?: boolean

Whether or not to display the legend on this widget.

Optional time

time?: WidgetTime

Time setting for the widget.

Optional title

title?: string

Title of the widget.

Optional titleAlign

titleAlign?: WidgetTextAlign

How to align the text on the widget.

Optional titleSize

titleSize?: string

Size of the title.

type

type: HeatMapWidgetDefinitionType

Type of the heat map widget.

Optional xaxis

xaxis?: HeatMapWidgetXAxis

X Axis controls for the heat map widget.

Optional yaxis

yaxis?: WidgetAxis

Axis controls for the widget.

Settings

Member Visibility

Theme

Generated using TypeDoc