2023-06-20 12:18:40 +08:00
---
keywords:
2023-07-18 17:03:16 +08:00
- grafana
- schema
2023-07-20 17:48:12 +08:00
labels:
products:
- cloud
- enterprise
- oss
2023-06-20 12:18:40 +08:00
title: CandlestickPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## CandlestickPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/enterprise-licensing pages to have 'Enterprise' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/recorded-queries pages to have labels cloud,enterprise
* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/stats-and-license pages to have labels cloud,enterprise
* Set alerting pages to have labels cloud,enterprise,oss
* Set breaking-changes pages to have labels cloud,enterprise,oss
* Set dashboards pages to have labels cloud,enterprise,oss
* Set datasources pages to have labels cloud,enterprise,oss
* Set explore pages to have labels cloud,enterprise,oss
* Set fundamentals pages to have labels cloud,enterprise,oss
* Set introduction/grafana-cloud pages to have labels cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix introduction pages products
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set panels-visualizations pages to have labels cloud,enterprise,oss
* Set release-notes pages to have labels cloud,enterprise,oss
* Set search pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set troubleshooting pages to have labels cloud,enterprise,oss
* Set whatsnew pages to have labels cloud,enterprise,oss
* Apply updated labels from review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 16:10:12 +08:00
#### Version: 0.0
2023-06-20 12:18:40 +08:00
2023-07-18 17:03:16 +08:00
2023-06-20 12:18:40 +08:00
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|-----------------------|---------------------------------------|----------|---------|-------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `CandleStyle` | string | **Yes** | | Possible values are: `candles` , `ohlcbars` . |
| `CandlestickColors` | [object ](#candlestickcolors ) | **Yes** | | |
| `CandlestickFieldMap` | [object ](#candlestickfieldmap ) | **Yes** | | |
| `ColorStrategy` | string | **Yes** | | Possible values are: `open-close` , `close-close` . |
| `FieldConfig` | [GraphFieldConfig ](#graphfieldconfig ) | **Yes** | | TODO docs |
| `Options` | [object ](#options ) | **Yes** | | |
| `VizDisplayMode` | string | **Yes** | | Possible values are: `candles+volume` , `candles` , `volume` . |
### CandlestickColors
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|----------|--------|----------|---------|-------------|
2023-06-20 12:18:40 +08:00
| `down` | string | **Yes** | `red` | |
| `flat` | string | **Yes** | `gray` | |
| `up` | string | **Yes** | `green` | |
### CandlestickFieldMap
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|----------|--------|----------|---------|------------------------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `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 ](#lineconfig ) and [FillConfig ](#fillconfig ) and [PointsConfig ](#pointsconfig ) and [AxisConfig ](#axisconfig ) and [BarConfig ](#barconfig ) and [StackableFieldConfig ](#stackablefieldconfig ) and [HideableFieldConfig ](#hideablefieldconfig ).
2023-07-18 17:03:16 +08:00
| Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2023-09-20 04:43:15 +08:00
| `axisBorderShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
2023-07-18 17:03:16 +08:00
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* < br /> TODO docs< br /> Possible values are: `text` , `series` . |
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* < br /> TODO docs< br /> Possible values are: `auto` , `top` , `right` , `bottom` , `left` , `hidden` . |
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))* < br /> TODO docs< br /> Possible values are: `-1` , `0` , `1` . |
| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
| `drawStyle` | string | No | | TODO docs< br /> Possible values are: `line` , `bars` , `points` . |
| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* |
| `gradientMode` | string | No | | TODO docs< br /> Possible values are: `none` , `opacity` , `hue` , `scheme` . |
| `hideFrom` | [HideSeriesConfig ](#hideseriesconfig ) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))* < br /> TODO docs |
| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* |
| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))* < br /> TODO docs< br /> Possible values are: `linear` , `smooth` , `stepBefore` , `stepAfter` . |
| `lineStyle` | [LineStyle ](#linestyle ) | No | | *(Inherited from [LineConfig](#lineconfig))* < br /> TODO docs |
| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* |
| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
| `scaleDistribution` | [ScaleDistributionConfig ](#scaledistributionconfig ) | No | | *(Inherited from [AxisConfig](#axisconfig))* < br /> TODO docs |
| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* < br /> TODO docs< br /> Possible values are: `auto` , `never` , `always` . |
| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))* < br /> Indicate if null values should be treated as gaps or connected.< br /> When the value is a number, it represents the maximum delta in the< br /> X axis that should be considered connected. For timeseries, this is milliseconds |
| `stacking` | [StackingConfig ](#stackingconfig ) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))* < br /> TODO docs |
| `thresholdsStyle` | [GraphThresholdsStyleConfig ](#graphthresholdsstyleconfig ) | No | | TODO docs |
| `transform` | string | No | | TODO docs< br /> Possible values are: `constant` , `negative-Y` . |
2023-06-20 12:18:40 +08:00
### AxisConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
2023-09-20 04:43:15 +08:00
| `axisBorderShow` | boolean | No | | |
2023-06-20 12:18:40 +08:00
| `axisCenteredZero` | boolean | No | | |
| `axisColorMode` | string | No | | TODO docs< br /> Possible values are: `text` , `series` . |
| `axisGridShow` | boolean | No | | |
| `axisLabel` | string | No | | |
| `axisPlacement` | string | No | | TODO docs< br /> Possible values are: `auto` , `top` , `right` , `bottom` , `left` , `hidden` . |
| `axisSoftMax` | number | No | | |
| `axisSoftMin` | number | No | | |
| `axisWidth` | number | No | | |
| `scaleDistribution` | [ScaleDistributionConfig ](#scaledistributionconfig ) | No | | TODO docs |
### ScaleDistributionConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `type` | string | **Yes** | | TODO docs< br /> Possible values are: `linear` , `log` , `ordinal` , `symlog` . |
| `linearThreshold` | number | No | | |
| `log` | number | No | | |
### BarConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|------------------|---------|----------|---------|----------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `barAlignment` | integer | No | | TODO docs< br /> Possible values are: `-1` , `0` , `1` . |
| `barMaxWidth` | number | No | | |
| `barWidthFactor` | number | No | | |
### FillConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|---------------|--------|----------|---------|-------------|
2023-06-20 12:18:40 +08:00
| `fillBelowTo` | string | No | | |
| `fillColor` | string | No | | |
| `fillOpacity` | number | No | | |
### GraphThresholdsStyleConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `mode` | string | **Yes** | | TODO docs< br /> Possible values are: `off` , `line` , `dashed` , `area` , `line+area` , `dashed+area` , `series` . |
### HideSeriesConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|-----------|---------|----------|---------|-------------|
2023-06-20 12:18:40 +08:00
| `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | |
### HideableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|------------|---------------------------------------|----------|---------|-------------|
2023-06-20 12:18:40 +08:00
| `hideFrom` | [HideSeriesConfig ](#hideseriesconfig ) | No | | TODO docs |
### LineConfig
TODO docs
2023-07-18 17:03:16 +08:00
| Property | Type | Required | Default | Description |
|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `lineColor` | string | No | | |
| `lineInterpolation` | string | No | | TODO docs< br /> Possible values are: `linear` , `smooth` , `stepBefore` , `stepAfter` . |
| `lineStyle` | [LineStyle ](#linestyle ) | No | | TODO docs |
| `lineWidth` | number | No | | |
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.< br /> When the value is a number, it represents the maximum delta in the< br /> X axis that should be considered connected. For timeseries, this is milliseconds |
2023-06-20 12:18:40 +08:00
### LineStyle
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|----------|----------|----------|---------|--------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `dash` | number[] | No | | |
| `fill` | string | No | | Possible values are: `solid` , `dash` , `dot` , `square` . |
### PointsConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|---------------|--------|----------|---------|---------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `pointColor` | string | No | | |
| `pointSize` | number | No | | |
| `pointSymbol` | string | No | | |
| `showPoints` | string | No | | TODO docs< br /> Possible values are: `auto` , `never` , `always` . |
### StackableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|------------|-----------------------------------|----------|---------|-------------|
2023-06-20 12:18:40 +08:00
| `stacking` | [StackingConfig ](#stackingconfig ) | No | | TODO docs |
### StackingConfig
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|----------|--------|----------|---------|-----------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `group` | string | No | | |
| `mode` | string | No | | TODO docs< br /> Possible values are: `none` , `normal` , `percent` . |
### Options
It extends [OptionsWithLegend ](#optionswithlegend ).
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|--------------------|-----------------------------------------|----------|---------|--------------------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `candleStyle` | string | **Yes** | | Sets the style of the candlesticks |
| `colorStrategy` | string | **Yes** | | Sets the color strategy for the candlesticks |
| `colors` | [CandlestickColors ](#candlestickcolors ) | **Yes** | | |
| `fields` | [object ](#fields ) | **Yes** | `map[]` | Map fields to appropriate dimension |
2023-07-18 17:03:16 +08:00
| `legend` | [VizLegendOptions ](#vizlegendoptions ) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))* < br /> TODO docs |
2023-06-20 12:18:40 +08:00
| `mode` | string | **Yes** | | Sets which dimensions are used for the visualization |
| `includeAllFields` | boolean | No | `false` | When enabled, all fields will be sent to the graph |
### OptionsWithLegend
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|----------|---------------------------------------|----------|---------|-------------|
2023-06-20 12:18:40 +08:00
| `legend` | [VizLegendOptions ](#vizlegendoptions ) | **Yes** | | TODO docs |
### VizLegendOptions
TODO docs
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
2023-06-20 12:18:40 +08:00
| `calcs` | string[] | **Yes** | | |
| `displayMode` | string | **Yes** | | TODO docs< br /> Note: "hidden" needs to remain as an option for plugins compatibility< br /> Possible values are: `list` , `table` , `hidden` . |
| `placement` | string | **Yes** | | TODO docs< br /> Possible values are: `bottom` , `right` . |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### Fields
Map fields to appropriate dimension
| Property | Type | Required | Default | Description |
2023-07-18 17:03:16 +08:00
|----------|-----------------------------------|----------|---------|-------------|
2023-06-20 12:18:40 +08:00
| `object` | Possible types are: [](#), [](#). | | |
2023-07-18 17:03:16 +08:00
