Skip to content

DashboardLink🔗

Links with references to other dashboards or external resources

Definition🔗

export interface DashboardLink {
    // Title to display with the link
    title: string;
    // Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)
    type: dashboard.DashboardLinkType;
    // Icon name to be displayed with the link
    icon: string;
    // Tooltip to display when the user hovers their mouse over it
    tooltip: string;
    // Link URL. Only required/valid if the type is link
    url?: string;
    // List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards
    tags: string[];
    // 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: boolean;
    // If true, the link will be opened in a new tab
    targetBlank: boolean;
    // If true, includes current template variables values in the link as query params
    includeVars: boolean;
    // If true, includes current time range in the link as query params
    keepTime: boolean;
}

Methods🔗

No methods.

See also🔗