IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Kindsys: update generated doc and add check in CI (#71871)

Browse Source 
* clean up docs

* fix Windows path issue

* add verify-gen-cue to doc pipeline

* fix linting error
This commit is contained in:
Agnès Toulet 2023-07-20 11:48:12 +02:00 committed by GitHub
parent 8dd3eb856d
commit ac445a25d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
83 changed files with 257 additions and 3017 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
.drone.yml
View File

@ -1084,6 +1084,15 @@ steps:
- cd /hugo && make prod
image: grafana/docs-base:dbd975af06
name: build-docs-website
- commands:
- '# It is required that code generated from Thema/CUE be committed and in sync
with its inputs.'
- '# The following command will fail if running code generators produces any diff
in output.'
- CODEGEN_VERIFY=1 make gen-cue
depends_on: []
image: grafana/build-container:1.7.5
name: verify-gen-cue
trigger:
event:
- pull_request
@ -1360,6 +1369,15 @@ steps:
- cd /hugo && make prod
image: grafana/docs-base:dbd975af06
name: build-docs-website
- commands:
- '# It is required that code generated from Thema/CUE be committed and in sync
with its inputs.'
- '# The following command will fail if running code generators produces any diff
in output.'
- CODEGEN_VERIFY=1 make gen-cue
depends_on: []
image: grafana/build-container:1.7.5
name: verify-gen-cue
trigger:
branch: main
event:
@ -5001,6 +5019,6 @@ kind: secret
name: delivery-bot-app-private-key
---
kind: signature
hmac: 10c93c162d673898b7de97d732f3e795ac6607fbd960ff2f893f976dd2a76682
hmac: 1eb4671cf92fa08539a22e82cfcf1a58573fa410df4d9512063a95e0c746fe97
...

5
docs/sources/developers/kinds/composable/alertgroups/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: AlertGroupsPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

30
docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md
View File

@ -1,30 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: AlertGroupsPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## AlertGroupsPanelCfg
#### Maturity: [merged](../../../maturity/#merged)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `alertmanager` | string | **Yes** | | Name of the alertmanager used as a source for alerts |
| `expandAll` | boolean | **Yes** | | Expand all alert groups by default |
| `labels` | string | **Yes** | | Comma-separated list of values used to filter alert results |

5
docs/sources/developers/kinds/composable/annotationslist/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: AnnotationsListPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

37
docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md
View File

@ -1,37 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: AnnotationsListPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## AnnotationsListPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| ----------------------- | -------- | -------- | ------- | ----------- |
| `limit` | uint32 | **Yes** | `10` | |
| `navigateAfter` | string | **Yes** | `10m` | |
| `navigateBefore` | string | **Yes** | `10m` | |
| `navigateToPanel` | boolean | **Yes** | `true` | |
| `onlyFromThisDashboard` | boolean | **Yes** | `false` | |
| `onlyInTimeRange` | boolean | **Yes** | `false` | |
| `showTags` | boolean | **Yes** | `true` | |
| `showTime` | boolean | **Yes** | `true` | |
| `showUser` | boolean | **Yes** | `true` | |
| `tags` | string[] | **Yes** | | |

5
docs/sources/developers/kinds/composable/azuremonitor/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: AzureMonitorDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

21
docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md
View File

@ -1,21 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: AzureMonitorDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## AzureMonitorDataQuery
#### Maturity: [merged](../../../maturity/#merged)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |

5
docs/sources/developers/kinds/composable/barchart/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: BarChartPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

176
docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md
View File

@ -1,176 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: BarChartPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## BarChartPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------- | ---------------------- | -------- | ------- | ----------- |
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
### FieldConfig
It extends [AxisConfig](#axisconfig) 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))_ |
| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
| `gradientMode` | string | No | | Set 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.<br/>Gradient appearance is influenced by the Fill opacity setting. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
| `lineWidth` | integer | No | `1` | Controls line width of the bars.<br/>Constraint: `>=0 & <=10`. |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
### 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 | | |
| `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 |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | |
| `log` | number | No | | |
### GraphThresholdsStyleConfig
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
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](#hideseriesconfig) | No | | TODO docs |
### Options
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Default | Description |
| --------------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| `barWidth` | number | **Yes** | `0.97` | Controls the width of bars. 1 = Max width, 0 = Min width.<br/>Constraint: `>=0 & <=1`. |
| `fullHighlight` | boolean | **Yes** | `false` | Enables mode which highlights the entire bar area and shows tooltip when cursor<br/>hovers over highlighted area |
| `groupWidth` | number | **Yes** | `0.7` | Controls the width of groups. 1 = max with, 0 = min width.<br/>Constraint: `>=0 & <=1`. |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
| `orientation` | string | **Yes** | | Controls the orientation of the bar chart, either vertical or horizontal. |
| `showValue` | string | **Yes** | | This controls whether values are shown on top or to the left of bars. |
| `stacking` | string | **Yes** | | Controls whether bars are stacked or not, either normally or in percent mode. |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
| `xTickLabelMaxLength` | integer | **Yes** | | Sets the max length that a label can have before it is truncated.<br/>Constraint: `>=0 & <=2147483647`. |
| `xTickLabelRotation` | integer | **Yes** | `0` | Controls the rotation of the x axis labels.<br/>Constraint: `>=-90 & <=90`. |
| `barRadius` | number | No | `0` | Controls the radius of each bar.<br/>Constraint: `>=0 & <=0.5`. |
| `colorByField` | string | No | | Use the color value for a sibling field to color each bar value. |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
| `xField` | string | No | | Manually select which field from the dataset to represent the x field. |
| `xTickLabelSpacing` | int32 | No | `0` | Controls the spacing between x axis labels.<br/>negative values indicate backwards skipping behavior |
### OptionsWithLegend
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------- | -------- | ------- | ----------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
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`. |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------ |
| `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | | Explicit value text size |
### OptionsWithTooltip
TODO docs
| Property | Type | Required | Default | Description |
| --------- | --------------------------------------- | -------- | ------- | ----------- |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

5
docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: BarGaugePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

77
docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md
View File

@ -1,77 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: BarGaugePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## BarGaugePanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Default | Description |
| --------------- | ----------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `displayMode` | string | **Yes** | | Enum expressing the possible display modes<br/>for the bar gauge component of Grafana UI<br/>Possible values are: `basic`, `lcd`, `gradient`. |
| `minVizHeight` | uint32 | **Yes** | `10` | |
| `minVizWidth` | uint32 | **Yes** | `0` | |
| `showUnfilled` | boolean | **Yes** | `true` | |
| `valueMode` | string | **Yes** | | Allows for the table cell gauge display type to set the gauge mode.<br/>Possible values are: `color`, `text`, `hidden`. |
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
### ReduceDataOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | -------- | -------- | ------- | ------------------------------------------------------------ |
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Default | Description |
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
### OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------ |
| `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | | Explicit value text size |

5
docs/sources/developers/kinds/composable/candlestick/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: CandlestickPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

93
docs/sources/developers/kinds/composable/candlestickpanelcfg/schema-reference.md
View File

@ -1,93 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: CandlestickPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
# CandlestickPanelCfg kind
## Maturity: experimental
## Version: 0.0
## Properties
| Property | Type | Required | Description |
| --------------------- | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `CandleStyle` | string | **Yes** | TODO docs Possible values are: `candles`, `ohlcbars`. |
| `CandlestickColors` | [object](#candlestickcolors) | **Yes** | TODO docs |
| `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | TODO docs |
| `ColorStrategy` | string | **Yes** | TODO docs<br/>"open-close": up/down color depends on current close vs current open<br/>filled always<br/>"close-close": up/down color depends on current close vs prior close<br/>filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. |
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
| `VizDisplayMode` | string | **Yes** | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. |
## CandlestickColors
TODO docs
### Properties
| Property | Type | Required | Description |
| -------- | ------ | -------- | ----------------- |
| `down` | string | **Yes** | Default: `red`. |
| `flat` | string | **Yes** | Default: `gray`. |
| `up` | string | **Yes** | Default: `green`. |
## CandlestickFieldMap
TODO docs
### Properties
| Property | Type | Required | Description |
| -------- | ------ | -------- | ----------- |
| `close` | string | No | |
| `high` | string | No | |
| `low` | string | No | |
| `open` | string | No | |
| `volume` | string | No | |
## PanelFieldConfig
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
## PanelOptions
### Properties
| Property | Type | Required | Description |
| ------------------ | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `candleStyle` | string | No | TODO docs Possible values are: `candles`, `ohlcbars`. |
| `colorStrategy` | string | No | TODO docs<br/>"open-close": up/down color depends on current close vs current open<br/>filled always<br/>"close-close": up/down color depends on current close vs prior close<br/>filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. |
| `colors` | [CandlestickColors](#candlestickcolors) | No | TODO docs |
| `fields` | [object](#fields) | No | TODO docs Default: `map[]`. |
| `includeAllFields` | boolean | No | When enabled, all fields will be sent to the graph Default: `false`. |
| `mode` | string | No | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. |
### CandlestickColors
TODO docs
#### Properties
| Property | Type | Required | Description |
| -------- | ------ | -------- | ----------------- |
| `down` | string | **Yes** | Default: `red`. |
| `flat` | string | **Yes** | Default: `gray`. |
| `up` | string | **Yes** | Default: `green`. |
### fields
TODO docs
The default value is: `map[]`.
| Property | Type | Required | Description |
|----------|------|----------|-------------|

5
docs/sources/developers/kinds/composable/canvas/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: CanvasPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/composable/cloudwatch/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: CloudWatchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

21
docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md
View File

@ -1,21 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: CloudWatchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## CloudWatchDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |

5
docs/sources/developers/kinds/composable/dashboardlist/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: DashboardListPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

37
docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md
View File

@ -1,37 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: DashboardListPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## DashboardListPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| -------------------- | -------- | -------- | ------- | ----------- |
| `includeVars` | boolean | **Yes** | `false` | |
| `keepTime` | boolean | **Yes** | `false` | |
| `maxItems` | integer | **Yes** | `10` | |
| `query` | string | **Yes** | `` | |
| `showHeadings` | boolean | **Yes** | `true` | |
| `showRecentlyViewed` | boolean | **Yes** | `false` | |
| `showSearch` | boolean | **Yes** | `false` | |
| `showStarred` | boolean | **Yes** | `true` | |
| `tags` | string[] | **Yes** | | |
| `folderId` | integer | No | | |

5
docs/sources/developers/kinds/composable/datagrid/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: DatagridPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

28
docs/sources/developers/kinds/composable/datagridpanelcfg/schema-reference.md
View File

@ -1,28 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: DatagridPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## DatagridPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | --------------------------------- |
| `selectedSeries` | integer | **Yes** | `0` | Constraint: `>=0 & <=2147483647`. |

5
docs/sources/developers/kinds/composable/debug/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: DebugPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

39
docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md
View File

@ -1,39 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: DebugPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## DebugPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| -------------- | ----------------------- | -------- | ------- | ------------------------------------------------------------------------- |
| `DebugMode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
| `Options` | [object](#options) | **Yes** | | |
| `UpdateConfig` | [object](#updateconfig) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| ---------- | ----------------------------- | -------- | ------- | ------------------------------------------------------------------------- |
| `mode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
| `counters` | [UpdateConfig](#updateconfig) | No | | |
### UpdateConfig
| Property | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------- |
| `dataChanged` | boolean | **Yes** | | |
| `render` | boolean | **Yes** | | |
| `schemaChanged` | boolean | **Yes** | | |

5
docs/sources/developers/kinds/composable/elasticsearch/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: ElasticsearchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

280
docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
View File

@ -1,280 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: ElasticsearchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## ElasticsearchDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------ | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
| `alias` | string | No | | Alias pattern |
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations |
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `metrics` | [MetricAggregation](#metricaggregation)[] | No | | List of metric aggregations |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
| `query` | string | No | | Lucene query |
| `timeField` | string | No | | Name of time field |
### BucketAggregation
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
### DateHistogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### BucketAggregationWithField
It extends [BaseBucketAggregation](#basebucketaggregation).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | |
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
### BaseBucketAggregation
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | |
| `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `settings` | | No | | |
### Filters
It extends [BaseBucketAggregation](#basebucketaggregation).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
### GeoHashGrid
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### Histogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### Nested
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### Terms
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### MetricAggregation
| Property | Type | Required | Default | Description |
| -------- | ---------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
### Count
It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
### BaseMetricAggregation
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | |
| `type` | string | **Yes** | | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | |
### PipelineMetricAggregation
| Property | Type | Required | Default | Description |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
### BucketScript
It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths).
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
| `id` | string | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
| `settings` | [object](#settings) | No | | |
### PipelineMetricAggregationWithMultipleBucketPaths
It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | |
### PipelineVariable
| Property | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `name` | string | **Yes** | | |
| `pipelineAgg` | string | **Yes** | | |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |
| `script` | | No | | |
### CumulativeSum
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `settings` | [object](#settings) | No | | |
### BasePipelineMetricAggregation
It extends [MetricAggregationWithField](#metricaggregationwithfield).
| Property | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
| `hide` | boolean | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
| `pipelineAgg` | string | No | | |
### MetricAggregationWithField
It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | |
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------- |
| `format` | string | No | | |
### Derivative
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `settings` | [object](#settings) | No | | |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------- |
| `unit` | string | No | | |
### MovingAverage
#MovingAverage's settings are overridden in types.ts
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `settings` | [object](#settings) | No | | |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |
### Meta
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |
### Settings
| Property | Type | Required | Default | Description |
| --------- | -------- | -------- | ------- | ----------- |
| `metrics` | string[] | No | | |
| `orderBy` | string | No | | |
| `order` | string | No | | |

5
docs/sources/developers/kinds/composable/gauge/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: GaugePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

74
docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md
View File

@ -1,74 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: GaugePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## GaugePanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Default | Description |
| ---------------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `showThresholdLabels` | boolean | **Yes** | `false` | |
| `showThresholdMarkers` | boolean | **Yes** | `true` | |
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
### ReduceDataOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | -------- | -------- | ------- | ------------------------------------------------------------ |
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Default | Description |
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
### OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------ |
| `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | | Explicit value text size |

5
docs/sources/developers/kinds/composable/geomap/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: GeomapPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

94
docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md
View File

@ -1,94 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: GeomapPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## GeomapPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ----------------- | -------------------------- | -------- | ------- | --------------------------------------------- |
| `ControlsOptions` | [object](#controlsoptions) | **Yes** | | |
| `MapCenterID` | string | **Yes** | | Possible values are: `zero`, `coords`, `fit`. |
| `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
| `TooltipMode` | string | **Yes** | | Possible values are: `none`, `details`. |
| `TooltipOptions` | [object](#tooltipoptions) | **Yes** | | |
### ControlsOptions
| Property | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ------------------------ |
| `mouseWheelZoom` | boolean | No | | let the mouse wheel zoom |
| `showAttribution` | boolean | No | | Lower right |
| `showDebug` | boolean | No | | Show debug |
| `showMeasure` | boolean | No | | Show measure |
| `showScale` | boolean | No | | Scale options |
| `showZoom` | boolean | No | | Zoom (upper left) |
### MapViewConfig
| Property | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------- |
| `id` | string | **Yes** | `zero` | |
| `allLayers` | boolean | No | `true` | |
| `lastOnly` | boolean | No | | |
| `lat` | int64 | No | `0` | |
| `layer` | string | No | | |
| `lon` | int64 | No | `0` | |
| `maxZoom` | integer | No | | |
| `minZoom` | integer | No | | |
| `padding` | integer | No | | |
| `shared` | boolean | No | | |
| `zoom` | int64 | No | `1` | |
### Options
| Property | Type | Required | Default | Description |
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
| `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | |
| `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | |
| `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | |
| `tooltip` | [TooltipOptions](#tooltipoptions) | **Yes** | | |
| `view` | [MapViewConfig](#mapviewconfig) | **Yes** | | |
### MapLayerOptions
| Property | Type | Required | Default | Description |
| ------------ | ------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | **Yes** | | configured unique display name |
| `type` | string | **Yes** | | |
| `config` | | No | | Custom options depending on the type |
| `filterData` | | No | | Defines a frame MatcherConfig that may filter data for the given layer |
| `location` | [FrameGeometrySource](#framegeometrysource) | No | | |
| `opacity` | integer | No | | Common properties:<br/>https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html<br/>Layer opacity (0-1) |
| `tooltip` | boolean | No | | Check tooltip (defaults to true) |
### FrameGeometrySource
| Property | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------------------------------------- |
| `mode` | string | **Yes** | | Possible values are: `auto`, `geohash`, `coords`, `lookup`. |
| `gazetteer` | string | No | | Path to Gazetteer |
| `geohash` | string | No | | Field mappings |
| `latitude` | string | No | | |
| `longitude` | string | No | | |
| `lookup` | string | No | | |
| `wkt` | string | No | | |
### TooltipOptions
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | --------------------------------------- |
| `mode` | string | **Yes** | | Possible values are: `none`, `details`. |

5
docs/sources/developers/kinds/composable/googlecloudmonitoring/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: GoogleCloudMonitoringDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

21
docs/sources/developers/kinds/composable/googlecloudmonitoringdataquery/schema-reference.md
View File

@ -1,21 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: GoogleCloudMonitoringDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## GoogleCloudMonitoringDataQuery
#### Maturity: [merged](../../../maturity/#merged)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |

5
docs/sources/developers/kinds/composable/grafanapyroscope/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: GrafanaPyroscopeDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

29
docs/sources/developers/kinds/composable/grafanapyroscopedataquery/schema-reference.md
View File

@ -1,29 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: GrafanaPyroscopeDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## GrafanaPyroscopeDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groupBy` | string[] | **Yes** | | Allows to group the results. |
| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `maxNodes` | integer | No | | Sets the maximum number of nodes in the flamegraph. |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |

5
docs/sources/developers/kinds/composable/heatmap/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: HeatmapPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

234
docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md
View File

@ -1,234 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: HeatmapPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## HeatmapPanelCfg
#### Maturity: [merged](../../../maturity/#merged)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------------------- | ------------------------------ | -------- | ------- | ----------------------------------------------------------------------------------------- |
| `CellValues` | [object](#cellvalues) | **Yes** | | Controls cell value options |
| `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | | Controls exemplar options |
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
| `FilterValueRange` | [object](#filtervaluerange) | **Yes** | | Controls the value filter range |
| `HeatmapColorMode` | string | **Yes** | | Controls the color mode of the heatmap<br/>Possible values are: `opacity`, `scheme`. |
| `HeatmapColorOptions` | [object](#heatmapcoloroptions) | **Yes** | | Controls various color options |
| `HeatmapColorScale` | string | **Yes** | | Controls the color scale of the heatmap<br/>Possible values are: `linear`, `exponential`. |
| `HeatmapLegend` | [object](#heatmaplegend) | **Yes** | | Controls legend options |
| `HeatmapTooltip` | [object](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `Options` | [object](#options) | **Yes** | | |
| `RowsHeatmapOptions` | [object](#rowsheatmapoptions) | **Yes** | | Controls frame rows options |
| `YAxisConfig` | [object](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
### CellValues
Controls cell value options
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------------------------------------------- |
| `decimals` | number | No | | Controls the number of decimals for cell values |
| `unit` | string | No | | Controls the cell value unit |
### ExemplarConfig
Controls exemplar options
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | -------------------------------------- |
| `color` | string | **Yes** | | Sets the color of the exemplar markers |
### FieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### 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](#hideseriesconfig) | No | | TODO docs |
### ScaleDistributionConfig
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 | | |
### FilterValueRange
Controls the value filter range
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `ge` | number | No | | Sets the filter range to values greater than or equal to the given value |
| `le` | number | No | | Sets the filter range to values less than or equal to the given value |
### HeatmapColorOptions
Controls various color options
| Property | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- |
| `exponent` | number | **Yes** | | Controls the exponent when scale is set to exponential |
| `fill` | string | **Yes** | | Controls the color fill when in opacity mode |
| `reverse` | boolean | **Yes** | | Reverses the color scheme |
| `scheme` | string | **Yes** | | Controls the color scheme used |
| `steps` | integer | **Yes** | | Controls the number of color steps<br/>Constraint: `>=2 & <=128`. |
| `max` | number | No | | Sets the maximum value for the color scale |
| `min` | number | No | | Sets the minimum value for the color scale |
| `mode` | string | No | | Controls the color mode of the heatmap<br/>Possible values are: `opacity`, `scheme`. |
| `scale` | string | No | | Controls the color scale of the heatmap<br/>Possible values are: `linear`, `exponential`. |
### HeatmapLegend
Controls legend options
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | ------------------------------- |
| `show` | boolean | **Yes** | | Controls if the legend is shown |
### HeatmapTooltip
Controls tooltip options
| Property | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------- |
| `show` | boolean | **Yes** | | Controls if the tooltip is shown |
| `yHistogram` | boolean | No | | Controls if the tooltip shows a histogram of the y-axis values |
### Options
| Property | Type | Required | Default | Description |
| -------------- | ------------------------------------------------------- | -------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options |
| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options |
| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options |
| `showValue` | string | **Yes** | | &#124; \*{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
| `cellRadius` | number | No | | Controls cell radius |
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
### HeatmapCalculationOptions
| Property | Type | Required | Default | Description |
| ---------- | ----------------------------------------------------------------- | -------- | ------- | ----------- |
| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
### HeatmapCalculationBucketConfig
| Property | Type | Required | Default | Description |
| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------- |
| `mode` | string | No | | Possible values are: `size`, `count`. |
| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
| `value` | string | No | | The number of buckets to use for the axis in the heatmap |
### RowsHeatmapOptions
Controls frame rows options
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `layout` | string | No | | Possible values are: `le`, `ge`, `unknown`, `auto`. |
| `value` | string | No | | Sets the name of the cell when not calculating from data |
### YAxisConfig
Configuration options for the yAxis
It extends [AxisConfig](#axisconfig).
| 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))_ |
| `decimals` | number | No | | Controls the number of decimals for yAxis values |
| `max` | number | No | | Sets the maximum value for the yAxis |
| `min` | number | No | | Sets the minimum value for the yAxis |
| `reverse` | boolean | No | | Reverses the yAxis |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
| `unit` | string | No | | Sets the yAxis unit |
### 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 | | |
| `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 |
### CellValues
Controls cell value unit
| Property | Type | Required | Default | Description |
| -------- | --------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [](#), [](#). | | |
### Color
Controls the color options
| Property | Type | Required | Default | Description |
| -------- | --------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [](#), [](#). | | |
### FilterValues
Filters values between a given range
| Property | Type | Required | Default | Description |
| -------- | --------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [](#), [](#). | | |

5
docs/sources/developers/kinds/composable/histogram/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: HistogramPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

140
docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md
View File

@ -1,140 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: HistogramPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## HistogramPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------- | ---------------------- | -------- | ------- | ----------- |
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
### FieldConfig
It extends [AxisConfig](#axisconfig) 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))_ |
| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
| `gradientMode` | string | No | | Set 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.<br/>Gradient appearance is influenced by the Fill opacity setting. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
| `lineWidth` | integer | No | `1` | Controls line width of the bars.<br/>Constraint: `>=0 & <=10`. |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
### 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 | | |
| `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 |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | |
| `log` | number | No | | |
### 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](#hideseriesconfig) | No | | TODO docs |
### Options
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
| Property | Type | Required | Default | Description |
| -------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
| `bucketOffset` | int32 | No | `0` | Offset buckets by this amount |
| `bucketSize` | integer | No | | Size of each bucket |
| `combine` | boolean | No | | Combines multiple series into a single histogram |
### OptionsWithLegend
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------- | -------- | ------- | ----------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
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`. |
| `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](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

5
docs/sources/developers/kinds/composable/logs/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: LogsPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

35
docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md
View File

@ -1,35 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: LogsPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## LogsPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------- |
| `dedupStrategy` | string | **Yes** | | Possible values are: `none`, `exact`, `numbers`, `signature`. |
| `enableLogDetails` | boolean | **Yes** | | |
| `prettifyLogMessage` | boolean | **Yes** | | |
| `showCommonLabels` | boolean | **Yes** | | |
| `showLabels` | boolean | **Yes** | | |
| `showTime` | boolean | **Yes** | | |
| `sortOrder` | string | **Yes** | | Possible values are: `Descending`, `Ascending`. |
| `wrapLogMessage` | boolean | **Yes** | | |

5
docs/sources/developers/kinds/composable/loki/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: LokiDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

32
docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md
View File

@ -1,32 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: LokiDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## LokiDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expr` | string | **Yes** | | The LogQL query. |
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `editorMode` | string | No | | Possible values are: `code`, `builder`. |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `instant` | boolean | No | | @deprecated, now use queryType. |
| `legendFormat` | string | No | | Used to override the name of the series. |
| `maxLines` | integer | No | | Used to limit the number of log rows returned. |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
| `range` | boolean | No | | @deprecated, now use queryType. |
| `resolution` | integer | No | | Used to scale the interval value. |

5
docs/sources/developers/kinds/composable/news/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: NewsPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

29
docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md
View File

@ -1,29 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: NewsPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## NewsPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------ |
| `feedUrl` | string | No | | empty/missing will default to grafana blog |
| `showImage` | boolean | No | `true` | |

5
docs/sources/developers/kinds/composable/nodegraph/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: NodeGraphPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

54
docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md
View File

@ -1,54 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: NodeGraphPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## NodeGraphPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------- | ---------------------- | -------- | ------- | ----------- |
| `ArcOption` | [object](#arcoption) | **Yes** | | |
| `EdgeOptions` | [object](#edgeoptions) | **Yes** | | |
| `NodeOptions` | [object](#nodeoptions) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
### ArcOption
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| `color` | string | No | | The color of the arc. |
| `field` | string | No | | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
### EdgeOptions
| Property | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------- |
| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
### NodeOptions
| Property | Type | Required | Default | Description |
| ------------------- | ------------------------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `arcs` | [ArcOption](#arcoption)[] | No | | Define which fields are shown as part of the node arc (colored circle around the node). |
| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
### Options
| Property | Type | Required | Default | Description |
| -------- | --------------------------- | -------- | ------- | ----------- |
| `edges` | [EdgeOptions](#edgeoptions) | No | | |
| `nodes` | [NodeOptions](#nodeoptions) | No | | |

5
docs/sources/developers/kinds/composable/parca/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: ParcaDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

27
docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md
View File

@ -1,27 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: ParcaDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## ParcaDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |

5
docs/sources/developers/kinds/composable/piechart/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: PieChartPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

149
docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md
View File

@ -1,149 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: PieChartPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## PieChartPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ----------------------- | ------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `FieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | | TODO docs |
| `Options` | [object](#options) | **Yes** | | |
| `PieChartLabels` | string | **Yes** | | Select labels to display on the pie chart.<br/> - Name - The series or field name.<br/> - Percent - The percentage of the whole.<br/> - Value - The raw numerical value.<br/>Possible values are: `name`, `value`, `percent`. |
| `PieChartLegendOptions` | [object](#piechartlegendoptions) | **Yes** | | |
| `PieChartLegendValues` | string | **Yes** | | Select values to display in the legend.<br/> - Percent: The percentage of the whole.<br/> - Value: The raw numerical value.<br/>Possible values are: `value`, `percent`. |
| `PieChartType` | string | **Yes** | | Select the pie chart display style.<br/>Possible values are: `pie`, `donut`. |
### HideableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### HideSeriesConfig
TODO docs
| Property | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------- |
| `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | |
### Options
It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Default | Description |
| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `displayLabels` | string[] | **Yes** | | |
| `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | |
| `pieType` | string | **Yes** | | Select the pie chart display style.<br/>Possible values are: `pie`, `donut`. |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
### OptionsWithTooltip
TODO docs
| Property | Type | Required | Default | Description |
| --------- | --------------------------------------- | -------- | ------- | ----------- |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
### PieChartLegendOptions
It extends [VizLegendOptions](#vizlegendoptions).
| Property | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `calcs` | string[] | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
| `displayMode` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_<br/>TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
| `placement` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_<br/>TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
| `values` | string[] | **Yes** | | |
| `asTable` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
| `isVisible` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
| `sortBy` | string | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
| `sortDesc` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
| `width` | number | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
### VizLegendOptions
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`. |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### ReduceDataOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | -------- | -------- | ------- | ------------------------------------------------------------ |
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Default | Description |
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
### OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------ |
| `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | | Explicit value text size |

5
docs/sources/developers/kinds/composable/prometheus/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: PrometheusDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

33
docs/sources/developers/kinds/composable/prometheusdataquery/schema-reference.md
View File

@ -1,33 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: PrometheusDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## PrometheusDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expr` | string | **Yes** | | The actual expression/query that will be evaluated by Prometheus |
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `editorMode` | string | No | | Possible values are: `code`, `builder`. |
| `exemplar` | boolean | No | | Execute an additional query to identify interesting raw samples relevant for the given expr |
| `format` | string | No | | Possible values are: `time_series`, `table`, `heatmap`. |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `instant` | boolean | No | | Returns only the latest value that Prometheus has scraped for the requested time series |
| `intervalFactor` | number | No | | @deprecated Used to specify how many times to divide max data points by. We use max data points under query options<br/>See https://github.com/grafana/grafana/issues/48081 |
| `legendFormat` | string | No | | Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
| `range` | boolean | No | | Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series |

5
docs/sources/developers/kinds/composable/stat/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: StatPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/composable/statetimeline/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: StateTimelinePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

114
docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md
View File

@ -1,114 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: StateTimelinePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## StateTimelinePanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------- | ---------------------- | -------- | ------- | ----------- |
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
### FieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Default | Description |
| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
| `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. |
### 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](#hideseriesconfig) | No | | TODO docs |
### Options
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
| Property | Type | Required | Default | Description |
| ------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
| `rowHeight` | number | **Yes** | `0.9` | Controls the row height |
| `showValue` | string | **Yes** | | Show timeline values on chart |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
| `alignValue` | string | No | | Controls value alignment on the timelines |
| `mergeValues` | boolean | No | `true` | Merge equal consecutive values |
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
### OptionsWithLegend
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------- | -------- | ------- | ----------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
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`. |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### OptionsWithTimezones
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | -------- | -------- | ------- | ----------- |
| `timezone` | string[] | No | | |
### OptionsWithTooltip
TODO docs
| Property | Type | Required | Default | Description |
| --------- | --------------------------------------- | -------- | ------- | ----------- |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

76
docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md
View File

@ -1,76 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: StatPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## StatPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Default | Description |
| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `colorMode` | string | **Yes** | | TODO docs<br/>Possible values are: `value`, `background`, `background_solid`, `none`. |
| `graphMode` | string | **Yes** | | TODO docs<br/>Possible values are: `none`, `line`, `area`. |
| `justifyMode` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `center`. |
| `textMode` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. |
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
### ReduceDataOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | -------- | -------- | ------- | ------------------------------------------------------------ |
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Default | Description |
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
### OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------ |
| `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | | Explicit value text size |

5
docs/sources/developers/kinds/composable/statushistory/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: StatusHistoryPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

113
docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md
View File

@ -1,113 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: StatusHistoryPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## StatusHistoryPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------- | ---------------------- | -------- | ------- | ----------- |
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
### FieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Default | Description |
| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
| `lineWidth` | integer | No | `1` | Constraint: `>=0 & <=10`. |
### 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](#hideseriesconfig) | No | | TODO docs |
### Options
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
| Property | Type | Required | Default | Description |
| ----------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
| `rowHeight` | number | **Yes** | `0.9` | Set the height of the rows<br/>Constraint: `>=0 & <=1`. |
| `showValue` | string | **Yes** | | Show values on the columns |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
| `colWidth` | number | No | `0.9` | Controls the column width |
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
### OptionsWithLegend
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------- | -------- | ------- | ----------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
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`. |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### OptionsWithTimezones
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | -------- | -------- | ------- | ----------- |
| `timezone` | string[] | No | | |
### OptionsWithTooltip
TODO docs
| Property | Type | Required | Default | Description |
| --------- | --------------------------------------- | -------- | ------- | ----------- |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

5
docs/sources/developers/kinds/composable/table/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: TablePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

50
docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md
View File

@ -1,50 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: TablePanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## TablePanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------- | ------------------ | -------- | ------- | ----------- |
| `Options` | [object](#options) | **Yes** | | |
### Options
| Property | Type | Required | Default | Description |
| --------------- | ------------------------------------------------- | -------- | -------------------------------------------- | ------------------------------------------------------------------ |
| `frameIndex` | number | **Yes** | `0` | Represents the index of the selected frame |
| `showHeader` | boolean | **Yes** | `true` | Controls whether the panel should show the header |
| `cellHeight` | string | No | | Controls the height of the rows |
| `footer` | [object](#footer) | No | `map[countRows:false reducer:[] show:false]` | Controls footer options |
| `showTypeIcons` | boolean | No | `false` | Controls whether the header should show icons for the column types |
| `sortBy` | [TableSortByFieldState](#tablesortbyfieldstate)[] | No | | Used to control row sorting |
### TableSortByFieldState
Sort by field state
| Property | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------- |
| `displayName` | string | **Yes** | | Sets the display name of the field to sort by |
| `desc` | boolean | No | | Flag used to indicate descending sort order |
### Footer
Controls footer options
| Property | Type | Required | Default | Description |
| -------- | --------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [](#), [](#). | | |

5
docs/sources/developers/kinds/composable/tempo/dataquery/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: TempoDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

21
docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md
View File

@ -1,21 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: TempoDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## TempoDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |

5
docs/sources/developers/kinds/composable/testdata/dataquery/schema-reference.md vendored
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: TestDataDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

113
docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md
View File

@ -1,113 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: TestDataDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## TestDataDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ----------------- | ----------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
| `alias` | string | No | | |
| `channel` | string | No | | |
| `csvContent` | string | No | | |
| `csvFileName` | string | No | | |
| `csvWave` | [CSVWave](#csvwave)[] | No | | |
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `errorType` | string | No | | Possible values are: `server_panic`, `frontend_exception`, `frontend_observable`. |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `labels` | string | No | | |
| `levelColumn` | boolean | No | | |
| `lines` | integer | No | | |
| `nodes` | [NodesQuery](#nodesquery) | No | | |
| `points` | array[] | No | | |
| `pulseWave` | [PulseWaveQuery](#pulsewavequery) | No | | |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
| `rawFrameContent` | string | No | | |
| `scenarioId` | string | No | | Possible values are: `random_walk`, `slow_query`, `random_walk_with_error`, `random_walk_table`, `exponential_heatmap_bucket_data`, `linear_heatmap_bucket_data`, `no_data_points`, `datapoints_outside_range`, `csv_metric_values`, `predictable_pulse`, `predictable_csv_wave`, `streaming_client`, `simulation`, `usa`, `live`, `grafana_api`, `arrow`, `annotations`, `table_static`, `server_error_500`, `logs`, `node_graph`, `flame_graph`, `raw_frame`, `csv_file`, `csv_content`, `trace`, `manual_entry`, `variables-query`. |
| `seriesCount` | integer | No | | |
| `sim` | [SimulationQuery](#simulationquery) | No | | |
| `spanCount` | integer | No | | |
| `stream` | [StreamingQuery](#streamingquery) | No | | |
| `stringInput` | string | No | | |
| `usa` | [USAQuery](#usaquery) | No | | |
### CSVWave
| Property | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------- |
| `labels` | string | No | | |
| `name` | string | No | | |
| `timeStep` | integer | No | | |
| `valuesCSV` | string | No | | |
### NodesQuery
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | ---------------------------------------------------------- |
| `count` | integer | No | | |
| `type` | string | No | | Possible values are: `random`, `response`, `random edges`. |
### PulseWaveQuery
| Property | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ----------- |
| `offCount` | integer | No | | |
| `offValue` | number | No | | |
| `onCount` | integer | No | | |
| `onValue` | number | No | | |
| `timeStep` | integer | No | | |
### SimulationQuery
| Property | Type | Required | Default | Description |
| -------- | ----------------- | -------- | ------- | ----------- |
| `key` | [object](#key) | **Yes** | | |
| `config` | [object](#config) | No | | |
| `last` | boolean | No | | |
| `stream` | boolean | No | | |
### Config
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |
### Key
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------- |
| `tick` | number | **Yes** | | |
| `type` | string | **Yes** | | |
| `uid` | string | No | | |
### StreamingQuery
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | ----------------------------------------------- |
| `noise` | integer | **Yes** | | |
| `speed` | integer | **Yes** | | |
| `spread` | integer | **Yes** | | |
| `type` | string | **Yes** | | Possible values are: `signal`, `logs`, `fetch`. |
| `bands` | integer | No | | |
| `url` | string | No | | |
### USAQuery
| Property | Type | Required | Default | Description |
| -------- | -------- | -------- | ------- | ----------- |
| `fields` | string[] | No | | |
| `mode` | string | No | | |
| `period` | string | No | | |
| `states` | string[] | No | | |

5
docs/sources/developers/kinds/composable/text/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: TextPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

43
docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md
View File

@ -1,43 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: TextPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## TextPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| -------------- | ---------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- |
| `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
| `CodeOptions` | [object](#codeoptions) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
| `TextMode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
### CodeOptions
| Property | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- |
| `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
| `showLineNumbers` | boolean | **Yes** | `false` | |
| `showMiniMap` | boolean | **Yes** | `false` | |
### Options
| Property | Type | Required | Default | Description |
| --------- | --------------------------- | -------- | ------------------------------------------------------------------------------ | ------------------------------------------------ |
| `content` | string | **Yes** | `# Title | |
| | | | | |
| | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | |
| `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
| `code` | [CodeOptions](#codeoptions) | No | | |

5
docs/sources/developers/kinds/composable/timeseries/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: TimeSeriesPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

226
docs/sources/developers/kinds/composable/timeseriespanelcfg/schema-reference.md
View File

@ -1,226 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: TimeSeriesPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## TimeSeriesPanelCfg
#### Maturity: [merged](../../../maturity/#merged)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------- | ------------------------------------- | -------- | ------- | ----------- |
| `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs |
| `Options` | [object](#options) | **Yes** | | |
### 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).
| 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 | | |
| `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 |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `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 |
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
| `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 |
| ------------- | ------ | -------- | ------- | ----------- |
| `fillBelowTo` | string | No | | |
| `fillColor` | string | No | | |
| `fillOpacity` | number | No | | |
### GraphThresholdsStyleConfig
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
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](#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 |
### 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<br/>Possible values are: `auto`, `never`, `always`. |
### StackableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | --------------------------------- | -------- | ------- | ----------- |
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
### StackingConfig
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
| `group` | string | No | | |
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
### Options
It extends [OptionsWithTimezones](#optionswithtimezones).
| Property | Type | Required | Default | Description |
| ---------- | --------------------------------------- | -------- | ------- | ---------------------------------------------------------------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
### OptionsWithTimezones
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | -------- | -------- | ------- | ----------- |
| `timezone` | string[] | No | | |
### VizLegendOptions
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`. |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

5
docs/sources/developers/kinds/composable/trend/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: TrendPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

218
docs/sources/developers/kinds/composable/trendpanelcfg/schema-reference.md
View File

@ -1,218 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: TrendPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## TrendPanelCfg
#### Maturity: [merged](../../../maturity/#merged)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------- | ------------------------------------- | -------- | ------- | -------------------------------------------------------------------- |
| `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs |
| `Options` | [object](#options) | **Yes** | | Identical to timeseries... except it does not have timezone settings |
### 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).
| 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 | | |
| `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 |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `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 |
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
| `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 |
| ------------- | ------ | -------- | ------- | ----------- |
| `fillBelowTo` | string | No | | |
| `fillColor` | string | No | | |
| `fillOpacity` | number | No | | |
### GraphThresholdsStyleConfig
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
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](#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 |
### 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<br/>Possible values are: `auto`, `never`, `always`. |
### StackableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
| ---------- | --------------------------------- | -------- | ------- | ----------- |
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
### StackingConfig
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
| `group` | string | No | | |
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
### Options
Identical to timeseries... except it does not have timezone settings
| Property | Type | Required | Default | Description |
| --------- | --------------------------------------- | -------- | ------- | ----------------------------------------------------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
| `xField` | string | No | | Name of the x field to use (defaults to first number) |
### VizLegendOptions
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`. |
| `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | |
| `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | |
| `width` | number | No | | |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

5
docs/sources/developers/kinds/composable/xychart/panelcfg/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: XYChartPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

247
docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md
View File

@ -1,247 +0,0 @@
---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: XYChartPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## XYChartPanelCfg
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| --------------------- | ------------------------------ | -------- | ------- | ------------------------------------------------------- |
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
| `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | |
| `ScatterShow` | string | **Yes** | | Possible values are: `points`, `lines`, `points+lines`. |
| `SeriesMapping` | string | **Yes** | | Possible values are: `auto`, `manual`. |
| `XYDimensionConfig` | [object](#xydimensionconfig) | **Yes** | | |
### FieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig).
| 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))_ |
| `fillOpacity` | number | No | `0.5` | Constraint: `>=0 & <=1`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | |
| `label` | string | No | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
| `lineWidth` | integer | No | | Constraint: `>=0 & <=2147483647`. |
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | |
| `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | Links to a resource (image/svg path) |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
| `show` | string | No | | Possible values are: `points`, `lines`, `points+lines`. |
### 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 | | |
| `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 |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | |
| `log` | number | No | | |
### ColorDimensionConfig
It extends [BaseDimensionConfig](#basedimensionconfig).
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
| `fixed` | string | No | | |
### BaseDimensionConfig
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------------------------------------- |
| `field` | string | No | | fixed: T -- will be added by each element |
### 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](#hideseriesconfig) | No | | TODO docs |
### LineStyle
TODO docs
| Property | Type | Required | Default | Description |
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
| `dash` | number[] | No | | |
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
### ResourceDimensionConfig
Links to a resource (image/svg path)
It extends [BaseDimensionConfig](#basedimensionconfig).
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `mapping`. |
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
| `fixed` | string | No | | |
### ScaleDimensionConfig
It extends [BaseDimensionConfig](#basedimensionconfig).
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `max` | number | **Yes** | | |
| `min` | number | **Yes** | | |
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
| `fixed` | number | No | | |
| `mode` | string | No | | Possible values are: `linear`, `quad`. |
### TextDimensionConfig
It extends [BaseDimensionConfig](#basedimensionconfig).
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `template`. |
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
| `fixed` | string | No | | |
### Options
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
| Property | Type | Required | Default | Description |
| --------------- | --------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
| `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
| `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
| `seriesMapping` | string | No | | Possible values are: `auto`, `manual`. |
### OptionsWithLegend
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------- | -------- | ------- | ----------- |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
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`. |
| `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](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
### ScatterSeriesConfig
It extends [FieldConfig](#fieldconfig).
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `axisCenteredZero` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `axisColorMode` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `axisLabel` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `axisPlacement` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
| `axisSoftMax` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `axisSoftMin` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `axisWidth` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `fillOpacity` | number | No | `0.5` | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Constraint: `>=0 & <=1`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `label` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
| `lineWidth` | integer | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Constraint: `>=0 & <=2147483647`. |
| `name` | string | No | | |
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
| `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Links to a resource (image/svg path) |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
| `show` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Possible values are: `points`, `lines`, `points+lines`. |
| `x` | string | No | | |
| `y` | string | No | | |
### XYDimensionConfig
| Property | Type | Required | Default | Description |
| --------- | -------- | -------- | ------- | --------------------------------- |
| `frame` | integer | **Yes** | | Constraint: `>=0 & <=2147483647`. |
| `exclude` | string[] | No | | |
| `x` | string | No | | |

5
docs/sources/developers/kinds/core/accesspolicy/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: AccessPolicy kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/dashboard/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: Dashboard kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/folder/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: Folder kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/librarypanel/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: LibraryPanel kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/playlist/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: Playlist kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/preferences/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: Preferences kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/publicdashboard/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: PublicDashboard kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/role/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: Role kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/rolebinding/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: RoleBinding kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
docs/sources/developers/kinds/core/team/schema-reference.md
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: Team kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

5
pkg/codegen/tmpl/docs.tmpl
View File

@ -2,6 +2,11 @@
keywords:
- grafana
- schema
labels:
products:
- cloud
- enterprise
- oss
title: {{ .KindName }} kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

11
public/app/plugins/gen.go
View File

@ -24,9 +24,9 @@ import (
)
var skipPlugins = map[string]bool{
"influxdb": true, // plugin.json fails validation (defaultMatchFormat)
"mixed": true, // plugin.json fails validation (mixed)
"opentsdb": true, // plugin.json fails validation (defaultMatchFormat)
"influxdb": true, // plugin.json fails validation (defaultMatchFormat)
"mixed": true, // plugin.json fails validation (mixed)
"opentsdb": true, // plugin.json fails validation (defaultMatchFormat)
}
const sep = string(filepath.Separator)
@ -110,9 +110,10 @@ func splitSchiffer(names []string) codejen.FileMapper {
}
return func(f codejen.File) (codejen.File, error) {
// TODO it's terrible that this has to exist, CODEJEN NEEDS TO BE BETTER
path := filepath.ToSlash(f.RelativePath)
for _, name := range names {
if idx := strings.Index(f.RelativePath, name); idx != -1 {
f.RelativePath = fmt.Sprintf("%s/%s", f.RelativePath[:idx], f.RelativePath[idx:])
if idx := strings.Index(path, name); idx != -1 {
f.RelativePath = fmt.Sprintf("%s/%s", path[:idx], path[idx:])
break
}
}

2
scripts/drone/pipelines/docs.star
View File

@ -7,6 +7,7 @@ load(
"build_docs_website_step",
"codespell_step",
"identify_runner_step",
"verify_gen_cue_step",
"yarn_install_step",
)
load(
@ -35,6 +36,7 @@ def docs_pipelines(ver_mode, trigger):
codespell_step(),
lint_docs(),
build_docs_website_step(),
verify_gen_cue_step(),
]
return pipeline(