7.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
`PanelOptions`	object	Yes

PanelOptions

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`
`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

<<<<<<< HEAD

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`.
`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

main

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