VisualizationBuilder🔗

Constructor🔗

func NewVisualizationBuilder() *VisualizationBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *VisualizationBuilder) Build() (dashboardv2beta1.VizConfigKind, error)

Actions🔗

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

func (builder *VisualizationBuilder) Actions(actions []cog.Builder[dashboardv2beta1.Action]) *VisualizationBuilder

AxisBorderShow🔗

func (builder *VisualizationBuilder) AxisBorderShow(axisBorderShow bool) *VisualizationBuilder

AxisCenteredZero🔗

func (builder *VisualizationBuilder) AxisCenteredZero(axisCenteredZero bool) *VisualizationBuilder

AxisColorMode🔗

func (builder *VisualizationBuilder) AxisColorMode(axisColorMode common.AxisColorMode) *VisualizationBuilder

AxisGridShow🔗

func (builder *VisualizationBuilder) AxisGridShow(axisGridShow bool) *VisualizationBuilder

AxisLabel🔗

func (builder *VisualizationBuilder) AxisLabel(axisLabel string) *VisualizationBuilder

AxisPlacement🔗

func (builder *VisualizationBuilder) AxisPlacement(axisPlacement common.AxisPlacement) *VisualizationBuilder

AxisSoftMax🔗

func (builder *VisualizationBuilder) AxisSoftMax(axisSoftMax float64) *VisualizationBuilder

AxisSoftMin🔗

func (builder *VisualizationBuilder) AxisSoftMin(axisSoftMin float64) *VisualizationBuilder

AxisWidth🔗

func (builder *VisualizationBuilder) AxisWidth(axisWidth float64) *VisualizationBuilder

BarAlignment🔗

func (builder *VisualizationBuilder) BarAlignment(barAlignment common.BarAlignment) *VisualizationBuilder

BarMaxWidth🔗

func (builder *VisualizationBuilder) BarMaxWidth(barMaxWidth float64) *VisualizationBuilder

BarWidthFactor🔗

func (builder *VisualizationBuilder) BarWidthFactor(barWidthFactor float64) *VisualizationBuilder

CandleStyle🔗

Sets the style of the candlesticks

func (builder *VisualizationBuilder) CandleStyle(candleStyle candlestick.CandleStyle) *VisualizationBuilder

ColorScheme🔗

Panel color configuration

func (builder *VisualizationBuilder) ColorScheme(color cog.Builder[dashboardv2beta1.FieldColor]) *VisualizationBuilder

ColorStrategy🔗

Sets the color strategy for the candlesticks

func (builder *VisualizationBuilder) ColorStrategy(colorStrategy candlestick.ColorStrategy) *VisualizationBuilder

Colors🔗

Set which colors are used when the price movement is up or down

func (builder *VisualizationBuilder) Colors(colors cog.Builder[candlestick.CandlestickColors]) *VisualizationBuilder

DataLinks🔗

The behavior when clicking on a result

func (builder *VisualizationBuilder) DataLinks(links []any) *VisualizationBuilder

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.

func (builder *VisualizationBuilder) Decimals(decimals float64) *VisualizationBuilder

Description🔗

Human readable field metadata

func (builder *VisualizationBuilder) Description(description string) *VisualizationBuilder

DisplayName🔗

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

func (builder *VisualizationBuilder) DisplayName(displayName string) *VisualizationBuilder

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 *VisualizationBuilder) DisplayNameFromDS(displayNameFromDS string) *VisualizationBuilder

DrawStyle🔗

func (builder *VisualizationBuilder) DrawStyle(drawStyle common.GraphDrawStyle) *VisualizationBuilder

FieldMinMax🔗

Calculate min max per field

func (builder *VisualizationBuilder) FieldMinMax(fieldMinMax bool) *VisualizationBuilder

Fields🔗

Map fields to appropriate dimension

func (builder *VisualizationBuilder) Fields(fields cog.Builder[candlestick.CandlestickFieldMap]) *VisualizationBuilder

FillBelowTo🔗

func (builder *VisualizationBuilder) FillBelowTo(fillBelowTo string) *VisualizationBuilder

FillColor🔗

func (builder *VisualizationBuilder) FillColor(fillColor string) *VisualizationBuilder

FillOpacity🔗

func (builder *VisualizationBuilder) FillOpacity(fillOpacity float64) *VisualizationBuilder

GradientMode🔗

func (builder *VisualizationBuilder) GradientMode(gradientMode common.GraphGradientMode) *VisualizationBuilder

HideFrom🔗

func (builder *VisualizationBuilder) HideFrom(hideFrom cog.Builder[common.HideSeriesConfig]) *VisualizationBuilder

IncludeAllFields🔗

When enabled, all fields will be sent to the graph

func (builder *VisualizationBuilder) IncludeAllFields(includeAllFields bool) *VisualizationBuilder

InsertNulls🔗

func (builder *VisualizationBuilder) InsertNulls(insertNulls common.BoolOrFloat64) *VisualizationBuilder

Legend🔗

func (builder *VisualizationBuilder) Legend(legend cog.Builder[common.VizLegendOptions]) *VisualizationBuilder

LineColor🔗

func (builder *VisualizationBuilder) LineColor(lineColor string) *VisualizationBuilder

LineInterpolation🔗

func (builder *VisualizationBuilder) LineInterpolation(lineInterpolation common.LineInterpolation) *VisualizationBuilder

LineStyle🔗

func (builder *VisualizationBuilder) LineStyle(lineStyle cog.Builder[common.LineStyle]) *VisualizationBuilder

LineWidth🔗

func (builder *VisualizationBuilder) LineWidth(lineWidth float64) *VisualizationBuilder

Mappings🔗

Convert input values into a display string

func (builder *VisualizationBuilder) Mappings(mappings []dashboardv2beta1.ValueMapping) *VisualizationBuilder

Max🔗

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

func (builder *VisualizationBuilder) Max(max float64) *VisualizationBuilder

Min🔗

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

func (builder *VisualizationBuilder) Min(min float64) *VisualizationBuilder

Mode🔗

Sets which dimensions are used for the visualization

func (builder *VisualizationBuilder) Mode(mode candlestick.VizDisplayMode) *VisualizationBuilder

NoValue🔗

Alternative to empty string

func (builder *VisualizationBuilder) NoValue(noValue string) *VisualizationBuilder

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 *VisualizationBuilder) NullValueMode(nullValueMode dashboardv2beta1.NullValueMode) *VisualizationBuilder

Override🔗

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

func (builder *VisualizationBuilder) Override(systemRef string, matcher dashboardv2beta1.MatcherConfig, properties []dashboardv2beta1.DynamicConfigValue) *VisualizationBuilder

OverrideByFieldType🔗

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

func (builder *VisualizationBuilder) OverrideByFieldType(fieldType string, properties []dashboardv2beta1.DynamicConfigValue) *VisualizationBuilder

OverrideByName🔗

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

func (builder *VisualizationBuilder) OverrideByName(name string, properties []dashboardv2beta1.DynamicConfigValue) *VisualizationBuilder

OverrideByQuery🔗

func (builder *VisualizationBuilder) OverrideByQuery(queryRefId string, properties []dashboardv2beta1.DynamicConfigValue) *VisualizationBuilder

OverrideByRegexp🔗

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

func (builder *VisualizationBuilder) OverrideByRegexp(regexp string, properties []dashboardv2beta1.DynamicConfigValue) *VisualizationBuilder

Overrides🔗

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

func (builder *VisualizationBuilder) Overrides(overrides []cog.Builder[dashboardv2beta1.Dashboardv2beta1FieldConfigSourceOverrides]) *VisualizationBuilder

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

func (builder *VisualizationBuilder) Path(path string) *VisualizationBuilder

PointColor🔗

func (builder *VisualizationBuilder) PointColor(pointColor string) *VisualizationBuilder

PointSize🔗

func (builder *VisualizationBuilder) PointSize(pointSize float64) *VisualizationBuilder

PointSymbol🔗

func (builder *VisualizationBuilder) PointSymbol(pointSymbol string) *VisualizationBuilder

ScaleDistribution🔗

func (builder *VisualizationBuilder) ScaleDistribution(scaleDistribution cog.Builder[common.ScaleDistributionConfig]) *VisualizationBuilder

ShowPoints🔗

func (builder *VisualizationBuilder) ShowPoints(showPoints common.VisibilityMode) *VisualizationBuilder

SpanNulls🔗

Indicate if null values should be treated as gaps or connected.

When the value is a number, it represents the maximum delta in the

X axis that should be considered connected. For timeseries, this is milliseconds

func (builder *VisualizationBuilder) SpanNulls(spanNulls common.BoolOrFloat64) *VisualizationBuilder

Stacking🔗

func (builder *VisualizationBuilder) Stacking(stacking cog.Builder[common.StackingConfig]) *VisualizationBuilder

Thresholds🔗

Map numeric values to states

func (builder *VisualizationBuilder) Thresholds(thresholds cog.Builder[dashboardv2beta1.ThresholdsConfig]) *VisualizationBuilder

ThresholdsStyle🔗

func (builder *VisualizationBuilder) ThresholdsStyle(thresholdsStyle cog.Builder[common.GraphThresholdsStyleConfig]) *VisualizationBuilder

func (builder *VisualizationBuilder) Tooltip(tooltip cog.Builder[common.VizTooltipOptions]) *VisualizationBuilder

Transform🔗

func (builder *VisualizationBuilder) Transform(transform common.GraphTransform) *VisualizationBuilder

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.

func (builder *VisualizationBuilder) Unit(unit string) *VisualizationBuilder