Dashboard🔗

Constructor🔗

Dashboard(title: str)

Methods🔗

build🔗

Builds the object.

def build() -> dashboardv2beta1.Dashboard

annotations🔗

def annotations(annotations: list[cogbuilder.Builder[dashboardv2beta1.AnnotationQueryKind]]) -> typing.Self

auto_grid_layout🔗

def auto_grid_layout(auto_grid_layout_kind: cogbuilder.Builder[dashboardv2beta1.AutoGridLayoutKind]) -> typing.Self

cursor_sync🔗

Configuration of dashboard cursor sync behavior.

"Off" for no shared crosshair or tooltip (default).

"Crosshair" for shared crosshair.

"Tooltip" for shared crosshair AND shared tooltip.

def cursor_sync(cursor_sync: dashboardv2beta1.DashboardCursorSync) -> typing.Self

description🔗

Description of dashboard.

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

editable🔗

Whether a dashboard is editable or not.

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

element🔗

def element(key: str, element: cogbuilder.Builder[dashboardv2beta1.Element]) -> typing.Self

elements🔗

def elements(elements: dict[str, cogbuilder.Builder[dashboardv2beta1.Element]]) -> typing.Self

grid_layout🔗

def grid_layout(grid_layout_kind: cogbuilder.Builder[dashboardv2beta1.GridLayoutKind]) -> typing.Self

links🔗

Links with references to other dashboards or external websites.

def links(links: list[cogbuilder.Builder[dashboardv2beta1.DashboardLink]]) -> typing.Self

live_now🔗

When set to true, the dashboard will redraw panels at an interval matching the pixel width.

This will keep data "moving left" regardless of the query refresh rate. This setting helps

avoid dashboards presenting stale live data.

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

preload🔗

When set to true, the dashboard will load all panels in the dashboard when it's loaded.

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

revision🔗

Plugins only. The version of the dashboard installed together with the plugin.

This is used to determine if the dashboard should be updated when the plugin is updated.

def revision(revision: int) -> typing.Self

rows_layout🔗

def rows_layout(rows_layout_kind: cogbuilder.Builder[dashboardv2beta1.RowsLayoutKind]) -> typing.Self

tabs_layout🔗

def tabs_layout(tabs_layout_kind: cogbuilder.Builder[dashboardv2beta1.TabsLayoutKind]) -> typing.Self

tags🔗

Tags associated with dashboard.

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

time_settings🔗

def time_settings(time_settings: cogbuilder.Builder[dashboardv2beta1.TimeSettingsSpec]) -> typing.Self

title🔗

Title of dashboard.

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

variable🔗

Configured template variables.

def variable(variable: cogbuilder.Builder[dashboardv2beta1.VariableKind]) -> typing.Self

variables🔗