BarChartPanelCfg kind | Grafana documentation

Documentation

Grafana documentation

Developers

Grafana schema

Composable kinds

BarChartPanelCfg kind

Grafana Cloud Enterprise Open source

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

BarChartPanelCfg

Maturity: experimental

Version: 0.0

Property	Type	Required	Default	Description
`FieldConfig`	object	Yes
`Options`	object	Yes

FieldConfig

It extends AxisConfig and HideableFieldConfig.

Property	Type	Required	Default	Description
`axisBorderShow`	boolean	No		(Inherited from AxisConfig)
`axisCenteredZero`	boolean	No		(Inherited from AxisConfig)
`axisColorMode`	string	No		(Inherited from AxisConfig) TODO docs Possible values are: `text`, `series`.
`axisGridShow`	boolean	No		(Inherited from AxisConfig)
`axisLabel`	string	No		(Inherited from AxisConfig)
`axisPlacement`	string	No		(Inherited from AxisConfig) TODO docs Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`.
`axisSoftMax`	number	No		(Inherited from AxisConfig)
`axisSoftMin`	number	No		(Inherited from AxisConfig)
`axisWidth`	number	No		(Inherited from AxisConfig)
`fillOpacity`	integer	No	`80`	Controls the fill opacity of the bars. Constraint: `>=0 & <=100`.
`gradientMode`	string	No		Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option. Gradient appearance is influenced by the Fill opacity setting.
`hideFrom`	HideSeriesConfig	No		(Inherited from HideableFieldConfig) TODO docs
`lineWidth`	integer	No	`1`	Controls line width of the bars. Constraint: `>=0 & <=10`.
`scaleDistribution`	ScaleDistributionConfig	No		(Inherited from AxisConfig) TODO docs
`thresholdsStyle`	GraphThresholdsStyleConfig	No		TODO docs

AxisConfig

TODO docs

Property	Type	Required	Description
`axisBorderShow`	boolean	No
`axisCenteredZero`	boolean	No
`axisColorMode`	string	No	TODO docs Possible values are: `text`, `series`.
`axisGridShow`	boolean	No
`axisLabel`	string	No
`axisPlacement`	string	No	TODO docs Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`.
`axisSoftMax`	number	No
`axisSoftMin`	number	No
`axisWidth`	number	No
`scaleDistribution`	ScaleDistributionConfig	No	TODO docs

ScaleDistributionConfig

TODO docs

Property	Type	Required	Description
`type`	string	Yes	TODO docs Possible values are: `linear`, `log`, `ordinal`, `symlog`.
`linearThreshold`	number	No
`log`	number	No

GraphThresholdsStyleConfig

TODO docs

Property	Type	Required	Default	Description
`mode`	string	Yes		TODO docs Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`.

HideSeriesConfig

TODO docs

Property	Type	Required
`legend`	boolean	Yes
`tooltip`	boolean	Yes
`viz`	boolean	Yes

HideableFieldConfig

TODO docs

Property	Type	Required	Default	Description
`hideFrom`	HideSeriesConfig	No		TODO docs

Options

It extends OptionsWithLegend and OptionsWithTooltip and OptionsWithTextFormatting.

Property	Type	Required	Default	Description
`barWidth`	number	Yes	`0.97`	Controls the width of bars. 1 = Max width, 0 = Min width. Constraint: `>=0 & <=1`.
`fullHighlight`	boolean	Yes	`false`	Enables mode which highlights the entire bar area and shows tooltip when cursor hovers over highlighted area
`groupWidth`	number	Yes	`0.7`	Controls the width of groups. 1 = max with, 0 = min width. Constraint: `>=0 & <=1`.
`legend`	VizLegendOptions	Yes		(Inherited from OptionsWithLegend) TODO docs
`orientation`	string	Yes		Controls the orientation of the bar chart, either vertical or horizontal.
`showValue`	string	Yes		This controls whether values are shown on top or to the left of bars.
`stacking`	string	Yes		Controls whether bars are stacked or not, either normally or in percent mode.
`tooltip`	VizTooltipOptions	Yes		(Inherited from OptionsWithTooltip) TODO docs
`xTickLabelMaxLength`	integer	Yes		Sets the max length that a label can have before it is truncated. Constraint: `>=0 & <=2147483647`.
`xTickLabelRotation`	integer	Yes	`0`	Controls the rotation of the x axis labels. Constraint: `>=-90 & <=90`.
`barRadius`	number	No	`0`	Controls the radius of each bar. Constraint: `>=0 & <=0.5`.
`colorByField`	string	No		Use the color value for a sibling field to color each bar value.
`text`	VizTextDisplayOptions	No		(Inherited from OptionsWithTextFormatting) TODO docs
`xField`	string	No		Manually select which field from the dataset to represent the x field.
`xTickLabelSpacing`	int32	No	`0`	Controls the spacing between x axis labels. negative values indicate backwards skipping behavior

OptionsWithLegend

TODO docs

Property	Type	Required	Default	Description
`legend`	VizLegendOptions	Yes		TODO docs

VizLegendOptions

TODO docs

Property	Type	Required	Description
`calcs`	string[]	Yes
`displayMode`	string	Yes	TODO docs Note: “hidden” needs to remain as an option for plugins compatibility Possible values are: `list`, `table`, `hidden`.
`placement`	string	Yes	TODO docs Possible values are: `bottom`, `right`.
`showLegend`	boolean	Yes
`asTable`	boolean	No
`isVisible`	boolean	No
`sortBy`	string	No
`sortDesc`	boolean	No
`width`	number	No

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

OptionsWithTooltip

TODO docs

Property	Type	Required	Default	Description
`tooltip`	VizTooltipOptions	Yes		TODO docs

VizTooltipOptions

TODO docs

Property	Type	Required	Description
`mode`	string	Yes	TODO docs Possible values are: `single`, `multi`, `none`.
`sort`	string	Yes	TODO docs Possible values are: `asc`, `desc`, `none`.
`maxHeight`	number	No
`maxWidth`	number	No