Menu
Grafana Cloud Enterprise Open source

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

HeatmapPanelCfg

Maturity: merged

Version: 0.0

PropertyTypeRequiredDefaultDescription
CellValuesobjectYesControls cell value options
ExemplarConfigobjectYesControls exemplar options
FieldConfigobjectYes
FilterValueRangeobjectYesControls the value filter range
HeatmapColorModestringYesControls the color mode of the heatmap
Possible values are: opacity, scheme.
HeatmapColorOptionsobjectYesControls various color options
HeatmapColorScalestringYesControls the color scale of the heatmap
Possible values are: linear, exponential.
HeatmapLegendobjectYesControls legend options
HeatmapTooltipobjectYesControls tooltip options
OptionsobjectYes
RowsHeatmapOptionsobjectYesControls frame rows options
YAxisConfigobjectYesConfiguration options for the yAxis

CellValues

Controls cell value options

PropertyTypeRequiredDefaultDescription
decimalsnumberNoControls the number of decimals for cell values
unitstringNoControls the cell value unit

ExemplarConfig

Controls exemplar options

PropertyTypeRequiredDefaultDescription
colorstringYesSets the color of the exemplar markers

FieldConfig

It extends HideableFieldConfig.

PropertyTypeRequiredDefaultDescription
hideFromHideSeriesConfigNo(Inherited from HideableFieldConfig)
TODO docs
scaleDistributionScaleDistributionConfigNoTODO docs

HideSeriesConfig

TODO docs

PropertyTypeRequiredDefaultDescription
legendbooleanYes
tooltipbooleanYes
vizbooleanYes

HideableFieldConfig

TODO docs

PropertyTypeRequiredDefaultDescription
hideFromHideSeriesConfigNoTODO docs

ScaleDistributionConfig

TODO docs

PropertyTypeRequiredDefaultDescription
typestringYesTODO docs
Possible values are: linear, log, ordinal, symlog.
linearThresholdnumberNo
lognumberNo

FilterValueRange

Controls the value filter range

PropertyTypeRequiredDefaultDescription
genumberNoSets the filter range to values greater than or equal to the given value
lenumberNoSets the filter range to values less than or equal to the given value

HeatmapColorOptions

Controls various color options

PropertyTypeRequiredDefaultDescription
exponentnumberYesControls the exponent when scale is set to exponential
fillstringYesControls the color fill when in opacity mode
reversebooleanYesReverses the color scheme
schemestringYesControls the color scheme used
stepsintegerYesControls the number of color steps
Constraint: >=2 & <=128.
maxnumberNoSets the maximum value for the color scale
minnumberNoSets the minimum value for the color scale
modestringNoControls the color mode of the heatmap
Possible values are: opacity, scheme.
scalestringNoControls the color scale of the heatmap
Possible values are: linear, exponential.

HeatmapLegend

Controls legend options

PropertyTypeRequiredDefaultDescription
showbooleanYesControls if the legend is shown

HeatmapTooltip

Controls tooltip options

PropertyTypeRequiredDefaultDescription
showbooleanYesControls if the tooltip is shown
yHistogrambooleanNoControls if the tooltip shows a histogram of the y-axis values

Options

PropertyTypeRequiredDefaultDescription
colorobjectYesmap[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]Controls the color options
exemplarsExemplarConfigYesControls exemplar options
legendHeatmapLegendYesControls legend options
showValuestringYes| *{
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
tooltipHeatmapTooltipYesControls tooltip options
yAxisYAxisConfigYesConfiguration options for the yAxis
calculatebooleanNofalseControls if the heatmap should be calculated from data
calculationHeatmapCalculationOptionsNo
cellGapintegerNo1Controls gap between cells
Constraint: >=0 & <=25.
cellRadiusnumberNoControls cell radius
cellValuesobjectNomap[]Controls cell value unit
filterValuesobjectNomap[le:1e-09]Filters values between a given range
rowsFrameRowsHeatmapOptionsNoControls frame rows options

HeatmapCalculationOptions

PropertyTypeRequiredDefaultDescription
xBucketsHeatmapCalculationBucketConfigNo
yBucketsHeatmapCalculationBucketConfigNo

HeatmapCalculationBucketConfig

PropertyTypeRequiredDefaultDescription
modestringNoPossible values are: size, count.
scaleScaleDistributionConfigNoTODO docs
valuestringNoThe number of buckets to use for the axis in the heatmap

RowsHeatmapOptions

Controls frame rows options

PropertyTypeRequiredDefaultDescription
layoutstringNoPossible values are: le, ge, unknown, auto.
valuestringNoSets the name of the cell when not calculating from data

YAxisConfig

Configuration options for the yAxis

It extends AxisConfig.

PropertyTypeRequiredDefaultDescription
axisCenteredZerobooleanNo(Inherited from AxisConfig)
axisColorModestringNo(Inherited from AxisConfig)
TODO docs
Possible values are: text, series.
axisGridShowbooleanNo(Inherited from AxisConfig)
axisLabelstringNo(Inherited from AxisConfig)
axisPlacementstringNo(Inherited from AxisConfig)
TODO docs
Possible values are: auto, top, right, bottom, left, hidden.
axisSoftMaxnumberNo(Inherited from AxisConfig)
axisSoftMinnumberNo(Inherited from AxisConfig)
axisWidthnumberNo(Inherited from AxisConfig)
decimalsnumberNoControls the number of decimals for yAxis values
maxnumberNoSets the maximum value for the yAxis
minnumberNoSets the minimum value for the yAxis
reversebooleanNoReverses the yAxis
scaleDistributionScaleDistributionConfigNo(Inherited from AxisConfig)
TODO docs
unitstringNoSets the yAxis unit

AxisConfig

TODO docs

PropertyTypeRequiredDefaultDescription
axisCenteredZerobooleanNo
axisColorModestringNoTODO docs
Possible values are: text, series.
axisGridShowbooleanNo
axisLabelstringNo
axisPlacementstringNoTODO docs
Possible values are: auto, top, right, bottom, left, hidden.
axisSoftMaxnumberNo
axisSoftMinnumberNo
axisWidthnumberNo
scaleDistributionScaleDistributionConfigNoTODO docs

CellValues

Controls cell value unit

PropertyTypeRequiredDefaultDescription
objectPossible types are: , .

Color

Controls the color options

PropertyTypeRequiredDefaultDescription
objectPossible types are: , .

FilterValues

Filters values between a given range

PropertyTypeRequiredDefaultDescription
objectPossible types are: , .