Visualization🔗

Constructor🔗

Visualization()

Methods🔗

build🔗

Builds the object.

def build() -> dashboardv2beta1.VizConfigKind

actions🔗

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

def actions(actions: list[cogbuilder.Builder[dashboardv2beta1.Action]]) -> typing.Self

calculate🔗

Controls if the heatmap should be calculated from data

def calculate(calculate: bool) -> typing.Self

calculation🔗

Calculation options for the heatmap

def calculation(calculation: cogbuilder.Builder[common.HeatmapCalculationOptions]) -> typing.Self

cell_gap🔗

Controls gap between cells

def cell_gap(cell_gap: int) -> typing.Self

cell_radius🔗

Controls cell radius

def cell_radius(cell_radius: float) -> typing.Self

cell_values🔗

Controls cell value unit

def cell_values(cell_values: cogbuilder.Builder[heatmap.CellValues]) -> typing.Self

color🔗

Controls the color options

def color(color: cogbuilder.Builder[heatmap.HeatmapColorOptions]) -> typing.Self

color_scheme🔗

Panel color configuration

def color_scheme(color: cogbuilder.Builder[dashboardv2beta1.FieldColor]) -> typing.Self

data_links🔗

The behavior when clicking on a result

def data_links(links: list[object]) -> typing.Self

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.

def decimals(decimals: float) -> typing.Self

description🔗

Human readable field metadata

def description(description: str) -> typing.Self

display_name🔗

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

def display_name(display_name: str) -> typing.Self

display_name_from_ds🔗

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.

def display_name_from_ds(display_name_from_ds: str) -> typing.Self

exemplars🔗

Controls exemplar options

def exemplars(exemplars: cogbuilder.Builder[heatmap.ExemplarConfig]) -> typing.Self

field_min_max🔗

Calculate min max per field

def field_min_max(field_min_max: bool) -> typing.Self

filter_values🔗

Filters values between a given range

def filter_values(filter_values: cogbuilder.Builder[heatmap.FilterValueRange]) -> typing.Self

hide_from🔗

def hide_from(hide_from: cogbuilder.Builder[common.HideSeriesConfig]) -> typing.Self

legend🔗

| *{

axisPlacement: ui.AxisPlacement & "left" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed

}

Controls legend options

def legend(legend: cogbuilder.Builder[heatmap.HeatmapLegend]) -> typing.Self

mappings🔗

Convert input values into a display string

def mappings(mappings: list[dashboardv2beta1.ValueMapping]) -> typing.Self

max_val🔗

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

def max_val(max_val: float) -> typing.Self

min_val🔗

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

def min_val(min_val: float) -> typing.Self

no_value🔗

Alternative to empty string

def no_value(no_value: str) -> typing.Self

null_value_mode🔗

How null values should be handled when calculating field stats

"null" - Include null values, "connected" - Ignore nulls, "null as zero" - Treat nulls as zero

def null_value_mode(null_value_mode: dashboardv2beta1.NullValueMode) -> typing.Self

override🔗

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

def override(override: cogbuilder.Builder[dashboardv2beta1.Dashboardv2beta1FieldConfigSourceOverrides]) -> typing.Self

override_by_field_type🔗

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

def override_by_field_type(field_type: str, properties: list[dashboardv2beta1.DynamicConfigValue]) -> typing.Self

override_by_name🔗

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

def override_by_name(name: str, properties: list[dashboardv2beta1.DynamicConfigValue]) -> typing.Self

override_by_query🔗

def override_by_query(query_ref_id: str, properties: list[dashboardv2beta1.DynamicConfigValue]) -> typing.Self

override_by_regexp🔗

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

def override_by_regexp(regexp: str, properties: list[dashboardv2beta1.DynamicConfigValue]) -> typing.Self

overrides🔗

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

def overrides(overrides: list[cogbuilder.Builder[dashboardv2beta1.Dashboardv2beta1FieldConfigSourceOverrides]]) -> typing.Self

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

def path(path: str) -> typing.Self

rows_frame🔗

Controls tick alignment and value name when not calculating from data

def rows_frame(rows_frame: cogbuilder.Builder[heatmap.RowsHeatmapOptions]) -> typing.Self

scale_distribution🔗

def scale_distribution(scale_distribution: cogbuilder.Builder[common.ScaleDistributionConfig]) -> typing.Self

selection_mode🔗

Controls which axis to allow selection on

def selection_mode(selection_mode: heatmap.HeatmapSelectionMode) -> typing.Self

show_value🔗

| *{

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

def show_value(show_value: common.VisibilityMode) -> typing.Self

thresholds🔗

Map numeric values to states

def thresholds(thresholds: cogbuilder.Builder[dashboardv2beta1.ThresholdsConfig]) -> typing.Self

Controls tooltip options

def tooltip(tooltip: cogbuilder.Builder[heatmap.HeatmapTooltip]) -> typing.Self

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.

def unit(unit: str) -> typing.Self

y_axis🔗

Controls yAxis placement

def y_axis(y_axis: cogbuilder.Builder[heatmap.YAxisConfig]) -> typing.Self