Menu
Grafana Cloud Enterprise Open source

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

CandlestickPanelCfg

Maturity: experimental

Version: 0.0

PropertyTypeRequiredDefaultDescription
CandleStylestringYesPossible values are: candles, ohlcbars.
CandlestickColorsobjectYes
CandlestickFieldMapobjectYes
ColorStrategystringYesPossible values are: open-close, close-close.
FieldConfigGraphFieldConfigYesTODO docs
OptionsobjectYes
VizDisplayModestringYesPossible values are: candles+volume, candles, volume.

CandlestickColors

PropertyTypeRequiredDefaultDescription
downstringYesred
flatstringYesgray
upstringYesgreen

CandlestickFieldMap

PropertyTypeRequiredDefaultDescription
closestringNoCorresponds to the final (end) value of the given period
highstringNoCorresponds to the highest value of the given period
lowstringNoCorresponds to the lowest value of the given period
openstringNoCorresponds to the starting value of the given period
volumestringNoCorresponds to the sample count in the given period. (e.g. number of trades)

GraphFieldConfig

TODO docs

It extends LineConfig and FillConfig and PointsConfig and AxisConfig and BarConfig and StackableFieldConfig 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)
barAlignmentintegerNo(Inherited from BarConfig)
TODO docs
Possible values are: -1, 0, 1.
barMaxWidthnumberNo(Inherited from BarConfig)
barWidthFactornumberNo(Inherited from BarConfig)
drawStylestringNoTODO docs
Possible values are: line, bars, points.
fillBelowTostringNo(Inherited from FillConfig)
fillColorstringNo(Inherited from FillConfig)
fillOpacitynumberNo(Inherited from FillConfig)
gradientModestringNoTODO docs
Possible values are: none, opacity, hue, scheme.
hideFromHideSeriesConfigNo(Inherited from HideableFieldConfig)
TODO docs
lineColorstringNo(Inherited from LineConfig)
lineInterpolationstringNo(Inherited from LineConfig)
TODO docs
Possible values are: linear, smooth, stepBefore, stepAfter.
lineStyleLineStyleNo(Inherited from LineConfig)
TODO docs
lineWidthnumberNo(Inherited from LineConfig)
pointColorstringNo(Inherited from PointsConfig)
pointSizenumberNo(Inherited from PointsConfig)
pointSymbolstringNo(Inherited from PointsConfig)
scaleDistributionScaleDistributionConfigNo(Inherited from AxisConfig)
TODO docs
showPointsstringNo(Inherited from PointsConfig)
TODO docs
Possible values are: auto, never, always.
spanNullsNo(Inherited from LineConfig)
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds
stackingStackingConfigNo(Inherited from StackableFieldConfig)
TODO docs
thresholdsStyleGraphThresholdsStyleConfigNoTODO docs
transformstringNoTODO docs
Possible values are: constant, negative-Y.

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

BarConfig

TODO docs

PropertyTypeRequiredDefaultDescription
barAlignmentintegerNoTODO docs
Possible values are: -1, 0, 1.
barMaxWidthnumberNo
barWidthFactornumberNo

FillConfig

TODO docs

PropertyTypeRequiredDefaultDescription
fillBelowTostringNo
fillColorstringNo
fillOpacitynumberNo

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

LineConfig

TODO docs

PropertyTypeRequiredDefaultDescription
lineColorstringNo
lineInterpolationstringNoTODO docs
Possible values are: linear, smooth, stepBefore, stepAfter.
lineStyleLineStyleNoTODO docs
lineWidthnumberNo
spanNullsNoIndicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds

LineStyle

TODO docs

PropertyTypeRequiredDefaultDescription
dashnumber[]No
fillstringNoPossible values are: solid, dash, dot, square.

PointsConfig

TODO docs

PropertyTypeRequiredDefaultDescription
pointColorstringNo
pointSizenumberNo
pointSymbolstringNo
showPointsstringNoTODO docs
Possible values are: auto, never, always.

StackableFieldConfig

TODO docs

PropertyTypeRequiredDefaultDescription
stackingStackingConfigNoTODO docs

StackingConfig

TODO docs

PropertyTypeRequiredDefaultDescription
groupstringNo
modestringNoTODO docs
Possible values are: none, normal, percent.

Options

It extends OptionsWithLegend.

PropertyTypeRequiredDefaultDescription
candleStylestringYesSets the style of the candlesticks
colorStrategystringYesSets the color strategy for the candlesticks
colorsCandlestickColorsYes
fieldsobjectYesmap[]Map fields to appropriate dimension
legendVizLegendOptionsYes(Inherited from OptionsWithLegend)
TODO docs
modestringYesSets which dimensions are used for the visualization
includeAllFieldsbooleanNofalseWhen enabled, all fields will be sent to the graph

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

Fields

Map fields to appropriate dimension

PropertyTypeRequiredDefaultDescription
objectPossible types are: , .