DashboardLink🔗

Constructor🔗

DashboardLink(title: str)

Methods🔗

build🔗

Builds the object.

def build() -> dashboard.DashboardLink

as_dropdown🔗

If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards

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

icon🔗

Icon name to be displayed with the link

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

include_vars🔗

If true, includes current template variables values in the link as query params

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

keep_time🔗

If true, includes current time range in the link as query params

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

tags🔗

List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards

def tags(tags: list[str]) -> typing.Self

target_blank🔗

If true, the link will be opened in a new tab

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

title🔗

Title to display with the link

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

tooltip🔗

Tooltip to display when the user hovers their mouse over it

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

type_val🔗

Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)

def type_val(type_val: dashboard.DashboardLinkType) -> typing.Self

url🔗

Link URL. Only required/valid if the type is link

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

See also🔗

• DashboardLink