Menu
DocumentationGrafana documentationDevelopersGrafana schemaComposable kindsHistogramPanelCfg kind
Grafana Cloud Enterprise Open source

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

HistogramPanelCfg

Maturity: experimental

Version: 0.0

PropertyTypeRequiredDefaultDescription
FieldConfigobjectYes
OptionsobjectYes

FieldConfig

It extends AxisConfig and HideableFieldConfig.

PropertyTypeRequiredDefaultDescription
axisBorderShowbooleanNo(Inherited from AxisConfig)
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

AxisConfig

TODO docs

PropertyTypeRequiredDefaultDescription
axisBorderShowbooleanNo
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

HideSeriesConfig

TODO docs

PropertyTypeRequiredDefaultDescription
legendbooleanYes
tooltipbooleanYes
vizbooleanYes

HideableFieldConfig

TODO docs

PropertyTypeRequiredDefaultDescription
hideFromHideSeriesConfigNoTODO docs

Options

It extends OptionsWithLegend and OptionsWithTooltip.

PropertyTypeRequiredDefaultDescription
legendVizLegendOptionsYes(Inherited from OptionsWithLegend)
TODO docs
tooltipVizTooltipOptionsYes(Inherited from OptionsWithTooltip)
TODO docs
bucketCountintegerNo30Bucket count (approx)
Constraint: >0 & <=2147483647.
bucketOffsetnumberNo0Offset buckets by this amount
Constraint: >=-340282346638528859811704183484516925440 & <=340282346638528859811704183484516925440.
bucketSizeintegerNoSize of each bucket
combinebooleanNoCombines multiple series into a single histogram

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

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.
maxHeightnumberNo
maxWidthnumberNo