Skip to content

PanelModelBuilder🔗

Constructor🔗

new PanelModelBuilder()

Methods🔗

build🔗

Builds the object.

build()

cacheTimeout🔗

Sets panel queries cache timeout.

cacheTimeout(cacheTimeout: string)

datasource🔗

The datasource used in all targets.

datasource(datasource: dashboard.DataSourceRef)

description🔗

Panel description.

description(description: string)

fieldConfig🔗

Field options allow you to change how the data is displayed in your visualizations.

fieldConfig(fieldConfig: dashboard.FieldConfigSource)

hideTimeOverride🔗

Controls if the timeFrom or timeShift overrides are shown in the panel header

hideTimeOverride(hideTimeOverride: boolean)

interval🔗

The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.

This value must be formatted as a number followed by a valid time

identifier like: "40s", "3d", etc.

See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options

interval(interval: string)

Panel links.

links(links: cog.Builder<dashboard.DashboardLink>[])

maxDataPoints🔗

The maximum number of data points that the panel queries are retrieving.

maxDataPoints(maxDataPoints: number)

maxPerRow🔗

Option for repeated panels that controls max items per row

Only relevant for horizontally repeated panels

maxPerRow(maxPerRow: number)

options🔗

It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.

options(options: any)

pluginVersion🔗

The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs.

pluginVersion(pluginVersion: string)

queryCachingTTL🔗

Overrides the data source configured time-to-live for a query cache item in milliseconds

queryCachingTTL(queryCachingTTL: number)

repeat🔗

Name of template variable to repeat for.

repeat(repeat: string)

repeatDirection🔗

Direction to repeat in if 'repeat' is set.

h for horizontal, v for vertical.

repeatDirection(repeatDirection: "h" | "v")

targets🔗

Depends on the panel plugin. See the plugin documentation for details.

targets(targets: cog.Builder<cog.Dataquery>[])

timeFrom🔗

Overrides the relative time range for individual panels,

which causes them to be different than what is selected in

the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different

time periods or days on the same dashboard.

The value is formatted as time operation like: now-5m (Last 5 minutes), now/d (the day so far),

now-5d/d(Last 5 days), now/w (This week so far), now-2y/y (Last 2 years).

Note: Panel time overrides have no effect when the dashboard’s time range is absolute.

See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options

timeFrom(timeFrom: string)

timeShift🔗

Overrides the time range for individual panels by shifting its start and end relative to the time picker.

For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting 2h.

Note: Panel time overrides have no effect when the dashboard’s time range is absolute.

See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options

timeShift(timeShift: string)

title🔗

Panel title.

title(title: string)

transformations🔗

List of transformations that are applied to the panel data before rendering.

When there are multiple transformations, Grafana applies them in the order they are listed.

Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.

transformations(transformations: dashboard.DataTransformerConfig[])

transparent🔗

Whether to display the panel without a background.

transparent(transparent: boolean)

type🔗

The panel plugin type id. This is used to find the plugin to display the panel.

type(type: string)

See also🔗