Files
Nathan Marrs 3e08abff3b Gauge: Simplify gauge dimension panel options (#76216)
Co-authored-by: Ihor Yeromin <yeryomin.igor@gmail.com>
2023-11-17 21:59:30 +02:00

5.3 KiB

keywords labels title
grafana
schema
products
cloud
enterprise
oss
GaugePanelCfg kind

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

GaugePanelCfg

Maturity: experimental

Version: 0.0

Property Type Required Default Description
Options object Yes

Options

It extends SingleStatBaseOptions.

Property Type Required Default Description
minVizHeight uint32 Yes 200
minVizWidth uint32 Yes 200
showThresholdLabels boolean Yes false
showThresholdMarkers boolean Yes true
sizing string Yes Allows for the bar gauge size to be set explicitly
Possible values are: auto, manual.
orientation string No (Inherited from SingleStatBaseOptions)
TODO docs
Possible values are: auto, vertical, horizontal.
reduceOptions ReduceDataOptions No (Inherited from SingleStatBaseOptions)
TODO docs
text VizTextDisplayOptions No (Inherited from SingleStatBaseOptions)
TODO docs

ReduceDataOptions

TODO docs

Property Type Required Default Description
calcs string[] Yes When !values, pick one value for the whole field
fields string No Which fields to show. By default this is only numeric fields
limit number No if showing all values limit
values boolean No If true show each row value

SingleStatBaseOptions

TODO docs

It extends OptionsWithTextFormatting.

Property Type Required Default Description
orientation string Yes TODO docs
Possible values are: auto, vertical, horizontal.
reduceOptions ReduceDataOptions Yes TODO docs
text VizTextDisplayOptions No (Inherited from OptionsWithTextFormatting)
TODO docs

OptionsWithTextFormatting

TODO docs

Property Type Required Default Description
text VizTextDisplayOptions No TODO docs

VizTextDisplayOptions

TODO docs

Property Type Required Default Description
titleSize number No Explicit title text size
valueSize number No Explicit value text size