VisualizationV2Builder🔗
Constructor🔗
Methods🔗
build🔗
Builds the object.
actions🔗
Define interactive HTTP requests that can be triggered from data visualizations.
calculate🔗
Controls if the heatmap should be calculated from data
calculation🔗
Calculation options for the heatmap
public VisualizationV2Builder calculation(com.grafana.foundation.cog.Builder<HeatmapCalculationOptions> calculation)
cellGap🔗
Controls gap between cells
cellRadius🔗
Controls cell radius
cellValues🔗
Controls cell value unit
color🔗
Controls the color options
colorScheme🔗
Panel color configuration
dataLinks🔗
The behavior when clicking on a result
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.
description🔗
Human readable field metadata
displayName🔗
The display value for this field. This supports template variables blank is auto
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.
exemplars🔗
Controls exemplar options
public VisualizationV2Builder exemplars(com.grafana.foundation.cog.Builder<ExemplarConfig> exemplars)
fieldMinMax🔗
Calculate min max per field
filterValues🔗
Filters values between a given range
public VisualizationV2Builder filterValues(com.grafana.foundation.cog.Builder<FilterValueRange> filterValues)
hideFrom🔗
public VisualizationV2Builder hideFrom(com.grafana.foundation.cog.Builder<HideSeriesConfig> hideFrom)
legend🔗
| *{
axisPlacement: ui.AxisPlacement & "left" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
}
Controls legend options
mappings🔗
Convert input values into a display string
max🔗
The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.
min🔗
The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.
noValue🔗
Alternative to empty string
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
override🔗
Overrides are the options applied to specific fields overriding the defaults.
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.
overrideByQuery🔗
public VisualizationV2Builder overrideByQuery(String queryRefId, List<DynamicConfigValue> properties)
overrideByRegexp🔗
Adds override rules for the fields whose name match the given regexp.
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
rowsFrame🔗
Controls tick alignment and value name when not calculating from data
public VisualizationV2Builder rowsFrame(com.grafana.foundation.cog.Builder<RowsHeatmapOptions> rowsFrame)
scaleDistribution🔗
public VisualizationV2Builder scaleDistribution(com.grafana.foundation.cog.Builder<ScaleDistributionConfig> scaleDistribution)
selectionMode🔗
Controls which axis to allow selection on
showValue🔗
| *{
layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
}
Controls the display of the value in the cell
thresholds🔗
Map numeric values to states
public VisualizationV2Builder thresholds(com.grafana.foundation.cog.Builder<ThresholdsConfig> thresholds)
tooltip🔗
Controls tooltip options
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.
yAxis🔗
Controls yAxis placement