grafana/dashboard-schemas/panels/Gauge.cue
Chris Trott 3d33de1751
dashboard-schemas cue 3.0.0 compatible (#29352)
Lead all top-level properties that we do not intend to export with an
underscore.

In 2.2.0, only definitions starting with a capital letter were exported.
As well, properties with a leading underscore were not visible to an
entire package - just within the same file. 3.0.0 still considers them
hidden, however, they are now visible to an entire package.
2020-11-25 07:43:09 +01:00

75 lines
1.5 KiB
CUE

package panels
// Gauge is a single value panel that can repeat a gauge for every series,
// column or row.
#Gauge: _panel & {
// Field config.
fieldConfig: {
// Defaults.
defaults: {
// Custom.
custom: {}
// Unit.
unit: string
// Min.
min: int
// Max.
max: int
// Decimals.
decimals: int
// Change the field or series name.
displayName: string
// What to show when there is no value.
noValue: string
// Threshold config.
thresholds: _thresholds
// Mappings.
mappings: [..._mapping]
// Data Links.
links: [..._dataLink]
}
// Overrides.
overrides: [..._override]
}
// Options.
options: {
// Reduce options.
reduceOptions: {
// * `true` - Show a calculated value based on all rows.
// * `false` - Show a separate stat for every row.
values: bool | *false
// If values is false, sets max number of rows to
// display.
limit: int
// Reducer function/calculation.
calcs: [
"allIsZero",
"allIsNull",
"changeCount",
"count",
"delta",
"diff",
"distinctCount",
"first",
"firstNotNull",
"lastNotNull",
"last",
"logmin",
"max",
"min",
"range",
"step",
"sum",
] | *["mean"]
// Fields that should be included in the panel.
fields: string | *""
}
// Render the threshold values around the gauge bar.
showThresholdLabels: bool | *false
// Render the thresholds as an outer bar.
showThresholdMarkers: bool | *true
}
// Panel type.
type: string | *"gauge"
}