VisualizationBuilder🔗
Constructor🔗
Methods🔗
Build🔗
Builds the object.
Actions🔗
Define interactive HTTP requests that can be triggered from data visualizations.
func (builder *VisualizationBuilder) Actions(actions []cog.Builder[dashboardv2beta1.Action]) *VisualizationBuilder
Align🔗
CellHeight🔗
Controls the height of the rows
func (builder *VisualizationBuilder) CellHeight(cellHeight common.TableCellHeight) *VisualizationBuilder
CellOptions🔗
func (builder *VisualizationBuilder) CellOptions(cellOptions common.TableCellOptions) *VisualizationBuilder
ColorScheme🔗
Panel color configuration
func (builder *VisualizationBuilder) ColorScheme(color cog.Builder[dashboardv2beta1.FieldColor]) *VisualizationBuilder
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
DisplayMode🔗
This field is deprecated in favor of using cellOptions
func (builder *VisualizationBuilder) DisplayMode(displayMode common.TableCellDisplayMode) *VisualizationBuilder
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 *VisualizationBuilder) DisplayNameFromDS(displayNameFromDS string) *VisualizationBuilder
FieldMinMax🔗
Calculate min max per field
Filterable🔗
Footer🔗
Controls footer options
func (builder *VisualizationBuilder) Footer(footer cog.Builder[common.TableFooterOptions]) *VisualizationBuilder
FrameIndex🔗
Represents the index of the selected frame
Hidden🔗
?? default is missing or false ??
HideHeader🔗
Hides any header for a column, useful for columns that show some static content or buttons.
Inspect🔗
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.
Min🔗
The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.
MinWidth🔗
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 *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
ShowHeader🔗
Controls whether the panel should show the header
ShowTypeIcons🔗
Controls whether the header should show icons for the column types
SortBy🔗
Used to control row sorting
func (builder *VisualizationBuilder) SortBy(sortBy []cog.Builder[common.TableSortByFieldState]) *VisualizationBuilder
Thresholds🔗
Map numeric values to states
func (builder *VisualizationBuilder) Thresholds(thresholds cog.Builder[dashboardv2beta1.ThresholdsConfig]) *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.