VisualizationV2Builder🔗
Constructor🔗
Methods🔗
Build🔗
Builds the object.
Actions🔗
Define interactive HTTP requests that can be triggered from data visualizations.
func (builder *VisualizationV2Builder) Actions(actions []cog.Builder[dashboardv2.Action]) *VisualizationV2Builder
Calculate🔗
Controls if the heatmap should be calculated from data
Calculation🔗
Calculation options for the heatmap
func (builder *VisualizationV2Builder) Calculation(calculation cog.Builder[common.HeatmapCalculationOptions]) *VisualizationV2Builder
CellGap🔗
Controls gap between cells
CellRadius🔗
Controls cell radius
CellValues🔗
Controls cell value unit
func (builder *VisualizationV2Builder) CellValues(cellValues cog.Builder[heatmap.CellValues]) *VisualizationV2Builder
Color🔗
Controls the color options
func (builder *VisualizationV2Builder) Color(color cog.Builder[heatmap.HeatmapColorOptions]) *VisualizationV2Builder
ColorScheme🔗
Panel color configuration
func (builder *VisualizationV2Builder) ColorScheme(color cog.Builder[dashboardv2.FieldColor]) *VisualizationV2Builder
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.
func (builder *VisualizationV2Builder) DisplayNameFromDS(displayNameFromDS string) *VisualizationV2Builder
Exemplars🔗
Controls exemplar options
func (builder *VisualizationV2Builder) Exemplars(exemplars cog.Builder[heatmap.ExemplarConfig]) *VisualizationV2Builder
FieldMinMax🔗
Calculate min max per field
FilterValues🔗
Filters values between a given range
func (builder *VisualizationV2Builder) FilterValues(filterValues cog.Builder[heatmap.FilterValueRange]) *VisualizationV2Builder
HideFrom🔗
func (builder *VisualizationV2Builder) HideFrom(hideFrom cog.Builder[common.HideSeriesConfig]) *VisualizationV2Builder
Legend🔗
| *{
axisPlacement: ui.AxisPlacement & "left" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
}
Controls legend options
func (builder *VisualizationV2Builder) Legend(legend cog.Builder[heatmap.HeatmapLegend]) *VisualizationV2Builder
Mappings🔗
Convert input values into a display string
func (builder *VisualizationV2Builder) Mappings(mappings []dashboardv2.ValueMapping) *VisualizationV2Builder
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
func (builder *VisualizationV2Builder) NullValueMode(nullValueMode dashboardv2.NullValueMode) *VisualizationV2Builder
Override🔗
Overrides are the options applied to specific fields overriding the defaults.
func (builder *VisualizationV2Builder) Override(matcher dashboardv2.MatcherConfig, properties []dashboardv2.DynamicConfigValue) *VisualizationV2Builder
OverrideByFieldType🔗
Adds override rules for all the fields of the given type.
func (builder *VisualizationV2Builder) OverrideByFieldType(fieldType string, properties []dashboardv2.DynamicConfigValue) *VisualizationV2Builder
OverrideByName🔗
Adds override rules for a specific field, referred to by its name.
func (builder *VisualizationV2Builder) OverrideByName(name string, properties []dashboardv2.DynamicConfigValue) *VisualizationV2Builder
OverrideByQuery🔗
func (builder *VisualizationV2Builder) OverrideByQuery(queryRefId string, properties []dashboardv2.DynamicConfigValue) *VisualizationV2Builder
OverrideByRegexp🔗
Adds override rules for the fields whose name match the given regexp.
func (builder *VisualizationV2Builder) OverrideByRegexp(regexp string, properties []dashboardv2.DynamicConfigValue) *VisualizationV2Builder
Overrides🔗
Overrides are the options applied to specific fields overriding the defaults.
func (builder *VisualizationV2Builder) Overrides(overrides []cog.Builder[dashboardv2.Dashboardv2FieldConfigSourceOverrides]) *VisualizationV2Builder
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
func (builder *VisualizationV2Builder) RowsFrame(rowsFrame cog.Builder[heatmap.RowsHeatmapOptions]) *VisualizationV2Builder
ScaleDistribution🔗
func (builder *VisualizationV2Builder) ScaleDistribution(scaleDistribution cog.Builder[common.ScaleDistributionConfig]) *VisualizationV2Builder
SelectionMode🔗
Controls which axis to allow selection on
func (builder *VisualizationV2Builder) SelectionMode(selectionMode heatmap.HeatmapSelectionMode) *VisualizationV2Builder
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
func (builder *VisualizationV2Builder) ShowValue(showValue common.VisibilityMode) *VisualizationV2Builder
Thresholds🔗
Map numeric values to states
func (builder *VisualizationV2Builder) Thresholds(thresholds cog.Builder[dashboardv2.ThresholdsConfig]) *VisualizationV2Builder
Tooltip🔗
Controls tooltip options
func (builder *VisualizationV2Builder) Tooltip(tooltip cog.Builder[heatmap.HeatmapTooltip]) *VisualizationV2Builder
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
func (builder *VisualizationV2Builder) YAxis(yAxis cog.Builder[heatmap.YAxisConfig]) *VisualizationV2Builder