VizConfigKindBuilder🔗

Constructor🔗

new VizConfigKindBuilder()

Methods🔗

build🔗

Builds the object.

public VizConfigKind build()

actions🔗

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

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

colorScheme🔗

Panel color configuration

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

custom🔗

custom is specified by the FieldConfig field

in panel plugin schemas.

public VizConfigKindBuilder custom(Object custom)

dataLinks🔗

The behavior when clicking on a result

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

defaults🔗

Defaults are the options applied to all fields.

public VizConfigKindBuilder defaults(FieldConfig defaults)

description🔗

Human readable field metadata

public VizConfigKindBuilder description(String description)

displayName🔗

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

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

fieldConfig🔗

public VizConfigKindBuilder fieldConfig(FieldConfigSource fieldConfig)

fieldMinMax🔗

Calculate min max per field

public VizConfigKindBuilder fieldMinMax(Boolean fieldMinMax)

filterable🔗

True if data source field supports ad-hoc filters

public VizConfigKindBuilder filterable(Boolean filterable)

group🔗

The group is the plugin ID

public VizConfigKindBuilder group(String group)

mappings🔗

Convert input values into a display string

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

min🔗

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

public VizConfigKindBuilder min(Double min)

noValue🔗

Alternative to empty string

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

options🔗

public VizConfigKindBuilder options(Object options)

override🔗

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

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

overrideByFieldType🔗

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

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

overrideByName🔗

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

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

overrideByQuery🔗

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

overrideByRegexp🔗

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

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

overrides🔗

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

public VizConfigKindBuilder 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 VizConfigKindBuilder path(String path)

spec🔗

public VizConfigKindBuilder spec(VizConfigSpec spec)

thresholds🔗

Map numeric values to states

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

version🔗

public VizConfigKindBuilder version(String version)

writeable🔗

True if data source can write a value to the path. Auth/authz are supported separately

public VizConfigKindBuilder writeable(Boolean writeable)

See also🔗

• VizConfigKind