Class DashboardTemplateVariable

Template variable.

Hierarchy

  • DashboardTemplateVariable

Constructors

constructor

Properties

_default? additionalProperties? availableValues? defaults? name prefix? type?

Constructors

constructor

Properties

Optional _default

_default?: string

(deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.

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 availableValues

availableValues?: string[]

The list of values that the template variable drop-down is limited to.

Optional defaults

defaults?: string[]

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

name

name: string

The name of the variable.

Optional prefix

prefix?: string

The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

Optional type

type?: string

The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).

Settings

Member Visibility

Theme

Generated using TypeDoc