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

Docs: Add Default column to generated schema docs (#64550)

Browse Source 
Docs: Add  column to generated schema docs
This commit is contained in:
Tania 2023-03-22 18:42:28 +01:00 committed by GitHub
parent 3cd952b8ba
commit 0409cfd116
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
36 changed files with 1591 additions and 1565 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,16 +13,16 @@ title: AlertGroupsPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|---------|----------|-------------------------------------------------------------| |----------------|---------|----------|---------|-------------------------------------------------------------|
| `alertmanager` | string | **Yes** | Name of the alertmanager used as a source for alerts | | `alertmanager` | string | **Yes** | | Name of the alertmanager used as a source for alerts |
| `expandAll` | boolean | **Yes** | Expand all alert groups by default | | `expandAll` | boolean | **Yes** | | Expand all alert groups by default |
| `labels` | string | **Yes** | Comma-separated list of values used to filter alert results | | `labels` | string | **Yes** | | Comma-separated list of values used to filter alert results |

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

@ -13,23 +13,23 @@ title: AnnotationsListPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------------|----------|----------|-------------------| |-------------------------|----------|----------|---------|-------------|
| `limit` | uint32 | **Yes** | Default: `10`. | | `limit` | uint32 | **Yes** | `10` | |
| `navigateAfter` | string | **Yes** | Default: `10m`. | | `navigateAfter` | string | **Yes** | `10m` | |
| `navigateBefore` | string | **Yes** | Default: `10m`. | | `navigateBefore` | string | **Yes** | `10m` | |
| `navigateToPanel` | boolean | **Yes** | Default: `true`. | | `navigateToPanel` | boolean | **Yes** | `true` | |
| `onlyFromThisDashboard` | boolean | **Yes** | Default: `false`. | | `onlyFromThisDashboard` | boolean | **Yes** | `false` | |
| `onlyInTimeRange` | boolean | **Yes** | Default: `false`. | | `onlyInTimeRange` | boolean | **Yes** | `false` | |
| `showTags` | boolean | **Yes** | Default: `true`. | | `showTags` | boolean | **Yes** | `true` | |
| `showTime` | boolean | **Yes** | Default: `true`. | | `showTime` | boolean | **Yes** | `true` | |
| `showUser` | boolean | **Yes** | Default: `true`. | | `showUser` | boolean | **Yes** | `true` | |
| `tags` | string[] | **Yes** | | | `tags` | string[] | **Yes** | | |

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

@ -13,7 +13,7 @@ title: AzureMonitorDataQuery kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|

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

@ -13,162 +13,162 @@ title: BarChartPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------------|-----------------------------|----------|-------------| |--------------------|-----------------------------|----------|---------|-------------|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | | `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig ### PanelFieldConfig
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig). It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisLabel` | string | 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`. | | `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))* | | `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `fillOpacity` | integer | No | Controls the fill opacity of the bars. Default: `80`.<br/>Constraint: `>=0 & <=100`. | | `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
| `gradientMode` | string | No | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. | | `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `lineWidth` | integer | No | Controls line width of the bars. Default: `1`.<br/>Constraint: `>=0 & <=10`. | | `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 | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | TODO docs | | `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
### AxisConfig ### AxisConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | | | `axisCenteredZero` | boolean | No | | |
| `axisColorMode` | string | No | TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | | | `axisGridShow` | boolean | No | | |
| `axisLabel` | string | No | | | `axisLabel` | string | No | | |
| `axisPlacement` | string | No | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | | `axisPlacement` | string | No | | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
| `axisSoftMax` | number | No | | | `axisSoftMax` | number | No | | |
| `axisSoftMin` | number | No | | | `axisSoftMin` | number | No | | |
| `axisWidth` | number | No | | | `axisWidth` | number | No | | |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### ScaleDistributionConfig ### ScaleDistributionConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|--------|----------|--------------------------------------------------------------------------| |-------------------|--------|----------|---------|--------------------------------------------------------------------------|
| `type` | string | **Yes** | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | | `linearThreshold` | number | No | | |
| `log` | number | No | | | `log` | number | No | | |
### GraphThresholdsStyleConfig ### GraphThresholdsStyleConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-----------------------------------------------------------------------------------------------------------| |----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. | | `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
### HideSeriesConfig ### HideSeriesConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------|----------|-------------| |-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | | `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | | `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | | `viz` | boolean | **Yes** | | |
### HideableFieldConfig ### HideableFieldConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions ### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting). It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------| |-----------------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------|
| `barWidth` | number | **Yes** | Controls the width of bars. 1 = Max width, 0 = Min width. Default: `0.97`.<br/>Constraint: `>=0 & <=1`. | | `barWidth` | number | **Yes** | `0.97` | Controls the width of bars. 1 = Max width, 0 = Min width.<br/>Constraint: `>=0 & <=1`. |
| `fullHighlight` | boolean | **Yes** | Enables mode which highlights the entire bar area and shows tooltip when cursor<br/>hovers over highlighted area Default: `false`. | | `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** | Controls the width of groups. 1 = max with, 0 = min width. Default: `0.7`.<br/>Constraint: `>=0 & <=1`. | | `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 | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `orientation` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. | | `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `showValue` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `never`, `always`. | | `showValue` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `stacking` | string | **Yes** | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. | | `stacking` | string | **Yes** | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs | | `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`. | | `xTickLabelMaxLength` | integer | **Yes** | | Sets the max length that a label can have before it is truncated.<br/>Constraint: `>=0 & <=2147483647`. |
| `xTickLabelRotation` | integer | **Yes** | Controls the rotation of the x axis labels. Default: `0`.<br/>Constraint: `>=-90 & <=90`. | | `xTickLabelRotation` | integer | **Yes** | `0` | Controls the rotation of the x axis labels.<br/>Constraint: `>=-90 & <=90`. |
| `barRadius` | number | No | Controls the radius of each bar. Default: `0`.<br/>Constraint: `>=0 & <=0.5`. | | `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. | | `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 | | `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. | | `xField` | string | No | | Manually select which field from the dataset to represent the x field. |
| `xTickLabelSpacing` | int32 | No | Controls the spacing between x axis labels.<br/>negative values indicate backwards skipping behavior Default: `0`. | | `xTickLabelSpacing` | int32 | No | `0` | Controls the spacing between x axis labels.<br/>negative values indicate backwards skipping behavior |
### OptionsWithLegend ### OptionsWithLegend
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------------------|----------|-------------| |----------|---------------------------------------|----------|---------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions ### VizLegendOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | | `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`. | | `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`. | | `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | | `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | | `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | | `isVisible` | boolean | No | | |
| `sortBy` | string | No | | | `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | | `sortDesc` | boolean | No | | |
| `width` | number | No | | | `width` | number | No | | |
### OptionsWithTextFormatting ### OptionsWithTextFormatting
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------------|----------|-------------| |----------|-------------------------------------------------|----------|---------|-------------|
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions ### VizTextDisplayOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|--------|----------|--------------------------| |-------------|--------|----------|---------|--------------------------|
| `titleSize` | number | No | Explicit title text size | | `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | Explicit value text size | | `valueSize` | number | No | | Explicit value text size |
### OptionsWithTooltip ### OptionsWithTooltip
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-----------------------------------------|----------|-------------| |-----------|-----------------------------------------|----------|---------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions ### VizTooltipOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|---------------------------------------------------------------| |----------|--------|----------|---------|---------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `single`, `multi`, `none`. | | `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. | | `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

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

@ -13,14 +13,25 @@ title: BarGaugePanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
It extends [SingleStatBaseOptions](#singlestatbaseoptions). It extends [SingleStatBaseOptions](#singlestatbaseoptions).
<<<<<<< HEAD
| 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` | |
| `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 |
=======
| Property | Type | Required | Description | | Property | Type | Required | 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`. | | `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`. |
@ -31,17 +42,18 @@ It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| `orientation` | string | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. | | `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 | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
>>>>>>> main
### ReduceDataOptions ### ReduceDataOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|----------|----------|---------------------------------------------------------------| |----------|----------|----------|---------|---------------------------------------------------------------|
| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field | | `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 | | `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | if showing all values limit | | `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | If true show each row value | | `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions ### SingleStatBaseOptions
@ -49,27 +61,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting). It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------| |-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
| `orientation` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. | | `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
### OptionsWithTextFormatting ### OptionsWithTextFormatting
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------------|----------|-------------| |----------|-------------------------------------------------|----------|---------|-------------|
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions ### VizTextDisplayOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|--------|----------|--------------------------| |-------------|--------|----------|---------|--------------------------|
| `titleSize` | number | No | Explicit title text size | | `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | Explicit value text size | | `valueSize` | number | No | | Explicit value text size |

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

@ -13,7 +13,7 @@ title: CloudWatchDataQuery kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|

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

@ -13,23 +13,23 @@ title: DashboardListPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|------------------------------------------| |----------------|-------------------------|----------|---------|------------------------------------------|
| `PanelLayout` | string | **Yes** | Possible values are: `list`, `previews`. | | `PanelLayout` | string | **Yes** | | Possible values are: `list`, `previews`. |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------------|----------|----------|------------------------------------------| |----------------------|----------|----------|---------|------------------------------------------|
| `maxItems` | integer | **Yes** | Default: `10`. | | `maxItems` | integer | **Yes** | `10` | |
| `query` | string | **Yes** | Default: ``. | | `query` | string | **Yes** | `` | |
| `showHeadings` | boolean | **Yes** | Default: `true`. | | `showHeadings` | boolean | **Yes** | `true` | |
| `showRecentlyViewed` | boolean | **Yes** | Default: `false`. | | `showRecentlyViewed` | boolean | **Yes** | `false` | |
| `showSearch` | boolean | **Yes** | Default: `false`. | | `showSearch` | boolean | **Yes** | `false` | |
| `showStarred` | boolean | **Yes** | Default: `true`. | | `showStarred` | boolean | **Yes** | `true` | |
| `tags` | string[] | **Yes** | | | `tags` | string[] | **Yes** | | |
| `folderId` | integer | No | | | `folderId` | integer | No | | |
| `layout` | string | No | Possible values are: `list`, `previews`. | | `layout` | string | No | | Possible values are: `list`, `previews`. |

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

@ -13,25 +13,25 @@ title: DebugPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|---------------------------------------------------------------------------| |----------------|-------------------------|----------|---------|---------------------------------------------------------------------------|
| `DebugMode` | string | **Yes** | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. | | `DebugMode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
| `UpdateConfig` | [object](#updateconfig) | **Yes** | | | `UpdateConfig` | [object](#updateconfig) | **Yes** | | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|-------------------------------|----------|---------------------------------------------------------------------------| |------------|-------------------------------|----------|---------|---------------------------------------------------------------------------|
| `mode` | string | **Yes** | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. | | `mode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
| `counters` | [UpdateConfig](#updateconfig) | No | | | `counters` | [UpdateConfig](#updateconfig) | No | | |
### UpdateConfig ### UpdateConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|---------|----------|-------------| |-----------------|---------|----------|---------|-------------|
| `dataChanged` | boolean | **Yes** | | | `dataChanged` | boolean | **Yes** | | |
| `render` | boolean | **Yes** | | | `render` | boolean | **Yes** | | |
| `schemaChanged` | boolean | **Yes** | | | `schemaChanged` | boolean | **Yes** | | |

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

@ -15,107 +15,107 @@ title: ElasticsearchDataQuery kind
It extends [DataQuery](#dataquery). It extends [DataQuery](#dataquery).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------|-------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------|-------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>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. | | `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | `alias` | string | No | | Alias pattern |
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | List of bucket aggregations | | `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations |
| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>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) | | `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | `metrics` | [MetricAggregation](#metricaggregation)[] | No | | List of metric aggregations |
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default | | `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
| `query` | string | No | Lucene query | | `query` | string | No | | Lucene query |
| `timeField` | string | No | Name of time field | | `timeField` | string | No | | Name of time field |
### BucketAggregation ### BucketAggregation
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------| |----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | | | `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
### DateHistogram ### DateHistogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield). It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `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))* | | `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### BucketAggregationWithField ### BucketAggregationWithField
It extends [BaseBucketAggregation](#basebucketaggregation). It extends [BaseBucketAggregation](#basebucketaggregation).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | | `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`. | | `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | | `field` | string | No | | |
| `settings` | | No | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | | `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
### BaseBucketAggregation ### BaseBucketAggregation
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|---------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|---------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | | | `id` | string | **Yes** | | |
| `type` | string | **Yes** | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `settings` | | No | | | `settings` | | No | | |
### Filters ### Filters
It extends [BaseBucketAggregation](#basebucketaggregation). It extends [BaseBucketAggregation](#basebucketaggregation).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* | | `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`. | | `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))* | | `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
### GeoHashGrid ### GeoHashGrid
It extends [BucketAggregationWithField](#bucketaggregationwithfield). It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `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))* | | `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### Histogram ### Histogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield). It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `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))* | | `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### Nested ### Nested
It extends [BucketAggregationWithField](#bucketaggregationwithfield). It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `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))* | | `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### Terms ### Terms
It extends [BucketAggregationWithField](#bucketaggregationwithfield). It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. | | `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))* | | `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* | | `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### DataQuery ### DataQuery
@ -123,139 +123,139 @@ These are the common properties available to all queries in all datasources.
Specific implementations will *extend* this interface, adding the required Specific implementations will *extend* this interface, adding the required
properties for the given context. properties for the given context.
| Property | Type | Required | Description | | 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. | | `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 | | `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) | | `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 | | `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
### MetricAggregation ### MetricAggregation
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------------------------------------------------------------------------------------------------------|----------|-------------| |----------|------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | | | `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
### Count ### Count
It extends [BaseMetricAggregation](#basemetricaggregation). It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | | `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`. | | `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))* | | `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
### BaseMetricAggregation ### BaseMetricAggregation
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | | | `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`. | | `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 | | | `hide` | boolean | No | | |
### PipelineMetricAggregation ### PipelineMetricAggregation
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------| |----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | | | `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
### BucketScript ### BucketScript
It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths). It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths).
| Property | Type | Required | Description | | 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`. | | `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))* | | `hide` | boolean | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
| `id` | string | No | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | | `id` | string | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* | | `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
| `settings` | [object](#settings) | No | | | `settings` | [object](#settings) | No | | |
### PipelineMetricAggregationWithMultipleBucketPaths ### PipelineMetricAggregationWithMultipleBucketPaths
It extends [BaseMetricAggregation](#basemetricaggregation). It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | | `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`. | | `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))* | | `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | | `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | |
### PipelineVariable ### PipelineVariable
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|--------|----------|-------------| |---------------|--------|----------|---------|-------------|
| `name` | string | **Yes** | | | `name` | string | **Yes** | | |
| `pipelineAgg` | string | **Yes** | | | `pipelineAgg` | string | **Yes** | | |
### Settings ### Settings
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
| `script` | | No | | | `script` | | No | | |
### CumulativeSum ### CumulativeSum
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Description | | 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`. | | `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))* | | `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `hide` | boolean | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `id` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `pipelineAgg` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `settings` | [object](#settings) | No | | | `settings` | [object](#settings) | No | | |
### BasePipelineMetricAggregation ### BasePipelineMetricAggregation
It extends [MetricAggregationWithField](#metricaggregationwithfield). It extends [MetricAggregationWithField](#metricaggregationwithfield).
| Property | Type | Required | Description | | 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`. | | `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))* | | `field` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
| `hide` | boolean | No | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | | `hide` | boolean | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
| `id` | string | No | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* | | `id` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
| `pipelineAgg` | string | No | | | `pipelineAgg` | string | No | | |
### MetricAggregationWithField ### MetricAggregationWithField
It extends [BaseMetricAggregation](#basemetricaggregation). It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | | `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`. | | `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 | | | `field` | string | No | | |
| `hide` | boolean | No | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* | | `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
### Settings ### Settings
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `format` | string | No | | | `format` | string | No | | |
### Derivative ### Derivative
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Description | | 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`. | | `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))* | | `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `hide` | boolean | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `id` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `pipelineAgg` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `settings` | [object](#settings) | No | | | `settings` | [object](#settings) | No | | |
### Settings ### Settings
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `unit` | string | No | | | `unit` | string | No | | |
### MovingAverage ### MovingAverage
@ -263,31 +263,31 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation). It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Description | | 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`. | | `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))* | | `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `hide` | boolean | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `id` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `pipelineAgg` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* | | `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
| `settings` | [object](#settings) | No | | | `settings` | [object](#settings) | No | | |
### Settings ### Settings
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
### Meta ### Meta
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
### Settings ### Settings
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|----------|----------|-------------| |-----------|----------|----------|---------|-------------|
| `metrics` | string[] | No | | | `metrics` | string[] | No | | |
| `orderBy` | string | No | | | `orderBy` | string | No | | |
| `order` | string | No | | | `order` | string | No | | |

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

@ -13,32 +13,32 @@ title: GaugePanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
It extends [SingleStatBaseOptions](#singlestatbaseoptions). It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------------------|-------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------| |------------------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `showThresholdLabels` | boolean | **Yes** | Default: `false`. | | `showThresholdLabels` | boolean | **Yes** | `false` | |
| `showThresholdMarkers` | boolean | **Yes** | Default: `true`. | | `showThresholdMarkers` | boolean | **Yes** | `true` | |
| `orientation` | string | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. | | `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 | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
### ReduceDataOptions ### ReduceDataOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|----------|----------|---------------------------------------------------------------| |----------|----------|----------|---------|---------------------------------------------------------------|
| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field | | `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 | | `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | if showing all values limit | | `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | If true show each row value | | `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions ### SingleStatBaseOptions
@ -46,27 +46,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting). It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------| |-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
| `orientation` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. | | `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
### OptionsWithTextFormatting ### OptionsWithTextFormatting
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------------|----------|-------------| |----------|-------------------------------------------------|----------|---------|-------------|
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions ### VizTextDisplayOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|--------|----------|--------------------------| |-------------|--------|----------|---------|--------------------------|
| `titleSize` | number | No | Explicit title text size | | `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | Explicit value text size | | `valueSize` | number | No | | Explicit value text size |

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

@ -13,80 +13,80 @@ title: GeomapPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|----------------------------|----------|-----------------------------------------------| |-------------------|----------------------------|----------|---------|-----------------------------------------------|
| `ControlsOptions` | [object](#controlsoptions) | **Yes** | | | `ControlsOptions` | [object](#controlsoptions) | **Yes** | | |
| `MapCenterID` | string | **Yes** | Possible values are: `zero`, `coords`, `fit`. | | `MapCenterID` | string | **Yes** | | Possible values are: `zero`, `coords`, `fit`. |
| `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | | `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
| `TooltipMode` | string | **Yes** | Possible values are: `none`, `details`. | | `TooltipMode` | string | **Yes** | | Possible values are: `none`, `details`. |
| `TooltipOptions` | [object](#tooltipoptions) | **Yes** | | | `TooltipOptions` | [object](#tooltipoptions) | **Yes** | | |
### ControlsOptions ### ControlsOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|---------|----------|--------------------------| |-------------------|---------|----------|---------|--------------------------|
| `mouseWheelZoom` | boolean | No | let the mouse wheel zoom | | `mouseWheelZoom` | boolean | No | | let the mouse wheel zoom |
| `showAttribution` | boolean | No | Lower right | | `showAttribution` | boolean | No | | Lower right |
| `showDebug` | boolean | No | Show debug | | `showDebug` | boolean | No | | Show debug |
| `showMeasure` | boolean | No | Show measure | | `showMeasure` | boolean | No | | Show measure |
| `showScale` | boolean | No | Scale options | | `showScale` | boolean | No | | Scale options |
| `showZoom` | boolean | No | Zoom (upper left) | | `showZoom` | boolean | No | | Zoom (upper left) |
### MapViewConfig ### MapViewConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|---------|----------|------------------| |-------------|---------|----------|---------|-------------|
| `id` | string | **Yes** | Default: `zero`. | | `id` | string | **Yes** | `zero` | |
| `allLayers` | boolean | No | Default: `true`. | | `allLayers` | boolean | No | `true` | |
| `lastOnly` | boolean | No | | | `lastOnly` | boolean | No | | |
| `lat` | int64 | No | Default: `0`. | | `lat` | int64 | No | `0` | |
| `layer` | string | No | | | `layer` | string | No | | |
| `lon` | int64 | No | Default: `0`. | | `lon` | int64 | No | `0` | |
| `maxZoom` | integer | No | | | `maxZoom` | integer | No | | |
| `minZoom` | integer | No | | | `minZoom` | integer | No | | |
| `padding` | integer | No | | | `padding` | integer | No | | |
| `shared` | boolean | No | | | `shared` | boolean | No | | |
| `zoom` | int64 | No | Default: `1`. | | `zoom` | int64 | No | `1` | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | | `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | |
| `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | | `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | |
| `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | | `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | |
| `tooltip` | [TooltipOptions](#tooltipoptions) | **Yes** | | | `tooltip` | [TooltipOptions](#tooltipoptions) | **Yes** | | |
| `view` | [MapViewConfig](#mapviewconfig) | **Yes** | | | `view` | [MapViewConfig](#mapviewconfig) | **Yes** | | |
### MapLayerOptions ### MapLayerOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------|---------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------| |--------------|---------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------|
| `name` | string | **Yes** | configured unique display name | | `name` | string | **Yes** | | configured unique display name |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
| `config` | | No | Custom options depending on the type | | `config` | | No | | Custom options depending on the type |
| `filterData` | | No | Defines a frame MatcherConfig that may filter data for the given layer | | `filterData` | | No | | Defines a frame MatcherConfig that may filter data for the given layer |
| `location` | [FrameGeometrySource](#framegeometrysource) | No | | | `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) | | `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) | | `tooltip` | boolean | No | | Check tooltip (defaults to true) |
### FrameGeometrySource ### FrameGeometrySource
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|--------|----------|-------------------------------------------------------------| |-------------|--------|----------|---------|-------------------------------------------------------------|
| `mode` | string | **Yes** | Possible values are: `auto`, `geohash`, `coords`, `lookup`. | | `mode` | string | **Yes** | | Possible values are: `auto`, `geohash`, `coords`, `lookup`. |
| `gazetteer` | string | No | Path to Gazetteer | | `gazetteer` | string | No | | Path to Gazetteer |
| `geohash` | string | No | Field mappings | | `geohash` | string | No | | Field mappings |
| `latitude` | string | No | | | `latitude` | string | No | | |
| `longitude` | string | No | | | `longitude` | string | No | | |
| `lookup` | string | No | | | `lookup` | string | No | | |
| `wkt` | string | No | | | `wkt` | string | No | | |
### TooltipOptions ### TooltipOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-----------------------------------------| |----------|--------|----------|---------|-----------------------------------------|
| `mode` | string | **Yes** | Possible values are: `none`, `details`. | | `mode` | string | **Yes** | | Possible values are: `none`, `details`. |

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

@ -13,158 +13,158 @@ title: HeatmapPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------------|--------------------------------|----------|-------------------------------------------------------------------------------------------| |-----------------------|--------------------------------|----------|---------|-------------------------------------------------------------------------------------------|
| `CellValues` | [object](#cellvalues) | **Yes** | Controls cell value options | | `CellValues` | [object](#cellvalues) | **Yes** | | Controls cell value options |
| `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | Controls exemplar options | | `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | | Controls exemplar options |
| `FilterValueRange` | [object](#filtervaluerange) | **Yes** | Controls the value filter range | | `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`. | | `HeatmapColorMode` | string | **Yes** | | Controls the color mode of the heatmap<br/>Possible values are: `opacity`, `scheme`. |
| `HeatmapColorOptions` | [object](#heatmapcoloroptions) | **Yes** | Controls various color options | | `HeatmapColorOptions` | [object](#heatmapcoloroptions) | **Yes** | | Controls various color options |
| `HeatmapColorScale` | string | **Yes** | Controls the color scale of the heatmap<br/>Possible values are: `linear`, `exponential`. | | `HeatmapColorScale` | string | **Yes** | | Controls the color scale of the heatmap<br/>Possible values are: `linear`, `exponential`. |
| `HeatmapLegend` | [object](#heatmaplegend) | **Yes** | Controls legend options | | `HeatmapLegend` | [object](#heatmaplegend) | **Yes** | | Controls legend options |
| `HeatmapTooltip` | [object](#heatmaptooltip) | **Yes** | Controls tooltip options | | `HeatmapTooltip` | [object](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | | `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
| `RowsHeatmapOptions` | [object](#rowsheatmapoptions) | **Yes** | Controls frame rows options | | `RowsHeatmapOptions` | [object](#rowsheatmapoptions) | **Yes** | | Controls frame rows options |
| `YAxisConfig` | [object](#yaxisconfig) | **Yes** | Configuration options for the yAxis | | `YAxisConfig` | [object](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
### CellValues ### CellValues
Controls cell value options Controls cell value options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|--------|----------|-------------------------------------------------| |------------|--------|----------|---------|-------------------------------------------------|
| `decimals` | number | No | Controls the number of decimals for cell values | | `decimals` | number | No | | Controls the number of decimals for cell values |
| `unit` | string | No | Controls the cell value unit | | `unit` | string | No | | Controls the cell value unit |
### ExemplarConfig ### ExemplarConfig
Controls exemplar options Controls exemplar options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|----------------------------------------| |----------|--------|----------|---------|----------------------------------------|
| `color` | string | **Yes** | Sets the color of the exemplar markers | | `color` | string | **Yes** | | Sets the color of the exemplar markers |
### FilterValueRange ### FilterValueRange
Controls the value filter range Controls the value filter range
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|--------------------------------------------------------------------------| |----------|--------|----------|---------|--------------------------------------------------------------------------|
| `ge` | number | No | Sets the filter range to values greater than or equal to the given value | | `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 | | `le` | number | No | | Sets the filter range to values less than or equal to the given value |
### HeatmapColorOptions ### HeatmapColorOptions
Controls various color options Controls various color options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------|----------|-------------------------------------------------------------------------------------------| |------------|---------|----------|---------|-------------------------------------------------------------------------------------------|
| `exponent` | number | **Yes** | Controls the exponent when scale is set to exponential | | `exponent` | number | **Yes** | | Controls the exponent when scale is set to exponential |
| `fill` | string | **Yes** | Controls the color fill when in opacity mode | | `fill` | string | **Yes** | | Controls the color fill when in opacity mode |
| `reverse` | boolean | **Yes** | Reverses the color scheme | | `reverse` | boolean | **Yes** | | Reverses the color scheme |
| `scheme` | string | **Yes** | Controls the color scheme used | | `scheme` | string | **Yes** | | Controls the color scheme used |
| `steps` | integer | **Yes** | Controls the number of color steps<br/>Constraint: `>=2 & <=128`. | | `steps` | integer | **Yes** | | Controls the number of color steps<br/>Constraint: `>=2 & <=128`. |
| `max` | number | No | Sets the maximum value for the color scale | | `max` | number | No | | Sets the maximum value for the color scale |
| `min` | number | No | Sets the minimum 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`. | | `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`. | | `scale` | string | No | | Controls the color scale of the heatmap<br/>Possible values are: `linear`, `exponential`. |
### HeatmapLegend ### HeatmapLegend
Controls legend options Controls legend options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|---------------------------------| |----------|---------|----------|---------|---------------------------------|
| `show` | boolean | **Yes** | Controls if the legend is shown | | `show` | boolean | **Yes** | | Controls if the legend is shown |
### HeatmapTooltip ### HeatmapTooltip
Controls tooltip options Controls tooltip options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------|---------|----------|----------------------------------------------------------------| |--------------|---------|----------|---------|----------------------------------------------------------------|
| `show` | boolean | **Yes** | Controls if the tooltip is shown | | `show` | boolean | **Yes** | | Controls if the tooltip is shown |
| `yHistogram` | boolean | No | Controls if the tooltip shows a histogram of the y-axis values | | `yHistogram` | boolean | No | | Controls if the tooltip shows a histogram of the y-axis values |
### PanelFieldConfig ### PanelFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig). It extends [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### HideSeriesConfig ### HideSeriesConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------|----------|-------------| |-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | | `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | | `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | | `viz` | boolean | **Yes** | | |
### HideableFieldConfig ### HideableFieldConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### ScaleDistributionConfig ### ScaleDistributionConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|--------|----------|--------------------------------------------------------------------------| |-------------------|--------|----------|---------|--------------------------------------------------------------------------|
| `type` | string | **Yes** | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | | `linearThreshold` | number | No | | |
| `log` | number | No | | | `log` | number | No | | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|---------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------| |----------------|---------------------------------------------------------|----------|----------------------------------------------------------------------------|---------------------------------------------------------------|
| `color` | [object](#color) | **Yes** | Controls the color options Default: `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]`. | | `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 | | `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options |
| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | Controls legend options | | `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options |
| `showValue` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `never`, `always`. | | `showValue` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | Controls tooltip options | | `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | Configuration options for the yAxis | | `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
| `calculate` | boolean | No | Controls if the heatmap should be calculated from data Default: `false`. | | `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | | `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
| `cellGap` | integer | No | Controls gap between cells Default: `1`.<br/>Constraint: `>=0 & <=25`. | | `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
| `cellRadius` | number | No | Controls cell radius | | `cellRadius` | number | No | | Controls cell radius |
| `cellValues` | [object](#cellvalues) | No | Controls cell value unit Default: `map[]`. | | `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
| `filterValues` | [object](#filtervalues) | No | Filters values between a given range Default: `map[le:1e-09]`. | | `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | Controls frame rows options | | `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
### HeatmapCalculationOptions ### HeatmapCalculationOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|-------------------------------------------------------------------|----------|-------------| |------------|-------------------------------------------------------------------|----------|---------|-------------|
| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | | `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | | `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
### HeatmapCalculationBucketConfig ### HeatmapCalculationBucketConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------------------------------|----------|----------------------------------------------------------| |----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------|
| `mode` | string | No | Possible values are: `size`, `count`. | | `mode` | string | No | | Possible values are: `size`, `count`. |
| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs | | `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
| `value` | string | No | The number of buckets to use for the axis in the heatmap | | `value` | string | No | | The number of buckets to use for the axis in the heatmap |
### RowsHeatmapOptions ### RowsHeatmapOptions
Controls frame rows options Controls frame rows options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|----------------------------------------------------------| |----------|--------|----------|---------|----------------------------------------------------------|
| `layout` | string | No | Possible values are: `le`, `ge`, `unknown`, `auto`. | | `layout` | string | No | | Possible values are: `le`, `ge`, `unknown`, `auto`. |
| `value` | string | No | Sets the name of the cell when not calculating from data | | `value` | string | No | | Sets the name of the cell when not calculating from data |
### YAxisConfig ### YAxisConfig
@ -172,61 +172,61 @@ Configuration options for the yAxis
It extends [AxisConfig](#axisconfig). It extends [AxisConfig](#axisconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisLabel` | string | 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`. | | `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))* | | `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `decimals` | number | No | Controls the number of decimals for yAxis values | | `decimals` | number | No | | Controls the number of decimals for yAxis values |
| `max` | number | No | Sets the maximum value for the yAxis | | `max` | number | No | | Sets the maximum value for the yAxis |
| `min` | number | No | Sets the minimum value for the yAxis | | `min` | number | No | | Sets the minimum value for the yAxis |
| `reverse` | boolean | No | Reverses the yAxis | | `reverse` | boolean | No | | Reverses the yAxis |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
| `unit` | string | No | Sets the yAxis unit | | `unit` | string | No | | Sets the yAxis unit |
### AxisConfig ### AxisConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | | | `axisCenteredZero` | boolean | No | | |
| `axisColorMode` | string | No | TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | | | `axisGridShow` | boolean | No | | |
| `axisLabel` | string | No | | | `axisLabel` | string | No | | |
| `axisPlacement` | string | No | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | | `axisPlacement` | string | No | | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
| `axisSoftMax` | number | No | | | `axisSoftMax` | number | No | | |
| `axisSoftMin` | number | No | | | `axisSoftMin` | number | No | | |
| `axisWidth` | number | No | | | `axisWidth` | number | No | | |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### CellValues ### CellValues
Controls cell value unit Controls cell value unit
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------------|----------|-------------| |----------|-----------------------------------|----------|---------|-------------|
| `object` | Possible types are: [](#), [](#). | | | | `object` | Possible types are: [](#), [](#). | | |
### Color ### Color
Controls the color options Controls the color options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------------|----------|-------------| |----------|-----------------------------------|----------|---------|-------------|
| `object` | Possible types are: [](#), [](#). | | | | `object` | Possible types are: [](#), [](#). | | |
### FilterValues ### FilterValues
Filters values between a given range Filters values between a given range
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------------|----------|-------------| |----------|-----------------------------------|----------|---------|-------------|
| `object` | Possible types are: [](#), [](#). | | | | `object` | Possible types are: [](#), [](#). | | |

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

@ -13,126 +13,126 @@ title: HistogramPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------------|-----------------------------|----------|-------------| |--------------------|-----------------------------|----------|---------|-------------|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | | `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig ### PanelFieldConfig
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig). It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisLabel` | string | 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`. | | `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))* | | `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `fillOpacity` | integer | No | Controls the fill opacity of the bars. Default: `80`.<br/>Constraint: `>=0 & <=100`. | | `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
| `gradientMode` | string | No | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. | | `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `lineWidth` | integer | No | Controls line width of the bars. Default: `1`.<br/>Constraint: `>=0 & <=10`. | | `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 | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
### AxisConfig ### AxisConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | | | `axisCenteredZero` | boolean | No | | |
| `axisColorMode` | string | No | TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | | | `axisGridShow` | boolean | No | | |
| `axisLabel` | string | No | | | `axisLabel` | string | No | | |
| `axisPlacement` | string | No | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | | `axisPlacement` | string | No | | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
| `axisSoftMax` | number | No | | | `axisSoftMax` | number | No | | |
| `axisSoftMin` | number | No | | | `axisSoftMin` | number | No | | |
| `axisWidth` | number | No | | | `axisWidth` | number | No | | |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### ScaleDistributionConfig ### ScaleDistributionConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|--------|----------|--------------------------------------------------------------------------| |-------------------|--------|----------|---------|--------------------------------------------------------------------------|
| `type` | string | **Yes** | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | | `linearThreshold` | number | No | | |
| `log` | number | No | | | `log` | number | No | | |
### HideSeriesConfig ### HideSeriesConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------|----------|-------------| |-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | | `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | | `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | | `viz` | boolean | **Yes** | | |
### HideableFieldConfig ### HideableFieldConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions ### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip). It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-----------------------------------------|----------|----------------------------------------------------------------------------| |----------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
| `bucketOffset` | int32 | No | Offset buckets by this amount Default: `0`. | | `bucketOffset` | int32 | No | `0` | Offset buckets by this amount |
| `bucketSize` | integer | No | Size of each bucket | | `bucketSize` | integer | No | | Size of each bucket |
| `combine` | boolean | No | Combines multiple series into a single histogram | | `combine` | boolean | No | | Combines multiple series into a single histogram |
### OptionsWithLegend ### OptionsWithLegend
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------------------|----------|-------------| |----------|---------------------------------------|----------|---------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions ### VizLegendOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | | `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`. | | `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`. | | `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | | `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | | `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | | `isVisible` | boolean | No | | |
| `sortBy` | string | No | | | `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | | `sortDesc` | boolean | No | | |
| `width` | number | No | | | `width` | number | No | | |
### OptionsWithTooltip ### OptionsWithTooltip
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-----------------------------------------|----------|-------------| |-----------|-----------------------------------------|----------|---------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions ### VizTooltipOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|---------------------------------------------------------------| |----------|--------|----------|---------|---------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `single`, `multi`, `none`. | | `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. | | `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

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

@ -13,21 +13,21 @@ title: LogsPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------------|---------|----------|---------------------------------------------------------------| |----------------------|---------|----------|---------|---------------------------------------------------------------|
| `dedupStrategy` | string | **Yes** | Possible values are: `none`, `exact`, `numbers`, `signature`. | | `dedupStrategy` | string | **Yes** | | Possible values are: `none`, `exact`, `numbers`, `signature`. |
| `enableLogDetails` | boolean | **Yes** | | | `enableLogDetails` | boolean | **Yes** | | |
| `prettifyLogMessage` | boolean | **Yes** | | | `prettifyLogMessage` | boolean | **Yes** | | |
| `showCommonLabels` | boolean | **Yes** | | | `showCommonLabels` | boolean | **Yes** | | |
| `showLabels` | boolean | **Yes** | | | `showLabels` | boolean | **Yes** | | |
| `showTime` | boolean | **Yes** | | | `showTime` | boolean | **Yes** | | |
| `sortOrder` | string | **Yes** | Possible values are: `Descending`, `Ascending`. | | `sortOrder` | string | **Yes** | | Possible values are: `Descending`, `Ascending`. |
| `wrapLogMessage` | boolean | **Yes** | | | `wrapLogMessage` | boolean | **Yes** | | |

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

@ -15,19 +15,19 @@ title: LokiDataQuery kind
It extends [DataQuery](#dataquery). It extends [DataQuery](#dataquery).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `expr` | string | **Yes** | The LogQL query. | | `expr` | string | **Yes** | | The LogQL query. |
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>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. | | `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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`. | | `editorMode` | string | No | | Possible values are: `code`, `builder`. |
| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*<br/>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) | | `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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. | | `instant` | boolean | No | | @deprecated, now use queryType. |
| `legendFormat` | string | No | Used to override the name of the series. | | `legendFormat` | string | No | | Used to override the name of the series. |
| `maxLines` | integer | No | Used to limit the number of log rows returned. | | `maxLines` | integer | No | | Used to limit the number of log rows returned. |
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default | | `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
| `range` | boolean | No | @deprecated, now use queryType. | | `range` | boolean | No | | @deprecated, now use queryType. |
| `resolution` | integer | No | Used to scale the interval value. | | `resolution` | integer | No | | Used to scale the interval value. |
### DataQuery ### DataQuery
@ -35,11 +35,11 @@ These are the common properties available to all queries in all datasources.
Specific implementations will *extend* this interface, adding the required Specific implementations will *extend* this interface, adding the required
properties for the given context. properties for the given context.
| Property | Type | Required | Description | | 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. | | `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 | | `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) | | `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 | | `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |

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

@ -13,15 +13,15 @@ title: NewsPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|---------|----------|--------------------------------------------| |-------------|---------|----------|---------|--------------------------------------------|
| `feedUrl` | string | No | empty/missing will default to grafana blog | | `feedUrl` | string | No | | empty/missing will default to grafana blog |
| `showImage` | boolean | No | Default: `true`. | | `showImage` | boolean | No | `true` | |

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

@ -13,40 +13,40 @@ title: NodeGraphPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `ArcOption` | [object](#arcoption) | **Yes** | | | `ArcOption` | [object](#arcoption) | **Yes** | | |
| `EdgeOptions` | [object](#edgeoptions) | **Yes** | | | `EdgeOptions` | [object](#edgeoptions) | **Yes** | | |
| `NodeOptions` | [object](#nodeoptions) | **Yes** | | | `NodeOptions` | [object](#nodeoptions) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### ArcOption ### ArcOption
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-----------------------------------------------------------------------------------------------------| |----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------|
| `color` | string | No | The color of the arc. | | `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. | | `field` | string | No | | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
### EdgeOptions ### EdgeOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|--------|----------|-----------------------------------------------------------------------------| |---------------------|--------|----------|---------|-----------------------------------------------------------------------------|
| `mainStatUnit` | string | No | Unit for the main stat to override what ever is set in the data frame. | | `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. | | `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
### NodeOptions ### NodeOptions
| Property | Type | Required | Description | | 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). | | `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. | | `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. | | `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------|----------|-------------| |----------|-----------------------------|----------|---------|-------------|
| `edges` | [EdgeOptions](#edgeoptions) | No | | | `edges` | [EdgeOptions](#edgeoptions) | No | | |
| `nodes` | [NodeOptions](#nodeoptions) | No | | | `nodes` | [NodeOptions](#nodeoptions) | No | | |

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

@ -15,14 +15,14 @@ title: ParcaDataQuery kind
It extends [DataQuery](#dataquery). It extends [DataQuery](#dataquery).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `labelSelector` | string | **Yes** | Specifies the query label selectors. Default: `{}`. | | `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
| `profileTypeId` | string | **Yes** | Specifies the type of profile to query. | | `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>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. | | `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>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) | | `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default | | `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
### DataQuery ### DataQuery
@ -30,11 +30,11 @@ These are the common properties available to all queries in all datasources.
Specific implementations will *extend* this interface, adding the required Specific implementations will *extend* this interface, adding the required
properties for the given context. properties for the given context.
| Property | Type | Required | Description | | 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. | | `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 | | `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) | | `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 | | `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |

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

@ -15,15 +15,15 @@ title: PhlareDataQuery kind
It extends [DataQuery](#dataquery). It extends [DataQuery](#dataquery).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------|----------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `groupBy` | string[] | **Yes** | Allows to group the results. | | `groupBy` | string[] | **Yes** | | Allows to group the results. |
| `labelSelector` | string | **Yes** | Specifies the query label selectors. Default: `{}`. | | `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
| `profileTypeId` | string | **Yes** | Specifies the type of profile to query. | | `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>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. | | `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>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) | | `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default | | `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
### DataQuery ### DataQuery
@ -31,11 +31,11 @@ These are the common properties available to all queries in all datasources.
Specific implementations will *extend* this interface, adding the required Specific implementations will *extend* this interface, adding the required
properties for the given context. properties for the given context.
| Property | Type | Required | Description | | 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. | | `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 | | `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) | | `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 | | `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |

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

@ -13,107 +13,107 @@ title: PieChartPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------------|---------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `PanelFieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | TODO docs | | `PanelFieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | | TODO docs |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **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`. | | `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** | | | `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`. | | `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`. | | `PieChartType` | string | **Yes** | | Select the pie chart display style.<br/>Possible values are: `pie`, `donut`. |
### HideableFieldConfig ### HideableFieldConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### HideSeriesConfig ### HideSeriesConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------|----------|-------------| |-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | | `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | | `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | | `viz` | boolean | **Yes** | | |
### PanelOptions ### PanelOptions
It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions). It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------| |-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `displayLabels` | string[] | **Yes** | | | `displayLabels` | string[] | **Yes** | | |
| `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | | `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | |
| `pieType` | string | **Yes** | Select the pie chart display style.<br/>Possible values are: `pie`, `donut`. | | `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 | | `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`. | | `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 | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
### OptionsWithTooltip ### OptionsWithTooltip
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-----------------------------------------|----------|-------------| |-----------|-----------------------------------------|----------|---------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions ### VizTooltipOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|---------------------------------------------------------------| |----------|--------|----------|---------|---------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `single`, `multi`, `none`. | | `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. | | `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
### PieChartLegendOptions ### PieChartLegendOptions
It extends [VizLegendOptions](#vizlegendoptions). It extends [VizLegendOptions](#vizlegendoptions).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | | `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`. | | `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`. | | `placement` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*<br/>TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | | `showLegend` | boolean | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
| `values` | string[] | **Yes** | | | `values` | string[] | **Yes** | | |
| `asTable` | boolean | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | | `asTable` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
| `isVisible` | boolean | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | | `isVisible` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
| `sortBy` | string | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | | `sortBy` | string | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
| `sortDesc` | boolean | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | | `sortDesc` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
| `width` | number | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* | | `width` | number | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
### VizLegendOptions ### VizLegendOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | | `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`. | | `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`. | | `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | | `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | | `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | | `isVisible` | boolean | No | | |
| `sortBy` | string | No | | | `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | | `sortDesc` | boolean | No | | |
| `width` | number | No | | | `width` | number | No | | |
### ReduceDataOptions ### ReduceDataOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|----------|----------|---------------------------------------------------------------| |----------|----------|----------|---------|---------------------------------------------------------------|
| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field | | `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 | | `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | if showing all values limit | | `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | If true show each row value | | `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions ### SingleStatBaseOptions
@ -121,27 +121,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting). It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------| |-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
| `orientation` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. | | `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
### OptionsWithTextFormatting ### OptionsWithTextFormatting
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------------|----------|-------------| |----------|-------------------------------------------------|----------|---------|-------------|
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions ### VizTextDisplayOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|--------|----------|--------------------------| |-------------|--------|----------|---------|--------------------------|
| `titleSize` | number | No | Explicit title text size | | `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | Explicit value text size | | `valueSize` | number | No | | Explicit value text size |

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

@ -13,100 +13,100 @@ title: StateTimelinePanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------------|-----------------------------|----------|-------------| |--------------------|-----------------------------|----------|---------|-------------|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | | `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig ### PanelFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig). It extends [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|---------------------------------------|----------|------------------------------------------------------------------------------| |---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
| `fillOpacity` | integer | No | Default: `70`.<br/>Constraint: `>=0 & <=100`. | | `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `lineWidth` | integer | No | Default: `0`.<br/>Constraint: `>=0 & <=10`. | | `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. |
### HideSeriesConfig ### HideSeriesConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------|----------|-------------| |-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | | `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | | `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | | `viz` | boolean | **Yes** | | |
### HideableFieldConfig ### HideableFieldConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions ### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones). It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|-----------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------| |---------------|-----------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `rowHeight` | number | **Yes** | Controls the row height Default: `0.9`. | | `rowHeight` | number | **Yes** | `0.9` | Controls the row height |
| `showValue` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `never`, `always`. | | `showValue` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
| `alignValue` | string | No | Controls the value alignment in the TimelineChart component<br/>Possible values are: `center`, `left`, `right`. | | `alignValue` | string | No | | Controls the value alignment in the TimelineChart component<br/>Possible values are: `center`, `left`, `right`. |
| `mergeValues` | boolean | No | Merge equal consecutive values Default: `true`. | | `mergeValues` | boolean | No | `true` | Merge equal consecutive values |
| `timezone` | string[] | No | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | | `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
### OptionsWithLegend ### OptionsWithLegend
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------------------|----------|-------------| |----------|---------------------------------------|----------|---------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions ### VizLegendOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | | `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`. | | `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`. | | `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | | `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | | `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | | `isVisible` | boolean | No | | |
| `sortBy` | string | No | | | `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | | `sortDesc` | boolean | No | | |
| `width` | number | No | | | `width` | number | No | | |
### OptionsWithTimezones ### OptionsWithTimezones
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|----------|----------|-------------| |------------|----------|----------|---------|-------------|
| `timezone` | string[] | No | | | `timezone` | string[] | No | | |
### OptionsWithTooltip ### OptionsWithTooltip
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-----------------------------------------|----------|-------------| |-----------|-----------------------------------------|----------|---------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions ### VizTooltipOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|---------------------------------------------------------------| |----------|--------|----------|---------|---------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `single`, `multi`, `none`. | | `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. | | `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

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

@ -13,34 +13,34 @@ title: StatPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
It extends [SingleStatBaseOptions](#singlestatbaseoptions). It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------| |-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `colorMode` | string | **Yes** | TODO docs<br/>Possible values are: `value`, `background`, `none`. | | `colorMode` | string | **Yes** | | TODO docs<br/>Possible values are: `value`, `background`, `none`. |
| `graphMode` | string | **Yes** | TODO docs<br/>Possible values are: `none`, `line`, `area`. | | `graphMode` | string | **Yes** | | TODO docs<br/>Possible values are: `none`, `line`, `area`. |
| `justifyMode` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `center`. | | `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`. | | `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`. | | `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 | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
### ReduceDataOptions ### ReduceDataOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|----------|----------|---------------------------------------------------------------| |----------|----------|----------|---------|---------------------------------------------------------------|
| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field | | `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 | | `fields` | string | No | | Which fields to show. By default this is only numeric fields |
| `limit` | number | No | if showing all values limit | | `limit` | number | No | | if showing all values limit |
| `values` | boolean | No | If true show each row value | | `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions ### SingleStatBaseOptions
@ -48,27 +48,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting). It extends [OptionsWithTextFormatting](#optionswithtextformatting).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------| |-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
| `orientation` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. | | `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs | | `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
### OptionsWithTextFormatting ### OptionsWithTextFormatting
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------------|----------|-------------| |----------|-------------------------------------------------|----------|---------|-------------|
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs | | `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions ### VizTextDisplayOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|--------|----------|--------------------------| |-------------|--------|----------|---------|--------------------------|
| `titleSize` | number | No | Explicit title text size | | `titleSize` | number | No | | Explicit title text size |
| `valueSize` | number | No | Explicit value text size | | `valueSize` | number | No | | Explicit value text size |

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

@ -13,99 +13,99 @@ title: StatusHistoryPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------------|-----------------------------|----------|-------------| |--------------------|-----------------------------|----------|---------|-------------|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | | `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig ### PanelFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig). It extends [HideableFieldConfig](#hideablefieldconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|---------------------------------------|----------|------------------------------------------------------------------------------| |---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
| `fillOpacity` | integer | No | Default: `70`.<br/>Constraint: `>=0 & <=100`. | | `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `lineWidth` | integer | No | Default: `1`.<br/>Constraint: `>=0 & <=10`. | | `lineWidth` | integer | No | `1` | Constraint: `>=0 & <=10`. |
### HideSeriesConfig ### HideSeriesConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------|----------|-------------| |-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | | `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | | `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | | `viz` | boolean | **Yes** | | |
### HideableFieldConfig ### HideableFieldConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions ### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones). It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|-----------------------------------------|----------|----------------------------------------------------------------------------| |-------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `rowHeight` | number | **Yes** | Set the height of the rows Default: `0.9`.<br/>Constraint: `>=0 & <=1`. | | `rowHeight` | number | **Yes** | `0.9` | Set the height of the rows<br/>Constraint: `>=0 & <=1`. |
| `showValue` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `never`, `always`. | | `showValue` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
| `colWidth` | number | No | Controls the column width Default: `0.9`. | | `colWidth` | number | No | `0.9` | Controls the column width |
| `timezone` | string[] | No | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* | | `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
### OptionsWithLegend ### OptionsWithLegend
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------------------|----------|-------------| |----------|---------------------------------------|----------|---------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions ### VizLegendOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | | `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`. | | `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`. | | `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | | `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | | `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | | `isVisible` | boolean | No | | |
| `sortBy` | string | No | | | `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | | `sortDesc` | boolean | No | | |
| `width` | number | No | | | `width` | number | No | | |
### OptionsWithTimezones ### OptionsWithTimezones
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|----------|----------|-------------| |------------|----------|----------|---------|-------------|
| `timezone` | string[] | No | | | `timezone` | string[] | No | | |
### OptionsWithTooltip ### OptionsWithTooltip
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-----------------------------------------|----------|-------------| |-----------|-----------------------------------------|----------|---------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions ### VizTooltipOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|---------------------------------------------------------------| |----------|--------|----------|---------|---------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `single`, `multi`, `none`. | | `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. | | `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |

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

@ -13,12 +13,22 @@ title: TablePanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------| |----------------|-------------------------|----------|---------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions ### PanelOptions
<<<<<<< HEAD
| 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 |
| `footer` | [object](#footer) | No | `map[countRows:false reducer:[] show:false]` | Controls footer options |
| `showRowNums` | boolean | No | `false` | Controls whether the columns should be numbered |
| `showTypeIcons` | boolean | No | `false` | Controls whether the header should show icons for the column types |
| `sortBy` | [TableSortByFieldState](#tablesortbyfieldstate)[] | No | | Used to control row sorting |
=======
| Property | Type | Required | Description | | Property | Type | Required | Description |
|-----------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------| |-----------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------|
| `frameIndex` | number | **Yes** | Represents the index of the selected frame Default: `0`. | | `frameIndex` | number | **Yes** | Represents the index of the selected frame Default: `0`. |
@ -28,22 +38,23 @@ title: TablePanelCfg kind
| `showRowNums` | boolean | No | Controls whether the columns should be numbered Default: `false`. | | `showRowNums` | boolean | No | Controls whether the columns should be numbered Default: `false`. |
| `showTypeIcons` | boolean | No | Controls whether the header should show icons for the column types Default: `false`. | | `showTypeIcons` | boolean | No | Controls whether the header should show icons for the column types Default: `false`. |
| `sortBy` | [TableSortByFieldState](#tablesortbyfieldstate)[] | No | Used to control row sorting | | `sortBy` | [TableSortByFieldState](#tablesortbyfieldstate)[] | No | Used to control row sorting |
>>>>>>> main
### TableSortByFieldState ### TableSortByFieldState
Sort by field state Sort by field state
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|---------|----------|-----------------------------------------------| |---------------|---------|----------|---------|-----------------------------------------------|
| `displayName` | string | **Yes** | Sets the display name of the field to sort by | | `displayName` | string | **Yes** | | Sets the display name of the field to sort by |
| `desc` | boolean | No | Flag used to indicate descending sort order | | `desc` | boolean | No | | Flag used to indicate descending sort order |
### Footer ### Footer
Controls footer options Controls footer options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------------|----------|-------------| |----------|-----------------------------------|----------|---------|-------------|
| `object` | Possible types are: [](#), [](#). | | | | `object` | Possible types are: [](#), [](#). | | |

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

@ -13,7 +13,7 @@ title: TempoDataQuery kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|

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

@ -15,41 +15,41 @@ title: TestDataDataQuery kind
It extends [DataQuery](#dataquery). It extends [DataQuery](#dataquery).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|-------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------|-------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>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. | | `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*<br/>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` | string | No | | |
| `channel` | string | No | | | `channel` | string | No | | |
| `csvContent` | string | No | | | `csvContent` | string | No | | |
| `csvFileName` | string | No | | | `csvFileName` | string | No | | |
| `csvWave` | [CSVWave](#csvwave)[] | No | | | `csvWave` | [CSVWave](#csvwave)[] | No | | |
| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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`. | | `errorType` | string | No | | Possible values are: `server_panic`, `frontend_exception`, `frontend_observable`. |
| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*<br/>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) | | `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*<br/>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 | | | `labels` | string | No | | |
| `levelColumn` | boolean | No | | | `levelColumn` | boolean | No | | |
| `lines` | integer | No | | | `lines` | integer | No | | |
| `nodes` | [NodesQuery](#nodesquery) | No | | | `nodes` | [NodesQuery](#nodesquery) | No | | |
| `points` | array[] | No | | | `points` | array[] | No | | |
| `pulseWave` | [PulseWaveQuery](#pulsewavequery) | No | | | `pulseWave` | [PulseWaveQuery](#pulsewavequery) | No | | |
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default | | `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
| `rawFrameContent` | string | No | | | `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`. | | `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 | | | `seriesCount` | integer | No | | |
| `sim` | [SimulationQuery](#simulationquery) | No | | | `sim` | [SimulationQuery](#simulationquery) | No | | |
| `spanCount` | integer | No | | | `spanCount` | integer | No | | |
| `stream` | [StreamingQuery](#streamingquery) | No | | | `stream` | [StreamingQuery](#streamingquery) | No | | |
| `stringInput` | string | No | | | `stringInput` | string | No | | |
| `usa` | [USAQuery](#usaquery) | No | | | `usa` | [USAQuery](#usaquery) | No | | |
### CSVWave ### CSVWave
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|---------|----------|-------------| |-------------|---------|----------|---------|-------------|
| `labels` | string | No | | | `labels` | string | No | | |
| `name` | string | No | | | `name` | string | No | | |
| `timeStep` | integer | No | | | `timeStep` | integer | No | | |
| `valuesCSV` | string | No | | | `valuesCSV` | string | No | | |
### DataQuery ### DataQuery
@ -57,70 +57,70 @@ These are the common properties available to all queries in all datasources.
Specific implementations will *extend* this interface, adding the required Specific implementations will *extend* this interface, adding the required
properties for the given context. properties for the given context.
| Property | Type | Required | Description | | 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. | | `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 | | `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) | | `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 | | `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
### NodesQuery ### NodesQuery
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|------------------------------------------------------------| |----------|---------|----------|---------|------------------------------------------------------------|
| `count` | integer | No | | | `count` | integer | No | | |
| `type` | string | No | Possible values are: `random`, `response`, `random edges`. | | `type` | string | No | | Possible values are: `random`, `response`, `random edges`. |
### PulseWaveQuery ### PulseWaveQuery
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------|----------|-------------| |------------|---------|----------|---------|-------------|
| `offCount` | integer | No | | | `offCount` | integer | No | | |
| `offValue` | number | No | | | `offValue` | number | No | | |
| `onCount` | integer | No | | | `onCount` | integer | No | | |
| `onValue` | number | No | | | `onValue` | number | No | | |
| `timeStep` | integer | No | | | `timeStep` | integer | No | | |
### SimulationQuery ### SimulationQuery
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------|----------|-------------| |----------|-------------------|----------|---------|-------------|
| `key` | [object](#key) | **Yes** | | | `key` | [object](#key) | **Yes** | | |
| `config` | [object](#config) | No | | | `config` | [object](#config) | No | | |
| `last` | boolean | No | | | `last` | boolean | No | | |
| `stream` | boolean | No | | | `stream` | boolean | No | | |
### Config ### Config
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
### Key ### Key
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `tick` | number | **Yes** | | | `tick` | number | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
| `uid` | string | No | | | `uid` | string | No | | |
### StreamingQuery ### StreamingQuery
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|-------------------------------------------------| |----------|---------|----------|---------|-------------------------------------------------|
| `noise` | integer | **Yes** | | | `noise` | integer | **Yes** | | |
| `speed` | integer | **Yes** | | | `speed` | integer | **Yes** | | |
| `spread` | integer | **Yes** | | | `spread` | integer | **Yes** | | |
| `type` | string | **Yes** | Possible values are: `signal`, `logs`, `fetch`. | | `type` | string | **Yes** | | Possible values are: `signal`, `logs`, `fetch`. |
| `bands` | integer | No | | | `bands` | integer | No | | |
| `url` | string | No | | | `url` | string | No | | |
### USAQuery ### USAQuery
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|----------|----------|-------------| |----------|----------|----------|---------|-------------|
| `fields` | string[] | No | | | `fields` | string[] | No | | |
| `mode` | string | No | | | `mode` | string | No | | |
| `period` | string | No | | | `period` | string | No | | |
| `states` | string[] | No | | | `states` | string[] | No | | |

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

@ -13,27 +13,29 @@ title: TextPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|-------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------| |----------------|-------------------------|----------|-------------|---------------------------------------------------------------------------------------------------------|
| `CodeLanguage` | string | **Yes** | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. Default: `plaintext`. | | `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
| `CodeOptions` | [object](#codeoptions) | **Yes** | | | `CodeOptions` | [object](#codeoptions) | **Yes** | | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
| `TextMode` | string | **Yes** | Possible values are: `html`, `markdown`, `code`. | | `TextMode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
### CodeOptions ### CodeOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|---------|----------|-------------------------------------------------------------------------------------------------------------------------------| |-------------------|---------|----------|-------------|---------------------------------------------------------------------------------------------------------|
| `language` | string | **Yes** | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. Default: `plaintext`. | | `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
| `showLineNumbers` | boolean | **Yes** | Default: `false`. | | `showLineNumbers` | boolean | **Yes** | `false` | |
| `showMiniMap` | boolean | **Yes** | Default: `false`. | | `showMiniMap` | boolean | **Yes** | `false` | |
### PanelOptions ### PanelOptions
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-----------------------------|----------|------------------------------------------------------------------------------------------------------------| |-----------|-----------------------------|----------|--------------------------------------------------------------------------------|--------------------------------------------------|
| `content` | string | **Yes** | Default: `# Title<br/><br/>For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)`. | | `content` | string | **Yes** | `# Title | |
| `mode` | string | **Yes** | Possible values are: `html`, `markdown`, `code`. | | | | | | |
| `code` | [CodeOptions](#codeoptions) | No | | | | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | |
| `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
| `code` | [CodeOptions](#codeoptions) | No | | |

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

@ -13,95 +13,95 @@ title: XYChartPanelCfg kind
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------------|--------------------------------|----------|---------------------------------------------------------| |-----------------------|--------------------------------|----------|---------|---------------------------------------------------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | | | `PanelOptions` | [object](#paneloptions) | **Yes** | | |
| `ScatterFieldConfig` | [object](#scatterfieldconfig) | **Yes** | | | `ScatterFieldConfig` | [object](#scatterfieldconfig) | **Yes** | | |
| `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | | `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | |
| `ScatterShow` | string | **Yes** | Possible values are: `points`, `lines`, `points+lines`. | | `ScatterShow` | string | **Yes** | | Possible values are: `points`, `lines`, `points+lines`. |
| `SeriesMapping` | string | **Yes** | Possible values are: `auto`, `manual`. | | `SeriesMapping` | string | **Yes** | | Possible values are: `auto`, `manual`. |
| `XYDimensionConfig` | [object](#xydimensionconfig) | **Yes** | | | `XYDimensionConfig` | [object](#xydimensionconfig) | **Yes** | | |
### PanelOptions ### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip). It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-----------------------------------------------|----------|----------------------------------------------------------------------------| |-----------------|-----------------------------------------------|----------|---------|----------------------------------------------------------------------------|
| `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | | `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | |
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
| `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | | `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | |
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
| `seriesMapping` | string | No | Possible values are: `auto`, `manual`. | | `seriesMapping` | string | No | | Possible values are: `auto`, `manual`. |
### OptionsWithLegend ### OptionsWithLegend
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------------------|----------|-------------| |----------|---------------------------------------|----------|---------|-------------|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs | | `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions ### VizLegendOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `calcs` | string[] | **Yes** | | | `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`. | | `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`. | | `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
| `showLegend` | boolean | **Yes** | | | `showLegend` | boolean | **Yes** | | |
| `asTable` | boolean | No | | | `asTable` | boolean | No | | |
| `isVisible` | boolean | No | | | `isVisible` | boolean | No | | |
| `sortBy` | string | No | | | `sortBy` | string | No | | |
| `sortDesc` | boolean | No | | | `sortDesc` | boolean | No | | |
| `width` | number | No | | | `width` | number | No | | |
### OptionsWithTooltip ### OptionsWithTooltip
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-----------------------------------------|----------|-------------| |-----------|-----------------------------------------|----------|---------|-------------|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs | | `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions ### VizTooltipOptions
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|---------------------------------------------------------------| |----------|--------|----------|---------|---------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs<br/>Possible values are: `single`, `multi`, `none`. | | `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
| `sort` | string | **Yes** | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. | | `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
### ScatterSeriesConfig ### ScatterSeriesConfig
It extends [ScatterFieldConfig](#scatterfieldconfig). It extends [ScatterFieldConfig](#scatterfieldconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `axisCenteredZero` | boolean | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `axisColorMode` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `axisGridShow` | boolean | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `axisLabel` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `axisLabel` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `axisPlacement` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | | `axisPlacement` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
| `axisSoftMax` | number | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `axisSoftMax` | number | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `axisSoftMin` | number | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `axisSoftMin` | number | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `axisWidth` | number | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `axisWidth` | number | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs |
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `label` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. | | `label` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>This is actually an empty interface used mainly for naming? | | `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>This is actually an empty interface used mainly for naming? |
| `lineStyle` | [LineStyle](#linestyle) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs | | `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs |
| `lineWidth` | integer | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>Constraint: `>=0 & <=2147483647`. | | `lineWidth` | integer | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>Constraint: `>=0 & <=2147483647`. |
| `name` | string | No | | | `name` | string | No | | |
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>This is actually an empty interface used mainly for naming? | | `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>This is actually an empty interface used mainly for naming? |
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* | | `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>TODO docs |
| `show` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>Possible values are: `points`, `lines`, `points+lines`. | | `show` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*<br/>Possible values are: `points`, `lines`, `points+lines`. |
| `x` | string | No | | | `x` | string | No | | |
| `y` | string | No | | | `y` | string | No | | |
### ColorDimensionConfig ### ColorDimensionConfig
@ -109,123 +109,123 @@ This is actually an empty interface used mainly for naming?
It extends [BaseDimensionConfig](#basedimensionconfig). It extends [BaseDimensionConfig](#basedimensionconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|----------------------------------------------------------------| |----------|--------|----------|---------|----------------------------------------------------------------|
| `fixed` | | **Yes** | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* | | `fixed` | | **Yes** | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
| `field` | string | No | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* | | `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
### BaseDimensionConfig ### BaseDimensionConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `fixed` | | **Yes** | | | `fixed` | | **Yes** | | |
| `field` | string | No | | | `field` | string | No | | |
### HideSeriesConfig ### HideSeriesConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------|----------|-------------| |-----------|---------|----------|---------|-------------|
| `legend` | boolean | **Yes** | | | `legend` | boolean | **Yes** | | |
| `tooltip` | boolean | **Yes** | | | `tooltip` | boolean | **Yes** | | |
| `viz` | boolean | **Yes** | | | `viz` | boolean | **Yes** | | |
### LineStyle ### LineStyle
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|----------|----------|--------------------------------------------------------| |----------|----------|----------|---------|--------------------------------------------------------|
| `dash` | number[] | No | | | `dash` | number[] | No | | |
| `fill` | string | No | Possible values are: `solid`, `dash`, `dot`, `square`. | | `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
### ScaleDimensionConfig ### ScaleDimensionConfig
It extends [BaseDimensionConfig](#basedimensionconfig). It extends [BaseDimensionConfig](#basedimensionconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|----------------------------------------------------------------| |----------|---------|----------|---------|----------------------------------------------------------------|
| `fixed` | | **Yes** | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* | | `fixed` | | **Yes** | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
| `max` | integer | **Yes** | | | `max` | integer | **Yes** | | |
| `min` | integer | **Yes** | | | `min` | integer | **Yes** | | |
| `field` | string | No | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* | | `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
### ScaleDistributionConfig ### ScaleDistributionConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|--------|----------|--------------------------------------------------------------------------| |-------------------|--------|----------|---------|--------------------------------------------------------------------------|
| `type` | string | **Yes** | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. | | `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
| `linearThreshold` | number | No | | | `linearThreshold` | number | No | | |
| `log` | number | No | | | `log` | number | No | | |
### ScatterFieldConfig ### ScatterFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig). It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisLabel` | string | 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`. | | `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))* | | `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* | | `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | | `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | |
| `label` | string | No | TODO docs<br/>Possible values are: `auto`, `never`, `always`. | | `label` | string | No | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | This is actually an empty interface used mainly for naming? | | `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | This is actually an empty interface used mainly for naming? |
| `lineStyle` | [LineStyle](#linestyle) | No | TODO docs | | `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
| `lineWidth` | integer | No | Constraint: `>=0 & <=2147483647`. | | `lineWidth` | integer | No | | Constraint: `>=0 & <=2147483647`. |
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | This is actually an empty interface used mainly for naming? | | `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | This is actually an empty interface used mainly for naming? |
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | | `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
| `show` | string | No | Possible values are: `points`, `lines`, `points+lines`. | | `show` | string | No | | Possible values are: `points`, `lines`, `points+lines`. |
### AxisConfig ### AxisConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------| |---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
| `axisCenteredZero` | boolean | No | | | `axisCenteredZero` | boolean | No | | |
| `axisColorMode` | string | No | TODO docs<br/>Possible values are: `text`, `series`. | | `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
| `axisGridShow` | boolean | No | | | `axisGridShow` | boolean | No | | |
| `axisLabel` | string | No | | | `axisLabel` | string | No | | |
| `axisPlacement` | string | No | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. | | `axisPlacement` | string | No | | TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
| `axisSoftMax` | number | No | | | `axisSoftMax` | number | No | | |
| `axisSoftMin` | number | No | | | `axisSoftMin` | number | No | | |
| `axisWidth` | number | No | | | `axisWidth` | number | No | | |
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs | | `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### HideableFieldConfig ### HideableFieldConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------------|----------|-------------| |------------|---------------------------------------|----------|---------|-------------|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs | | `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### TextDimensionConfig ### TextDimensionConfig
It extends [BaseDimensionConfig](#basedimensionconfig). It extends [BaseDimensionConfig](#basedimensionconfig).
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|----------------------------------------------------------------| |----------|--------|----------|---------|----------------------------------------------------------------|
| `fixed` | | **Yes** | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* | | `fixed` | | **Yes** | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
| `mode` | string | **Yes** | Possible values are: `fixed`, `field`, `template`. | | `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `template`. |
| `field` | string | No | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* | | `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
### XYDimensionConfig ### XYDimensionConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|----------|----------|-----------------------------------| |-----------|----------|----------|---------|-----------------------------------|
| `frame` | integer | **Yes** | Constraint: `>=0 & <=2147483647`. | | `frame` | integer | **Yes** | | Constraint: `>=0 & <=2147483647`. |
| `exclude` | string[] | No | | | `exclude` | string[] | No | | |
| `x` | string | No | | | `x` | string | No | | |

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

@ -13,336 +13,336 @@ title: Dashboard kind
A Grafana dashboard. A Grafana dashboard.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------------------|-----------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------|-----------------------------------|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `editable` | boolean | **Yes** | Whether a dashboard is editable or not. Default: `true`. | | `editable` | boolean | **Yes** | `true` | Whether a dashboard is editable or not. |
| `graphTooltip` | integer | **Yes** | 0 for no shared crosshair or tooltip (default).<br/>1 for shared crosshair.<br/>2 for shared crosshair AND shared tooltip.<br/>Possible values are: `0`, `1`, `2`. Default: `0`. | | `graphTooltip` | integer | **Yes** | `0` | 0 for no shared crosshair or tooltip (default).<br/>1 for shared crosshair.<br/>2 for shared crosshair AND shared tooltip.<br/>Possible values are: `0`, `1`, `2`. |
| `schemaVersion` | uint16 | **Yes** | Version of the JSON schema, incremented each time a Grafana update brings<br/>changes to said schema.<br/>TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion Default: `36`. | | `schemaVersion` | uint16 | **Yes** | `36` | Version of the JSON schema, incremented each time a Grafana update brings<br/>changes to said schema.<br/>TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion |
| `style` | string | **Yes** | Theme of dashboard.<br/>Possible values are: `dark`, `light`. Default: `dark`. | | `style` | string | **Yes** | `dark` | Theme of dashboard.<br/>Possible values are: `dark`, `light`. |
| `annotations` | [object](#annotations) | No | TODO docs | | `annotations` | [object](#annotations) | No | | TODO docs |
| `description` | string | No | Description of dashboard. | | `description` | string | No | | Description of dashboard. |
| `fiscalYearStartMonth` | integer | No | The month that the fiscal year starts on. 0 = January, 11 = December Default: `0`.<br/>Constraint: `>=0 & <12`. | | `fiscalYearStartMonth` | integer | No | `0` | The month that the fiscal year starts on. 0 = January, 11 = December<br/>Constraint: `>=0 & <12`. |
| `gnetId` | string | No | For dashboards imported from the https://grafana.com/grafana/dashboards/ portal | | `gnetId` | string | No | | For dashboards imported from the https://grafana.com/grafana/dashboards/ portal |
| `id` | integer | No | Unique numeric identifier for the dashboard.<br/>TODO must isolate or remove identifiers local to a Grafana instance...? | | `id` | integer | No | | Unique numeric identifier for the dashboard.<br/>TODO must isolate or remove identifiers local to a Grafana instance...? |
| `links` | [DashboardLink](#dashboardlink)[] | No | TODO docs | | `links` | [DashboardLink](#dashboardlink)[] | No | | TODO docs |
| `liveNow` | boolean | No | When set to true, the dashboard will redraw panels at an interval matching the pixel width.<br/>This will keep data "moving left" regardless of the query refresh rate. This setting helps<br/>avoid dashboards presenting stale live data | | `liveNow` | boolean | No | | When set to true, the dashboard will redraw panels at an interval matching the pixel width.<br/>This will keep data "moving left" regardless of the query refresh rate. This setting helps<br/>avoid dashboards presenting stale live data |
| `panels` | [object](#panels)[] | No | | | `panels` | [object](#panels)[] | No | | |
| `refresh` | | No | Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". | | `refresh` | | No | | Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". |
| `revision` | integer | No | This property should only be used in dashboards defined by plugins. It is a quick check<br/>to see if the version has changed since the last time. Unclear why using the version property<br/>is insufficient. | | `revision` | integer | No | | This property should only be used in dashboards defined by plugins. It is a quick check<br/>to see if the version has changed since the last time. Unclear why using the version property<br/>is insufficient. |
| `snapshot` | [Snapshot](#snapshot) | No | TODO docs | | `snapshot` | [Snapshot](#snapshot) | No | | TODO docs |
| `tags` | string[] | No | Tags associated with dashboard. | | `tags` | string[] | No | | Tags associated with dashboard. |
| `templating` | [object](#templating) | No | TODO docs | | `templating` | [object](#templating) | No | | TODO docs |
| `time` | [object](#time) | No | Time range for dashboard, e.g. last 6 hours, last 7 days, etc | | `time` | [object](#time) | No | | Time range for dashboard, e.g. last 6 hours, last 7 days, etc |
| `timepicker` | [object](#timepicker) | No | TODO docs<br/>TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes | | `timepicker` | [object](#timepicker) | No | | TODO docs<br/>TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes |
| `timezone` | string | No | Timezone of dashboard. Accepts IANA TZDB zone ID or "browser" or "utc". Default: `browser`. | | `timezone` | string | No | `browser` | Timezone of dashboard. Accepts IANA TZDB zone ID or "browser" or "utc". |
| `title` | string | No | Title of dashboard. | | `title` | string | No | | Title of dashboard. |
| `uid` | string | No | Unique dashboard identifier that can be generated by anyone. string (8-40) | | `uid` | string | No | | Unique dashboard identifier that can be generated by anyone. string (8-40) |
| `version` | uint32 | No | Version of the dashboard, incremented each time the dashboard is updated. | | `version` | uint32 | No | | Version of the dashboard, incremented each time the dashboard is updated. |
| `weekStart` | string | No | TODO docs | | `weekStart` | string | No | | TODO docs |
### DashboardLink ### DashboardLink
FROM public/app/features/dashboard/state/DashboardModels.ts - ish FROM public/app/features/dashboard/state/DashboardModels.ts - ish
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|----------|----------|----------------------------------------------------------| |---------------|----------|----------|---------|----------------------------------------------------------|
| `asDropdown` | boolean | **Yes** | Default: `false`. | | `asDropdown` | boolean | **Yes** | `false` | |
| `icon` | string | **Yes** | | | `icon` | string | **Yes** | | |
| `includeVars` | boolean | **Yes** | Default: `false`. | | `includeVars` | boolean | **Yes** | `false` | |
| `keepTime` | boolean | **Yes** | Default: `false`. | | `keepTime` | boolean | **Yes** | `false` | |
| `tags` | string[] | **Yes** | | | `tags` | string[] | **Yes** | | |
| `targetBlank` | boolean | **Yes** | Default: `false`. | | `targetBlank` | boolean | **Yes** | `false` | |
| `title` | string | **Yes** | | | `title` | string | **Yes** | | |
| `tooltip` | string | **Yes** | | | `tooltip` | string | **Yes** | | |
| `type` | string | **Yes** | TODO docs<br/>Possible values are: `link`, `dashboards`. | | `type` | string | **Yes** | | TODO docs<br/>Possible values are: `link`, `dashboards`. |
| `url` | string | **Yes** | | | `url` | string | **Yes** | | |
### Snapshot ### Snapshot
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------|---------|----------|-------------| |---------------|---------|----------|---------|-------------|
| `created` | string | **Yes** | TODO docs | | `created` | string | **Yes** | | TODO docs |
| `expires` | string | **Yes** | TODO docs | | `expires` | string | **Yes** | | TODO docs |
| `externalUrl` | string | **Yes** | TODO docs | | `externalUrl` | string | **Yes** | | TODO docs |
| `external` | boolean | **Yes** | TODO docs | | `external` | boolean | **Yes** | | TODO docs |
| `id` | uint32 | **Yes** | TODO docs | | `id` | uint32 | **Yes** | | TODO docs |
| `key` | string | **Yes** | TODO docs | | `key` | string | **Yes** | | TODO docs |
| `name` | string | **Yes** | TODO docs | | `name` | string | **Yes** | | TODO docs |
| `orgId` | uint32 | **Yes** | TODO docs | | `orgId` | uint32 | **Yes** | | TODO docs |
| `updated` | string | **Yes** | TODO docs | | `updated` | string | **Yes** | | TODO docs |
| `userId` | uint32 | **Yes** | TODO docs | | `userId` | uint32 | **Yes** | | TODO docs |
| `url` | string | No | TODO docs | | `url` | string | No | | TODO docs |
### Annotations ### Annotations
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------------------|----------|-------------| |----------|---------------------------------------|----------|---------|-------------|
| `list` | [AnnotationQuery](#annotationquery)[] | No | | | `list` | [AnnotationQuery](#annotationquery)[] | No | | |
### AnnotationQuery ### AnnotationQuery
TODO docs TODO docs
FROM: AnnotationQuery in grafana-data/src/types/annotations.ts FROM: AnnotationQuery in grafana-data/src/types/annotations.ts
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------|---------------------------------------|----------|-------------------------------------------------| |--------------|---------------------------------------|----------|-------------|-----------------------------------|
| `builtIn` | uint8 | **Yes** | Default: `0`. | | `builtIn` | uint8 | **Yes** | `0` | |
| `datasource` | [object](#datasource) | **Yes** | Datasource to use for annotation. | | `datasource` | [object](#datasource) | **Yes** | | Datasource to use for annotation. |
| `enable` | boolean | **Yes** | Whether annotation is enabled. Default: `true`. | | `enable` | boolean | **Yes** | `true` | Whether annotation is enabled. |
| `showIn` | uint8 | **Yes** | Default: `0`. | | `showIn` | uint8 | **Yes** | `0` | |
| `type` | string | **Yes** | Default: `dashboard`. | | `type` | string | **Yes** | `dashboard` | |
| `hide` | boolean | No | Whether to hide annotation. Default: `false`. | | `hide` | boolean | No | `false` | Whether to hide annotation. |
| `iconColor` | string | No | Annotation icon color. | | `iconColor` | string | No | | Annotation icon color. |
| `name` | string | No | Name of annotation. | | `name` | string | No | | Name of annotation. |
| `rawQuery` | string | No | Query for annotation data. | | `rawQuery` | string | No | | Query for annotation data. |
| `target` | [AnnotationTarget](#annotationtarget) | No | TODO docs | | `target` | [AnnotationTarget](#annotationtarget) | No | | TODO docs |
### AnnotationTarget ### AnnotationTarget
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|----------|----------|-------------| |------------|----------|----------|---------|-------------|
| `limit` | integer | **Yes** | | | `limit` | integer | **Yes** | | |
| `matchAny` | boolean | **Yes** | | | `matchAny` | boolean | **Yes** | | |
| `tags` | string[] | **Yes** | | | `tags` | string[] | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### Datasource ### Datasource
Datasource to use for annotation. Datasource to use for annotation.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `type` | string | No | | | `type` | string | No | | |
| `uid` | string | No | | | `uid` | string | No | | |
### Panels ### Panels
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------------------------------------------------------------------------------------------------|----------|-------------| |----------|-----------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [Panel](#panel), [RowPanel](#rowpanel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | | | `object` | Possible types are: [Panel](#panel), [RowPanel](#rowpanel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
### DataTransformerConfig ### DataTransformerConfig
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------|----------|----------------------------------------------------------------------------------------| |------------|---------------------------------|----------|---------|----------------------------------------------------------------------------------------|
| `id` | string | **Yes** | Unique identifier of transformer | | `id` | string | **Yes** | | Unique identifier of transformer |
| `options` | | **Yes** | Options to be passed to the transformer<br/>Valid options depend on the transformer id | | `options` | | **Yes** | | Options to be passed to the transformer<br/>Valid options depend on the transformer id |
| `disabled` | boolean | No | Disabled transformations are skipped | | `disabled` | boolean | No | | Disabled transformations are skipped |
| `filter` | [MatcherConfig](#matcherconfig) | No | | | `filter` | [MatcherConfig](#matcherconfig) | No | | |
### MatcherConfig ### MatcherConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|--------|----------|--------------| |-----------|--------|----------|---------|-------------|
| `id` | string | **Yes** | Default: ``. | | `id` | string | **Yes** | `` | |
| `options` | | No | | | `options` | | No | | |
### FieldConfigSource ### FieldConfigSource
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|-----------------------------|----------|-------------| |-------------|-----------------------------|----------|---------|-------------|
| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | | `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | |
| `overrides` | [object](#overrides)[] | **Yes** | | | `overrides` | [object](#overrides)[] | **Yes** | | |
### FieldConfig ### FieldConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|---------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `color` | [FieldColor](#fieldcolor) | No | TODO docs | | `color` | [FieldColor](#fieldcolor) | No | | TODO docs |
| `custom` | [object](#custom) | No | custom is specified by the PanelFieldConfig field<br/>in panel plugin schemas. | | `custom` | [object](#custom) | No | | custom is specified by the PanelFieldConfig field<br/>in panel plugin schemas. |
| `decimals` | number | No | Significant digits (for display) | | `decimals` | number | No | | Significant digits (for display) |
| `description` | string | No | Human readable field metadata | | `description` | string | No | | Human readable field metadata |
| `displayNameFromDS` | string | No | This can be used by data sources that return and explicit naming structure for values and labels<br/>When this property is configured, this value is used rather than the default naming strategy. | | `displayNameFromDS` | string | No | | This can be used by data sources that return and explicit naming structure for values and labels<br/>When this property is configured, this value is used rather than the default naming strategy. |
| `displayName` | string | No | The display value for this field. This supports template variables blank is auto | | `displayName` | string | No | | The display value for this field. This supports template variables blank is auto |
| `filterable` | boolean | No | True if data source field supports ad-hoc filters | | `filterable` | boolean | No | | True if data source field supports ad-hoc filters |
| `links` | | No | The behavior when clicking on a result | | `links` | | No | | The behavior when clicking on a result |
| `mappings` | [ValueMapping](#valuemapping)[] | No | Convert input values into a display string | | `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string |
| `max` | number | No | | | `max` | number | No | | |
| `min` | number | No | | | `min` | number | No | | |
| `noValue` | string | No | Alternative to empty string | | `noValue` | string | No | | Alternative to empty string |
| `path` | string | No | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results | | `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results |
| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | | `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | |
| `unit` | string | No | Numeric Options | | `unit` | string | No | | Numeric Options |
| `writeable` | boolean | No | True if data source can write a value to the path. Auth/authz are supported separately | | `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately |
### FieldColor ### FieldColor
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------|--------|----------|----------------------------------------------------------| |--------------|--------|----------|---------|----------------------------------------------------------|
| `mode` | string | **Yes** | The main color scheme mode | | `mode` | string | **Yes** | | The main color scheme mode |
| `fixedColor` | string | No | Stores the fixed color value if mode is fixed | | `fixedColor` | string | No | | Stores the fixed color value if mode is fixed |
| `seriesBy` | string | No | TODO docs<br/>Possible values are: `min`, `max`, `last`. | | `seriesBy` | string | No | | TODO docs<br/>Possible values are: `min`, `max`, `last`. |
### ThresholdsConfig ### ThresholdsConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------------------------|----------|------------------------------------------------------------| |----------|---------------------------|----------|---------|------------------------------------------------------------|
| `mode` | string | **Yes** | Possible values are: `absolute`, `percentage`. | | `mode` | string | **Yes** | | Possible values are: `absolute`, `percentage`. |
| `steps` | [Threshold](#threshold)[] | **Yes** | Must be sorted by 'value', first value is always -Infinity | | `steps` | [Threshold](#threshold)[] | **Yes** | | Must be sorted by 'value', first value is always -Infinity |
### Threshold ### Threshold
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------| |----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| `color` | string | **Yes** | TODO docs | | `color` | string | **Yes** | | TODO docs |
| `index` | integer | No | Threshold index, an old property that is not needed an should only appear in older dashboards | | `index` | integer | No | | Threshold index, an old property that is not needed an should only appear in older dashboards |
| `state` | string | No | TODO docs<br/>TODO are the values here enumerable into a disjunction?<br/>Some seem to be listed in typescript comment | | `state` | string | No | | TODO docs<br/>TODO are the values here enumerable into a disjunction?<br/>Some seem to be listed in typescript comment |
| `value` | number | No | TODO docs<br/>FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON | | `value` | number | No | | TODO docs<br/>FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON |
### ValueMapping ### ValueMapping
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------------------------------------------------------------------------------------------|----------|-------------| |----------|-------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [ValueMap](#valuemap), [RangeMap](#rangemap), [RegexMap](#regexmap), [SpecialValueMap](#specialvaluemap). | | | | `object` | Possible types are: [ValueMap](#valuemap), [RangeMap](#rangemap), [RegexMap](#regexmap), [SpecialValueMap](#specialvaluemap). | | |
### RangeMap ### RangeMap
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|--------------------|----------|-------------| |-----------|--------------------|----------|---------|-------------|
| `options` | [object](#options) | **Yes** | | | `options` | [object](#options) | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### Options ### Options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------------------------------|----------|--------------------------------------------------------------------------------| |----------|-------------------------------------------|----------|---------|--------------------------------------------------------------------------------|
| `from` | number | **Yes** | to and from are `number &#124; null` in current ts, really not sure what to do | | `from` | number | **Yes** | | to and from are `number &#124; null` in current ts, really not sure what to do |
| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | TODO docs | | `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | TODO docs |
| `to` | number | **Yes** | | | `to` | number | **Yes** | | |
### ValueMappingResult ### ValueMappingResult
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|-------------| |----------|---------|----------|---------|-------------|
| `color` | string | No | | | `color` | string | No | | |
| `icon` | string | No | | | `icon` | string | No | | |
| `index` | integer | No | | | `index` | integer | No | | |
| `text` | string | No | | | `text` | string | No | | |
### RegexMap ### RegexMap
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|--------------------|----------|-------------| |-----------|--------------------|----------|---------|-------------|
| `options` | [object](#options) | **Yes** | | | `options` | [object](#options) | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### Options ### Options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-------------------------------------------|----------|-------------| |-----------|-------------------------------------------|----------|---------|-------------|
| `pattern` | string | **Yes** | | | `pattern` | string | **Yes** | | |
| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | TODO docs | | `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | TODO docs |
### SpecialValueMap ### SpecialValueMap
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|--------------------|----------|-------------| |-----------|--------------------|----------|---------|-------------|
| `options` | [object](#options) | **Yes** | | | `options` | [object](#options) | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### Options ### Options
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|-------------------------------------------|----------|---------------------------------------| |-----------|-------------------------------------------|----------|---------|---------------------------------------|
| `match` | string | **Yes** | Possible values are: `true`, `false`. | | `match` | string | **Yes** | | Possible values are: `true`, `false`. |
| `pattern` | string | **Yes** | | | `pattern` | string | **Yes** | | |
| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | TODO docs | | `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | TODO docs |
### ValueMap ### ValueMap
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|------------------------------------------------------|----------|-------------| |-----------|------------------------------------------------------|----------|---------|-------------|
| `options` | map[string][ValueMappingResult](#valuemappingresult) | **Yes** | | | `options` | map[string][ValueMappingResult](#valuemappingresult) | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### Custom ### Custom
custom is specified by the PanelFieldConfig field custom is specified by the PanelFieldConfig field
in panel plugin schemas. in panel plugin schemas.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
### Overrides ### Overrides
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------|---------------------------------------------|----------|-------------| |--------------|---------------------------------------------|----------|---------|-------------|
| `matcher` | [MatcherConfig](#matcherconfig) | **Yes** | | | `matcher` | [MatcherConfig](#matcherconfig) | **Yes** | | |
| `properties` | [DynamicConfigValue](#dynamicconfigvalue)[] | **Yes** | | | `properties` | [DynamicConfigValue](#dynamicconfigvalue)[] | **Yes** | | |
### DynamicConfigValue ### DynamicConfigValue
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|--------------| |----------|--------|----------|---------|-------------|
| `id` | string | **Yes** | Default: ``. | | `id` | string | **Yes** | `` | |
| `value` | | No | | | `value` | | No | | |
### GraphPanel ### GraphPanel
Support for legacy graph and heatmap panels. Support for legacy graph and heatmap panels.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------|----------|----------------------------------------------------| |----------|-------------------|----------|---------|----------------------------------------------------|
| `type` | string | **Yes** | Possible values are: `graph`. | | `type` | string | **Yes** | | Possible values are: `graph`. |
| `legend` | [object](#legend) | No | @deprecated this is part of deprecated graph panel | | `legend` | [object](#legend) | No | | @deprecated this is part of deprecated graph panel |
### Legend ### Legend
@deprecated this is part of deprecated graph panel @deprecated this is part of deprecated graph panel
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------|----------|------------------| |------------|---------|----------|---------|-------------|
| `show` | boolean | **Yes** | Default: `true`. | | `show` | boolean | **Yes** | `true` | |
| `sortDesc` | boolean | No | | | `sortDesc` | boolean | No | | |
| `sort` | string | No | | | `sort` | string | No | | |
### GridPos ### GridPos
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|---------|----------|----------------------------------------------------| |----------|---------|----------|---------|--------------------------------------|
| `h` | uint32 | **Yes** | Panel Default: `9`. | | `h` | uint32 | **Yes** | `9` | Panel |
| `w` | integer | **Yes** | Panel Default: `12`.<br/>Constraint: `>0 & <=24`. | | `w` | integer | **Yes** | `12` | Panel<br/>Constraint: `>0 & <=24`. |
| `x` | integer | **Yes** | Panel x Default: `0`.<br/>Constraint: `>=0 & <24`. | | `x` | integer | **Yes** | `0` | Panel x<br/>Constraint: `>=0 & <24`. |
| `y` | uint32 | **Yes** | Panel y Default: `0`. | | `y` | uint32 | **Yes** | `0` | Panel y |
| `static` | boolean | No | true if fixed | | `static` | boolean | No | | true if fixed |
### HeatmapPanel ### HeatmapPanel
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|---------------------------------| |----------|--------|----------|---------|---------------------------------|
| `type` | string | **Yes** | Possible values are: `heatmap`. | | `type` | string | **Yes** | | Possible values are: `heatmap`. |
### LibraryPanelRef ### LibraryPanelRef
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `name` | string | **Yes** | | | `name` | string | **Yes** | | |
| `uid` | string | **Yes** | | | `uid` | string | **Yes** | | |
### Panel ### Panel
@ -350,87 +350,87 @@ Dashboard panels. Panels are canonically defined inline
because they share a version timeline with the dashboard because they share a version timeline with the dashboard
schema; they do not evolve independently. schema; they do not evolve independently.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------|---------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | | `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | |
| `options` | [object](#options) | **Yes** | options is specified by the PanelOptions field in panel<br/>plugin schemas. | | `options` | [object](#options) | **Yes** | | options is specified by the PanelOptions field in panel<br/>plugin schemas. |
| `repeatDirection` | string | **Yes** | Direction to repeat in if 'repeat' is set.<br/>"h" for horizontal, "v" for vertical.<br/>TODO this is probably optional<br/>Possible values are: `h`, `v`. Default: `h`. | | `repeatDirection` | string | **Yes** | `h` | Direction to repeat in if 'repeat' is set.<br/>"h" for horizontal, "v" for vertical.<br/>TODO this is probably optional<br/>Possible values are: `h`, `v`. |
| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | | `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | |
| `transparent` | boolean | **Yes** | Whether to display the panel without a background. Default: `false`. | | `transparent` | boolean | **Yes** | `false` | Whether to display the panel without a background. |
| `type` | string | **Yes** | The panel plugin type id. May not be empty.<br/>Constraint: `length >=1`. | | `type` | string | **Yes** | | The panel plugin type id. May not be empty.<br/>Constraint: `length >=1`. |
| `datasource` | [object](#datasource) | No | The datasource used in all targets. | | `datasource` | [object](#datasource) | No | | The datasource used in all targets. |
| `description` | string | No | Description. | | `description` | string | No | | Description. |
| `gridPos` | [GridPos](#gridpos) | No | | | `gridPos` | [GridPos](#gridpos) | No | | |
| `id` | uint32 | No | TODO docs | | `id` | uint32 | No | | TODO docs |
| `interval` | string | No | TODO docs<br/>TODO tighter constraint | | `interval` | string | No | | TODO docs<br/>TODO tighter constraint |
| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | | `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | |
| `links` | [DashboardLink](#dashboardlink)[] | No | Panel links.<br/>TODO fill this out - seems there are a couple variants? | | `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links.<br/>TODO fill this out - seems there are a couple variants? |
| `maxDataPoints` | number | No | TODO docs | | `maxDataPoints` | number | No | | TODO docs |
| `pluginVersion` | string | No | FIXME this almost certainly has to be changed in favor of scuemata versions | | `pluginVersion` | string | No | | FIXME this almost certainly has to be changed in favor of scuemata versions |
| `repeatPanelId` | integer | No | Id of the repeating panel. | | `repeatPanelId` | integer | No | | Id of the repeating panel. |
| `repeat` | string | No | Name of template variable to repeat for. | | `repeat` | string | No | | Name of template variable to repeat for. |
| `tags` | string[] | No | TODO docs | | `tags` | string[] | No | | TODO docs |
| `targets` | [Target](#target)[] | No | TODO docs | | `targets` | [Target](#target)[] | No | | TODO docs |
| `thresholds` | | No | TODO docs - seems to be an old field from old dashboard alerts? | | `thresholds` | | No | | TODO docs - seems to be an old field from old dashboard alerts? |
| `timeFrom` | string | No | TODO docs<br/>TODO tighter constraint | | `timeFrom` | string | No | | TODO docs<br/>TODO tighter constraint |
| `timeRegions` | | No | TODO docs | | `timeRegions` | | No | | TODO docs |
| `timeShift` | string | No | TODO docs<br/>TODO tighter constraint | | `timeShift` | string | No | | TODO docs<br/>TODO tighter constraint |
| `title` | string | No | Panel title. | | `title` | string | No | | Panel title. |
### FieldConfigSource ### FieldConfigSource
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|-----------------------------|----------|-------------| |-------------|-----------------------------|----------|---------|-------------|
| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | | `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | |
| `overrides` | [overrides](#overrides)[] | **Yes** | | | `overrides` | [overrides](#overrides)[] | **Yes** | | |
### FieldConfig ### FieldConfig
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|---------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `color` | [FieldColor](#fieldcolor) | No | TODO docs | | `color` | [FieldColor](#fieldcolor) | No | | TODO docs |
| `custom` | [custom](#custom) | No | custom is specified by the PanelFieldConfig field<br/>in panel plugin schemas. | | `custom` | [custom](#custom) | No | | custom is specified by the PanelFieldConfig field<br/>in panel plugin schemas. |
| `decimals` | number | No | Significant digits (for display) | | `decimals` | number | No | | Significant digits (for display) |
| `description` | string | No | Human readable field metadata | | `description` | string | No | | Human readable field metadata |
| `displayNameFromDS` | string | No | This can be used by data sources that return and explicit naming structure for values and labels<br/>When this property is configured, this value is used rather than the default naming strategy. | | `displayNameFromDS` | string | No | | This can be used by data sources that return and explicit naming structure for values and labels<br/>When this property is configured, this value is used rather than the default naming strategy. |
| `displayName` | string | No | The display value for this field. This supports template variables blank is auto | | `displayName` | string | No | | The display value for this field. This supports template variables blank is auto |
| `filterable` | boolean | No | True if data source field supports ad-hoc filters | | `filterable` | boolean | No | | True if data source field supports ad-hoc filters |
| `links` | | No | The behavior when clicking on a result | | `links` | | No | | The behavior when clicking on a result |
| `mappings` | [ValueMapping](#valuemapping)[] | No | Convert input values into a display string | | `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string |
| `max` | number | No | | | `max` | number | No | | |
| `min` | number | No | | | `min` | number | No | | |
| `noValue` | string | No | Alternative to empty string | | `noValue` | string | No | | Alternative to empty string |
| `path` | string | No | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results | | `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results |
| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | | `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | |
| `unit` | string | No | Numeric Options | | `unit` | string | No | | Numeric Options |
| `writeable` | boolean | No | True if data source can write a value to the path. Auth/authz are supported separately | | `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately |
### RangeMap ### RangeMap
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------------------|----------|-------------| |-----------|---------------------|----------|---------|-------------|
| `options` | [options](#options) | **Yes** | | | `options` | [options](#options) | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### RegexMap ### RegexMap
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------------------|----------|-------------| |-----------|---------------------|----------|---------|-------------|
| `options` | [options](#options) | **Yes** | | | `options` | [options](#options) | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### SpecialValueMap ### SpecialValueMap
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|---------------------|----------|-------------| |-----------|---------------------|----------|---------|-------------|
| `options` | [options](#options) | **Yes** | | | `options` | [options](#options) | **Yes** | | |
| `type` | string | **Yes** | | | `type` | string | **Yes** | | |
### Target ### Target
@ -442,64 +442,64 @@ with types derived from plugins in the Instance variant.
When working directly from CUE, importers can extend this When working directly from CUE, importers can extend this
type directly to achieve the same effect. type directly to achieve the same effect.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
### Datasource ### Datasource
The datasource used in all targets. The datasource used in all targets.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `type` | string | No | | | `type` | string | No | | |
| `uid` | string | No | | | `uid` | string | No | | |
### Options ### Options
options is specified by the PanelOptions field in panel options is specified by the PanelOptions field in panel
plugin schemas. plugin schemas.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
### RowPanel ### RowPanel
Row panel Row panel
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------|-----------------------|----------|------------------------------------------| |--------------|-----------------------|----------|---------|------------------------------------------|
| `collapsed` | boolean | **Yes** | Default: `false`. | | `collapsed` | boolean | **Yes** | `false` | |
| `id` | uint32 | **Yes** | | | `id` | uint32 | **Yes** | | |
| `panels` | [panels](#panels)[] | **Yes** | | | `panels` | [panels](#panels)[] | **Yes** | | |
| `type` | string | **Yes** | Possible values are: `row`. | | `type` | string | **Yes** | | Possible values are: `row`. |
| `datasource` | [object](#datasource) | No | Name of default datasource. | | `datasource` | [object](#datasource) | No | | Name of default datasource. |
| `gridPos` | [GridPos](#gridpos) | No | | | `gridPos` | [GridPos](#gridpos) | No | | |
| `repeat` | string | No | Name of template variable to repeat for. | | `repeat` | string | No | | Name of template variable to repeat for. |
| `title` | string | No | | | `title` | string | No | | |
### Datasource ### Datasource
Name of default datasource. Name of default datasource.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------| |----------|--------|----------|---------|-------------|
| `type` | string | No | | | `type` | string | No | | |
| `uid` | string | No | | | `uid` | string | No | | |
### Panels ### Panels
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------------------------------------------------------------------------------------------------|----------|-------------| |----------|------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [Panel](#panel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | | | `object` | Possible types are: [Panel](#panel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
### GraphPanel ### GraphPanel
Support for legacy graph and heatmap panels. Support for legacy graph and heatmap panels.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-------------------|----------|----------------------------------------------------| |----------|-------------------|----------|---------|----------------------------------------------------|
| `type` | string | **Yes** | Possible values are: `graph`. | | `type` | string | **Yes** | | Possible values are: `graph`. |
| `legend` | [legend](#legend) | No | @deprecated this is part of deprecated graph panel | | `legend` | [legend](#legend) | No | | @deprecated this is part of deprecated graph panel |
### Panel ### Panel
@ -507,40 +507,40 @@ Dashboard panels. Panels are canonically defined inline
because they share a version timeline with the dashboard because they share a version timeline with the dashboard
schema; they do not evolve independently. schema; they do not evolve independently.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------|---------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | | `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | |
| `options` | [options](#options) | **Yes** | options is specified by the PanelOptions field in panel<br/>plugin schemas. | | `options` | [options](#options) | **Yes** | | options is specified by the PanelOptions field in panel<br/>plugin schemas. |
| `repeatDirection` | string | **Yes** | Direction to repeat in if 'repeat' is set.<br/>"h" for horizontal, "v" for vertical.<br/>TODO this is probably optional<br/>Possible values are: `h`, `v`. Default: `h`. | | `repeatDirection` | string | **Yes** | `h` | Direction to repeat in if 'repeat' is set.<br/>"h" for horizontal, "v" for vertical.<br/>TODO this is probably optional<br/>Possible values are: `h`, `v`. |
| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | | `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | |
| `transparent` | boolean | **Yes** | Whether to display the panel without a background. Default: `false`. | | `transparent` | boolean | **Yes** | `false` | Whether to display the panel without a background. |
| `type` | string | **Yes** | The panel plugin type id. May not be empty.<br/>Constraint: `length >=1`. | | `type` | string | **Yes** | | The panel plugin type id. May not be empty.<br/>Constraint: `length >=1`. |
| `datasource` | [datasource](#datasource) | No | The datasource used in all targets. | | `datasource` | [datasource](#datasource) | No | | The datasource used in all targets. |
| `description` | string | No | Description. | | `description` | string | No | | Description. |
| `gridPos` | [GridPos](#gridpos) | No | | | `gridPos` | [GridPos](#gridpos) | No | | |
| `id` | uint32 | No | TODO docs | | `id` | uint32 | No | | TODO docs |
| `interval` | string | No | TODO docs<br/>TODO tighter constraint | | `interval` | string | No | | TODO docs<br/>TODO tighter constraint |
| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | | `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | |
| `links` | [DashboardLink](#dashboardlink)[] | No | Panel links.<br/>TODO fill this out - seems there are a couple variants? | | `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links.<br/>TODO fill this out - seems there are a couple variants? |
| `maxDataPoints` | number | No | TODO docs | | `maxDataPoints` | number | No | | TODO docs |
| `pluginVersion` | string | No | FIXME this almost certainly has to be changed in favor of scuemata versions | | `pluginVersion` | string | No | | FIXME this almost certainly has to be changed in favor of scuemata versions |
| `repeatPanelId` | integer | No | Id of the repeating panel. | | `repeatPanelId` | integer | No | | Id of the repeating panel. |
| `repeat` | string | No | Name of template variable to repeat for. | | `repeat` | string | No | | Name of template variable to repeat for. |
| `tags` | string[] | No | TODO docs | | `tags` | string[] | No | | TODO docs |
| `targets` | [Target](#target)[] | No | TODO docs | | `targets` | [Target](#target)[] | No | | TODO docs |
| `thresholds` | | No | TODO docs - seems to be an old field from old dashboard alerts? | | `thresholds` | | No | | TODO docs - seems to be an old field from old dashboard alerts? |
| `timeFrom` | string | No | TODO docs<br/>TODO tighter constraint | | `timeFrom` | string | No | | TODO docs<br/>TODO tighter constraint |
| `timeRegions` | | No | TODO docs | | `timeRegions` | | No | | TODO docs |
| `timeShift` | string | No | TODO docs<br/>TODO tighter constraint | | `timeShift` | string | No | | TODO docs<br/>TODO tighter constraint |
| `title` | string | No | Panel title. | | `title` | string | No | | Panel title. |
### Templating ### Templating
TODO docs TODO docs
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|-----------------------------------|----------|-------------| |----------|-----------------------------------|----------|---------|-------------|
| `list` | [VariableModel](#variablemodel)[] | No | | | `list` | [VariableModel](#variablemodel)[] | No | | |
### VariableModel ### VariableModel
@ -549,57 +549,57 @@ TODO docs
TODO what about what's in public/app/features/types.ts? TODO what about what's in public/app/features/types.ts?
TODO there appear to be a lot of different kinds of [template] vars here? if so need a disjunction TODO there appear to be a lot of different kinds of [template] vars here? if so need a disjunction
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------------|---------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------------|---------------------------------|----------|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `global` | boolean | **Yes** | Default: `false`. | | `global` | boolean | **Yes** | `false` | |
| `hide` | integer | **Yes** | Possible values are: `0`, `1`, `2`. | | `hide` | integer | **Yes** | | Possible values are: `0`, `1`, `2`. |
| `id` | string | **Yes** | Default: `00000000-0000-0000-0000-000000000000`. | | `id` | string | **Yes** | `00000000-0000-0000-0000-000000000000` | |
| `index` | int32 | **Yes** | Default: `-1`. | | `index` | int32 | **Yes** | `-1` | |
| `name` | string | **Yes** | | | `name` | string | **Yes** | | |
| `skipUrlSync` | boolean | **Yes** | Default: `false`. | | `skipUrlSync` | boolean | **Yes** | `false` | |
| `state` | string | **Yes** | Possible values are: `NotStarted`, `Loading`, `Streaming`, `Done`, `Error`. | | `state` | string | **Yes** | | Possible values are: `NotStarted`, `Loading`, `Streaming`, `Done`, `Error`. |
| `type` | string | **Yes** | FROM: packages/grafana-data/src/types/templateVars.ts<br/>TODO docs<br/>TODO this implies some wider pattern/discriminated union, probably?<br/>Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. | | `type` | string | **Yes** | | FROM: packages/grafana-data/src/types/templateVars.ts<br/>TODO docs<br/>TODO this implies some wider pattern/discriminated union, probably?<br/>Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. |
| `datasource` | [DataSourceRef](#datasourceref) | No | Ref to a DataSource instance | | `datasource` | [DataSourceRef](#datasourceref) | No | | Ref to a DataSource instance |
| `description` | string | No | | | `description` | string | No | | |
| `error` | [object](#error) | No | | | `error` | [object](#error) | No | | |
| `label` | string | No | | | `label` | string | No | | |
| `query` | | No | TODO: Move this into a separated QueryVariableModel type | | `query` | | No | | TODO: Move this into a separated QueryVariableModel type |
| `rootStateKey` | string | No | | | `rootStateKey` | string | No | | |
### DataSourceRef ### DataSourceRef
Ref to a DataSource instance Ref to a DataSource instance
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|------------------------------| |----------|--------|----------|---------|------------------------------|
| `type` | string | No | The plugin type-id | | `type` | string | No | | The plugin type-id |
| `uid` | string | No | Specific datasource instance | | `uid` | string | No | | Specific datasource instance |
### Error ### Error
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|
### Time ### Time
Time range for dashboard, e.g. last 6 hours, last 7 days, etc Time range for dashboard, e.g. last 6 hours, last 7 days, etc
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|--------------------| |----------|--------|----------|----------|-------------|
| `from` | string | **Yes** | Default: `now-6h`. | | `from` | string | **Yes** | `now-6h` | |
| `to` | string | **Yes** | Default: `now`. | | `to` | string | **Yes** | `now` | |
### Timepicker ### Timepicker
TODO docs TODO docs
TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|---------------------|----------|----------|----------------------------------------------------------------------------------------| |---------------------|----------|----------|---------------------------------------|-----------------------------------------|
| `collapse` | boolean | **Yes** | Whether timepicker is collapsed or not. Default: `false`. | | `collapse` | boolean | **Yes** | `false` | Whether timepicker is collapsed or not. |
| `enable` | boolean | **Yes** | Whether timepicker is enabled or not. Default: `true`. | | `enable` | boolean | **Yes** | `true` | Whether timepicker is enabled or not. |
| `hidden` | boolean | **Yes** | Whether timepicker is visible or not. Default: `false`. | | `hidden` | boolean | **Yes** | `false` | Whether timepicker is visible or not. |
| `refresh_intervals` | string[] | **Yes** | Selectable intervals for auto-refresh. Default: `[5s 10s 30s 1m 5m 15m 30m 1h 2h 1d]`. | | `refresh_intervals` | string[] | **Yes** | `[5s 10s 30s 1m 5m 15m 30m 1h 2h 1d]` | Selectable intervals for auto-refresh. |
| `time_options` | string[] | **Yes** | TODO docs Default: `[5m 15m 1h 6h 12h 24h 2d 7d 30d]`. | | `time_options` | string[] | **Yes** | `[5m 15m 1h 6h 12h 24h 2d 7d 30d]` | TODO docs |

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

@ -13,44 +13,44 @@ title: LibraryPanel kind
A standalone panel A standalone panel
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|-------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------| |-----------------|-------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
| `model` | [object](#model) | **Yes** | TODO: should be the same panel schema defined in dashboard<br/>Typescript: Omit<Panel, 'gridPos' &#124; 'id' &#124; 'libraryPanel'>; | | `model` | [object](#model) | **Yes** | | TODO: should be the same panel schema defined in dashboard<br/>Typescript: Omit<Panel, 'gridPos' &#124; 'id' &#124; 'libraryPanel'>; |
| `name` | string | **Yes** | Panel name (also saved in the model)<br/>Constraint: `length >=1`. | | `name` | string | **Yes** | | Panel name (also saved in the model)<br/>Constraint: `length >=1`. |
| `type` | string | **Yes** | The panel type (from inside the model)<br/>Constraint: `length >=1`. | | `type` | string | **Yes** | | The panel type (from inside the model)<br/>Constraint: `length >=1`. |
| `uid` | string | **Yes** | Library element UID | | `uid` | string | **Yes** | | Library element UID |
| `version` | integer | **Yes** | panel version, incremented each time the dashboard is updated. | | `version` | integer | **Yes** | | panel version, incremented each time the dashboard is updated. |
| `description` | string | No | Panel description | | `description` | string | No | | Panel description |
| `folderUid` | string | No | Folder UID | | `folderUid` | string | No | | Folder UID |
| `meta` | [LibraryElementDTOMeta](#libraryelementdtometa) | No | | | `meta` | [LibraryElementDTOMeta](#libraryelementdtometa) | No | | |
| `schemaVersion` | uint16 | No | Dashboard version when this was saved (zero if unknown) | | `schemaVersion` | uint16 | No | | Dashboard version when this was saved (zero if unknown) |
### LibraryElementDTOMeta ### LibraryElementDTOMeta
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------------|---------------------------------------------------------|----------|-------------| |-----------------------|---------------------------------------------------------|----------|---------|-------------|
| `connectedDashboards` | integer | **Yes** | | | `connectedDashboards` | integer | **Yes** | | |
| `createdBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | | `createdBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | |
| `created` | string | **Yes** | | | `created` | string | **Yes** | | |
| `folderName` | string | **Yes** | | | `folderName` | string | **Yes** | | |
| `folderUid` | string | **Yes** | | | `folderUid` | string | **Yes** | | |
| `updatedBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | | `updatedBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | |
| `updated` | string | **Yes** | | | `updated` | string | **Yes** | | |
### LibraryElementDTOMetaUser ### LibraryElementDTOMetaUser
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-------------|---------|----------|-------------| |-------------|---------|----------|---------|-------------|
| `avatarUrl` | string | **Yes** | | | `avatarUrl` | string | **Yes** | | |
| `id` | integer | **Yes** | | | `id` | integer | **Yes** | | |
| `name` | string | **Yes** | | | `name` | string | **Yes** | | |
### Model ### Model
TODO: should be the same panel schema defined in dashboard TODO: should be the same panel schema defined in dashboard
Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>; Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|------|----------|-------------| |----------|------|----------|---------|-------------|

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

@ -13,19 +13,19 @@ title: Playlist kind
A playlist is a series of dashboards that is automatically rotated in the browser, on a configurable interval. A playlist is a series of dashboards that is automatically rotated in the browser, on a configurable interval.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------|---------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|---------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `interval` | string | **Yes** | Interval sets the time between switching views in a playlist.<br/>FIXME: Is this based on a standardized format or what options are available? Can datemath be used? Default: `5m`. | | `interval` | string | **Yes** | `5m` | Interval sets the time between switching views in a playlist.<br/>FIXME: Is this based on a standardized format or what options are available? Can datemath be used? |
| `name` | string | **Yes** | Name of the playlist. | | `name` | string | **Yes** | | Name of the playlist. |
| `uid` | string | **Yes** | Unique playlist identifier. Generated on creation, either by the<br/>creator of the playlist of by the application. | | `uid` | string | **Yes** | | Unique playlist identifier. Generated on creation, either by the<br/>creator of the playlist of by the application. |
| `items` | [PlaylistItem](#playlistitem)[] | No | The ordered list of items that the playlist will iterate over.<br/>FIXME! This should not be optional, but changing it makes the godegen awkward | | `items` | [PlaylistItem](#playlistitem)[] | No | | The ordered list of items that the playlist will iterate over.<br/>FIXME! This should not be optional, but changing it makes the godegen awkward |
### PlaylistItem ### PlaylistItem
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|----------|--------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |----------|--------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `type` | string | **Yes** | Type of the item.<br/>Possible values are: `dashboard_by_uid`, `dashboard_by_id`, `dashboard_by_tag`. | | `type` | string | **Yes** | | Type of the item.<br/>Possible values are: `dashboard_by_uid`, `dashboard_by_id`, `dashboard_by_tag`. |
| `value` | string | **Yes** | Value depends on type and describes the playlist item.<br/><br/> - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This<br/> is not portable as the numerical identifier is non-deterministic between different instances.<br/> Will be replaced by dashboard_by_uid in the future. (deprecated)<br/> - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All<br/> dashboards behind the tag will be added to the playlist.<br/> - dashboard_by_uid: The value is the dashboard UID | | `value` | string | **Yes** | | Value depends on type and describes the playlist item.<br/><br/> - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This<br/> is not portable as the numerical identifier is non-deterministic between different instances.<br/> Will be replaced by dashboard_by_uid in the future. (deprecated)<br/> - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All<br/> dashboards behind the tag will be added to the playlist.<br/> - dashboard_by_uid: The value is the dashboard UID |
| `title` | string | No | Title is an unused property -- it will be removed in the future | | `title` | string | No | | Title is an unused property -- it will be removed in the future |

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

@ -13,19 +13,19 @@ title: Preferences kind
The user or team frontend preferences The user or team frontend preferences
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|--------------------|---------------------------------------------------|----------|---------------------------------------------------------------------------------| |--------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------|
| `homeDashboardUID` | string | No | UID for the home dashboard | | `homeDashboardUID` | string | No | | UID for the home dashboard |
| `language` | string | No | Selected language (beta) | | `language` | string | No | | Selected language (beta) |
| `queryHistory` | [QueryHistoryPreference](#queryhistorypreference) | No | | | `queryHistory` | [QueryHistoryPreference](#queryhistorypreference) | No | | |
| `theme` | string | No | light, dark, empty is default | | `theme` | string | No | | light, dark, empty is default |
| `timezone` | string | No | The timezone selection<br/>TODO: this should use the timezone defined in common | | `timezone` | string | No | | The timezone selection<br/>TODO: this should use the timezone defined in common |
| `weekStart` | string | No | day of the week (sunday, monday, etc) | | `weekStart` | string | No | | day of the week (sunday, monday, etc) |
### QueryHistoryPreference ### QueryHistoryPreference
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------|--------|----------|---------------------------------------------| |-----------|--------|----------|---------|---------------------------------------------|
| `homeTab` | string | No | one of: '' &#124; 'query' &#124; 'starred'; | | `homeTab` | string | No | | one of: '' &#124; 'query' &#124; 'starred'; |

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

@ -13,13 +13,13 @@ title: PublicDashboard kind
Public dashboard configuration Public dashboard configuration
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|------------------------|---------|----------|-----------------------------------------------------------------| |------------------------|---------|----------|---------|-----------------------------------------------------------------|
| `annotationsEnabled` | boolean | **Yes** | Flag that indicates if annotations are enabled | | `annotationsEnabled` | boolean | **Yes** | | Flag that indicates if annotations are enabled |
| `dashboardUid` | string | **Yes** | Dashboard unique identifier referenced by this public dashboard | | `dashboardUid` | string | **Yes** | | Dashboard unique identifier referenced by this public dashboard |
| `isEnabled` | boolean | **Yes** | Flag that indicates if the public dashboard is enabled | | `isEnabled` | boolean | **Yes** | | Flag that indicates if the public dashboard is enabled |
| `timeSelectionEnabled` | boolean | **Yes** | Flag that indicates if the time range picker is enabled | | `timeSelectionEnabled` | boolean | **Yes** | | Flag that indicates if the time range picker is enabled |
| `uid` | string | **Yes** | Unique public dashboard identifier | | `uid` | string | **Yes** | | Unique public dashboard identifier |
| `accessToken` | string | No | Unique public access token | | `accessToken` | string | No | | Unique public access token |

28
docs/sources/developers/kinds/core/serviceaccount/schema-reference.md
View File

@ -13,19 +13,19 @@ title: ServiceAccount kind
system account system account
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|--------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------| |-----------------|--------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `avatarUrl` | string | **Yes** | AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front<br/>of the service account. | | `avatarUrl` | string | **Yes** | | AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front<br/>of the service account. |
| `id` | integer | **Yes** | ID is the unique identifier of the service account in the database. | | `id` | integer | **Yes** | | ID is the unique identifier of the service account in the database. |
| `isDisabled` | boolean | **Yes** | IsDisabled indicates if the service account is disabled. | | `isDisabled` | boolean | **Yes** | | IsDisabled indicates if the service account is disabled. |
| `login` | string | **Yes** | Login of the service account. | | `login` | string | **Yes** | | Login of the service account. |
| `name` | string | **Yes** | Name of the service account. | | `name` | string | **Yes** | | Name of the service account. |
| `orgId` | integer | **Yes** | OrgId is the ID of an organisation the service account belongs to. | | `orgId` | integer | **Yes** | | OrgId is the ID of an organisation the service account belongs to. |
| `role` | string | **Yes** | OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'.<br/>Possible values are: `Admin`, `Editor`, `Viewer`. | | `role` | string | **Yes** | | OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'.<br/>Possible values are: `Admin`, `Editor`, `Viewer`. |
| `tokens` | integer | **Yes** | Tokens is the number of active tokens for the service account.<br/>Tokens are used to authenticate the service account against Grafana. | | `tokens` | integer | **Yes** | | Tokens is the number of active tokens for the service account.<br/>Tokens are used to authenticate the service account against Grafana. |
| `accessControl` | map[string]boolean | No | AccessControl metadata associated with a given resource. | | `accessControl` | map[string]boolean | No | | AccessControl metadata associated with a given resource. |
| `created` | string | No | Created indicates when the service account was created. | | `created` | string | No | | Created indicates when the service account was created. |
| `teams` | string[] | No | Teams is a list of teams the service account belongs to. | | `teams` | string[] | No | | Teams is a list of teams the service account belongs to. |
| `updated` | string | No | Updated indicates when the service account was updated. | | `updated` | string | No | | Updated indicates when the service account was updated. |

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

@ -13,16 +13,16 @@ title: Team kind
A team is a named grouping of Grafana users to which access control rules may be assigned. A team is a named grouping of Grafana users to which access control rules may be assigned.
| Property | Type | Required | Description | | Property | Type | Required | Default | Description |
|-----------------|--------------------|----------|----------------------------------------------------------| |-----------------|--------------------|----------|---------|----------------------------------------------------------|
| `created` | string | **Yes** | Created indicates when the team was created. | | `created` | string | **Yes** | | Created indicates when the team was created. |
| `memberCount` | integer | **Yes** | MemberCount is the number of the team members. | | `memberCount` | integer | **Yes** | | MemberCount is the number of the team members. |
| `name` | string | **Yes** | Name of the team. | | `name` | string | **Yes** | | Name of the team. |
| `orgId` | integer | **Yes** | OrgId is the ID of an organisation the team belongs to. | | `orgId` | integer | **Yes** | | OrgId is the ID of an organisation the team belongs to. |
| `permission` | integer | **Yes** | Possible values are: `0`, `1`, `2`, `4`. | | `permission` | integer | **Yes** | | Possible values are: `0`, `1`, `2`, `4`. |
| `updated` | string | **Yes** | Updated indicates when the team was updated. | | `updated` | string | **Yes** | | Updated indicates when the team was updated. |
| `accessControl` | map[string]boolean | No | AccessControl metadata associated with a given resource. | | `accessControl` | map[string]boolean | No | | AccessControl metadata associated with a given resource. |
| `avatarUrl` | string | No | AvatarUrl is the team's avatar URL. | | `avatarUrl` | string | No | | AvatarUrl is the team's avatar URL. |
| `email` | string | No | Email of the team. | | `email` | string | No | | Email of the team. |

7
pkg/codegen/jenny_docs.go
View File

@ -371,7 +371,7 @@ func (md mdSection) write(w io.Writer) {
} }
table := tablewriter.NewWriter(w) table := tablewriter.NewWriter(w)
table.SetHeader([]string{"Property", "Type", "Required", "Description"}) table.SetHeader([]string{"Property", "Type", "Required", "Default", "Description"})
table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false}) table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
table.SetCenterSeparator("|") table.SetCenterSeparator("|")
table.SetAutoFormatHeaders(false) table.SetAutoFormatHeaders(false)
@ -558,15 +558,16 @@ func makeRows(s *schema) [][]string {
desc += "\nPossible values are: `" + strings.Join(vals, "`, `") + "`." desc += "\nPossible values are: `" + strings.Join(vals, "`, `") + "`."
} }
var defaultValue string
if p.Default != nil { if p.Default != nil {
desc += fmt.Sprintf(" Default: `%v`.", p.Default) defaultValue = fmt.Sprintf("`%v`", p.Default)
} }
// Render a constraint only if it's not a type alias https://cuelang.org/docs/references/spec/#predeclared-identifiers // Render a constraint only if it's not a type alias https://cuelang.org/docs/references/spec/#predeclared-identifiers
if alias == "" { if alias == "" {
desc += constraintDescr(p) desc += constraintDescr(p)
} }
rows = append(rows, []string{fmt.Sprintf("`%s`", key), typeStr, required, formatForTable(desc)}) rows = append(rows, []string{fmt.Sprintf("`%s`", key), typeStr, required, defaultValue, formatForTable(desc)})
} }
// Sort by the required column, then by the name column. // Sort by the required column, then by the name column.