Menu
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

PropertyTypeRequiredDefaultDescription
FieldConfigobjectYes
OptionsobjectYes

FieldConfig

It extends AxisConfig and HideableFieldConfig.

PropertyTypeRequiredDefaultDescription
axisCenteredZerobooleanNo(Inherited from AxisConfig)
axisColorModestringNo(Inherited from AxisConfig)
TODO docs
Possible values are: text, series.
axisGridShowbooleanNo(Inherited from AxisConfig)
axisLabelstringNo(Inherited from AxisConfig)
axisPlacementstringNo(Inherited from AxisConfig)
TODO docs
Possible values are: auto, top, right, bottom, left, hidden.
axisSoftMaxnumberNo(Inherited from AxisConfig)
axisSoftMinnumberNo(Inherited from AxisConfig)
axisWidthnumberNo(Inherited from AxisConfig)
fillOpacityintegerNo80Controls the fill opacity of the bars.
Constraint: >=0 & <=100.
gradientModestringNoSet 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.
hideFromHideSeriesConfigNo(Inherited from HideableFieldConfig)
TODO docs
lineWidthintegerNo1Controls line width of the bars.
Constraint: >=0 & <=10.
scaleDistributionScaleDistributionConfigNo(Inherited from AxisConfig)
TODO docs
thresholdsStyleGraphThresholdsStyleConfigNoTODO docs

AxisConfig

TODO docs

PropertyTypeRequiredDefaultDescription
axisCenteredZerobooleanNo
axisColorModestringNoTODO docs
Possible values are: text, series.
axisGridShowbooleanNo
axisLabelstringNo
axisPlacementstringNoTODO docs
Possible values are: auto, top, right, bottom, left, hidden.
axisSoftMaxnumberNo
axisSoftMinnumberNo
axisWidthnumberNo
scaleDistributionScaleDistributionConfigNoTODO docs

ScaleDistributionConfig

TODO docs

PropertyTypeRequiredDefaultDescription
typestringYesTODO docs
Possible values are: linear, log, ordinal, symlog.
linearThresholdnumberNo
lognumberNo

GraphThresholdsStyleConfig

TODO docs

PropertyTypeRequiredDefaultDescription
modestringYesTODO docs
Possible values are: off, line, dashed, area, line+area, dashed+area, series.

HideSeriesConfig

TODO docs

PropertyTypeRequiredDefaultDescription
legendbooleanYes
tooltipbooleanYes
vizbooleanYes

HideableFieldConfig

TODO docs

PropertyTypeRequiredDefaultDescription
hideFromHideSeriesConfigNoTODO docs

Options

It extends OptionsWithLegend and OptionsWithTooltip and OptionsWithTextFormatting.

PropertyTypeRequiredDefaultDescription
barWidthnumberYes0.97Controls the width of bars. 1 = Max width, 0 = Min width.
Constraint: >=0 & <=1.
fullHighlightbooleanYesfalseEnables mode which highlights the entire bar area and shows tooltip when cursor
hovers over highlighted area
groupWidthnumberYes0.7Controls the width of groups. 1 = max with, 0 = min width.
Constraint: >=0 & <=1.
legendVizLegendOptionsYes(Inherited from OptionsWithLegend)
TODO docs
orientationstringYesControls the orientation of the bar chart, either vertical or horizontal.
showValuestringYesThis controls whether values are shown on top or to the left of bars.
stackingstringYesControls whether bars are stacked or not, either normally or in percent mode.
tooltipVizTooltipOptionsYes(Inherited from OptionsWithTooltip)
TODO docs
xTickLabelMaxLengthintegerYesSets the max length that a label can have before it is truncated.
Constraint: >=0 & <=2147483647.
xTickLabelRotationintegerYes0Controls the rotation of the x axis labels.
Constraint: >=-90 & <=90.
barRadiusnumberNo0Controls the radius of each bar.
Constraint: >=0 & <=0.5.
colorByFieldstringNoUse the color value for a sibling field to color each bar value.
textVizTextDisplayOptionsNo(Inherited from OptionsWithTextFormatting)
TODO docs
xFieldstringNoManually select which field from the dataset to represent the x field.
xTickLabelSpacingint32No0Controls the spacing between x axis labels.
negative values indicate backwards skipping behavior

OptionsWithLegend

TODO docs

PropertyTypeRequiredDefaultDescription
legendVizLegendOptionsYesTODO docs

VizLegendOptions

TODO docs

PropertyTypeRequiredDefaultDescription
calcsstring[]Yes
displayModestringYesTODO docs
Note: “hidden” needs to remain as an option for plugins compatibility
Possible values are: list, table, hidden.
placementstringYesTODO docs
Possible values are: bottom, right.
showLegendbooleanYes
asTablebooleanNo
isVisiblebooleanNo
sortBystringNo
sortDescbooleanNo
widthnumberNo

OptionsWithTextFormatting

TODO docs

PropertyTypeRequiredDefaultDescription
textVizTextDisplayOptionsNoTODO docs

VizTextDisplayOptions

TODO docs

PropertyTypeRequiredDefaultDescription
titleSizenumberNoExplicit title text size
valueSizenumberNoExplicit value text size

OptionsWithTooltip

TODO docs

PropertyTypeRequiredDefaultDescription
tooltipVizTooltipOptionsYesTODO docs

VizTooltipOptions

TODO docs

PropertyTypeRequiredDefaultDescription
modestringYesTODO docs
Possible values are: single, multi, none.
sortstringYesTODO docs
Possible values are: asc, desc, none.