VisualizationBuilder🔗

Constructor🔗

new VisualizationBuilder()

Methods🔗

build🔗

Builds the object.

public Visualization build()

actions🔗

Define interactive HTTP requests that can be triggered from data visualizations.

public VisualizationBuilder actions(List<com.grafana.foundation.cog.Builder<Action>> actions)

axisBorderShow🔗

public VisualizationBuilder axisBorderShow(Boolean axisBorderShow)

axisCenteredZero🔗

public VisualizationBuilder axisCenteredZero(Boolean axisCenteredZero)

axisColorMode🔗

public VisualizationBuilder axisColorMode(AxisColorMode axisColorMode)

axisGridShow🔗

public VisualizationBuilder axisGridShow(Boolean axisGridShow)

axisLabel🔗

public VisualizationBuilder axisLabel(String axisLabel)

axisPlacement🔗

public VisualizationBuilder axisPlacement(AxisPlacement axisPlacement)

axisSoftMax🔗

public VisualizationBuilder axisSoftMax(Double axisSoftMax)

axisSoftMin🔗

public VisualizationBuilder axisSoftMin(Double axisSoftMin)

axisWidth🔗

public VisualizationBuilder axisWidth(Double axisWidth)

barAlignment🔗

public VisualizationBuilder barAlignment(BarAlignment barAlignment)

barMaxWidth🔗

public VisualizationBuilder barMaxWidth(Double barMaxWidth)

barWidthFactor🔗

public VisualizationBuilder barWidthFactor(Double barWidthFactor)

candleStyle🔗

Sets the style of the candlesticks

public VisualizationBuilder candleStyle(CandleStyle candleStyle)

colorScheme🔗

Panel color configuration

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

colorStrategy🔗

Sets the color strategy for the candlesticks

public VisualizationBuilder colorStrategy(ColorStrategy colorStrategy)

colors🔗

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

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

dataLinks🔗

The behavior when clicking on a result

public VisualizationBuilder dataLinks(List<Object> links)

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 VisualizationBuilder decimals(Double decimals)

description🔗

Human readable field metadata

public VisualizationBuilder description(String description)

displayName🔗

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

public VisualizationBuilder displayName(String displayName)

displayNameFromDS🔗

This can be used by data sources that return and explicit naming structure for values and labels

When this property is configured, this value is used rather than the default naming strategy.

public VisualizationBuilder displayNameFromDS(String displayNameFromDS)

drawStyle🔗

public VisualizationBuilder drawStyle(GraphDrawStyle drawStyle)

fieldMinMax🔗

Calculate min max per field

public VisualizationBuilder fieldMinMax(Boolean fieldMinMax)

fields🔗

Map fields to appropriate dimension

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

fillBelowTo🔗

public VisualizationBuilder fillBelowTo(String fillBelowTo)

fillColor🔗

public VisualizationBuilder fillColor(String fillColor)

fillOpacity🔗

public VisualizationBuilder fillOpacity(Double fillOpacity)

gradientMode🔗

public VisualizationBuilder gradientMode(GraphGradientMode gradientMode)

hideFrom🔗

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

includeAllFields🔗

When enabled, all fields will be sent to the graph

public VisualizationBuilder includeAllFields(Boolean includeAllFields)

insertNulls🔗

public VisualizationBuilder insertNulls(BoolOrFloat64 insertNulls)

legend🔗

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

lineColor🔗

public VisualizationBuilder lineColor(String lineColor)

lineInterpolation🔗

public VisualizationBuilder lineInterpolation(LineInterpolation lineInterpolation)

lineStyle🔗

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

lineWidth🔗

public VisualizationBuilder lineWidth(Double lineWidth)

mappings🔗

Convert input values into a display string

public VisualizationBuilder 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 VisualizationBuilder max(Double max)

min🔗

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

public VisualizationBuilder min(Double min)

mode🔗

Sets which dimensions are used for the visualization

public VisualizationBuilder mode(VizDisplayMode mode)

noValue🔗

Alternative to empty string

public VisualizationBuilder noValue(String noValue)

nullValueMode🔗

How null values should be handled when calculating field stats

"null" - Include null values, "connected" - Ignore nulls, "null as zero" - Treat nulls as zero

public VisualizationBuilder nullValueMode(NullValueMode nullValueMode)

override🔗

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

public VisualizationBuilder override(String systemRef, MatcherConfig matcher, List<DynamicConfigValue> properties)

overrideByFieldType🔗

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

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

overrideByName🔗

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

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

overrideByQuery🔗

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

overrideByRegexp🔗

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

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

overrides🔗

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

public VisualizationBuilder overrides(List<com.grafana.foundation.cog.Builder<Dashboardv2beta1FieldConfigSourceOverrides>> overrides)

path🔗

An explicit path to the field in the datasource. When the frame meta includes a path,

This will default to `${frame.meta.path}/${field.name}

When defined, this value can be used as an identifier within the datasource scope, and

may be used to update the results

public VisualizationBuilder path(String path)

pointColor🔗

public VisualizationBuilder pointColor(String pointColor)

pointSize🔗

public VisualizationBuilder pointSize(Double pointSize)

pointSymbol🔗

public VisualizationBuilder pointSymbol(String pointSymbol)

scaleDistribution🔗

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

showPoints🔗

public VisualizationBuilder showPoints(VisibilityMode showPoints)

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 VisualizationBuilder spanNulls(BoolOrFloat64 spanNulls)

stacking🔗

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

thresholds🔗

Map numeric values to states

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

thresholdsStyle🔗

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

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

transform🔗

public VisualizationBuilder transform(GraphTransform transform)

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 VisualizationBuilder unit(String unit)