opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-09-24 09:34:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md
sam boyer 09895c26b6 Chore: Hacky first pass on generating composable kinds within grafana/schema (#64723) 
* Super hacky first pass on gen types

* First sketchy pass at generated compo kinds in TS, grok-style

* Merge fix

* Create jenny for MajorsOrX for plugins

* Re-generate files with imports

* Delete invalid generated file

* Fix cue

* Update go.mod

* Update schemas

* Fix go-imports

* Regenerate cue files

---------

Co-authored-by: spinillos <selenepinillos@gmail.com>
2023-05-30 05:56:18 -07:00

5.2 KiB
Raw Blame History

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 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.
minVizHeight uint32 Yes 10
minVizWidth uint32 Yes 0
showUnfilled boolean Yes true
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