Skip to content

CustomVariable🔗

Constructor🔗

CustomVariable(name: str)

Methods🔗

build🔗

Builds the object.

def build() -> dashboard.VariableModel

all_value🔗

Custom all value

def all_value(all_value: str) -> typing.Self

allow_custom_value🔗

Allow custom values to be entered in the variable

def allow_custom_value(allow_custom_value: bool) -> typing.Self

current🔗

Shows current selected variable text/value on the dashboard

def current(current: dashboard.VariableOption) -> typing.Self

definition🔗

def definition(definition: str) -> typing.Self

description🔗

Description of variable. It can be defined but null.

def description(description: str) -> typing.Self

hide🔗

Visibility configuration for the variable

def hide(hide: dashboard.VariableHide) -> typing.Self

include_all🔗

Whether all value option is available or not

def include_all(include_all: bool) -> typing.Self

label🔗

Optional display name

def label(label: str) -> typing.Self

multi🔗

Whether multiple values can be selected or not from variable value list

def multi(multi: bool) -> typing.Self

name🔗

Name of variable

def name(name: str) -> typing.Self

options🔗

Options that can be selected for a variable.

def options(options: list[dashboard.VariableOption]) -> typing.Self

static_options🔗

Additional static options for query variable

def static_options(static_options: list[dashboard.VariableOption]) -> typing.Self

static_options_order🔗

Ordering of static options in relation to options returned from data source for query variable

def static_options_order(static_options_order: typing.Literal["before", "after", "sorted"]) -> typing.Self

values🔗

Query used to fetch values for a variable

def values(query: typing.Union[str, dict[str, object]]) -> typing.Self

See also🔗