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
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
CandleStyle | string | Yes | Possible values are: candles, ohlcbars. | |
CandlestickColors | object | Yes | ||
CandlestickFieldMap | object | Yes | ||
ColorStrategy | string | Yes | Possible values are: open-close, close-close. | |
FieldConfig | GraphFieldConfig | Yes | TODO docs | |
Options | object | Yes | ||
VizDisplayMode | string | Yes | Possible values are: candles+volume, candles, volume. |
CandlestickColors
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
down | string | Yes | red | |
flat | string | Yes | gray | |
up | string | Yes | green |
CandlestickFieldMap
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
close | string | No | Corresponds to the final (end) value of the given period | |
high | string | No | Corresponds to the highest value of the given period | |
low | string | No | Corresponds to the lowest value of the given period | |
open | string | No | Corresponds to the starting value of the given period | |
volume | string | No | Corresponds 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.
| 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) | |
barAlignment | integer | No | (Inherited from BarConfig) TODO docs Possible values are: -1, 0, 1. | |
barMaxWidth | number | No | (Inherited from BarConfig) | |
barWidthFactor | number | No | (Inherited from BarConfig) | |
drawStyle | string | No | TODO docs Possible values are: line, bars, points. | |
fillBelowTo | string | No | (Inherited from FillConfig) | |
fillColor | string | No | (Inherited from FillConfig) | |
fillOpacity | number | No | (Inherited from FillConfig) | |
gradientMode | string | No | TODO docs Possible values are: none, opacity, hue, scheme. | |
hideFrom | HideSeriesConfig | No | (Inherited from HideableFieldConfig) TODO docs | |
lineColor | string | No | (Inherited from LineConfig) | |
lineInterpolation | string | No | (Inherited from LineConfig) TODO docs Possible values are: linear, smooth, stepBefore, stepAfter. | |
lineStyle | LineStyle | No | (Inherited from LineConfig) TODO docs | |
lineWidth | number | No | (Inherited from LineConfig) | |
pointColor | string | No | (Inherited from PointsConfig) | |
pointSize | number | No | (Inherited from PointsConfig) | |
pointSymbol | string | No | (Inherited from PointsConfig) | |
scaleDistribution | ScaleDistributionConfig | No | (Inherited from AxisConfig) TODO docs | |
showPoints | string | No | (Inherited from PointsConfig) TODO docs Possible values are: auto, never, always. | |
spanNulls | No | (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 | ||
stacking | StackingConfig | No | (Inherited from StackableFieldConfig) TODO docs | |
thresholdsStyle | GraphThresholdsStyleConfig | No | TODO docs | |
transform | string | No | TODO docs Possible values are: constant, negative-Y. |
AxisConfig
TODO docs
| Property | Type | Required | Default | 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 | Default | Description |
|---|---|---|---|---|
type | string | Yes | TODO docs Possible values are: linear, log, ordinal, symlog. | |
linearThreshold | number | No | ||
log | number | No |
BarConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
barAlignment | integer | No | TODO docs Possible values are: -1, 0, 1. | |
barMaxWidth | number | No | ||
barWidthFactor | number | No |
FillConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
fillBelowTo | string | No | ||
fillColor | string | No | ||
fillOpacity | 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 | Default | Description |
|---|---|---|---|---|
legend | boolean | Yes | ||
tooltip | boolean | Yes | ||
viz | boolean | Yes |
HideableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
hideFrom | HideSeriesConfig | No | TODO docs |
LineConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
lineColor | string | No | ||
lineInterpolation | string | No | TODO docs Possible values are: linear, smooth, stepBefore, stepAfter. | |
lineStyle | LineStyle | No | TODO docs | |
lineWidth | number | No | ||
spanNulls | No | 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 |
LineStyle
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
dash | number[] | No | ||
fill | string | No | Possible values are: solid, dash, dot, square. |
PointsConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
pointColor | string | No | ||
pointSize | number | No | ||
pointSymbol | string | No | ||
showPoints | string | No | TODO docs Possible values are: auto, never, always. |
StackableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
stacking | StackingConfig | No | TODO docs |
StackingConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
group | string | No | ||
mode | string | No | TODO docs Possible values are: none, normal, percent. |
Options
It extends OptionsWithLegend and OptionsWithTooltip.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
candleStyle | string | Yes | Sets the style of the candlesticks | |
colorStrategy | string | Yes | Sets the color strategy for the candlesticks | |
colors | CandlestickColors | Yes | ||
fields | object | Yes | map[] | Map fields to appropriate dimension |
legend | VizLegendOptions | Yes | (Inherited from OptionsWithLegend) TODO docs | |
mode | string | Yes | Sets which dimensions are used for the visualization | |
tooltip | VizTooltipOptions | Yes | (Inherited from OptionsWithTooltip) TODO docs | |
includeAllFields | boolean | No | false | When enabled, all fields will be sent to the graph |
OptionsWithLegend
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
legend | VizLegendOptions | Yes | TODO docs |
VizLegendOptions
TODO docs
| Property | Type | Required | Default | 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 |
OptionsWithTooltip
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
tooltip | VizTooltipOptions | Yes | TODO docs |
VizTooltipOptions
TODO docs
| Property | Type | Required | Default | 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 |
Fields
Map fields to appropriate dimension
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
object | Possible types are: , . |
Was this page helpful?
Related resources from Grafana Labs
Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.