Class HostMapWidgetDefinition

The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page.

Hierarchy

  • HostMapWidgetDefinition

Constructors

constructor

Properties

additionalProperties? customLinks? description? group? noGroupHosts? noMetricHosts? nodeType? notes? requests scope? style? title? titleAlign? titleSize? type

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 description

description?: string

The description of the widget.

Optional group

group?: string[]

Deprecated - Only used by the legacy metric-based format. Use group_by (infrastructure) or a group dimension (DDSQL) inside requests instead.

Optional noGroupHosts

noGroupHosts?: boolean

Deprecated - Only used by the legacy metric-based format. Use no_group_hosts inside requests instead.

Optional noMetricHosts

noMetricHosts?: boolean

Deprecated - Only used by the legacy metric-based format. Use no_metric_hosts inside requests instead.

Optional nodeType

nodeType?: WidgetNodeType

Which type of node to use in the map.

Optional notes

notes?: string

Notes on the title.

requests

requests: HostMapWidgetDefinitionRequests

Query definition for the host map widget. Supports three mutually exclusive formats distinguished by request_type: the deprecated legacy metric-based format (fill/size, no request_type), the infrastructure-backed format (request_type: infrastructure_hostmap), and the DDSQL published-dataset format (request_type: data_projection).

Optional scope

scope?: string[]

Deprecated - Only used by the legacy metric-based format. Use filter inside requests instead.

Optional style

style?: HostMapWidgetDefinitionStyle

Deprecated - The style to apply to the legacy metric-based host map widget. Use HostMapWidgetInfrastructureStyle instead.

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: HostMapWidgetDefinitionType

Type of the host map widget.

Settings

Member Visibility

Theme

Generated using TypeDoc