Skip to content

DashboardLinkBuilder🔗

Constructor🔗

new DashboardLinkBuilder(title: string)

Methods🔗

build🔗

Builds the object.

build()

asDropdown🔗

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

asDropdown(asDropdown: boolean)

icon🔗

Icon name to be displayed with the link

icon(icon: string)

includeVars🔗

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

includeVars(includeVars: boolean)

keepTime🔗

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

keepTime(keepTime: boolean)

tags🔗

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

tags(tags: string[])

targetBlank🔗

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

targetBlank(targetBlank: boolean)

title🔗

Title to display with the link

title(title: string)

tooltip🔗

Tooltip to display when the user hovers their mouse over it

tooltip(tooltip: string)

type🔗

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

type(type: dashboard.DashboardLinkType)

url🔗

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

url(url: string)

See also🔗