PanelModelBuilder🔗

Constructor🔗

new PanelModelBuilder()

Methods🔗

build🔗

Builds the object.

public PanelModel build()

cacheTimeout🔗

Sets panel queries cache timeout.

public PanelModelBuilder cacheTimeout(String cacheTimeout)

datasource🔗

The datasource used in all targets.

public PanelModelBuilder datasource(DataSourceRef datasource)

description🔗

Panel description.

public PanelModelBuilder description(String description)

fieldConfig🔗

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

public PanelModelBuilder fieldConfig(FieldConfigSource fieldConfig)

hideTimeOverride🔗

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

public PanelModelBuilder hideTimeOverride(Boolean hideTimeOverride)

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

public PanelModelBuilder interval(String interval)

links🔗

Panel links.

public PanelModelBuilder links(List<com.grafana.foundation.cog.Builder<DashboardLink>> links)

maxDataPoints🔗

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

public PanelModelBuilder maxDataPoints(Double maxDataPoints)

maxPerRow🔗

Option for repeated panels that controls max items per row

Only relevant for horizontally repeated panels

public PanelModelBuilder maxPerRow(Double maxPerRow)

options🔗

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

public PanelModelBuilder options(Object options)

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.

public PanelModelBuilder pluginVersion(String pluginVersion)

queryCachingTTL🔗

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

public PanelModelBuilder queryCachingTTL(Double queryCachingTTL)

repeat🔗

Name of template variable to repeat for.

public PanelModelBuilder repeat(String repeat)

repeatDirection🔗

Direction to repeat in if 'repeat' is set.

h for horizontal, v for vertical.

public PanelModelBuilder repeatDirection(PanelModelRepeatDirection repeatDirection)

targets🔗

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

public PanelModelBuilder targets(List<com.grafana.foundation.cog.Builder<Dataquery>> targets)

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

public PanelModelBuilder timeFrom(String timeFrom)

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

public PanelModelBuilder timeShift(String timeShift)

title🔗

Panel title.

public PanelModelBuilder title(String title)

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.

public PanelModelBuilder transformations(List<DataTransformerConfig> transformations)

transparent🔗

Whether to display the panel without a background.

public PanelModelBuilder transparent(Boolean transparent)

type🔗

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

public PanelModelBuilder type(String type)

See also🔗

• PanelModel