public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(cue): run make gen-cue (#71819)

Browse Source
This commit is contained in:
Jean-Philippe Quéméner
2023-07-18 11:03:16 +02:00
committed by GitHub
parent ca6f616bf3
commit 09dd7ae980
45 changed files with 1072 additions and 1182 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/kinds/composable/candlestick/panelcfg/schema-reference.md
+64 -66
View File
@@ -1,24 +1,20 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
- grafana
- schema
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)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------------------- | ------------------------------------- | -------- | ------- | ----------------------------------------------------------- |
|-----------------------|---------------------------------------|----------|---------|-------------------------------------------------------------|
| `CandleStyle` | string | **Yes** | | Possible values are: `candles`, `ohlcbars`. |
| `CandlestickColors` | [object](#candlestickcolors) | **Yes** | | |
| `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | | |
@@ -30,7 +26,7 @@ title: CandlestickPanelCfg kind
### CandlestickColors
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------- |
|----------|--------|----------|---------|-------------|
| `down` | string | **Yes** | `red` | |
| `flat` | string | **Yes** | `gray` | |
| `up` | string | **Yes** | `green` | |
@@ -38,7 +34,7 @@ title: CandlestickPanelCfg kind
### 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 |
@@ -51,45 +47,45 @@ TODO docs
It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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`. |
| Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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`. |
### AxisConfig
TODO docs
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | | |
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | | |
@@ -105,7 +101,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | |
| `log` | number | No | | |
@@ -115,7 +111,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
|------------------|---------|----------|---------|----------------------------------------------------|
| `barAlignment` | integer | No | | TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
| `barMaxWidth` | number | No | | |
| `barWidthFactor` | number | No | | |
@@ -125,7 +121,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
|---------------|--------|----------|---------|-------------|
| `fillBelowTo` | string | No | | |
| `fillColor` | string | No | | |
| `fillOpacity` | number | No | | |
@@ -135,7 +131,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
### HideSeriesConfig
@@ -143,7 +139,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------- |
|-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | |
@@ -153,27 +149,27 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### LineConfig
TODO docs
| 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 |
| 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 |
### LineStyle
TODO docs
| Property | Type | Required | Default | Description |
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|----------|----------|----------|---------|--------------------------------------------------------|
| `dash` | number[] | No | | |
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
@@ -182,7 +178,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|---------------|--------|----------|---------|---------------------------------------------------------------|
| `pointColor` | string | No | | |
| `pointSize` | number | No | | |
| `pointSymbol` | string | No | | |
@@ -193,7 +189,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | --------------------------------- | -------- | ------- | ----------- |
|------------|-----------------------------------|----------|---------|-------------|
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
### StackingConfig
@@ -201,7 +197,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
|----------|--------|----------|---------|-----------------------------------------------------------------|
| `group` | string | No | | |
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
@@ -210,12 +206,12 @@ TODO docs
It extends [OptionsWithLegend](#optionswithlegend).
| 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](#candlestickcolors) | **Yes** | | |
| `fields` | [object](#fields) | **Yes** | `map[]` | Map fields to appropriate dimension |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `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 |
@@ -224,7 +220,7 @@ It extends [OptionsWithLegend](#optionswithlegend).
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|----------|---------------------------------------|----------|---------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
@@ -232,7 +228,7 @@ TODO docs
TODO docs
| Property | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `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`. |
@@ -248,5 +244,7 @@ TODO docs
Map fields to appropriate dimension
| Property | Type | Required | Default | Description |
| -------- | --------------------------------- | -------- | ------- | ----------- |
|----------|-----------------------------------|----------|---------|-------------|
| `object` | Possible types are: [](#), [](#). | | |