VizConfigKindBuilder🔗
Constructor🔗
Methods🔗
Build🔗
Builds the object.
Actions🔗
Define interactive HTTP requests that can be triggered from data visualizations.
func (builder *VizConfigKindBuilder) Actions(actions []cog.Builder[dashboardv2beta1.Action]) *VizConfigKindBuilder
ColorScheme🔗
Panel color configuration
func (builder *VizConfigKindBuilder) ColorScheme(color cog.Builder[dashboardv2beta1.FieldColor]) *VizConfigKindBuilder
Custom🔗
custom is specified by the FieldConfig field
in panel plugin schemas.
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.
Defaults🔗
Defaults are the options applied to all fields.
func (builder *VizConfigKindBuilder) Defaults(defaults dashboardv2beta1.FieldConfig) *VizConfigKindBuilder
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 *VizConfigKindBuilder) DisplayNameFromDS(displayNameFromDS string) *VizConfigKindBuilder
FieldConfig🔗
func (builder *VizConfigKindBuilder) FieldConfig(fieldConfig dashboardv2beta1.FieldConfigSource) *VizConfigKindBuilder
FieldMinMax🔗
Calculate min max per field
Filterable🔗
True if data source field supports ad-hoc filters
Group🔗
The group is the plugin ID
Mappings🔗
Convert input values into a display string
func (builder *VizConfigKindBuilder) Mappings(mappings []dashboardv2beta1.ValueMapping) *VizConfigKindBuilder
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 *VizConfigKindBuilder) NullValueMode(nullValueMode dashboardv2beta1.NullValueMode) *VizConfigKindBuilder
Options🔗
Override🔗
Overrides are the options applied to specific fields overriding the defaults.
func (builder *VizConfigKindBuilder) Override(systemRef string, matcher dashboardv2beta1.MatcherConfig, properties []dashboardv2beta1.DynamicConfigValue) *VizConfigKindBuilder
OverrideByFieldType🔗
Adds override rules for all the fields of the given type.
func (builder *VizConfigKindBuilder) OverrideByFieldType(fieldType string, properties []dashboardv2beta1.DynamicConfigValue) *VizConfigKindBuilder
OverrideByName🔗
Adds override rules for a specific field, referred to by its name.
func (builder *VizConfigKindBuilder) OverrideByName(name string, properties []dashboardv2beta1.DynamicConfigValue) *VizConfigKindBuilder
OverrideByQuery🔗
func (builder *VizConfigKindBuilder) OverrideByQuery(queryRefId string, properties []dashboardv2beta1.DynamicConfigValue) *VizConfigKindBuilder
OverrideByRegexp🔗
Adds override rules for the fields whose name match the given regexp.
func (builder *VizConfigKindBuilder) OverrideByRegexp(regexp string, properties []dashboardv2beta1.DynamicConfigValue) *VizConfigKindBuilder
Overrides🔗
Overrides are the options applied to specific fields overriding the defaults.
func (builder *VizConfigKindBuilder) Overrides(overrides []cog.Builder[dashboardv2beta1.Dashboardv2beta1FieldConfigSourceOverrides]) *VizConfigKindBuilder
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
Spec🔗
func (builder *VizConfigKindBuilder) Spec(spec dashboardv2beta1.VizConfigSpec) *VizConfigKindBuilder
Thresholds🔗
Map numeric values to states
func (builder *VizConfigKindBuilder) Thresholds(thresholds cog.Builder[dashboardv2beta1.ThresholdsConfig]) *VizConfigKindBuilder
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.
Version🔗
Writeable🔗
True if data source can write a value to the path. Auth/authz are supported separately