Skip to content

PanelBuilder🔗

Constructor🔗

func NewPanelBuilder() *PanelBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *PanelBuilder) Build() (dashboard.Panel, error)

AxisBorderShow🔗

func (builder *PanelBuilder) AxisBorderShow(axisBorderShow bool) *PanelBuilder

AxisCenteredZero🔗

func (builder *PanelBuilder) AxisCenteredZero(axisCenteredZero bool) *PanelBuilder

AxisColorMode🔗

func (builder *PanelBuilder) AxisColorMode(axisColorMode common.AxisColorMode) *PanelBuilder

AxisGridShow🔗

func (builder *PanelBuilder) AxisGridShow(axisGridShow bool) *PanelBuilder

AxisLabel🔗

func (builder *PanelBuilder) AxisLabel(axisLabel string) *PanelBuilder

AxisPlacement🔗

func (builder *PanelBuilder) AxisPlacement(axisPlacement common.AxisPlacement) *PanelBuilder

AxisSoftMax🔗

func (builder *PanelBuilder) AxisSoftMax(axisSoftMax float64) *PanelBuilder

AxisSoftMin🔗

func (builder *PanelBuilder) AxisSoftMin(axisSoftMin float64) *PanelBuilder

AxisWidth🔗

func (builder *PanelBuilder) AxisWidth(axisWidth float64) *PanelBuilder

CacheTimeout🔗

Sets panel queries cache timeout.

func (builder *PanelBuilder) CacheTimeout(cacheTimeout string) *PanelBuilder

ColorScheme🔗

Panel color configuration

func (builder *PanelBuilder) ColorScheme(color cog.Builder[dashboard.FieldColor]) *PanelBuilder

Datasource🔗

The datasource used in all targets.

func (builder *PanelBuilder) Datasource(datasource dashboard.DataSourceRef) *PanelBuilder

Decimals🔗

Specify the number of decimals Grafana includes in the rendered value.

If you leave this field blank, Grafana automatically truncates the number of decimals based on the value.

For example 1.1234 will display as 1.12 and 100.456 will display as 100.

To display all decimals, set the unit to String.

func (builder *PanelBuilder) Decimals(decimals float64) *PanelBuilder

Description🔗

Panel description.

func (builder *PanelBuilder) Description(description string) *PanelBuilder

Dims🔗

Table Mode (auto)

func (builder *PanelBuilder) Dims(dims cog.Builder[xychart.XYDimensionConfig]) *PanelBuilder

DisplayName🔗

The display value for this field. This supports template variables blank is auto

func (builder *PanelBuilder) DisplayName(displayName string) *PanelBuilder

GridPos🔗

Grid position.

func (builder *PanelBuilder) GridPos(gridPos dashboard.GridPos) *PanelBuilder

Height🔗

Panel height. The height is the number of rows from the top edge of the panel.

func (builder *PanelBuilder) Height(h uint32) *PanelBuilder

HideFrom🔗

func (builder *PanelBuilder) HideFrom(hideFrom cog.Builder[common.HideSeriesConfig]) *PanelBuilder

HideTimeOverride🔗

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

func (builder *PanelBuilder) HideTimeOverride(hideTimeOverride bool) *PanelBuilder

Id🔗

Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.

func (builder *PanelBuilder) Id(id uint32) *PanelBuilder

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

func (builder *PanelBuilder) Interval(interval string) *PanelBuilder

Label🔗

func (builder *PanelBuilder) Label(label common.VisibilityMode) *PanelBuilder

LabelValue🔗

func (builder *PanelBuilder) LabelValue(labelValue cog.Builder[common.TextDimensionConfig]) *PanelBuilder

Legend🔗

func (builder *PanelBuilder) Legend(legend cog.Builder[common.VizLegendOptions]) *PanelBuilder

LibraryPanel🔗

Dynamically load the panel

func (builder *PanelBuilder) LibraryPanel(libraryPanel dashboard.LibraryPanelRef) *PanelBuilder

LineColor🔗

func (builder *PanelBuilder) LineColor(lineColor cog.Builder[common.ColorDimensionConfig]) *PanelBuilder

LineStyle🔗

func (builder *PanelBuilder) LineStyle(lineStyle cog.Builder[common.LineStyle]) *PanelBuilder

LineWidth🔗

func (builder *PanelBuilder) LineWidth(lineWidth int32) *PanelBuilder

Panel links.

func (builder *PanelBuilder) Links(links []cog.Builder[dashboard.DashboardLink]) *PanelBuilder

Mappings🔗

Convert input values into a display string

func (builder *PanelBuilder) Mappings(mappings []dashboard.ValueMapping) *PanelBuilder

Max🔗

The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.

func (builder *PanelBuilder) Max(max float64) *PanelBuilder

MaxDataPoints🔗

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

func (builder *PanelBuilder) MaxDataPoints(maxDataPoints float64) *PanelBuilder

MaxPerRow🔗

Option for repeated panels that controls max items per row

Only relevant for horizontally repeated panels

func (builder *PanelBuilder) MaxPerRow(maxPerRow float64) *PanelBuilder

Min🔗

The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.

func (builder *PanelBuilder) Min(min float64) *PanelBuilder

NoValue🔗

Alternative to empty string

func (builder *PanelBuilder) NoValue(noValue string) *PanelBuilder

Overrides🔗

Overrides are the options applied to specific fields overriding the defaults.

func (builder *PanelBuilder) Overrides(overrides []cog.Builder[dashboard.DashboardFieldConfigSourceOverrides]) *PanelBuilder

PointColor🔗

func (builder *PanelBuilder) PointColor(pointColor cog.Builder[common.ColorDimensionConfig]) *PanelBuilder

PointSize🔗

func (builder *PanelBuilder) PointSize(pointSize cog.Builder[common.ScaleDimensionConfig]) *PanelBuilder

QueryCachingTTL🔗

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

func (builder *PanelBuilder) QueryCachingTTL(queryCachingTTL float64) *PanelBuilder

Repeat🔗

Name of template variable to repeat for.

func (builder *PanelBuilder) Repeat(repeat string) *PanelBuilder

RepeatDirection🔗

Direction to repeat in if 'repeat' is set.

h for horizontal, v for vertical.

func (builder *PanelBuilder) RepeatDirection(repeatDirection dashboard.PanelRepeatDirection) *PanelBuilder

ScaleDistribution🔗

func (builder *PanelBuilder) ScaleDistribution(scaleDistribution cog.Builder[common.ScaleDistributionConfig]) *PanelBuilder

Series🔗

Manual Mode

func (builder *PanelBuilder) Series(series []cog.Builder[xychart.ScatterSeriesConfig]) *PanelBuilder

SeriesMapping🔗

func (builder *PanelBuilder) SeriesMapping(seriesMapping xychart.SeriesMapping) *PanelBuilder

Show🔗

func (builder *PanelBuilder) Show(show xychart.ScatterShow) *PanelBuilder

Span🔗

Panel width. The width is the number of columns from the left edge of the panel.

func (builder *PanelBuilder) Span(w uint32) *PanelBuilder

Targets🔗

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

func (builder *PanelBuilder) Targets(targets []cog.Builder[cog/variants.Dataquery]) *PanelBuilder

Thresholds🔗

Map numeric values to states

func (builder *PanelBuilder) Thresholds(thresholds cog.Builder[dashboard.ThresholdsConfig]) *PanelBuilder

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

func (builder *PanelBuilder) TimeFrom(timeFrom string) *PanelBuilder

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

func (builder *PanelBuilder) TimeShift(timeShift string) *PanelBuilder

Title🔗

Panel title.

func (builder *PanelBuilder) Title(title string) *PanelBuilder

Tooltip🔗

func (builder *PanelBuilder) Tooltip(tooltip cog.Builder[common.VizTooltipOptions]) *PanelBuilder

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.

func (builder *PanelBuilder) Transformations(transformations []dashboard.DataTransformerConfig) *PanelBuilder

Transparent🔗

Whether to display the panel without a background.

func (builder *PanelBuilder) Transparent(transparent bool) *PanelBuilder

Unit🔗

Unit a field should use. The unit you select is applied to all fields except time.

You can use the units ID availables in Grafana or a custom unit.

Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts

As custom unit, you can use the following formats:

suffix:<suffix> for custom unit that should go after value.

prefix:<prefix> for custom unit that should go before value.

time:<format> For custom date time formats type for example time:YYYY-MM-DD.

si:<base scale><unit characters> for custom SI units. For example: si: mF. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.

count:<unit> for a custom count unit.

currency:<unit> for custom a currency unit.

func (builder *PanelBuilder) Unit(unit string) *PanelBuilder

WithOverride🔗

Overrides are the options applied to specific fields overriding the defaults.

func (builder *PanelBuilder) WithOverride(matcher dashboard.MatcherConfig, properties []dashboard.DynamicConfigValue) *PanelBuilder

WithTarget🔗

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

func (builder *PanelBuilder) WithTarget(target cog.Builder[cog/variants.Dataquery]) *PanelBuilder

WithTransformation🔗

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.

func (builder *PanelBuilder) WithTransformation(transformation dashboard.DataTransformerConfig) *PanelBuilder

See also🔗