Files
grafana/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md
T
Tania f0333ac41f Codegen: Render constraints in generated docs (#63196)
* Add constraints rendering

* Generate docs

* Fix constraint format

* Add type alias

* Compare numbers as strings

* fixup! Compare numbers as strings

* Add missing return
2023-02-10 06:40:50 -05:00

4.7 KiB

keywords, title
keywords title
grafana
schema
BarGaugePanelCfg kind

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

BarGaugePanelCfg

Maturity: experimental

Version: 0.0

Property Type Required Description
PanelOptions object Yes

PanelOptions

It extends SingleStatBaseOptions.

Property Type Required Description
displayMode string Yes Enum expressing the possible display modes
for the bar gauge component of Grafana UI
Possible values are: basic, lcd, gradient.
minVizHeight uint32 Yes Default: 10.
minVizWidth uint32 Yes Default: 0.
showUnfilled boolean Yes Default: true.
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 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 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 Description
text VizTextDisplayOptions No TODO docs

VizTextDisplayOptions

TODO docs

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