PanelBuilder🔗

Constructor🔗

new PanelBuilder()

Methods🔗

build🔗

Builds the object.

public Panel build()

axisBorderShow🔗

public PanelBuilder axisBorderShow(Boolean axisBorderShow)

axisCenteredZero🔗

public PanelBuilder axisCenteredZero(Boolean axisCenteredZero)

axisColorMode🔗

public PanelBuilder axisColorMode(AxisColorMode axisColorMode)

axisGridShow🔗

public PanelBuilder axisGridShow(Boolean axisGridShow)

axisLabel🔗

public PanelBuilder axisLabel(String axisLabel)

axisPlacement🔗

public PanelBuilder axisPlacement(AxisPlacement axisPlacement)

axisSoftMax🔗

public PanelBuilder axisSoftMax(Double axisSoftMax)

axisSoftMin🔗

public PanelBuilder axisSoftMin(Double axisSoftMin)

axisWidth🔗

public PanelBuilder axisWidth(Double axisWidth)

barAlignment🔗

public PanelBuilder barAlignment(BarAlignment barAlignment)

barMaxWidth🔗

public PanelBuilder barMaxWidth(Double barMaxWidth)

barWidthFactor🔗

public PanelBuilder barWidthFactor(Double barWidthFactor)

cacheTimeout🔗

Sets panel queries cache timeout.

public PanelBuilder cacheTimeout(String cacheTimeout)

candleStyle🔗

Sets the style of the candlesticks

public PanelBuilder candleStyle(CandleStyle candleStyle)

colorScheme🔗

Panel color configuration

public PanelBuilder colorScheme(com.grafana.foundation.cog.Builder<FieldColor> color)

colorStrategy🔗

Sets the color strategy for the candlesticks

public PanelBuilder colorStrategy(ColorStrategy colorStrategy)

colors🔗

Set which colors are used when the price movement is up or down

public PanelBuilder colors(com.grafana.foundation.cog.Builder<CandlestickColors> colors)

dataLinks🔗

The behavior when clicking on a result

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

datasource🔗

The datasource used in all targets.

public PanelBuilder datasource(DataSourceRef datasource)

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.

public PanelBuilder decimals(Double decimals)

description🔗

Panel description.

public PanelBuilder description(String description)

displayName🔗

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

public PanelBuilder displayName(String displayName)

drawStyle🔗

public PanelBuilder drawStyle(GraphDrawStyle drawStyle)

fields🔗

Map fields to appropriate dimension

public PanelBuilder fields(com.grafana.foundation.cog.Builder<CandlestickFieldMap> fields)

fillBelowTo🔗

public PanelBuilder fillBelowTo(String fillBelowTo)

fillColor🔗

public PanelBuilder fillColor(String fillColor)

fillOpacity🔗

public PanelBuilder fillOpacity(Double fillOpacity)

gradientMode🔗

public PanelBuilder gradientMode(GraphGradientMode gradientMode)

gridPos🔗

Grid position.

public PanelBuilder gridPos(GridPos gridPos)

height🔗

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

public PanelBuilder height(Integer h)

hideFrom🔗

public PanelBuilder hideFrom(com.grafana.foundation.cog.Builder<HideSeriesConfig> hideFrom)

hideTimeOverride🔗

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

public PanelBuilder hideTimeOverride(Boolean hideTimeOverride)

id🔗

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

public PanelBuilder id(Integer id)

includeAllFields🔗

When enabled, all fields will be sent to the graph

public PanelBuilder includeAllFields(Boolean includeAllFields)

insertNulls🔗

public PanelBuilder insertNulls(BoolOrFloat64 insertNulls)

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 PanelBuilder interval(String interval)

legend🔗

public PanelBuilder legend(com.grafana.foundation.cog.Builder<VizLegendOptions> legend)

libraryPanel🔗

Dynamically load the panel

public PanelBuilder libraryPanel(LibraryPanelRef libraryPanel)

lineColor🔗

public PanelBuilder lineColor(String lineColor)

lineInterpolation🔗

public PanelBuilder lineInterpolation(LineInterpolation lineInterpolation)

lineStyle🔗

public PanelBuilder lineStyle(com.grafana.foundation.cog.Builder<LineStyle> lineStyle)

lineWidth🔗

public PanelBuilder lineWidth(Double lineWidth)

links🔗

Panel links.

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

mappings🔗

Convert input values into a display string

public PanelBuilder mappings(List<ValueMapping> mappings)

max🔗

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

public PanelBuilder max(Double max)

maxDataPoints🔗

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

public PanelBuilder maxDataPoints(Double maxDataPoints)

maxPerRow🔗

Option for repeated panels that controls max items per row

Only relevant for horizontally repeated panels

public PanelBuilder maxPerRow(Double maxPerRow)

min🔗

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

public PanelBuilder min(Double min)

mode🔗

Sets which dimensions are used for the visualization

public PanelBuilder mode(VizDisplayMode mode)

noValue🔗

Alternative to empty string

public PanelBuilder noValue(String noValue)

overrideByFieldType🔗

Adds override rules for all the fields of the given type.

public PanelBuilder overrideByFieldType(String fieldType, List<DynamicConfigValue> properties)

overrideByName🔗

Adds override rules for a specific field, referred to by its name.

public PanelBuilder overrideByName(String name, List<DynamicConfigValue> properties)

overrideByQuery🔗

public PanelBuilder overrideByQuery(String queryRefId, List<DynamicConfigValue> properties)

overrideByRegexp🔗

Adds override rules for the fields whose name match the given regexp.

public PanelBuilder overrideByRegexp(String regexp, List<DynamicConfigValue> properties)

overrides🔗

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

public PanelBuilder overrides(List<com.grafana.foundation.cog.Builder<DashboardFieldConfigSourceOverrides>> overrides)

pointColor🔗

public PanelBuilder pointColor(String pointColor)

pointSize🔗

public PanelBuilder pointSize(Double pointSize)

pointSymbol🔗

public PanelBuilder pointSymbol(String pointSymbol)

queryCachingTTL🔗

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

public PanelBuilder queryCachingTTL(Double queryCachingTTL)

repeat🔗

Name of template variable to repeat for.

public PanelBuilder repeat(String repeat)

repeatDirection🔗

Direction to repeat in if 'repeat' is set.

h for horizontal, v for vertical.

public PanelBuilder repeatDirection(PanelRepeatDirection repeatDirection)

scaleDistribution🔗

public PanelBuilder scaleDistribution(com.grafana.foundation.cog.Builder<ScaleDistributionConfig> scaleDistribution)

showPoints🔗

public PanelBuilder showPoints(VisibilityMode showPoints)

span🔗

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

public PanelBuilder span(Integer w)

spanNulls🔗

Indicate if null values should be treated as gaps or connected.

When the value is a number, it represents the maximum delta in the

X axis that should be considered connected. For timeseries, this is milliseconds

public PanelBuilder spanNulls(BoolOrFloat64 spanNulls)

stacking🔗

public PanelBuilder stacking(com.grafana.foundation.cog.Builder<StackingConfig> stacking)

targets🔗

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

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

thresholds🔗

Map numeric values to states

public PanelBuilder thresholds(com.grafana.foundation.cog.Builder<ThresholdsConfig> thresholds)

thresholdsStyle🔗

public PanelBuilder thresholdsStyle(com.grafana.foundation.cog.Builder<GraphThresholdsStyleConfig> thresholdsStyle)

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 PanelBuilder 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 PanelBuilder timeShift(String timeShift)

title🔗

Panel title.

public PanelBuilder title(String title)

tooltip🔗

public PanelBuilder tooltip(com.grafana.foundation.cog.Builder<VizTooltipOptions> tooltip)

transform🔗

public PanelBuilder transform(GraphTransform transform)

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 PanelBuilder transformations(List<DataTransformerConfig> transformations)

transparent🔗

Whether to display the panel without a background.

public PanelBuilder transparent(Boolean transparent)

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.

public PanelBuilder unit(String unit)

withOverride🔗

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

public PanelBuilder withOverride(com.grafana.foundation.cog.Builder<DashboardFieldConfigSourceOverrides> override)

withTarget🔗

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

public PanelBuilder withTarget(com.grafana.foundation.cog.Builder<Dataquery> target)

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.

public PanelBuilder withTransformation(DataTransformerConfig transformation)

See also🔗

• dashboard.Panel