DashboardBuilder🔗

Constructor🔗

new DashboardBuilder(string $title)

Methods🔗

build🔗

Builds the object.

build()

annotations🔗

@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\AnnotationQueryKind>> $annotations

annotations(array $annotations)

autoGridLayout🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\AutoGridLayoutKind> $autoGridLayoutKind

autoGridLayout(\Grafana\Foundation\Cog\Builder $autoGridLayoutKind)

cursorSync🔗

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.

cursorSync(\Grafana\Foundation\Dashboardv2beta1\DashboardCursorSync $cursorSync)

description🔗

Description of dashboard.

description(string $description)

editable🔗

Whether a dashboard is editable or not.

editable(bool $editable)

elements🔗

@param array<string, \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\PanelKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\LibraryPanelKind>> $elements

elements(array $elements)

gridLayout🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\GridLayoutKind> $gridLayoutKind

gridLayout(\Grafana\Foundation\Cog\Builder $gridLayoutKind)

libraryPanel🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\LibraryPanelKind> $libraryPanelKind

libraryPanel(string $key, \Grafana\Foundation\Cog\Builder $libraryPanelKind)

links🔗

Links with references to other dashboards or external websites.

@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\DashboardLink>> $links

links(array $links)

liveNow🔗

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.

liveNow(bool $liveNow)

panel🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\PanelKind> $panelKind

panel(string $key, \Grafana\Foundation\Cog\Builder $panelKind)

preload🔗

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

preload(bool $preload)

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.

revision(int $revision)

rowsLayout🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\RowsLayoutKind> $rowsLayoutKind

rowsLayout(\Grafana\Foundation\Cog\Builder $rowsLayoutKind)

tabsLayout🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\TabsLayoutKind> $tabsLayoutKind

tabsLayout(\Grafana\Foundation\Cog\Builder $tabsLayoutKind)

tags🔗

Tags associated with dashboard.

@param array $tags

tags(array $tags)

timeSettings🔗

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\TimeSettingsSpec> $timeSettings

timeSettings(\Grafana\Foundation\Cog\Builder $timeSettings)

title🔗

Title of dashboard.

title(string $title)

variable🔗

Configured template variables.

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\QueryVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\TextVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\ConstantVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\DatasourceVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\IntervalVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\CustomVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\GroupByVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\AdhocVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\SwitchVariableKind> $variable

variable($variable)

variables🔗

Configured template variables.

@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\QueryVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\TextVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\ConstantVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\DatasourceVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\IntervalVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\CustomVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\GroupByVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\AdhocVariableKind>|\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\SwitchVariableKind>> $variables

variables(array $variables)

See also🔗

• Dashboard