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)

axisBorderShow🔗

public VisualizationV2Builder axisBorderShow(Boolean axisBorderShow)

axisCenteredZero🔗

public VisualizationV2Builder axisCenteredZero(Boolean axisCenteredZero)

axisColorMode🔗

public VisualizationV2Builder axisColorMode(AxisColorMode axisColorMode)

axisGridShow🔗

public VisualizationV2Builder axisGridShow(Boolean axisGridShow)

axisLabel🔗

public VisualizationV2Builder axisLabel(String axisLabel)

axisPlacement🔗

public VisualizationV2Builder axisPlacement(AxisPlacement axisPlacement)

axisSoftMax🔗

public VisualizationV2Builder axisSoftMax(Double axisSoftMax)

axisSoftMin🔗

public VisualizationV2Builder axisSoftMin(Double axisSoftMin)

axisWidth🔗

public VisualizationV2Builder axisWidth(Double axisWidth)

barRadius🔗

Controls the radius of each bar.

public VisualizationV2Builder barRadius(Double barRadius)

barWidth🔗

Controls the width of bars. 1 = Max width, 0 = Min width.

public VisualizationV2Builder barWidth(Double barWidth)

colorByField🔗

Use the color value for a sibling field to color each bar value.

public VisualizationV2Builder colorByField(String colorByField)

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)

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)

fillOpacity🔗

Controls the fill opacity of the bars.

public VisualizationV2Builder fillOpacity(Integer fillOpacity)

fullHighlight🔗

Enables mode which highlights the entire bar area and shows tooltip when cursor

hovers over highlighted area

public VisualizationV2Builder fullHighlight(Boolean fullHighlight)

gradientMode🔗

Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.

Gradient appearance is influenced by the Fill opacity setting.

public VisualizationV2Builder gradientMode(GraphGradientMode gradientMode)

groupWidth🔗

Controls the width of groups. 1 = max with, 0 = min width.

public VisualizationV2Builder groupWidth(Double groupWidth)

hideFrom🔗

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

legend🔗

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

lineWidth🔗

Controls line width of the bars.

public VisualizationV2Builder lineWidth(Integer lineWidth)

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)

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)

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🔗

Controls the orientation of the bar chart, either vertical or horizontal.

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)

scaleDistribution🔗

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

showValue🔗

This controls whether values are shown on top or to the left of bars.

public VisualizationV2Builder showValue(VisibilityMode showValue)

stacking🔗

Controls whether bars are stacked or not, either normally or in percent mode.

public VisualizationV2Builder stacking(StackingMode stacking)

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)

thresholdsStyle🔗

Threshold rendering

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

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

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)

xField🔗

Manually select which field from the dataset to represent the x field.

public VisualizationV2Builder xField(String xField)

xTickLabelMaxLength🔗

Sets the max length that a label can have before it is truncated.

public VisualizationV2Builder xTickLabelMaxLength(Integer xTickLabelMaxLength)

xTickLabelRotation🔗

Controls the rotation of the x axis labels.

public VisualizationV2Builder xTickLabelRotation(Integer xTickLabelRotation)

xTickLabelSpacing🔗

Controls the spacing between x axis labels.

negative values indicate backwards skipping behavior

public VisualizationV2Builder xTickLabelSpacing(Integer xTickLabelSpacing)