IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
4b87f38f668db93852518fff3238187ecd95ab46
grafana/docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md
Ihor Yeromin 4b87f38f66 Bar Gauge: Add max height option (#76042) 
Co-authored-by: nmarrs <nathanielmarrs@gmail.com>
2023-11-07 07:11:13 +02:00

5.9 KiB
Raw Blame History

keywords, labels, title
keywords labels title
grafana
schema
products
cloud
enterprise
oss
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 Default Description
Options object Yes

Options

It extends SingleStatBaseOptions.

Property Type Required Default Description
displayMode string Yes Enum expressing the possible display modes
for the bar gauge component of Grafana UI
Possible values are: basic, lcd, gradient.
maxVizHeight uint32 Yes 300
minVizHeight uint32 Yes 75
minVizWidth uint32 Yes 75
namePlacement string Yes Allows for the bar gauge name to be placed explicitly
Possible values are: auto, top, left.
showUnfilled boolean Yes true
sizing string Yes Allows for the bar gauge size to be set explicitly
Possible values are: auto, manual.
valueMode string Yes Allows for the table cell gauge display type to set the gauge mode.
Possible values are: color, text, hidden.
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