VisualizationV2Builder🔗

Constructor🔗

new VisualizationV2Builder()

Methods🔗

build🔗

Builds the object.

public VisualizationV2 build()

actions🔗

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

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

colorScheme🔗

Panel color configuration

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

dataLinks🔗

The behavior when clicking on a result

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

description🔗

Human readable field metadata

public VisualizationV2Builder description(String description)

displayMode🔗

public VisualizationV2Builder displayMode(BarGaugeDisplayMode displayMode)

displayName🔗

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

public VisualizationV2Builder 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 VisualizationV2Builder displayNameFromDS(String displayNameFromDS)

fieldMinMax🔗

Calculate min max per field

public VisualizationV2Builder fieldMinMax(Boolean fieldMinMax)

legend🔗

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

mappings🔗

Convert input values into a display string

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

maxVizHeight🔗

public VisualizationV2Builder maxVizHeight(Integer maxVizHeight)

min🔗

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

public VisualizationV2Builder min(Double min)

minVizHeight🔗

public VisualizationV2Builder minVizHeight(Integer minVizHeight)

minVizWidth🔗

public VisualizationV2Builder minVizWidth(Integer minVizWidth)

namePlacement🔗

public VisualizationV2Builder namePlacement(BarGaugeNamePlacement namePlacement)

noValue🔗

Alternative to empty string

public VisualizationV2Builder 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 VisualizationV2Builder nullValueMode(NullValueMode nullValueMode)

orientation🔗

public VisualizationV2Builder orientation(VizOrientation orientation)

override🔗

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

public VisualizationV2Builder override(MatcherConfig matcher, List<DynamicConfigValue> properties)

overrideByFieldType🔗

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

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

overrideByName🔗

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

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

overrideByQuery🔗

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

overrideByRegexp🔗

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

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

overrides🔗

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

public VisualizationV2Builder overrides(List<com.grafana.foundation.cog.Builder<Dashboardv2FieldConfigSourceOverrides>> 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 VisualizationV2Builder path(String path)

reduceOptions🔗

public VisualizationV2Builder reduceOptions(com.grafana.foundation.cog.Builder<ReduceDataOptions> reduceOptions)

showUnfilled🔗

public VisualizationV2Builder showUnfilled(Boolean showUnfilled)

sizing🔗

public VisualizationV2Builder sizing(BarGaugeSizing sizing)

text🔗

public VisualizationV2Builder text(com.grafana.foundation.cog.Builder<VizTextDisplayOptions> text)

thresholds🔗

Map numeric values to states

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

unit🔗

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

You can use the units ID available 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 VisualizationV2Builder unit(String unit)

valueMode🔗

public VisualizationV2Builder valueMode(BarGaugeValueMode valueMode)