diff --git a/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md
index 9afa576f4c3..40697956a47 100644
--- a/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md
@@ -13,16 +13,16 @@ title: AlertGroupsPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
-| Property | Type | Required | Description |
-|----------------|---------|----------|-------------------------------------------------------------|
-| `alertmanager` | string | **Yes** | Name of the alertmanager used as a source for alerts |
-| `expandAll` | boolean | **Yes** | Expand all alert groups by default |
-| `labels` | string | **Yes** | Comma-separated list of values used to filter alert results |
+| Property | Type | Required | Default | Description |
+|----------------|---------|----------|---------|-------------------------------------------------------------|
+| `alertmanager` | string | **Yes** | | Name of the alertmanager used as a source for alerts |
+| `expandAll` | boolean | **Yes** | | Expand all alert groups by default |
+| `labels` | string | **Yes** | | Comma-separated list of values used to filter alert results |
diff --git a/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md
index 743e30ade22..b5d98acf461 100644
--- a/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md
@@ -13,23 +13,23 @@ title: AnnotationsListPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
-| Property | Type | Required | Description |
-|-------------------------|----------|----------|-------------------|
-| `limit` | uint32 | **Yes** | Default: `10`. |
-| `navigateAfter` | string | **Yes** | Default: `10m`. |
-| `navigateBefore` | string | **Yes** | Default: `10m`. |
-| `navigateToPanel` | boolean | **Yes** | Default: `true`. |
-| `onlyFromThisDashboard` | boolean | **Yes** | Default: `false`. |
-| `onlyInTimeRange` | boolean | **Yes** | Default: `false`. |
-| `showTags` | boolean | **Yes** | Default: `true`. |
-| `showTime` | boolean | **Yes** | Default: `true`. |
-| `showUser` | boolean | **Yes** | Default: `true`. |
-| `tags` | string[] | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-------------------------|----------|----------|---------|-------------|
+| `limit` | uint32 | **Yes** | `10` | |
+| `navigateAfter` | string | **Yes** | `10m` | |
+| `navigateBefore` | string | **Yes** | `10m` | |
+| `navigateToPanel` | boolean | **Yes** | `true` | |
+| `onlyFromThisDashboard` | boolean | **Yes** | `false` | |
+| `onlyInTimeRange` | boolean | **Yes** | `false` | |
+| `showTags` | boolean | **Yes** | `true` | |
+| `showTime` | boolean | **Yes** | `true` | |
+| `showUser` | boolean | **Yes** | `true` | |
+| `tags` | string[] | **Yes** | | |
diff --git a/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md b/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md
index d94e3200e87..5b73ca87685 100644
--- a/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md
@@ -13,7 +13,7 @@ title: AzureMonitorDataQuery kind
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
diff --git a/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md
index 9db2c67df42..42042d782e2 100644
--- a/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md
@@ -13,162 +13,162 @@ title: BarChartPanelCfg kind
-| Property | Type | Required | Description |
-|--------------------|-----------------------------|----------|-------------|
-| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|--------------------|-----------------------------|----------|---------|-------------|
+| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisLabel` | string | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisPlacement` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `fillOpacity` | integer | No | Controls the fill opacity of the bars. Default: `80`.
Constraint: `>=0 & <=100`. |
-| `gradientMode` | string | No | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. |
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
-| `lineWidth` | integer | No | Controls line width of the bars. Default: `1`.
Constraint: `>=0 & <=10`. |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
-| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.
Constraint: `>=0 & <=100`. |
+| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. |
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
+| `lineWidth` | integer | No | `1` | Controls line width of the bars.
Constraint: `>=0 & <=10`. |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
+| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
### AxisConfig
TODO docs
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | |
-| `axisColorMode` | string | No | TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | |
-| `axisLabel` | string | No | |
-| `axisPlacement` | string | No | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | |
-| `axisSoftMin` | number | No | |
-| `axisWidth` | number | No | |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | |
+| `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | |
+| `axisLabel` | string | No | | |
+| `axisPlacement` | string | No | | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | |
+| `axisSoftMin` | number | No | | |
+| `axisWidth` | number | No | | |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### ScaleDistributionConfig
TODO docs
-| Property | Type | Required | Description |
-|-------------------|--------|----------|--------------------------------------------------------------------------|
-| `type` | string | **Yes** | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
-| `linearThreshold` | number | No | |
-| `log` | number | No | |
+| Property | Type | Required | Default | Description |
+|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
+| `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
+| `linearThreshold` | number | No | | |
+| `log` | number | No | | |
### GraphThresholdsStyleConfig
TODO docs
-| Property | Type | Required | Description |
-|----------|--------|----------|-----------------------------------------------------------------------------------------------------------|
-| `mode` | string | **Yes** | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
+| `mode` | string | **Yes** | | TODO docs
Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
### HideSeriesConfig
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------|----------|-------------|
-| `legend` | boolean | **Yes** | |
-| `tooltip` | boolean | **Yes** | |
-| `viz` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------|----------|---------|-------------|
+| `legend` | boolean | **Yes** | | |
+| `tooltip` | boolean | **Yes** | | |
+| `viz` | boolean | **Yes** | | |
### HideableFieldConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting).
-| Property | Type | Required | Description |
-|-----------------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------|
-| `barWidth` | number | **Yes** | Controls the width of bars. 1 = Max width, 0 = Min width. Default: `0.97`.
Constraint: `>=0 & <=1`. |
-| `fullHighlight` | boolean | **Yes** | Enables mode which highlights the entire bar area and shows tooltip when cursor
hovers over highlighted area Default: `false`. |
-| `groupWidth` | number | **Yes** | Controls the width of groups. 1 = max with, 0 = min width. Default: `0.7`.
Constraint: `>=0 & <=1`. |
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
-| `orientation` | string | **Yes** | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `showValue` | string | **Yes** | TODO docs
Possible values are: `auto`, `never`, `always`. |
-| `stacking` | string | **Yes** | TODO docs
Possible values are: `none`, `normal`, `percent`. |
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
-| `xTickLabelMaxLength` | integer | **Yes** | Sets the max length that a label can have before it is truncated.
Constraint: `>=0 & <=2147483647`. |
-| `xTickLabelRotation` | integer | **Yes** | Controls the rotation of the x axis labels. Default: `0`.
Constraint: `>=-90 & <=90`. |
-| `barRadius` | number | No | Controls the radius of each bar. Default: `0`.
Constraint: `>=0 & <=0.5`. |
-| `colorByField` | string | No | Use the color value for a sibling field to color each bar value. |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
-| `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.
negative values indicate backwards skipping behavior Default: `0`. |
+| Property | Type | Required | Default | Description |
+|-----------------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------|
+| `barWidth` | number | **Yes** | `0.97` | Controls the width of bars. 1 = Max width, 0 = Min width.
Constraint: `>=0 & <=1`. |
+| `fullHighlight` | boolean | **Yes** | `false` | Enables mode which highlights the entire bar area and shows tooltip when cursor
hovers over highlighted area |
+| `groupWidth` | number | **Yes** | `0.7` | Controls the width of groups. 1 = max with, 0 = min width.
Constraint: `>=0 & <=1`. |
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
+| `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `showValue` | string | **Yes** | | TODO docs
Possible values are: `auto`, `never`, `always`. |
+| `stacking` | string | **Yes** | | TODO docs
Possible values are: `none`, `normal`, `percent`. |
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
+| `xTickLabelMaxLength` | integer | **Yes** | | Sets the max length that a label can have before it is truncated.
Constraint: `>=0 & <=2147483647`. |
+| `xTickLabelRotation` | integer | **Yes** | `0` | Controls the rotation of the x axis labels.
Constraint: `>=-90 & <=90`. |
+| `barRadius` | number | No | `0` | Controls the radius of each bar.
Constraint: `>=0 & <=0.5`. |
+| `colorByField` | string | No | | Use the color value for a sibling field to color each bar value. |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
+| `xField` | string | No | | Manually select which field from the dataset to represent the x field. |
+| `xTickLabelSpacing` | int32 | No | `0` | Controls the spacing between x axis labels.
negative values indicate backwards skipping behavior |
### OptionsWithLegend
TODO docs
-| Property | Type | Required | Description |
-|----------|---------------------------------------|----------|-------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------------------|----------|---------|-------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
TODO docs
-| Property | Type | Required | Description |
-|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | |
-| `displayMode` | string | **Yes** | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
-| `placement` | string | **Yes** | TODO docs
Possible values are: `bottom`, `right`. |
-| `showLegend` | boolean | **Yes** | |
-| `asTable` | boolean | No | |
-| `isVisible` | boolean | No | |
-| `sortBy` | string | No | |
-| `sortDesc` | boolean | No | |
-| `width` | number | No | |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | |
+| `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
+| `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. |
+| `showLegend` | boolean | **Yes** | | |
+| `asTable` | boolean | No | | |
+| `isVisible` | boolean | No | | |
+| `sortBy` | string | No | | |
+| `sortDesc` | boolean | No | | |
+| `width` | number | No | | |
### OptionsWithTextFormatting
TODO docs
-| Property | Type | Required | Description |
-|----------|-------------------------------------------------|----------|-------------|
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------------|----------|---------|-------------|
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
-| Property | Type | Required | Description |
-|-------------|--------|----------|--------------------------|
-| `titleSize` | number | No | Explicit title text size |
-| `valueSize` | number | No | Explicit value text size |
+| Property | Type | Required | Default | Description |
+|-------------|--------|----------|---------|--------------------------|
+| `titleSize` | number | No | | Explicit title text size |
+| `valueSize` | number | No | | Explicit value text size |
### OptionsWithTooltip
TODO docs
-| Property | Type | Required | Description |
-|-----------|-----------------------------------------|----------|-------------|
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-----------------------------------------|----------|---------|-------------|
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|--------|----------|---------------------------------------------------------------|
-| `mode` | string | **Yes** | TODO docs
Possible values are: `single`, `multi`, `none`. |
-| `sort` | string | **Yes** | TODO docs
Possible values are: `asc`, `desc`, `none`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|---------------------------------------------------------------|
+| `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. |
+| `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. |
diff --git a/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md
index a4ecf690870..a4b0ff51d8a 100644
--- a/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md
@@ -13,14 +13,25 @@ title: BarGaugePanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
+<<<<<<< HEAD
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| `displayMode` | string | **Yes** | | Enum expressing the possible display modes
for the bar gauge component of Grafana UI
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))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+=======
| Property | Type | Required | Description |
|-----------------|-------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| `displayMode` | string | **Yes** | Enum expressing the possible display modes
for the bar gauge component of Grafana UI
Possible values are: `basic`, `lcd`, `gradient`. |
@@ -31,17 +42,18 @@ It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| `orientation` | string | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+>>>>>>> main
### ReduceDataOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|----------|----------|---------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field |
-| `fields` | string | No | Which fields to show. By default this is only numeric fields |
-| `limit` | number | No | if showing all values limit |
-| `values` | boolean | No | If true show each row value |
+| Property | Type | Required | Default | Description |
+|----------|----------|----------|---------|---------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
+| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
+| `limit` | number | No | | if showing all values limit |
+| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
@@ -49,27 +61,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
-| Property | Type | Required | Description |
-|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------|
-| `orientation` | string | **Yes** | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
+| `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
### OptionsWithTextFormatting
TODO docs
-| Property | Type | Required | Description |
-|----------|-------------------------------------------------|----------|-------------|
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------------|----------|---------|-------------|
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
-| Property | Type | Required | Description |
-|-------------|--------|----------|--------------------------|
-| `titleSize` | number | No | Explicit title text size |
-| `valueSize` | number | No | Explicit value text size |
+| Property | Type | Required | Default | Description |
+|-------------|--------|----------|---------|--------------------------|
+| `titleSize` | number | No | | Explicit title text size |
+| `valueSize` | number | No | | Explicit value text size |
diff --git a/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md b/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md
index a078327bf36..04cda4263be 100644
--- a/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md
@@ -13,7 +13,7 @@ title: CloudWatchDataQuery kind
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
diff --git a/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md
index 0d4dafedeb5..2ee58ccd471 100644
--- a/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md
@@ -13,23 +13,23 @@ title: DashboardListPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|------------------------------------------|
-| `PanelLayout` | string | **Yes** | Possible values are: `list`, `previews`. |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|------------------------------------------|
+| `PanelLayout` | string | **Yes** | | Possible values are: `list`, `previews`. |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
-| Property | Type | Required | Description |
-|----------------------|----------|----------|------------------------------------------|
-| `maxItems` | integer | **Yes** | Default: `10`. |
-| `query` | string | **Yes** | Default: ``. |
-| `showHeadings` | boolean | **Yes** | Default: `true`. |
-| `showRecentlyViewed` | boolean | **Yes** | Default: `false`. |
-| `showSearch` | boolean | **Yes** | Default: `false`. |
-| `showStarred` | boolean | **Yes** | Default: `true`. |
-| `tags` | string[] | **Yes** | |
-| `folderId` | integer | No | |
-| `layout` | string | No | Possible values are: `list`, `previews`. |
+| Property | Type | Required | Default | Description |
+|----------------------|----------|----------|---------|------------------------------------------|
+| `maxItems` | integer | **Yes** | `10` | |
+| `query` | string | **Yes** | `` | |
+| `showHeadings` | boolean | **Yes** | `true` | |
+| `showRecentlyViewed` | boolean | **Yes** | `false` | |
+| `showSearch` | boolean | **Yes** | `false` | |
+| `showStarred` | boolean | **Yes** | `true` | |
+| `tags` | string[] | **Yes** | | |
+| `folderId` | integer | No | | |
+| `layout` | string | No | | Possible values are: `list`, `previews`. |
diff --git a/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md
index afcd6de529f..cef92f15639 100644
--- a/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md
@@ -13,25 +13,25 @@ title: DebugPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|---------------------------------------------------------------------------|
-| `DebugMode` | string | **Yes** | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
-| `UpdateConfig` | [object](#updateconfig) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|---------------------------------------------------------------------------|
+| `DebugMode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
+| `UpdateConfig` | [object](#updateconfig) | **Yes** | | |
### PanelOptions
-| Property | Type | Required | Description |
-|------------|-------------------------------|----------|---------------------------------------------------------------------------|
-| `mode` | string | **Yes** | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
-| `counters` | [UpdateConfig](#updateconfig) | No | |
+| Property | Type | Required | Default | Description |
+|------------|-------------------------------|----------|---------|---------------------------------------------------------------------------|
+| `mode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
+| `counters` | [UpdateConfig](#updateconfig) | No | | |
### UpdateConfig
-| Property | Type | Required | Description |
-|-----------------|---------|----------|-------------|
-| `dataChanged` | boolean | **Yes** | |
-| `render` | boolean | **Yes** | |
-| `schemaChanged` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------------|---------|----------|---------|-------------|
+| `dataChanged` | boolean | **Yes** | | |
+| `render` | boolean | **Yes** | | |
+| `schemaChanged` | boolean | **Yes** | | |
diff --git a/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md b/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
index dda50523b93..5042aa2a09b 100644
--- a/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
@@ -15,107 +15,107 @@ title: ElasticsearchDataQuery kind
It extends [DataQuery](#dataquery).
-| Property | Type | Required | Description |
-|--------------|-------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
-| `alias` | string | No | Alias pattern |
-| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | List of bucket aggregations |
-| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `metrics` | [MetricAggregation](#metricaggregation)[] | No | List of metric aggregations |
-| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
-| `query` | string | No | Lucene query |
-| `timeField` | string | No | Name of time field |
+| Property | Type | Required | Default | Description |
+|--------------|-------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
+| `alias` | string | No | | Alias pattern |
+| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations |
+| `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `metrics` | [MetricAggregation](#metricaggregation)[] | No | | List of metric aggregations |
+| `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
+| `query` | string | No | | Lucene query |
+| `timeField` | string | No | | Name of time field |
### BucketAggregation
-| Property | Type | Required | Description |
-|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------|
-| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
### DateHistogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
-| Property | Type | Required | Description |
-|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `field` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### BucketAggregationWithField
It extends [BaseBucketAggregation](#basebucketaggregation).
-| Property | Type | Required | Description |
-|------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
-| `type` | string | **Yes** | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `field` | string | No | |
-| `settings` | | No | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
+| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `field` | string | No | | |
+| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
### BaseBucketAggregation
-| Property | Type | Required | Description |
-|------------|--------|----------|---------------------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | |
-| `type` | string | **Yes** | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `settings` | | No | |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|---------------------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | |
+| `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `settings` | | No | | |
### Filters
It extends [BaseBucketAggregation](#basebucketaggregation).
-| Property | Type | Required | Description |
-|------------|--------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
-| `type` | string | **Yes** | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `settings` | | No | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
+| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
### GeoHashGrid
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
-| Property | Type | Required | Description |
-|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `field` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### Histogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
-| Property | Type | Required | Description |
-|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `field` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### Nested
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
-| Property | Type | Required | Description |
-|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `field` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### Terms
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
-| Property | Type | Required | Description |
-|------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
-| `field` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `id` | string | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
-| `settings` | | No | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*
Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
+| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
+| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
### 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
properties for the given context.
-| Property | Type | Required | Description |
-|--------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `refId` | string | **Yes** | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `queryType` | string | No | Specify the query flavor
TODO make this required and give it a default |
+| Property | Type | Required | Default | Description |
+|--------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default |
### MetricAggregation
-| Property | Type | Required | Description |
-|----------|------------------------------------------------------------------------------------------------------|----------|-------------|
-| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
+| Property | Type | Required | Default | Description |
+|----------|------------------------------------------------------------------------------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
### Count
It extends [BaseMetricAggregation](#basemetricaggregation).
-| Property | Type | Required | Description |
-|----------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
-| `type` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
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))* |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
+| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
### BaseMetricAggregation
-| Property | Type | Required | Description |
-|----------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | |
-| `type` | string | **Yes** | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `hide` | boolean | No | |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | |
+| `type` | string | **Yes** | | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `hide` | boolean | No | | |
### PipelineMetricAggregation
-| Property | Type | Required | Description |
-|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------|
-| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
### BucketScript
It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `hide` | boolean | No | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
-| `id` | string | No | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
-| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
-| `settings` | [object](#settings) | No | |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `hide` | boolean | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
+| `id` | string | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
+| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
+| `settings` | [object](#settings) | No | | |
### PipelineMetricAggregationWithMultipleBucketPaths
It extends [BaseMetricAggregation](#basemetricaggregation).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
-| `type` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `hide` | boolean | No | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
-| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
+| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
+| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | |
### PipelineVariable
-| Property | Type | Required | Description |
-|---------------|--------|----------|-------------|
-| `name` | string | **Yes** | |
-| `pipelineAgg` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|---------------|--------|----------|---------|-------------|
+| `name` | string | **Yes** | | |
+| `pipelineAgg` | string | **Yes** | | |
### Settings
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
-| `script` | | No | |
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `script` | | No | | |
### CumulativeSum
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
-| Property | Type | Required | Description |
-|---------------|---------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `field` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `hide` | boolean | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `id` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `pipelineAgg` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `settings` | [object](#settings) | No | |
+| Property | Type | Required | Default | Description |
+|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `settings` | [object](#settings) | No | | |
### BasePipelineMetricAggregation
It extends [MetricAggregationWithField](#metricaggregationwithfield).
-| Property | Type | Required | Description |
-|---------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `field` | string | No | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
-| `hide` | boolean | No | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
-| `id` | string | No | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
-| `pipelineAgg` | string | No | |
+| Property | Type | Required | Default | Description |
+|---------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `field` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
+| `hide` | boolean | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
+| `id` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
+| `pipelineAgg` | string | No | | |
### MetricAggregationWithField
It extends [BaseMetricAggregation](#basemetricaggregation).
-| Property | Type | Required | Description |
-|----------|---------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
-| `type` | string | **Yes** | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `field` | string | No | |
-| `hide` | boolean | No | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
+| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `field` | string | No | | |
+| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
### Settings
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `format` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `format` | string | No | | |
### Derivative
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
-| Property | Type | Required | Description |
-|---------------|---------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `field` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `hide` | boolean | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `id` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `pipelineAgg` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `settings` | [object](#settings) | No | |
+| Property | Type | Required | Default | Description |
+|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `settings` | [object](#settings) | No | | |
### Settings
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `unit` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `unit` | string | No | | |
### MovingAverage
@@ -263,31 +263,31 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
-| Property | Type | Required | Description |
-|---------------|---------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
-| `field` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `hide` | boolean | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `id` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `pipelineAgg` | string | No | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
-| `settings` | [object](#settings) | No | |
+| Property | Type | Required | Default | Description |
+|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*
Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
+| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
+| `settings` | [object](#settings) | No | | |
### Settings
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
### Meta
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
### Settings
-| Property | Type | Required | Description |
-|-----------|----------|----------|-------------|
-| `metrics` | string[] | No | |
-| `orderBy` | string | No | |
-| `order` | string | No | |
+| Property | Type | Required | Default | Description |
+|-----------|----------|----------|---------|-------------|
+| `metrics` | string[] | No | | |
+| `orderBy` | string | No | | |
+| `order` | string | No | | |
diff --git a/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md
index be1b76932df..1821b3ccea6 100644
--- a/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md
@@ -13,32 +13,32 @@ title: GaugePanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
-| Property | Type | Required | Description |
-|------------------------|-------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| `showThresholdLabels` | boolean | **Yes** | Default: `false`. |
-| `showThresholdMarkers` | boolean | **Yes** | Default: `true`. |
-| `orientation` | string | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|------------------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| `showThresholdLabels` | boolean | **Yes** | `false` | |
+| `showThresholdMarkers` | boolean | **Yes** | `true` | |
+| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
### ReduceDataOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|----------|----------|---------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field |
-| `fields` | string | No | Which fields to show. By default this is only numeric fields |
-| `limit` | number | No | if showing all values limit |
-| `values` | boolean | No | If true show each row value |
+| Property | Type | Required | Default | Description |
+|----------|----------|----------|---------|---------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
+| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
+| `limit` | number | No | | if showing all values limit |
+| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
@@ -46,27 +46,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
-| Property | Type | Required | Description |
-|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------|
-| `orientation` | string | **Yes** | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
+| `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
### OptionsWithTextFormatting
TODO docs
-| Property | Type | Required | Description |
-|----------|-------------------------------------------------|----------|-------------|
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------------|----------|---------|-------------|
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
-| Property | Type | Required | Description |
-|-------------|--------|----------|--------------------------|
-| `titleSize` | number | No | Explicit title text size |
-| `valueSize` | number | No | Explicit value text size |
+| Property | Type | Required | Default | Description |
+|-------------|--------|----------|---------|--------------------------|
+| `titleSize` | number | No | | Explicit title text size |
+| `valueSize` | number | No | | Explicit value text size |
diff --git a/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md
index e82f6cbdd48..6b68810de66 100644
--- a/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md
@@ -13,80 +13,80 @@ title: GeomapPanelCfg kind
-| Property | Type | Required | Description |
-|-------------------|----------------------------|----------|-----------------------------------------------|
-| `ControlsOptions` | [object](#controlsoptions) | **Yes** | |
-| `MapCenterID` | string | **Yes** | Possible values are: `zero`, `coords`, `fit`. |
-| `MapViewConfig` | [object](#mapviewconfig) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
-| `TooltipMode` | string | **Yes** | Possible values are: `none`, `details`. |
-| `TooltipOptions` | [object](#tooltipoptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-------------------|----------------------------|----------|---------|-----------------------------------------------|
+| `ControlsOptions` | [object](#controlsoptions) | **Yes** | | |
+| `MapCenterID` | string | **Yes** | | Possible values are: `zero`, `coords`, `fit`. |
+| `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
+| `TooltipMode` | string | **Yes** | | Possible values are: `none`, `details`. |
+| `TooltipOptions` | [object](#tooltipoptions) | **Yes** | | |
### ControlsOptions
-| Property | Type | Required | Description |
-|-------------------|---------|----------|--------------------------|
-| `mouseWheelZoom` | boolean | No | let the mouse wheel zoom |
-| `showAttribution` | boolean | No | Lower right |
-| `showDebug` | boolean | No | Show debug |
-| `showMeasure` | boolean | No | Show measure |
-| `showScale` | boolean | No | Scale options |
-| `showZoom` | boolean | No | Zoom (upper left) |
+| Property | Type | Required | Default | Description |
+|-------------------|---------|----------|---------|--------------------------|
+| `mouseWheelZoom` | boolean | No | | let the mouse wheel zoom |
+| `showAttribution` | boolean | No | | Lower right |
+| `showDebug` | boolean | No | | Show debug |
+| `showMeasure` | boolean | No | | Show measure |
+| `showScale` | boolean | No | | Scale options |
+| `showZoom` | boolean | No | | Zoom (upper left) |
### MapViewConfig
-| Property | Type | Required | Description |
-|-------------|---------|----------|------------------|
-| `id` | string | **Yes** | Default: `zero`. |
-| `allLayers` | boolean | No | Default: `true`. |
-| `lastOnly` | boolean | No | |
-| `lat` | int64 | No | Default: `0`. |
-| `layer` | string | No | |
-| `lon` | int64 | No | Default: `0`. |
-| `maxZoom` | integer | No | |
-| `minZoom` | integer | No | |
-| `padding` | integer | No | |
-| `shared` | boolean | No | |
-| `zoom` | int64 | No | Default: `1`. |
+| Property | Type | Required | Default | Description |
+|-------------|---------|----------|---------|-------------|
+| `id` | string | **Yes** | `zero` | |
+| `allLayers` | boolean | No | `true` | |
+| `lastOnly` | boolean | No | | |
+| `lat` | int64 | No | `0` | |
+| `layer` | string | No | | |
+| `lon` | int64 | No | `0` | |
+| `maxZoom` | integer | No | | |
+| `minZoom` | integer | No | | |
+| `padding` | integer | No | | |
+| `shared` | boolean | No | | |
+| `zoom` | int64 | No | `1` | |
### PanelOptions
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | |
-| `controls` | [ControlsOptions](#controlsoptions) | **Yes** | |
-| `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | |
-| `tooltip` | [TooltipOptions](#tooltipoptions) | **Yes** | |
-| `view` | [MapViewConfig](#mapviewconfig) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | |
+| `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | |
+| `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | |
+| `tooltip` | [TooltipOptions](#tooltipoptions) | **Yes** | | |
+| `view` | [MapViewConfig](#mapviewconfig) | **Yes** | | |
### MapLayerOptions
-| Property | Type | Required | Description |
-|--------------|---------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------|
-| `name` | string | **Yes** | configured unique display name |
-| `type` | string | **Yes** | |
-| `config` | | No | Custom options depending on the type |
-| `filterData` | | No | Defines a frame MatcherConfig that may filter data for the given layer |
-| `location` | [FrameGeometrySource](#framegeometrysource) | No | |
-| `opacity` | integer | No | Common properties:
https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html
Layer opacity (0-1) |
-| `tooltip` | boolean | No | Check tooltip (defaults to true) |
+| Property | Type | Required | Default | Description |
+|--------------|---------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------|
+| `name` | string | **Yes** | | configured unique display name |
+| `type` | string | **Yes** | | |
+| `config` | | No | | Custom options depending on the type |
+| `filterData` | | No | | Defines a frame MatcherConfig that may filter data for the given layer |
+| `location` | [FrameGeometrySource](#framegeometrysource) | No | | |
+| `opacity` | integer | No | | Common properties:
https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html
Layer opacity (0-1) |
+| `tooltip` | boolean | No | | Check tooltip (defaults to true) |
### FrameGeometrySource
-| Property | Type | Required | Description |
-|-------------|--------|----------|-------------------------------------------------------------|
-| `mode` | string | **Yes** | Possible values are: `auto`, `geohash`, `coords`, `lookup`. |
-| `gazetteer` | string | No | Path to Gazetteer |
-| `geohash` | string | No | Field mappings |
-| `latitude` | string | No | |
-| `longitude` | string | No | |
-| `lookup` | string | No | |
-| `wkt` | string | No | |
+| Property | Type | Required | Default | Description |
+|-------------|--------|----------|---------|-------------------------------------------------------------|
+| `mode` | string | **Yes** | | Possible values are: `auto`, `geohash`, `coords`, `lookup`. |
+| `gazetteer` | string | No | | Path to Gazetteer |
+| `geohash` | string | No | | Field mappings |
+| `latitude` | string | No | | |
+| `longitude` | string | No | | |
+| `lookup` | string | No | | |
+| `wkt` | string | No | | |
### TooltipOptions
-| Property | Type | Required | Description |
-|----------|--------|----------|-----------------------------------------|
-| `mode` | string | **Yes** | Possible values are: `none`, `details`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-----------------------------------------|
+| `mode` | string | **Yes** | | Possible values are: `none`, `details`. |
diff --git a/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md
index 9967057d6a7..a94cf9395e9 100644
--- a/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md
@@ -13,158 +13,158 @@ title: HeatmapPanelCfg kind
-| Property | Type | Required | Description |
-|-----------------------|--------------------------------|----------|-------------------------------------------------------------------------------------------|
-| `CellValues` | [object](#cellvalues) | **Yes** | Controls cell value options |
-| `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | Controls exemplar options |
-| `FilterValueRange` | [object](#filtervaluerange) | **Yes** | Controls the value filter range |
-| `HeatmapColorMode` | string | **Yes** | Controls the color mode of the heatmap
Possible values are: `opacity`, `scheme`. |
-| `HeatmapColorOptions` | [object](#heatmapcoloroptions) | **Yes** | Controls various color options |
-| `HeatmapColorScale` | string | **Yes** | Controls the color scale of the heatmap
Possible values are: `linear`, `exponential`. |
-| `HeatmapLegend` | [object](#heatmaplegend) | **Yes** | Controls legend options |
-| `HeatmapTooltip` | [object](#heatmaptooltip) | **Yes** | Controls tooltip options |
-| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
-| `RowsHeatmapOptions` | [object](#rowsheatmapoptions) | **Yes** | Controls frame rows options |
-| `YAxisConfig` | [object](#yaxisconfig) | **Yes** | Configuration options for the yAxis |
+| Property | Type | Required | Default | Description |
+|-----------------------|--------------------------------|----------|---------|-------------------------------------------------------------------------------------------|
+| `CellValues` | [object](#cellvalues) | **Yes** | | Controls cell value options |
+| `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | | Controls exemplar options |
+| `FilterValueRange` | [object](#filtervaluerange) | **Yes** | | Controls the value filter range |
+| `HeatmapColorMode` | string | **Yes** | | Controls the color mode of the heatmap
Possible values are: `opacity`, `scheme`. |
+| `HeatmapColorOptions` | [object](#heatmapcoloroptions) | **Yes** | | Controls various color options |
+| `HeatmapColorScale` | string | **Yes** | | Controls the color scale of the heatmap
Possible values are: `linear`, `exponential`. |
+| `HeatmapLegend` | [object](#heatmaplegend) | **Yes** | | Controls legend options |
+| `HeatmapTooltip` | [object](#heatmaptooltip) | **Yes** | | Controls tooltip options |
+| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
+| `RowsHeatmapOptions` | [object](#rowsheatmapoptions) | **Yes** | | Controls frame rows options |
+| `YAxisConfig` | [object](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
### CellValues
Controls cell value options
-| Property | Type | Required | Description |
-|------------|--------|----------|-------------------------------------------------|
-| `decimals` | number | No | Controls the number of decimals for cell values |
-| `unit` | string | No | Controls the cell value unit |
+| Property | Type | Required | Default | Description |
+|------------|--------|----------|---------|-------------------------------------------------|
+| `decimals` | number | No | | Controls the number of decimals for cell values |
+| `unit` | string | No | | Controls the cell value unit |
### ExemplarConfig
Controls exemplar options
-| Property | Type | Required | Description |
-|----------|--------|----------|----------------------------------------|
-| `color` | string | **Yes** | Sets the color of the exemplar markers |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|----------------------------------------|
+| `color` | string | **Yes** | | Sets the color of the exemplar markers |
### FilterValueRange
Controls the value filter range
-| Property | Type | Required | Description |
-|----------|--------|----------|--------------------------------------------------------------------------|
-| `ge` | number | No | Sets the filter range to values greater than or equal to the given value |
-| `le` | number | No | Sets the filter range to values less than or equal to the given value |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|--------------------------------------------------------------------------|
+| `ge` | number | No | | Sets the filter range to values greater than or equal to the given value |
+| `le` | number | No | | Sets the filter range to values less than or equal to the given value |
### HeatmapColorOptions
Controls various color options
-| Property | Type | Required | Description |
-|------------|---------|----------|-------------------------------------------------------------------------------------------|
-| `exponent` | number | **Yes** | Controls the exponent when scale is set to exponential |
-| `fill` | string | **Yes** | Controls the color fill when in opacity mode |
-| `reverse` | boolean | **Yes** | Reverses the color scheme |
-| `scheme` | string | **Yes** | Controls the color scheme used |
-| `steps` | integer | **Yes** | Controls the number of color steps
Constraint: `>=2 & <=128`. |
-| `max` | number | No | Sets the maximum value for the color scale |
-| `min` | number | No | Sets the minimum value for the color scale |
-| `mode` | string | No | Controls the color mode of the heatmap
Possible values are: `opacity`, `scheme`. |
-| `scale` | string | No | Controls the color scale of the heatmap
Possible values are: `linear`, `exponential`. |
+| Property | Type | Required | Default | Description |
+|------------|---------|----------|---------|-------------------------------------------------------------------------------------------|
+| `exponent` | number | **Yes** | | Controls the exponent when scale is set to exponential |
+| `fill` | string | **Yes** | | Controls the color fill when in opacity mode |
+| `reverse` | boolean | **Yes** | | Reverses the color scheme |
+| `scheme` | string | **Yes** | | Controls the color scheme used |
+| `steps` | integer | **Yes** | | Controls the number of color steps
Constraint: `>=2 & <=128`. |
+| `max` | number | No | | Sets the maximum value for the color scale |
+| `min` | number | No | | Sets the minimum value for the color scale |
+| `mode` | string | No | | Controls the color mode of the heatmap
Possible values are: `opacity`, `scheme`. |
+| `scale` | string | No | | Controls the color scale of the heatmap
Possible values are: `linear`, `exponential`. |
### HeatmapLegend
Controls legend options
-| Property | Type | Required | Description |
-|----------|---------|----------|---------------------------------|
-| `show` | boolean | **Yes** | Controls if the legend is shown |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|---------------------------------|
+| `show` | boolean | **Yes** | | Controls if the legend is shown |
### HeatmapTooltip
Controls tooltip options
-| Property | Type | Required | Description |
-|--------------|---------|----------|----------------------------------------------------------------|
-| `show` | boolean | **Yes** | Controls if the tooltip is shown |
-| `yHistogram` | boolean | No | Controls if the tooltip shows a histogram of the y-axis values |
+| Property | Type | Required | Default | Description |
+|--------------|---------|----------|---------|----------------------------------------------------------------|
+| `show` | boolean | **Yes** | | Controls if the tooltip is shown |
+| `yHistogram` | boolean | No | | Controls if the tooltip shows a histogram of the y-axis values |
### PanelFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|------------------------------------------------------------------------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### HideSeriesConfig
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------|----------|-------------|
-| `legend` | boolean | **Yes** | |
-| `tooltip` | boolean | **Yes** | |
-| `viz` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------|----------|---------|-------------|
+| `legend` | boolean | **Yes** | | |
+| `tooltip` | boolean | **Yes** | | |
+| `viz` | boolean | **Yes** | | |
### HideableFieldConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### ScaleDistributionConfig
TODO docs
-| Property | Type | Required | Description |
-|-------------------|--------|----------|--------------------------------------------------------------------------|
-| `type` | string | **Yes** | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
-| `linearThreshold` | number | No | |
-| `log` | number | No | |
+| Property | Type | Required | Default | Description |
+|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
+| `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
+| `linearThreshold` | number | No | | |
+| `log` | number | No | | |
### PanelOptions
-| Property | Type | Required | Description |
-|----------------|---------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------|
-| `color` | [object](#color) | **Yes** | Controls the color options Default: `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]`. |
-| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | Controls exemplar options |
-| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | Controls legend options |
-| `showValue` | string | **Yes** | TODO docs
Possible values are: `auto`, `never`, `always`. |
-| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | Controls tooltip options |
-| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | Configuration options for the yAxis |
-| `calculate` | boolean | No | Controls if the heatmap should be calculated from data Default: `false`. |
-| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | |
-| `cellGap` | integer | No | Controls gap between cells Default: `1`.
Constraint: `>=0 & <=25`. |
-| `cellRadius` | number | No | Controls cell radius |
-| `cellValues` | [object](#cellvalues) | No | Controls cell value unit Default: `map[]`. |
-| `filterValues` | [object](#filtervalues) | No | Filters values between a given range Default: `map[le:1e-09]`. |
-| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | Controls frame rows options |
+| Property | Type | Required | Default | Description |
+|----------------|---------------------------------------------------------|----------|----------------------------------------------------------------------------|---------------------------------------------------------------|
+| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options |
+| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options |
+| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options |
+| `showValue` | string | **Yes** | | TODO docs
Possible values are: `auto`, `never`, `always`. |
+| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
+| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
+| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
+| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
+| `cellGap` | integer | No | `1` | Controls gap between cells
Constraint: `>=0 & <=25`. |
+| `cellRadius` | number | No | | Controls cell radius |
+| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
+| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
+| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
### HeatmapCalculationOptions
-| Property | Type | Required | Description |
-|------------|-------------------------------------------------------------------|----------|-------------|
-| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | |
-| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | |
+| Property | Type | Required | Default | Description |
+|------------|-------------------------------------------------------------------|----------|---------|-------------|
+| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
+| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
### HeatmapCalculationBucketConfig
-| Property | Type | Required | Description |
-|----------|-----------------------------------------------------|----------|----------------------------------------------------------|
-| `mode` | string | No | Possible values are: `size`, `count`. |
-| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs |
-| `value` | string | No | The number of buckets to use for the axis in the heatmap |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------|
+| `mode` | string | No | | Possible values are: `size`, `count`. |
+| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
+| `value` | string | No | | The number of buckets to use for the axis in the heatmap |
### RowsHeatmapOptions
Controls frame rows options
-| Property | Type | Required | Description |
-|----------|--------|----------|----------------------------------------------------------|
-| `layout` | string | No | Possible values are: `le`, `ge`, `unknown`, `auto`. |
-| `value` | string | No | Sets the name of the cell when not calculating from data |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|----------------------------------------------------------|
+| `layout` | string | No | | Possible values are: `le`, `ge`, `unknown`, `auto`. |
+| `value` | string | No | | Sets the name of the cell when not calculating from data |
### YAxisConfig
@@ -172,61 +172,61 @@ Configuration options for the yAxis
It extends [AxisConfig](#axisconfig).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisLabel` | string | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisPlacement` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `decimals` | number | No | Controls the number of decimals for yAxis values |
-| `max` | number | No | Sets the maximum value for the yAxis |
-| `min` | number | No | Sets the minimum value for the yAxis |
-| `reverse` | boolean | No | Reverses the yAxis |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
-| `unit` | string | No | Sets the yAxis unit |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `decimals` | number | No | | Controls the number of decimals for yAxis values |
+| `max` | number | No | | Sets the maximum value for the yAxis |
+| `min` | number | No | | Sets the minimum value for the yAxis |
+| `reverse` | boolean | No | | Reverses the yAxis |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
+| `unit` | string | No | | Sets the yAxis unit |
### AxisConfig
TODO docs
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | |
-| `axisColorMode` | string | No | TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | |
-| `axisLabel` | string | No | |
-| `axisPlacement` | string | No | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | |
-| `axisSoftMin` | number | No | |
-| `axisWidth` | number | No | |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | |
+| `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | |
+| `axisLabel` | string | No | | |
+| `axisPlacement` | string | No | | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | |
+| `axisSoftMin` | number | No | | |
+| `axisWidth` | number | No | | |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### CellValues
Controls cell value unit
-| Property | Type | Required | Description |
-|----------|-----------------------------------|----------|-------------|
-| `object` | Possible types are: [](#), [](#). | | |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [](#), [](#). | | |
### Color
Controls the color options
-| Property | Type | Required | Description |
-|----------|-----------------------------------|----------|-------------|
-| `object` | Possible types are: [](#), [](#). | | |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [](#), [](#). | | |
### FilterValues
Filters values between a given range
-| Property | Type | Required | Description |
-|----------|-----------------------------------|----------|-------------|
-| `object` | Possible types are: [](#), [](#). | | |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [](#), [](#). | | |
diff --git a/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md
index 9e2b699d320..aff139666d8 100644
--- a/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md
@@ -13,126 +13,126 @@ title: HistogramPanelCfg kind
-| Property | Type | Required | Description |
-|--------------------|-----------------------------|----------|-------------|
-| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|--------------------|-----------------------------|----------|---------|-------------|
+| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisLabel` | string | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisPlacement` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `fillOpacity` | integer | No | Controls the fill opacity of the bars. Default: `80`.
Constraint: `>=0 & <=100`. |
-| `gradientMode` | string | No | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. |
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
-| `lineWidth` | integer | No | Controls line width of the bars. Default: `1`.
Constraint: `>=0 & <=10`. |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.
Constraint: `>=0 & <=100`. |
+| `gradientMode` | string | No | | TODO docs
Possible values are: `none`, `opacity`, `hue`, `scheme`. |
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
+| `lineWidth` | integer | No | `1` | Controls line width of the bars.
Constraint: `>=0 & <=10`. |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
### AxisConfig
TODO docs
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | |
-| `axisColorMode` | string | No | TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | |
-| `axisLabel` | string | No | |
-| `axisPlacement` | string | No | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | |
-| `axisSoftMin` | number | No | |
-| `axisWidth` | number | No | |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | |
+| `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | |
+| `axisLabel` | string | No | | |
+| `axisPlacement` | string | No | | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | |
+| `axisSoftMin` | number | No | | |
+| `axisWidth` | number | No | | |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### ScaleDistributionConfig
TODO docs
-| Property | Type | Required | Description |
-|-------------------|--------|----------|--------------------------------------------------------------------------|
-| `type` | string | **Yes** | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
-| `linearThreshold` | number | No | |
-| `log` | number | No | |
+| Property | Type | Required | Default | Description |
+|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
+| `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
+| `linearThreshold` | number | No | | |
+| `log` | number | No | | |
### HideSeriesConfig
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------|----------|-------------|
-| `legend` | boolean | **Yes** | |
-| `tooltip` | boolean | **Yes** | |
-| `viz` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------|----------|---------|-------------|
+| `legend` | boolean | **Yes** | | |
+| `tooltip` | boolean | **Yes** | | |
+| `viz` | boolean | **Yes** | | |
### HideableFieldConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
-| Property | Type | Required | Description |
-|----------------|-----------------------------------------|----------|----------------------------------------------------------------------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
-| `bucketOffset` | int32 | No | Offset buckets by this amount Default: `0`. |
-| `bucketSize` | integer | No | Size of each bucket |
-| `combine` | boolean | No | Combines multiple series into a single histogram |
+| Property | Type | Required | Default | Description |
+|----------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
+| `bucketOffset` | int32 | No | `0` | Offset buckets by this amount |
+| `bucketSize` | integer | No | | Size of each bucket |
+| `combine` | boolean | No | | Combines multiple series into a single histogram |
### OptionsWithLegend
TODO docs
-| Property | Type | Required | Description |
-|----------|---------------------------------------|----------|-------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------------------|----------|---------|-------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
TODO docs
-| Property | Type | Required | Description |
-|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | |
-| `displayMode` | string | **Yes** | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
-| `placement` | string | **Yes** | TODO docs
Possible values are: `bottom`, `right`. |
-| `showLegend` | boolean | **Yes** | |
-| `asTable` | boolean | No | |
-| `isVisible` | boolean | No | |
-| `sortBy` | string | No | |
-| `sortDesc` | boolean | No | |
-| `width` | number | No | |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | |
+| `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
+| `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. |
+| `showLegend` | boolean | **Yes** | | |
+| `asTable` | boolean | No | | |
+| `isVisible` | boolean | No | | |
+| `sortBy` | string | No | | |
+| `sortDesc` | boolean | No | | |
+| `width` | number | No | | |
### OptionsWithTooltip
TODO docs
-| Property | Type | Required | Description |
-|-----------|-----------------------------------------|----------|-------------|
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-----------------------------------------|----------|---------|-------------|
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|--------|----------|---------------------------------------------------------------|
-| `mode` | string | **Yes** | TODO docs
Possible values are: `single`, `multi`, `none`. |
-| `sort` | string | **Yes** | TODO docs
Possible values are: `asc`, `desc`, `none`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|---------------------------------------------------------------|
+| `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. |
+| `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. |
diff --git a/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md
index 0e320ff5693..f055a682486 100644
--- a/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md
@@ -13,21 +13,21 @@ title: LogsPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
-| Property | Type | Required | Description |
-|----------------------|---------|----------|---------------------------------------------------------------|
-| `dedupStrategy` | string | **Yes** | Possible values are: `none`, `exact`, `numbers`, `signature`. |
-| `enableLogDetails` | boolean | **Yes** | |
-| `prettifyLogMessage` | boolean | **Yes** | |
-| `showCommonLabels` | boolean | **Yes** | |
-| `showLabels` | boolean | **Yes** | |
-| `showTime` | boolean | **Yes** | |
-| `sortOrder` | string | **Yes** | Possible values are: `Descending`, `Ascending`. |
-| `wrapLogMessage` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------------|---------|----------|---------|---------------------------------------------------------------|
+| `dedupStrategy` | string | **Yes** | | Possible values are: `none`, `exact`, `numbers`, `signature`. |
+| `enableLogDetails` | boolean | **Yes** | | |
+| `prettifyLogMessage` | boolean | **Yes** | | |
+| `showCommonLabels` | boolean | **Yes** | | |
+| `showLabels` | boolean | **Yes** | | |
+| `showTime` | boolean | **Yes** | | |
+| `sortOrder` | string | **Yes** | | Possible values are: `Descending`, `Ascending`. |
+| `wrapLogMessage` | boolean | **Yes** | | |
diff --git a/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md b/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md
index 6b022166568..44a9511a5c6 100644
--- a/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md
@@ -15,19 +15,19 @@ title: LokiDataQuery kind
It extends [DataQuery](#dataquery).
-| Property | Type | Required | Description |
-|----------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `expr` | string | **Yes** | The LogQL query. |
-| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
-| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `editorMode` | string | No | Possible values are: `code`, `builder`. |
-| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `instant` | boolean | No | @deprecated, now use queryType. |
-| `legendFormat` | string | No | Used to override the name of the series. |
-| `maxLines` | integer | No | Used to limit the number of log rows returned. |
-| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
-| `range` | boolean | No | @deprecated, now use queryType. |
-| `resolution` | integer | No | Used to scale the interval value. |
+| Property | Type | Required | Default | Description |
+|----------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `expr` | string | **Yes** | | The LogQL query. |
+| `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
+| `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `editorMode` | string | No | | Possible values are: `code`, `builder`. |
+| `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `instant` | boolean | No | | @deprecated, now use queryType. |
+| `legendFormat` | string | No | | Used to override the name of the series. |
+| `maxLines` | integer | No | | Used to limit the number of log rows returned. |
+| `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
+| `range` | boolean | No | | @deprecated, now use queryType. |
+| `resolution` | integer | No | | Used to scale the interval value. |
### 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
properties for the given context.
-| Property | Type | Required | Description |
-|--------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `refId` | string | **Yes** | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `queryType` | string | No | Specify the query flavor
TODO make this required and give it a default |
+| Property | Type | Required | Default | Description |
+|--------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default |
diff --git a/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md
index dc66c2052e3..b9351ea28f0 100644
--- a/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md
@@ -13,15 +13,15 @@ title: NewsPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
-| Property | Type | Required | Description |
-|-------------|---------|----------|--------------------------------------------|
-| `feedUrl` | string | No | empty/missing will default to grafana blog |
-| `showImage` | boolean | No | Default: `true`. |
+| Property | Type | Required | Default | Description |
+|-------------|---------|----------|---------|--------------------------------------------|
+| `feedUrl` | string | No | | empty/missing will default to grafana blog |
+| `showImage` | boolean | No | `true` | |
diff --git a/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md
index 51b1440acde..e5196d3bf5f 100644
--- a/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md
@@ -13,40 +13,40 @@ title: NodeGraphPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `ArcOption` | [object](#arcoption) | **Yes** | |
-| `EdgeOptions` | [object](#edgeoptions) | **Yes** | |
-| `NodeOptions` | [object](#nodeoptions) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `ArcOption` | [object](#arcoption) | **Yes** | | |
+| `EdgeOptions` | [object](#edgeoptions) | **Yes** | | |
+| `NodeOptions` | [object](#nodeoptions) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### ArcOption
-| Property | Type | Required | Description |
-|----------|--------|----------|-----------------------------------------------------------------------------------------------------|
-| `color` | string | No | The color of the arc. |
-| `field` | string | No | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------|
+| `color` | string | No | | The color of the arc. |
+| `field` | string | No | | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
### EdgeOptions
-| Property | Type | Required | Description |
-|---------------------|--------|----------|-----------------------------------------------------------------------------|
-| `mainStatUnit` | string | No | Unit for the main stat to override what ever is set in the data frame. |
-| `secondaryStatUnit` | string | No | Unit for the secondary stat to override what ever is set in the data frame. |
+| Property | Type | Required | Default | Description |
+|---------------------|--------|----------|---------|-----------------------------------------------------------------------------|
+| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
+| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
### NodeOptions
-| Property | Type | Required | Description |
-|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------|
-| `arcs` | [ArcOption](#arcoption)[] | No | Define which fields are shown as part of the node arc (colored circle around the node). |
-| `mainStatUnit` | string | No | Unit for the main stat to override what ever is set in the data frame. |
-| `secondaryStatUnit` | string | No | Unit for the secondary stat to override what ever is set in the data frame. |
+| Property | Type | Required | Default | Description |
+|---------------------|---------------------------|----------|---------|-----------------------------------------------------------------------------------------|
+| `arcs` | [ArcOption](#arcoption)[] | No | | Define which fields are shown as part of the node arc (colored circle around the node). |
+| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
+| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
### PanelOptions
-| Property | Type | Required | Description |
-|----------|-----------------------------|----------|-------------|
-| `edges` | [EdgeOptions](#edgeoptions) | No | |
-| `nodes` | [NodeOptions](#nodeoptions) | No | |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------|----------|---------|-------------|
+| `edges` | [EdgeOptions](#edgeoptions) | No | | |
+| `nodes` | [NodeOptions](#nodeoptions) | No | | |
diff --git a/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md b/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md
index 3bc24556ada..55000fe4c4e 100644
--- a/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md
@@ -15,14 +15,14 @@ title: ParcaDataQuery kind
It extends [DataQuery](#dataquery).
-| Property | Type | Required | Description |
-|-----------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `labelSelector` | string | **Yes** | Specifies the query label selectors. Default: `{}`. |
-| `profileTypeId` | string | **Yes** | Specifies the type of profile to query. |
-| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
-| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
+| Property | Type | Required | Default | Description |
+|-----------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
+| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
+| `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
+| `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
### 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
properties for the given context.
-| Property | Type | Required | Description |
-|--------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `refId` | string | **Yes** | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `queryType` | string | No | Specify the query flavor
TODO make this required and give it a default |
+| Property | Type | Required | Default | Description |
+|--------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default |
diff --git a/docs/sources/developers/kinds/composable/phlaredataquery/schema-reference.md b/docs/sources/developers/kinds/composable/phlaredataquery/schema-reference.md
index bafb2005be1..94224fc8fd5 100644
--- a/docs/sources/developers/kinds/composable/phlaredataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/phlaredataquery/schema-reference.md
@@ -15,15 +15,15 @@ title: PhlareDataQuery kind
It extends [DataQuery](#dataquery).
-| Property | Type | Required | Description |
-|-----------------|----------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `groupBy` | string[] | **Yes** | Allows to group the results. |
-| `labelSelector` | string | **Yes** | Specifies the query label selectors. Default: `{}`. |
-| `profileTypeId` | string | **Yes** | Specifies the type of profile to query. |
-| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
-| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
+| Property | Type | Required | Default | Description |
+|-----------------|----------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `groupBy` | string[] | **Yes** | | Allows to group the results. |
+| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
+| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
+| `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
+| `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
### 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
properties for the given context.
-| Property | Type | Required | Description |
-|--------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `refId` | string | **Yes** | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `queryType` | string | No | Specify the query flavor
TODO make this required and give it a default |
+| Property | Type | Required | Default | Description |
+|--------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default |
diff --git a/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md
index e136e6ce56c..2f2b779c35a 100644
--- a/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md
@@ -13,107 +13,107 @@ title: PieChartPanelCfg kind
-| Property | Type | Required | Description |
-|-------------------------|---------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `PanelFieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | TODO docs |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
-| `PieChartLabels` | string | **Yes** | Select labels to display on the pie chart.
- Name - The series or field name.
- Percent - The percentage of the whole.
- Value - The raw numerical value.
Possible values are: `name`, `value`, `percent`. |
-| `PieChartLegendOptions` | [object](#piechartlegendoptions) | **Yes** | |
-| `PieChartLegendValues` | string | **Yes** | Select values to display in the legend.
- Percent: The percentage of the whole.
- Value: The raw numerical value.
Possible values are: `value`, `percent`. |
-| `PieChartType` | string | **Yes** | Select the pie chart display style.
Possible values are: `pie`, `donut`. |
+| Property | Type | Required | Default | Description |
+|-------------------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `PanelFieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | | TODO docs |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
+| `PieChartLabels` | string | **Yes** | | Select labels to display on the pie chart.
- Name - The series or field name.
- Percent - The percentage of the whole.
- Value - The raw numerical value.
Possible values are: `name`, `value`, `percent`. |
+| `PieChartLegendOptions` | [object](#piechartlegendoptions) | **Yes** | | |
+| `PieChartLegendValues` | string | **Yes** | | Select values to display in the legend.
- Percent: The percentage of the whole.
- Value: The raw numerical value.
Possible values are: `value`, `percent`. |
+| `PieChartType` | string | **Yes** | | Select the pie chart display style.
Possible values are: `pie`, `donut`. |
### HideableFieldConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### HideSeriesConfig
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------|----------|-------------|
-| `legend` | boolean | **Yes** | |
-| `tooltip` | boolean | **Yes** | |
-| `viz` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------|----------|---------|-------------|
+| `legend` | boolean | **Yes** | | |
+| `tooltip` | boolean | **Yes** | | |
+| `viz` | boolean | **Yes** | | |
### PanelOptions
It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions).
-| Property | Type | Required | Description |
-|-----------------|-------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| `displayLabels` | string[] | **Yes** | |
-| `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | |
-| `pieType` | string | **Yes** | Select the pie chart display style.
Possible values are: `pie`, `donut`. |
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
-| `orientation` | string | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| `displayLabels` | string[] | **Yes** | | |
+| `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | |
+| `pieType` | string | **Yes** | | Select the pie chart display style.
Possible values are: `pie`, `donut`. |
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
+| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
### OptionsWithTooltip
TODO docs
-| Property | Type | Required | Description |
-|-----------|-----------------------------------------|----------|-------------|
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-----------------------------------------|----------|---------|-------------|
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|--------|----------|---------------------------------------------------------------|
-| `mode` | string | **Yes** | TODO docs
Possible values are: `single`, `multi`, `none`. |
-| `sort` | string | **Yes** | TODO docs
Possible values are: `asc`, `desc`, `none`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|---------------------------------------------------------------|
+| `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. |
+| `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. |
### PieChartLegendOptions
It extends [VizLegendOptions](#vizlegendoptions).
-| Property | Type | Required | Description |
-|---------------|----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
-| `displayMode` | string | **Yes** | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
-| `placement` | string | **Yes** | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Possible values are: `bottom`, `right`. |
-| `showLegend` | boolean | **Yes** | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
-| `values` | string[] | **Yes** | |
-| `asTable` | boolean | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
-| `isVisible` | boolean | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
-| `sortBy` | string | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
-| `sortDesc` | boolean | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
-| `width` | number | No | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
+| `displayMode` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
+| `placement` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*
TODO docs
Possible values are: `bottom`, `right`. |
+| `showLegend` | boolean | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
+| `values` | string[] | **Yes** | | |
+| `asTable` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
+| `isVisible` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
+| `sortBy` | string | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
+| `sortDesc` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
+| `width` | number | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
### VizLegendOptions
TODO docs
-| Property | Type | Required | Description |
-|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | |
-| `displayMode` | string | **Yes** | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
-| `placement` | string | **Yes** | TODO docs
Possible values are: `bottom`, `right`. |
-| `showLegend` | boolean | **Yes** | |
-| `asTable` | boolean | No | |
-| `isVisible` | boolean | No | |
-| `sortBy` | string | No | |
-| `sortDesc` | boolean | No | |
-| `width` | number | No | |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | |
+| `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
+| `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. |
+| `showLegend` | boolean | **Yes** | | |
+| `asTable` | boolean | No | | |
+| `isVisible` | boolean | No | | |
+| `sortBy` | string | No | | |
+| `sortDesc` | boolean | No | | |
+| `width` | number | No | | |
### ReduceDataOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|----------|----------|---------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field |
-| `fields` | string | No | Which fields to show. By default this is only numeric fields |
-| `limit` | number | No | if showing all values limit |
-| `values` | boolean | No | If true show each row value |
+| Property | Type | Required | Default | Description |
+|----------|----------|----------|---------|---------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
+| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
+| `limit` | number | No | | if showing all values limit |
+| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
@@ -121,27 +121,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
-| Property | Type | Required | Description |
-|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------|
-| `orientation` | string | **Yes** | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
+| `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
### OptionsWithTextFormatting
TODO docs
-| Property | Type | Required | Description |
-|----------|-------------------------------------------------|----------|-------------|
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------------|----------|---------|-------------|
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
-| Property | Type | Required | Description |
-|-------------|--------|----------|--------------------------|
-| `titleSize` | number | No | Explicit title text size |
-| `valueSize` | number | No | Explicit value text size |
+| Property | Type | Required | Default | Description |
+|-------------|--------|----------|---------|--------------------------|
+| `titleSize` | number | No | | Explicit title text size |
+| `valueSize` | number | No | | Explicit value text size |
diff --git a/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md
index 3dd707310bf..2bb36773f31 100644
--- a/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md
@@ -13,100 +13,100 @@ title: StateTimelinePanelCfg kind
-| Property | Type | Required | Description |
-|--------------------|-----------------------------|----------|-------------|
-| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|--------------------|-----------------------------|----------|---------|-------------|
+| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig).
-| Property | Type | Required | Description |
-|---------------|---------------------------------------|----------|------------------------------------------------------------------------------|
-| `fillOpacity` | integer | No | Default: `70`.
Constraint: `>=0 & <=100`. |
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
-| `lineWidth` | integer | No | Default: `0`.
Constraint: `>=0 & <=10`. |
+| Property | Type | Required | Default | Description |
+|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
+| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
+| `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. |
### HideSeriesConfig
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------|----------|-------------|
-| `legend` | boolean | **Yes** | |
-| `tooltip` | boolean | **Yes** | |
-| `viz` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------|----------|---------|-------------|
+| `legend` | boolean | **Yes** | | |
+| `tooltip` | boolean | **Yes** | | |
+| `viz` | boolean | **Yes** | | |
### HideableFieldConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
-| Property | Type | Required | Description |
-|---------------|-----------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
-| `rowHeight` | number | **Yes** | Controls the row height Default: `0.9`. |
-| `showValue` | string | **Yes** | TODO docs
Possible values are: `auto`, `never`, `always`. |
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
-| `alignValue` | string | No | Controls the value alignment in the TimelineChart component
Possible values are: `center`, `left`, `right`. |
-| `mergeValues` | boolean | No | Merge equal consecutive values Default: `true`. |
-| `timezone` | string[] | No | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
+| Property | Type | Required | Default | Description |
+|---------------|-----------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
+| `rowHeight` | number | **Yes** | `0.9` | Controls the row height |
+| `showValue` | string | **Yes** | | TODO docs
Possible values are: `auto`, `never`, `always`. |
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
+| `alignValue` | string | No | | Controls the value alignment in the TimelineChart component
Possible values are: `center`, `left`, `right`. |
+| `mergeValues` | boolean | No | `true` | Merge equal consecutive values |
+| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
### OptionsWithLegend
TODO docs
-| Property | Type | Required | Description |
-|----------|---------------------------------------|----------|-------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------------------|----------|---------|-------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
TODO docs
-| Property | Type | Required | Description |
-|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | |
-| `displayMode` | string | **Yes** | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
-| `placement` | string | **Yes** | TODO docs
Possible values are: `bottom`, `right`. |
-| `showLegend` | boolean | **Yes** | |
-| `asTable` | boolean | No | |
-| `isVisible` | boolean | No | |
-| `sortBy` | string | No | |
-| `sortDesc` | boolean | No | |
-| `width` | number | No | |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | |
+| `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
+| `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. |
+| `showLegend` | boolean | **Yes** | | |
+| `asTable` | boolean | No | | |
+| `isVisible` | boolean | No | | |
+| `sortBy` | string | No | | |
+| `sortDesc` | boolean | No | | |
+| `width` | number | No | | |
### OptionsWithTimezones
TODO docs
-| Property | Type | Required | Description |
-|------------|----------|----------|-------------|
-| `timezone` | string[] | No | |
+| Property | Type | Required | Default | Description |
+|------------|----------|----------|---------|-------------|
+| `timezone` | string[] | No | | |
### OptionsWithTooltip
TODO docs
-| Property | Type | Required | Description |
-|-----------|-----------------------------------------|----------|-------------|
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-----------------------------------------|----------|---------|-------------|
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|--------|----------|---------------------------------------------------------------|
-| `mode` | string | **Yes** | TODO docs
Possible values are: `single`, `multi`, `none`. |
-| `sort` | string | **Yes** | TODO docs
Possible values are: `asc`, `desc`, `none`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|---------------------------------------------------------------|
+| `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. |
+| `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. |
diff --git a/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md
index 4435cb03d81..c7a13e43cee 100644
--- a/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md
@@ -13,34 +13,34 @@ title: StatPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelOptions
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
-| Property | Type | Required | Description |
-|-----------------|-------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
-| `colorMode` | string | **Yes** | TODO docs
Possible values are: `value`, `background`, `none`. |
-| `graphMode` | string | **Yes** | TODO docs
Possible values are: `none`, `line`, `area`. |
-| `justifyMode` | string | **Yes** | TODO docs
Possible values are: `auto`, `center`. |
-| `textMode` | string | **Yes** | TODO docs
Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. |
-| `orientation` | string | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| `colorMode` | string | **Yes** | | TODO docs
Possible values are: `value`, `background`, `none`. |
+| `graphMode` | string | **Yes** | | TODO docs
Possible values are: `none`, `line`, `area`. |
+| `justifyMode` | string | **Yes** | | TODO docs
Possible values are: `auto`, `center`. |
+| `textMode` | string | **Yes** | | TODO docs
Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. |
+| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*
TODO docs |
### ReduceDataOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|----------|----------|---------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | When !values, pick one value for the whole field |
-| `fields` | string | No | Which fields to show. By default this is only numeric fields |
-| `limit` | number | No | if showing all values limit |
-| `values` | boolean | No | If true show each row value |
+| Property | Type | Required | Default | Description |
+|----------|----------|----------|---------|---------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
+| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
+| `limit` | number | No | | if showing all values limit |
+| `values` | boolean | No | | If true show each row value |
### SingleStatBaseOptions
@@ -48,27 +48,27 @@ TODO docs
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
-| Property | Type | Required | Description |
-|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------|
-| `orientation` | string | **Yes** | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
-| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs |
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
+| `orientation` | string | **Yes** | | TODO docs
Possible values are: `auto`, `vertical`, `horizontal`. |
+| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*
TODO docs |
### OptionsWithTextFormatting
TODO docs
-| Property | Type | Required | Description |
-|----------|-------------------------------------------------|----------|-------------|
-| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------------|----------|---------|-------------|
+| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
### VizTextDisplayOptions
TODO docs
-| Property | Type | Required | Description |
-|-------------|--------|----------|--------------------------|
-| `titleSize` | number | No | Explicit title text size |
-| `valueSize` | number | No | Explicit value text size |
+| Property | Type | Required | Default | Description |
+|-------------|--------|----------|---------|--------------------------|
+| `titleSize` | number | No | | Explicit title text size |
+| `valueSize` | number | No | | Explicit value text size |
diff --git a/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md
index 5eeac4bf191..4cfa74dcd2b 100644
--- a/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md
@@ -13,99 +13,99 @@ title: StatusHistoryPanelCfg kind
-| Property | Type | Required | Description |
-|--------------------|-----------------------------|----------|-------------|
-| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|--------------------|-----------------------------|----------|---------|-------------|
+| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### PanelFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig).
-| Property | Type | Required | Description |
-|---------------|---------------------------------------|----------|------------------------------------------------------------------------------|
-| `fillOpacity` | integer | No | Default: `70`.
Constraint: `>=0 & <=100`. |
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
-| `lineWidth` | integer | No | Default: `1`.
Constraint: `>=0 & <=10`. |
+| Property | Type | Required | Default | Description |
+|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
+| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
+| `lineWidth` | integer | No | `1` | Constraint: `>=0 & <=10`. |
### HideSeriesConfig
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------|----------|-------------|
-| `legend` | boolean | **Yes** | |
-| `tooltip` | boolean | **Yes** | |
-| `viz` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------|----------|---------|-------------|
+| `legend` | boolean | **Yes** | | |
+| `tooltip` | boolean | **Yes** | | |
+| `viz` | boolean | **Yes** | | |
### HideableFieldConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
-| Property | Type | Required | Description |
-|-------------|-----------------------------------------|----------|----------------------------------------------------------------------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
-| `rowHeight` | number | **Yes** | Set the height of the rows Default: `0.9`.
Constraint: `>=0 & <=1`. |
-| `showValue` | string | **Yes** | TODO docs
Possible values are: `auto`, `never`, `always`. |
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
-| `colWidth` | number | No | Controls the column width Default: `0.9`. |
-| `timezone` | string[] | No | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
+| Property | Type | Required | Default | Description |
+|-------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
+| `rowHeight` | number | **Yes** | `0.9` | Set the height of the rows
Constraint: `>=0 & <=1`. |
+| `showValue` | string | **Yes** | | TODO docs
Possible values are: `auto`, `never`, `always`. |
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
+| `colWidth` | number | No | `0.9` | Controls the column width |
+| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
### OptionsWithLegend
TODO docs
-| Property | Type | Required | Description |
-|----------|---------------------------------------|----------|-------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------------------|----------|---------|-------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
TODO docs
-| Property | Type | Required | Description |
-|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | |
-| `displayMode` | string | **Yes** | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
-| `placement` | string | **Yes** | TODO docs
Possible values are: `bottom`, `right`. |
-| `showLegend` | boolean | **Yes** | |
-| `asTable` | boolean | No | |
-| `isVisible` | boolean | No | |
-| `sortBy` | string | No | |
-| `sortDesc` | boolean | No | |
-| `width` | number | No | |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | |
+| `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
+| `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. |
+| `showLegend` | boolean | **Yes** | | |
+| `asTable` | boolean | No | | |
+| `isVisible` | boolean | No | | |
+| `sortBy` | string | No | | |
+| `sortDesc` | boolean | No | | |
+| `width` | number | No | | |
### OptionsWithTimezones
TODO docs
-| Property | Type | Required | Description |
-|------------|----------|----------|-------------|
-| `timezone` | string[] | No | |
+| Property | Type | Required | Default | Description |
+|------------|----------|----------|---------|-------------|
+| `timezone` | string[] | No | | |
### OptionsWithTooltip
TODO docs
-| Property | Type | Required | Description |
-|-----------|-----------------------------------------|----------|-------------|
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-----------------------------------------|----------|---------|-------------|
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|--------|----------|---------------------------------------------------------------|
-| `mode` | string | **Yes** | TODO docs
Possible values are: `single`, `multi`, `none`. |
-| `sort` | string | **Yes** | TODO docs
Possible values are: `asc`, `desc`, `none`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|---------------------------------------------------------------|
+| `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. |
+| `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. |
diff --git a/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md
index f012f709d25..27d2e502fe0 100644
--- a/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md
@@ -13,12 +13,22 @@ title: TablePanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|---------|-------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
### 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 |
|-----------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------|
| `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`. |
| `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 |
+>>>>>>> main
### TableSortByFieldState
Sort by field state
-| Property | Type | Required | Description |
-|---------------|---------|----------|-----------------------------------------------|
-| `displayName` | string | **Yes** | Sets the display name of the field to sort by |
-| `desc` | boolean | No | Flag used to indicate descending sort order |
+| Property | Type | Required | Default | Description |
+|---------------|---------|----------|---------|-----------------------------------------------|
+| `displayName` | string | **Yes** | | Sets the display name of the field to sort by |
+| `desc` | boolean | No | | Flag used to indicate descending sort order |
### Footer
Controls footer options
-| Property | Type | Required | Description |
-|----------|-----------------------------------|----------|-------------|
-| `object` | Possible types are: [](#), [](#). | | |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [](#), [](#). | | |
diff --git a/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md b/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md
index a16582d8e3d..9886ce72c7a 100644
--- a/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md
@@ -13,7 +13,7 @@ title: TempoDataQuery kind
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
diff --git a/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md b/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md
index f571a4274b5..1e65a3db882 100644
--- a/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md
@@ -15,41 +15,41 @@ title: TestDataDataQuery kind
It extends [DataQuery](#dataquery).
-| Property | Type | Required | Description |
-|-------------------|-------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
-| `alias` | string | No | |
-| `channel` | string | No | |
-| `csvContent` | string | No | |
-| `csvFileName` | string | No | |
-| `csvWave` | [CSVWave](#csvwave)[] | No | |
-| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `errorType` | string | No | Possible values are: `server_panic`, `frontend_exception`, `frontend_observable`. |
-| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `labels` | string | No | |
-| `levelColumn` | boolean | No | |
-| `lines` | integer | No | |
-| `nodes` | [NodesQuery](#nodesquery) | No | |
-| `points` | array[] | No | |
-| `pulseWave` | [PulseWaveQuery](#pulsewavequery) | No | |
-| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
-| `rawFrameContent` | string | No | |
-| `scenarioId` | string | No | Possible values are: `random_walk`, `slow_query`, `random_walk_with_error`, `random_walk_table`, `exponential_heatmap_bucket_data`, `linear_heatmap_bucket_data`, `no_data_points`, `datapoints_outside_range`, `csv_metric_values`, `predictable_pulse`, `predictable_csv_wave`, `streaming_client`, `simulation`, `usa`, `live`, `grafana_api`, `arrow`, `annotations`, `table_static`, `server_error_500`, `logs`, `node_graph`, `flame_graph`, `raw_frame`, `csv_file`, `csv_content`, `trace`, `manual_entry`, `variables-query`. |
-| `seriesCount` | integer | No | |
-| `sim` | [SimulationQuery](#simulationquery) | No | |
-| `spanCount` | integer | No | |
-| `stream` | [StreamingQuery](#streamingquery) | No | |
-| `stringInput` | string | No | |
-| `usa` | [USAQuery](#usaquery) | No | |
+| Property | Type | Required | Default | Description |
+|-------------------|-------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `refId` | string | **Yes** | | *(Inherited from [DataQuery](#dataquery))*
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful. |
+| `alias` | string | No | | |
+| `channel` | string | No | | |
+| `csvContent` | string | No | | |
+| `csvFileName` | string | No | | |
+| `csvWave` | [CSVWave](#csvwave)[] | No | | |
+| `datasource` | | No | | *(Inherited from [DataQuery](#dataquery))*
For mixed data sources the selected datasource is on the query level.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `errorType` | string | No | | Possible values are: `server_panic`, `frontend_exception`, `frontend_observable`. |
+| `hide` | boolean | No | | *(Inherited from [DataQuery](#dataquery))*
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `labels` | string | No | | |
+| `levelColumn` | boolean | No | | |
+| `lines` | integer | No | | |
+| `nodes` | [NodesQuery](#nodesquery) | No | | |
+| `points` | array[] | No | | |
+| `pulseWave` | [PulseWaveQuery](#pulsewavequery) | No | | |
+| `queryType` | string | No | | *(Inherited from [DataQuery](#dataquery))*
Specify the query flavor
TODO make this required and give it a default |
+| `rawFrameContent` | string | No | | |
+| `scenarioId` | string | No | | Possible values are: `random_walk`, `slow_query`, `random_walk_with_error`, `random_walk_table`, `exponential_heatmap_bucket_data`, `linear_heatmap_bucket_data`, `no_data_points`, `datapoints_outside_range`, `csv_metric_values`, `predictable_pulse`, `predictable_csv_wave`, `streaming_client`, `simulation`, `usa`, `live`, `grafana_api`, `arrow`, `annotations`, `table_static`, `server_error_500`, `logs`, `node_graph`, `flame_graph`, `raw_frame`, `csv_file`, `csv_content`, `trace`, `manual_entry`, `variables-query`. |
+| `seriesCount` | integer | No | | |
+| `sim` | [SimulationQuery](#simulationquery) | No | | |
+| `spanCount` | integer | No | | |
+| `stream` | [StreamingQuery](#streamingquery) | No | | |
+| `stringInput` | string | No | | |
+| `usa` | [USAQuery](#usaquery) | No | | |
### CSVWave
-| Property | Type | Required | Description |
-|-------------|---------|----------|-------------|
-| `labels` | string | No | |
-| `name` | string | No | |
-| `timeStep` | integer | No | |
-| `valuesCSV` | string | No | |
+| Property | Type | Required | Default | Description |
+|-------------|---------|----------|---------|-------------|
+| `labels` | string | No | | |
+| `name` | string | No | | |
+| `timeStep` | integer | No | | |
+| `valuesCSV` | string | No | | |
### 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
properties for the given context.
-| Property | Type | Required | Description |
-|--------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `refId` | string | **Yes** | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
-| `hide` | boolean | No | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
-| `queryType` | string | No | Specify the query flavor
TODO make this required and give it a default |
+| Property | Type | Required | Default | Description |
+|--------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
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.
For non mixed scenarios this is undefined.
TODO find a better way to do this ^ that's friendly to schema
TODO this shouldn't be unknown but DataSourceRef | null |
+| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc) |
+| `queryType` | string | No | | Specify the query flavor
TODO make this required and give it a default |
### NodesQuery
-| Property | Type | Required | Description |
-|----------|---------|----------|------------------------------------------------------------|
-| `count` | integer | No | |
-| `type` | string | No | Possible values are: `random`, `response`, `random edges`. |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|------------------------------------------------------------|
+| `count` | integer | No | | |
+| `type` | string | No | | Possible values are: `random`, `response`, `random edges`. |
### PulseWaveQuery
-| Property | Type | Required | Description |
-|------------|---------|----------|-------------|
-| `offCount` | integer | No | |
-| `offValue` | number | No | |
-| `onCount` | integer | No | |
-| `onValue` | number | No | |
-| `timeStep` | integer | No | |
+| Property | Type | Required | Default | Description |
+|------------|---------|----------|---------|-------------|
+| `offCount` | integer | No | | |
+| `offValue` | number | No | | |
+| `onCount` | integer | No | | |
+| `onValue` | number | No | | |
+| `timeStep` | integer | No | | |
### SimulationQuery
-| Property | Type | Required | Description |
-|----------|-------------------|----------|-------------|
-| `key` | [object](#key) | **Yes** | |
-| `config` | [object](#config) | No | |
-| `last` | boolean | No | |
-| `stream` | boolean | No | |
+| Property | Type | Required | Default | Description |
+|----------|-------------------|----------|---------|-------------|
+| `key` | [object](#key) | **Yes** | | |
+| `config` | [object](#config) | No | | |
+| `last` | boolean | No | | |
+| `stream` | boolean | No | | |
### Config
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
### Key
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `tick` | number | **Yes** | |
-| `type` | string | **Yes** | |
-| `uid` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `tick` | number | **Yes** | | |
+| `type` | string | **Yes** | | |
+| `uid` | string | No | | |
### StreamingQuery
-| Property | Type | Required | Description |
-|----------|---------|----------|-------------------------------------------------|
-| `noise` | integer | **Yes** | |
-| `speed` | integer | **Yes** | |
-| `spread` | integer | **Yes** | |
-| `type` | string | **Yes** | Possible values are: `signal`, `logs`, `fetch`. |
-| `bands` | integer | No | |
-| `url` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|-------------------------------------------------|
+| `noise` | integer | **Yes** | | |
+| `speed` | integer | **Yes** | | |
+| `spread` | integer | **Yes** | | |
+| `type` | string | **Yes** | | Possible values are: `signal`, `logs`, `fetch`. |
+| `bands` | integer | No | | |
+| `url` | string | No | | |
### USAQuery
-| Property | Type | Required | Description |
-|----------|----------|----------|-------------|
-| `fields` | string[] | No | |
-| `mode` | string | No | |
-| `period` | string | No | |
-| `states` | string[] | No | |
+| Property | Type | Required | Default | Description |
+|----------|----------|----------|---------|-------------|
+| `fields` | string[] | No | | |
+| `mode` | string | No | | |
+| `period` | string | No | | |
+| `states` | string[] | No | | |
diff --git a/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md
index 158cc432825..acdeb39703c 100644
--- a/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/textpanelcfg/schema-reference.md
@@ -13,27 +13,29 @@ title: TextPanelCfg kind
-| Property | Type | Required | Description |
-|----------------|-------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------|
-| `CodeLanguage` | string | **Yes** | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. Default: `plaintext`. |
-| `CodeOptions` | [object](#codeoptions) | **Yes** | |
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
-| `TextMode` | string | **Yes** | Possible values are: `html`, `markdown`, `code`. |
+| Property | Type | Required | Default | Description |
+|----------------|-------------------------|----------|-------------|---------------------------------------------------------------------------------------------------------|
+| `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
+| `CodeOptions` | [object](#codeoptions) | **Yes** | | |
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
+| `TextMode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
### CodeOptions
-| Property | Type | Required | Description |
-|-------------------|---------|----------|-------------------------------------------------------------------------------------------------------------------------------|
-| `language` | string | **Yes** | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. Default: `plaintext`. |
-| `showLineNumbers` | boolean | **Yes** | Default: `false`. |
-| `showMiniMap` | boolean | **Yes** | Default: `false`. |
+| Property | Type | Required | Default | Description |
+|-------------------|---------|----------|-------------|---------------------------------------------------------------------------------------------------------|
+| `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
+| `showLineNumbers` | boolean | **Yes** | `false` | |
+| `showMiniMap` | boolean | **Yes** | `false` | |
### PanelOptions
-| Property | Type | Required | Description |
-|-----------|-----------------------------|----------|------------------------------------------------------------------------------------------------------------|
-| `content` | string | **Yes** | Default: `# Title
For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)`. |
-| `mode` | string | **Yes** | Possible values are: `html`, `markdown`, `code`. |
-| `code` | [CodeOptions](#codeoptions) | No | |
+| Property | Type | Required | Default | Description |
+|-----------|-----------------------------|----------|--------------------------------------------------------------------------------|--------------------------------------------------|
+| `content` | string | **Yes** | `# Title | |
+| | | | | |
+| | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | |
+| `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
+| `code` | [CodeOptions](#codeoptions) | No | | |
diff --git a/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md b/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md
index 7cda98f98da..59c8f980f33 100644
--- a/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md
+++ b/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md
@@ -13,95 +13,95 @@ title: XYChartPanelCfg kind
-| Property | Type | Required | Description |
-|-----------------------|--------------------------------|----------|---------------------------------------------------------|
-| `PanelOptions` | [object](#paneloptions) | **Yes** | |
-| `ScatterFieldConfig` | [object](#scatterfieldconfig) | **Yes** | |
-| `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | |
-| `ScatterShow` | string | **Yes** | Possible values are: `points`, `lines`, `points+lines`. |
-| `SeriesMapping` | string | **Yes** | Possible values are: `auto`, `manual`. |
-| `XYDimensionConfig` | [object](#xydimensionconfig) | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------------------|--------------------------------|----------|---------|---------------------------------------------------------|
+| `PanelOptions` | [object](#paneloptions) | **Yes** | | |
+| `ScatterFieldConfig` | [object](#scatterfieldconfig) | **Yes** | | |
+| `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | |
+| `ScatterShow` | string | **Yes** | | Possible values are: `points`, `lines`, `points+lines`. |
+| `SeriesMapping` | string | **Yes** | | Possible values are: `auto`, `manual`. |
+| `XYDimensionConfig` | [object](#xydimensionconfig) | **Yes** | | |
### PanelOptions
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
-| Property | Type | Required | Description |
-|-----------------|-----------------------------------------------|----------|----------------------------------------------------------------------------|
-| `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | |
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
-| `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | |
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
-| `seriesMapping` | string | No | Possible values are: `auto`, `manual`. |
+| Property | Type | Required | Default | Description |
+|-----------------|-----------------------------------------------|----------|---------|----------------------------------------------------------------------------|
+| `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | |
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*
TODO docs |
+| `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | |
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*
TODO docs |
+| `seriesMapping` | string | No | | Possible values are: `auto`, `manual`. |
### OptionsWithLegend
TODO docs
-| Property | Type | Required | Description |
-|----------|---------------------------------------|----------|-------------|
-| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------------------|----------|---------|-------------|
+| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
### VizLegendOptions
TODO docs
-| Property | Type | Required | Description |
-|---------------|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `calcs` | string[] | **Yes** | |
-| `displayMode` | string | **Yes** | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
-| `placement` | string | **Yes** | TODO docs
Possible values are: `bottom`, `right`. |
-| `showLegend` | boolean | **Yes** | |
-| `asTable` | boolean | No | |
-| `isVisible` | boolean | No | |
-| `sortBy` | string | No | |
-| `sortDesc` | boolean | No | |
-| `width` | number | No | |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `calcs` | string[] | **Yes** | | |
+| `displayMode` | string | **Yes** | | TODO docs
Note: "hidden" needs to remain as an option for plugins compatibility
Possible values are: `list`, `table`, `hidden`. |
+| `placement` | string | **Yes** | | TODO docs
Possible values are: `bottom`, `right`. |
+| `showLegend` | boolean | **Yes** | | |
+| `asTable` | boolean | No | | |
+| `isVisible` | boolean | No | | |
+| `sortBy` | string | No | | |
+| `sortDesc` | boolean | No | | |
+| `width` | number | No | | |
### OptionsWithTooltip
TODO docs
-| Property | Type | Required | Description |
-|-----------|-----------------------------------------|----------|-------------|
-| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-----------------------------------------|----------|---------|-------------|
+| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
### VizTooltipOptions
TODO docs
-| Property | Type | Required | Description |
-|----------|--------|----------|---------------------------------------------------------------|
-| `mode` | string | **Yes** | TODO docs
Possible values are: `single`, `multi`, `none`. |
-| `sort` | string | **Yes** | TODO docs
Possible values are: `asc`, `desc`, `none`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|---------------------------------------------------------------|
+| `mode` | string | **Yes** | | TODO docs
Possible values are: `single`, `multi`, `none`. |
+| `sort` | string | **Yes** | | TODO docs
Possible values are: `asc`, `desc`, `none`. |
### ScatterSeriesConfig
It extends [ScatterFieldConfig](#scatterfieldconfig).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `axisColorMode` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `axisLabel` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `axisPlacement` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `axisSoftMin` | number | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `axisWidth` | number | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs |
-| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `label` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. |
-| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
This is actually an empty interface used mainly for naming? |
-| `lineStyle` | [LineStyle](#linestyle) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs |
-| `lineWidth` | integer | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
Constraint: `>=0 & <=2147483647`. |
-| `name` | string | No | |
-| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
This is actually an empty interface used mainly for naming? |
-| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs |
-| `show` | string | No | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
Possible values are: `points`, `lines`, `points+lines`. |
-| `x` | string | No | |
-| `y` | string | No | |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `axisColorMode` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `axisLabel` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `axisPlacement` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `axisSoftMin` | number | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `axisWidth` | number | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs |
+| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `label` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs
Possible values are: `auto`, `never`, `always`. |
+| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
This is actually an empty interface used mainly for naming? |
+| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs |
+| `lineWidth` | integer | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
Constraint: `>=0 & <=2147483647`. |
+| `name` | string | No | | |
+| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
This is actually an empty interface used mainly for naming? |
+| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))* |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
TODO docs |
+| `show` | string | No | | *(Inherited from [ScatterFieldConfig](#scatterfieldconfig))*
Possible values are: `points`, `lines`, `points+lines`. |
+| `x` | string | No | | |
+| `y` | string | No | | |
### ColorDimensionConfig
@@ -109,123 +109,123 @@ This is actually an empty interface used mainly for naming?
It extends [BaseDimensionConfig](#basedimensionconfig).
-| Property | Type | Required | Description |
-|----------|--------|----------|----------------------------------------------------------------|
-| `fixed` | | **Yes** | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
-| `field` | string | No | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|----------------------------------------------------------------|
+| `fixed` | | **Yes** | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
+| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
### BaseDimensionConfig
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `fixed` | | **Yes** | |
-| `field` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `fixed` | | **Yes** | | |
+| `field` | string | No | | |
### HideSeriesConfig
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------|----------|-------------|
-| `legend` | boolean | **Yes** | |
-| `tooltip` | boolean | **Yes** | |
-| `viz` | boolean | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------|----------|---------|-------------|
+| `legend` | boolean | **Yes** | | |
+| `tooltip` | boolean | **Yes** | | |
+| `viz` | boolean | **Yes** | | |
### LineStyle
TODO docs
-| Property | Type | Required | Description |
-|----------|----------|----------|--------------------------------------------------------|
-| `dash` | number[] | No | |
-| `fill` | string | No | Possible values are: `solid`, `dash`, `dot`, `square`. |
+| Property | Type | Required | Default | Description |
+|----------|----------|----------|---------|--------------------------------------------------------|
+| `dash` | number[] | No | | |
+| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
### ScaleDimensionConfig
It extends [BaseDimensionConfig](#basedimensionconfig).
-| Property | Type | Required | Description |
-|----------|---------|----------|----------------------------------------------------------------|
-| `fixed` | | **Yes** | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
-| `max` | integer | **Yes** | |
-| `min` | integer | **Yes** | |
-| `field` | string | No | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|----------------------------------------------------------------|
+| `fixed` | | **Yes** | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
+| `max` | integer | **Yes** | | |
+| `min` | integer | **Yes** | | |
+| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
### ScaleDistributionConfig
TODO docs
-| Property | Type | Required | Description |
-|-------------------|--------|----------|--------------------------------------------------------------------------|
-| `type` | string | **Yes** | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
-| `linearThreshold` | number | No | |
-| `log` | number | No | |
+| Property | Type | Required | Default | Description |
+|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
+| `type` | string | **Yes** | | TODO docs
Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
+| `linearThreshold` | number | No | | |
+| `log` | number | No | | |
### ScatterFieldConfig
It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig).
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisColorMode` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisLabel` | string | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisPlacement` | string | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisSoftMin` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `axisWidth` | number | No | *(Inherited from [AxisConfig](#axisconfig))* |
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
-| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | |
-| `label` | string | No | TODO docs
Possible values are: `auto`, `never`, `always`. |
-| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | This is actually an empty interface used mainly for naming? |
-| `lineStyle` | [LineStyle](#linestyle) | No | TODO docs |
-| `lineWidth` | integer | No | Constraint: `>=0 & <=2147483647`. |
-| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | This is actually an empty interface used mainly for naming? |
-| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
-| `show` | string | No | Possible values are: `points`, `lines`, `points+lines`. |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*
TODO docs |
+| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | |
+| `label` | string | No | | TODO docs
Possible values are: `auto`, `never`, `always`. |
+| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | This is actually an empty interface used mainly for naming? |
+| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
+| `lineWidth` | integer | No | | Constraint: `>=0 & <=2147483647`. |
+| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | This is actually an empty interface used mainly for naming? |
+| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*
TODO docs |
+| `show` | string | No | | Possible values are: `points`, `lines`, `points+lines`. |
### AxisConfig
TODO docs
-| Property | Type | Required | Description |
-|---------------------|-----------------------------------------------------|----------|----------------------------------------------------------------------------------------|
-| `axisCenteredZero` | boolean | No | |
-| `axisColorMode` | string | No | TODO docs
Possible values are: `text`, `series`. |
-| `axisGridShow` | boolean | No | |
-| `axisLabel` | string | No | |
-| `axisPlacement` | string | No | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
-| `axisSoftMax` | number | No | |
-| `axisSoftMin` | number | No | |
-| `axisWidth` | number | No | |
-| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
+| `axisCenteredZero` | boolean | No | | |
+| `axisColorMode` | string | No | | TODO docs
Possible values are: `text`, `series`. |
+| `axisGridShow` | boolean | No | | |
+| `axisLabel` | string | No | | |
+| `axisPlacement` | string | No | | TODO docs
Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
+| `axisSoftMax` | number | No | | |
+| `axisSoftMin` | number | No | | |
+| `axisWidth` | number | No | | |
+| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
### HideableFieldConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------------|----------|-------------|
-| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------------|----------|---------|-------------|
+| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
### TextDimensionConfig
It extends [BaseDimensionConfig](#basedimensionconfig).
-| Property | Type | Required | Description |
-|----------|--------|----------|----------------------------------------------------------------|
-| `fixed` | | **Yes** | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
-| `mode` | string | **Yes** | Possible values are: `fixed`, `field`, `template`. |
-| `field` | string | No | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|----------------------------------------------------------------|
+| `fixed` | | **Yes** | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
+| `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `template`. |
+| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))* |
### XYDimensionConfig
-| Property | Type | Required | Description |
-|-----------|----------|----------|-----------------------------------|
-| `frame` | integer | **Yes** | Constraint: `>=0 & <=2147483647`. |
-| `exclude` | string[] | No | |
-| `x` | string | No | |
+| Property | Type | Required | Default | Description |
+|-----------|----------|----------|---------|-----------------------------------|
+| `frame` | integer | **Yes** | | Constraint: `>=0 & <=2147483647`. |
+| `exclude` | string[] | No | | |
+| `x` | string | No | | |
diff --git a/docs/sources/developers/kinds/core/dashboard/schema-reference.md b/docs/sources/developers/kinds/core/dashboard/schema-reference.md
index 92f5834fd29..cedcf5c525b 100644
--- a/docs/sources/developers/kinds/core/dashboard/schema-reference.md
+++ b/docs/sources/developers/kinds/core/dashboard/schema-reference.md
@@ -13,336 +13,336 @@ title: Dashboard kind
A Grafana dashboard.
-| Property | Type | Required | Description |
-|------------------------|-----------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `editable` | boolean | **Yes** | Whether a dashboard is editable or not. Default: `true`. |
-| `graphTooltip` | integer | **Yes** | 0 for no shared crosshair or tooltip (default).
1 for shared crosshair.
2 for shared crosshair AND shared tooltip.
Possible values are: `0`, `1`, `2`. Default: `0`. |
-| `schemaVersion` | uint16 | **Yes** | Version of the JSON schema, incremented each time a Grafana update brings
changes to said schema.
TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion Default: `36`. |
-| `style` | string | **Yes** | Theme of dashboard.
Possible values are: `dark`, `light`. Default: `dark`. |
-| `annotations` | [object](#annotations) | No | TODO docs |
-| `description` | string | No | Description of dashboard. |
-| `fiscalYearStartMonth` | integer | No | The month that the fiscal year starts on. 0 = January, 11 = December Default: `0`.
Constraint: `>=0 & <12`. |
-| `gnetId` | string | No | For dashboards imported from the https://grafana.com/grafana/dashboards/ portal |
-| `id` | integer | No | Unique numeric identifier for the dashboard.
TODO must isolate or remove identifiers local to a Grafana instance...? |
-| `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.
This will keep data "moving left" regardless of the query refresh rate. This setting helps
avoid dashboards presenting stale live data |
-| `panels` | [object](#panels)[] | No | |
-| `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
to see if the version has changed since the last time. Unclear why using the version property
is insufficient. |
-| `snapshot` | [Snapshot](#snapshot) | No | TODO docs |
-| `tags` | string[] | No | Tags associated with dashboard. |
-| `templating` | [object](#templating) | No | TODO docs |
-| `time` | [object](#time) | No | Time range for dashboard, e.g. last 6 hours, last 7 days, etc |
-| `timepicker` | [object](#timepicker) | No | TODO docs
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`. |
-| `title` | string | No | Title of dashboard. |
-| `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. |
-| `weekStart` | string | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|------------------------|-----------------------------------|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `editable` | boolean | **Yes** | `true` | Whether a dashboard is editable or not. |
+| `graphTooltip` | integer | **Yes** | `0` | 0 for no shared crosshair or tooltip (default).
1 for shared crosshair.
2 for shared crosshair AND shared tooltip.
Possible values are: `0`, `1`, `2`. |
+| `schemaVersion` | uint16 | **Yes** | `36` | Version of the JSON schema, incremented each time a Grafana update brings
changes to said schema.
TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion |
+| `style` | string | **Yes** | `dark` | Theme of dashboard.
Possible values are: `dark`, `light`. |
+| `annotations` | [object](#annotations) | No | | TODO docs |
+| `description` | string | No | | Description of dashboard. |
+| `fiscalYearStartMonth` | integer | No | `0` | The month that the fiscal year starts on. 0 = January, 11 = December
Constraint: `>=0 & <12`. |
+| `gnetId` | string | No | | For dashboards imported from the https://grafana.com/grafana/dashboards/ portal |
+| `id` | integer | No | | Unique numeric identifier for the dashboard.
TODO must isolate or remove identifiers local to a Grafana instance...? |
+| `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.
This will keep data "moving left" regardless of the query refresh rate. This setting helps
avoid dashboards presenting stale live data |
+| `panels` | [object](#panels)[] | No | | |
+| `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
to see if the version has changed since the last time. Unclear why using the version property
is insufficient. |
+| `snapshot` | [Snapshot](#snapshot) | No | | TODO docs |
+| `tags` | string[] | No | | Tags associated with dashboard. |
+| `templating` | [object](#templating) | No | | TODO docs |
+| `time` | [object](#time) | No | | Time range for dashboard, e.g. last 6 hours, last 7 days, etc |
+| `timepicker` | [object](#timepicker) | No | | TODO docs
TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes |
+| `timezone` | string | No | `browser` | Timezone of dashboard. Accepts IANA TZDB zone ID or "browser" or "utc". |
+| `title` | string | No | | Title of dashboard. |
+| `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. |
+| `weekStart` | string | No | | TODO docs |
### DashboardLink
FROM public/app/features/dashboard/state/DashboardModels.ts - ish
TODO docs
-| Property | Type | Required | Description |
-|---------------|----------|----------|----------------------------------------------------------|
-| `asDropdown` | boolean | **Yes** | Default: `false`. |
-| `icon` | string | **Yes** | |
-| `includeVars` | boolean | **Yes** | Default: `false`. |
-| `keepTime` | boolean | **Yes** | Default: `false`. |
-| `tags` | string[] | **Yes** | |
-| `targetBlank` | boolean | **Yes** | Default: `false`. |
-| `title` | string | **Yes** | |
-| `tooltip` | string | **Yes** | |
-| `type` | string | **Yes** | TODO docs
Possible values are: `link`, `dashboards`. |
-| `url` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|---------------|----------|----------|---------|----------------------------------------------------------|
+| `asDropdown` | boolean | **Yes** | `false` | |
+| `icon` | string | **Yes** | | |
+| `includeVars` | boolean | **Yes** | `false` | |
+| `keepTime` | boolean | **Yes** | `false` | |
+| `tags` | string[] | **Yes** | | |
+| `targetBlank` | boolean | **Yes** | `false` | |
+| `title` | string | **Yes** | | |
+| `tooltip` | string | **Yes** | | |
+| `type` | string | **Yes** | | TODO docs
Possible values are: `link`, `dashboards`. |
+| `url` | string | **Yes** | | |
### Snapshot
TODO docs
-| Property | Type | Required | Description |
-|---------------|---------|----------|-------------|
-| `created` | string | **Yes** | TODO docs |
-| `expires` | string | **Yes** | TODO docs |
-| `externalUrl` | string | **Yes** | TODO docs |
-| `external` | boolean | **Yes** | TODO docs |
-| `id` | uint32 | **Yes** | TODO docs |
-| `key` | string | **Yes** | TODO docs |
-| `name` | string | **Yes** | TODO docs |
-| `orgId` | uint32 | **Yes** | TODO docs |
-| `updated` | string | **Yes** | TODO docs |
-| `userId` | uint32 | **Yes** | TODO docs |
-| `url` | string | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|---------------|---------|----------|---------|-------------|
+| `created` | string | **Yes** | | TODO docs |
+| `expires` | string | **Yes** | | TODO docs |
+| `externalUrl` | string | **Yes** | | TODO docs |
+| `external` | boolean | **Yes** | | TODO docs |
+| `id` | uint32 | **Yes** | | TODO docs |
+| `key` | string | **Yes** | | TODO docs |
+| `name` | string | **Yes** | | TODO docs |
+| `orgId` | uint32 | **Yes** | | TODO docs |
+| `updated` | string | **Yes** | | TODO docs |
+| `userId` | uint32 | **Yes** | | TODO docs |
+| `url` | string | No | | TODO docs |
### Annotations
TODO docs
-| Property | Type | Required | Description |
-|----------|---------------------------------------|----------|-------------|
-| `list` | [AnnotationQuery](#annotationquery)[] | No | |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------------------|----------|---------|-------------|
+| `list` | [AnnotationQuery](#annotationquery)[] | No | | |
### AnnotationQuery
TODO docs
FROM: AnnotationQuery in grafana-data/src/types/annotations.ts
-| Property | Type | Required | Description |
-|--------------|---------------------------------------|----------|-------------------------------------------------|
-| `builtIn` | uint8 | **Yes** | Default: `0`. |
-| `datasource` | [object](#datasource) | **Yes** | Datasource to use for annotation. |
-| `enable` | boolean | **Yes** | Whether annotation is enabled. Default: `true`. |
-| `showIn` | uint8 | **Yes** | Default: `0`. |
-| `type` | string | **Yes** | Default: `dashboard`. |
-| `hide` | boolean | No | Whether to hide annotation. Default: `false`. |
-| `iconColor` | string | No | Annotation icon color. |
-| `name` | string | No | Name of annotation. |
-| `rawQuery` | string | No | Query for annotation data. |
-| `target` | [AnnotationTarget](#annotationtarget) | No | TODO docs |
+| Property | Type | Required | Default | Description |
+|--------------|---------------------------------------|----------|-------------|-----------------------------------|
+| `builtIn` | uint8 | **Yes** | `0` | |
+| `datasource` | [object](#datasource) | **Yes** | | Datasource to use for annotation. |
+| `enable` | boolean | **Yes** | `true` | Whether annotation is enabled. |
+| `showIn` | uint8 | **Yes** | `0` | |
+| `type` | string | **Yes** | `dashboard` | |
+| `hide` | boolean | No | `false` | Whether to hide annotation. |
+| `iconColor` | string | No | | Annotation icon color. |
+| `name` | string | No | | Name of annotation. |
+| `rawQuery` | string | No | | Query for annotation data. |
+| `target` | [AnnotationTarget](#annotationtarget) | No | | TODO docs |
### AnnotationTarget
TODO docs
-| Property | Type | Required | Description |
-|------------|----------|----------|-------------|
-| `limit` | integer | **Yes** | |
-| `matchAny` | boolean | **Yes** | |
-| `tags` | string[] | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|------------|----------|----------|---------|-------------|
+| `limit` | integer | **Yes** | | |
+| `matchAny` | boolean | **Yes** | | |
+| `tags` | string[] | **Yes** | | |
+| `type` | string | **Yes** | | |
### Datasource
Datasource to use for annotation.
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `type` | string | No | |
-| `uid` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `type` | string | No | | |
+| `uid` | string | No | | |
### Panels
-| Property | Type | Required | Description |
-|----------|-----------------------------------------------------------------------------------------------------------------------|----------|-------------|
-| `object` | Possible types are: [Panel](#panel), [RowPanel](#rowpanel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [Panel](#panel), [RowPanel](#rowpanel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
### DataTransformerConfig
TODO docs
-| Property | Type | Required | Description |
-|------------|---------------------------------|----------|----------------------------------------------------------------------------------------|
-| `id` | string | **Yes** | Unique identifier of transformer |
-| `options` | | **Yes** | Options to be passed to the transformer
Valid options depend on the transformer id |
-| `disabled` | boolean | No | Disabled transformations are skipped |
-| `filter` | [MatcherConfig](#matcherconfig) | No | |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------|----------|---------|----------------------------------------------------------------------------------------|
+| `id` | string | **Yes** | | Unique identifier of transformer |
+| `options` | | **Yes** | | Options to be passed to the transformer
Valid options depend on the transformer id |
+| `disabled` | boolean | No | | Disabled transformations are skipped |
+| `filter` | [MatcherConfig](#matcherconfig) | No | | |
### MatcherConfig
-| Property | Type | Required | Description |
-|-----------|--------|----------|--------------|
-| `id` | string | **Yes** | Default: ``. |
-| `options` | | No | |
+| Property | Type | Required | Default | Description |
+|-----------|--------|----------|---------|-------------|
+| `id` | string | **Yes** | `` | |
+| `options` | | No | | |
### FieldConfigSource
-| Property | Type | Required | Description |
-|-------------|-----------------------------|----------|-------------|
-| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | |
-| `overrides` | [object](#overrides)[] | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-------------|-----------------------------|----------|---------|-------------|
+| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | |
+| `overrides` | [object](#overrides)[] | **Yes** | | |
### FieldConfig
-| Property | Type | Required | Description |
-|---------------------|---------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `color` | [FieldColor](#fieldcolor) | No | TODO docs |
-| `custom` | [object](#custom) | No | custom is specified by the PanelFieldConfig field
in panel plugin schemas. |
-| `decimals` | number | No | Significant digits (for display) |
-| `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
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 |
-| `filterable` | boolean | No | True if data source field supports ad-hoc filters |
-| `links` | | No | The behavior when clicking on a result |
-| `mappings` | [ValueMapping](#valuemapping)[] | No | Convert input values into a display string |
-| `max` | number | No | |
-| `min` | number | No | |
-| `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,
This will default to `${frame.meta.path}/${field.name}
When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results |
-| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | |
-| `unit` | string | No | Numeric Options |
-| `writeable` | boolean | No | True if data source can write a value to the path. Auth/authz are supported separately |
+| Property | Type | Required | Default | Description |
+|---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `color` | [FieldColor](#fieldcolor) | No | | TODO docs |
+| `custom` | [object](#custom) | No | | custom is specified by the PanelFieldConfig field
in panel plugin schemas. |
+| `decimals` | number | No | | Significant digits (for display) |
+| `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
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 |
+| `filterable` | boolean | No | | True if data source field supports ad-hoc filters |
+| `links` | | No | | The behavior when clicking on a result |
+| `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string |
+| `max` | number | No | | |
+| `min` | number | No | | |
+| `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,
This will default to `${frame.meta.path}/${field.name}
When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results |
+| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | |
+| `unit` | string | No | | Numeric Options |
+| `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately |
### FieldColor
TODO docs
-| Property | Type | Required | Description |
-|--------------|--------|----------|----------------------------------------------------------|
-| `mode` | string | **Yes** | The main color scheme mode |
-| `fixedColor` | string | No | Stores the fixed color value if mode is fixed |
-| `seriesBy` | string | No | TODO docs
Possible values are: `min`, `max`, `last`. |
+| Property | Type | Required | Default | Description |
+|--------------|--------|----------|---------|----------------------------------------------------------|
+| `mode` | string | **Yes** | | The main color scheme mode |
+| `fixedColor` | string | No | | Stores the fixed color value if mode is fixed |
+| `seriesBy` | string | No | | TODO docs
Possible values are: `min`, `max`, `last`. |
### ThresholdsConfig
-| Property | Type | Required | Description |
-|----------|---------------------------|----------|------------------------------------------------------------|
-| `mode` | string | **Yes** | Possible values are: `absolute`, `percentage`. |
-| `steps` | [Threshold](#threshold)[] | **Yes** | Must be sorted by 'value', first value is always -Infinity |
+| Property | Type | Required | Default | Description |
+|----------|---------------------------|----------|---------|------------------------------------------------------------|
+| `mode` | string | **Yes** | | Possible values are: `absolute`, `percentage`. |
+| `steps` | [Threshold](#threshold)[] | **Yes** | | Must be sorted by 'value', first value is always -Infinity |
### Threshold
TODO docs
-| Property | Type | Required | Description |
-|----------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
-| `color` | string | **Yes** | TODO docs |
-| `index` | integer | No | Threshold index, an old property that is not needed an should only appear in older dashboards |
-| `state` | string | No | TODO docs
TODO are the values here enumerable into a disjunction?
Some seem to be listed in typescript comment |
-| `value` | number | No | TODO docs
FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
+| `color` | string | **Yes** | | TODO docs |
+| `index` | integer | No | | Threshold index, an old property that is not needed an should only appear in older dashboards |
+| `state` | string | No | | TODO docs
TODO are the values here enumerable into a disjunction?
Some seem to be listed in typescript comment |
+| `value` | number | No | | TODO docs
FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON |
### ValueMapping
TODO docs
-| Property | Type | Required | Description |
-|----------|-------------------------------------------------------------------------------------------------------------------------------|----------|-------------|
-| `object` | Possible types are: [ValueMap](#valuemap), [RangeMap](#rangemap), [RegexMap](#regexmap), [SpecialValueMap](#specialvaluemap). | | |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [ValueMap](#valuemap), [RangeMap](#rangemap), [RegexMap](#regexmap), [SpecialValueMap](#specialvaluemap). | | |
### RangeMap
TODO docs
-| Property | Type | Required | Description |
-|-----------|--------------------|----------|-------------|
-| `options` | [object](#options) | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|--------------------|----------|---------|-------------|
+| `options` | [object](#options) | **Yes** | | |
+| `type` | string | **Yes** | | |
### Options
-| Property | Type | Required | Description |
-|----------|-------------------------------------------|----------|--------------------------------------------------------------------------------|
-| `from` | number | **Yes** | to and from are `number | null` in current ts, really not sure what to do |
-| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | TODO docs |
-| `to` | number | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------|-------------------------------------------|----------|---------|--------------------------------------------------------------------------------|
+| `from` | number | **Yes** | | to and from are `number | null` in current ts, really not sure what to do |
+| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | TODO docs |
+| `to` | number | **Yes** | | |
### ValueMappingResult
TODO docs
-| Property | Type | Required | Description |
-|----------|---------|----------|-------------|
-| `color` | string | No | |
-| `icon` | string | No | |
-| `index` | integer | No | |
-| `text` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|-------------|
+| `color` | string | No | | |
+| `icon` | string | No | | |
+| `index` | integer | No | | |
+| `text` | string | No | | |
### RegexMap
TODO docs
-| Property | Type | Required | Description |
-|-----------|--------------------|----------|-------------|
-| `options` | [object](#options) | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|--------------------|----------|---------|-------------|
+| `options` | [object](#options) | **Yes** | | |
+| `type` | string | **Yes** | | |
### Options
-| Property | Type | Required | Description |
-|-----------|-------------------------------------------|----------|-------------|
-| `pattern` | string | **Yes** | |
-| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-------------------------------------------|----------|---------|-------------|
+| `pattern` | string | **Yes** | | |
+| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | TODO docs |
### SpecialValueMap
TODO docs
-| Property | Type | Required | Description |
-|-----------|--------------------|----------|-------------|
-| `options` | [object](#options) | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|--------------------|----------|---------|-------------|
+| `options` | [object](#options) | **Yes** | | |
+| `type` | string | **Yes** | | |
### Options
-| Property | Type | Required | Description |
-|-----------|-------------------------------------------|----------|---------------------------------------|
-| `match` | string | **Yes** | Possible values are: `true`, `false`. |
-| `pattern` | string | **Yes** | |
-| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | TODO docs |
+| Property | Type | Required | Default | Description |
+|-----------|-------------------------------------------|----------|---------|---------------------------------------|
+| `match` | string | **Yes** | | Possible values are: `true`, `false`. |
+| `pattern` | string | **Yes** | | |
+| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | TODO docs |
### ValueMap
TODO docs
-| Property | Type | Required | Description |
-|-----------|------------------------------------------------------|----------|-------------|
-| `options` | map[string][ValueMappingResult](#valuemappingresult) | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|------------------------------------------------------|----------|---------|-------------|
+| `options` | map[string][ValueMappingResult](#valuemappingresult) | **Yes** | | |
+| `type` | string | **Yes** | | |
### Custom
custom is specified by the PanelFieldConfig field
in panel plugin schemas.
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
### Overrides
-| Property | Type | Required | Description |
-|--------------|---------------------------------------------|----------|-------------|
-| `matcher` | [MatcherConfig](#matcherconfig) | **Yes** | |
-| `properties` | [DynamicConfigValue](#dynamicconfigvalue)[] | **Yes** | |
+| Property | Type | Required | Default | Description |
+|--------------|---------------------------------------------|----------|---------|-------------|
+| `matcher` | [MatcherConfig](#matcherconfig) | **Yes** | | |
+| `properties` | [DynamicConfigValue](#dynamicconfigvalue)[] | **Yes** | | |
### DynamicConfigValue
-| Property | Type | Required | Description |
-|----------|--------|----------|--------------|
-| `id` | string | **Yes** | Default: ``. |
-| `value` | | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `id` | string | **Yes** | `` | |
+| `value` | | No | | |
### GraphPanel
Support for legacy graph and heatmap panels.
-| Property | Type | Required | Description |
-|----------|-------------------|----------|----------------------------------------------------|
-| `type` | string | **Yes** | Possible values are: `graph`. |
-| `legend` | [object](#legend) | No | @deprecated this is part of deprecated graph panel |
+| Property | Type | Required | Default | Description |
+|----------|-------------------|----------|---------|----------------------------------------------------|
+| `type` | string | **Yes** | | Possible values are: `graph`. |
+| `legend` | [object](#legend) | No | | @deprecated this is part of deprecated graph panel |
### Legend
@deprecated this is part of deprecated graph panel
-| Property | Type | Required | Description |
-|------------|---------|----------|------------------|
-| `show` | boolean | **Yes** | Default: `true`. |
-| `sortDesc` | boolean | No | |
-| `sort` | string | No | |
+| Property | Type | Required | Default | Description |
+|------------|---------|----------|---------|-------------|
+| `show` | boolean | **Yes** | `true` | |
+| `sortDesc` | boolean | No | | |
+| `sort` | string | No | | |
### GridPos
-| Property | Type | Required | Description |
-|----------|---------|----------|----------------------------------------------------|
-| `h` | uint32 | **Yes** | Panel Default: `9`. |
-| `w` | integer | **Yes** | Panel Default: `12`.
Constraint: `>0 & <=24`. |
-| `x` | integer | **Yes** | Panel x Default: `0`.
Constraint: `>=0 & <24`. |
-| `y` | uint32 | **Yes** | Panel y Default: `0`. |
-| `static` | boolean | No | true if fixed |
+| Property | Type | Required | Default | Description |
+|----------|---------|----------|---------|--------------------------------------|
+| `h` | uint32 | **Yes** | `9` | Panel |
+| `w` | integer | **Yes** | `12` | Panel
Constraint: `>0 & <=24`. |
+| `x` | integer | **Yes** | `0` | Panel x
Constraint: `>=0 & <24`. |
+| `y` | uint32 | **Yes** | `0` | Panel y |
+| `static` | boolean | No | | true if fixed |
### HeatmapPanel
-| Property | Type | Required | Description |
-|----------|--------|----------|---------------------------------|
-| `type` | string | **Yes** | Possible values are: `heatmap`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|---------------------------------|
+| `type` | string | **Yes** | | Possible values are: `heatmap`. |
### LibraryPanelRef
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `name` | string | **Yes** | |
-| `uid` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `name` | string | **Yes** | | |
+| `uid` | string | **Yes** | | |
### Panel
@@ -350,87 +350,87 @@ Dashboard panels. Panels are canonically defined inline
because they share a version timeline with the dashboard
schema; they do not evolve independently.
-| Property | Type | Required | Description |
-|-------------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | |
-| `options` | [object](#options) | **Yes** | options is specified by the PanelOptions field in panel
plugin schemas. |
-| `repeatDirection` | string | **Yes** | Direction to repeat in if 'repeat' is set.
"h" for horizontal, "v" for vertical.
TODO this is probably optional
Possible values are: `h`, `v`. Default: `h`. |
-| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | |
-| `transparent` | boolean | **Yes** | Whether to display the panel without a background. Default: `false`. |
-| `type` | string | **Yes** | The panel plugin type id. May not be empty.
Constraint: `length >=1`. |
-| `datasource` | [object](#datasource) | No | The datasource used in all targets. |
-| `description` | string | No | Description. |
-| `gridPos` | [GridPos](#gridpos) | No | |
-| `id` | uint32 | No | TODO docs |
-| `interval` | string | No | TODO docs
TODO tighter constraint |
-| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | |
-| `links` | [DashboardLink](#dashboardlink)[] | No | Panel links.
TODO fill this out - seems there are a couple variants? |
-| `maxDataPoints` | number | No | TODO docs |
-| `pluginVersion` | string | No | FIXME this almost certainly has to be changed in favor of scuemata versions |
-| `repeatPanelId` | integer | No | Id of the repeating panel. |
-| `repeat` | string | No | Name of template variable to repeat for. |
-| `tags` | string[] | No | TODO docs |
-| `targets` | [Target](#target)[] | No | TODO docs |
-| `thresholds` | | No | TODO docs - seems to be an old field from old dashboard alerts? |
-| `timeFrom` | string | No | TODO docs
TODO tighter constraint |
-| `timeRegions` | | No | TODO docs |
-| `timeShift` | string | No | TODO docs
TODO tighter constraint |
-| `title` | string | No | Panel title. |
+| Property | Type | Required | Default | Description |
+|-------------------|---------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | |
+| `options` | [object](#options) | **Yes** | | options is specified by the PanelOptions field in panel
plugin schemas. |
+| `repeatDirection` | string | **Yes** | `h` | Direction to repeat in if 'repeat' is set.
"h" for horizontal, "v" for vertical.
TODO this is probably optional
Possible values are: `h`, `v`. |
+| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | |
+| `transparent` | boolean | **Yes** | `false` | Whether to display the panel without a background. |
+| `type` | string | **Yes** | | The panel plugin type id. May not be empty.
Constraint: `length >=1`. |
+| `datasource` | [object](#datasource) | No | | The datasource used in all targets. |
+| `description` | string | No | | Description. |
+| `gridPos` | [GridPos](#gridpos) | No | | |
+| `id` | uint32 | No | | TODO docs |
+| `interval` | string | No | | TODO docs
TODO tighter constraint |
+| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | |
+| `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links.
TODO fill this out - seems there are a couple variants? |
+| `maxDataPoints` | number | No | | TODO docs |
+| `pluginVersion` | string | No | | FIXME this almost certainly has to be changed in favor of scuemata versions |
+| `repeatPanelId` | integer | No | | Id of the repeating panel. |
+| `repeat` | string | No | | Name of template variable to repeat for. |
+| `tags` | string[] | No | | TODO docs |
+| `targets` | [Target](#target)[] | No | | TODO docs |
+| `thresholds` | | No | | TODO docs - seems to be an old field from old dashboard alerts? |
+| `timeFrom` | string | No | | TODO docs
TODO tighter constraint |
+| `timeRegions` | | No | | TODO docs |
+| `timeShift` | string | No | | TODO docs
TODO tighter constraint |
+| `title` | string | No | | Panel title. |
### FieldConfigSource
-| Property | Type | Required | Description |
-|-------------|-----------------------------|----------|-------------|
-| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | |
-| `overrides` | [overrides](#overrides)[] | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-------------|-----------------------------|----------|---------|-------------|
+| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | |
+| `overrides` | [overrides](#overrides)[] | **Yes** | | |
### FieldConfig
-| Property | Type | Required | Description |
-|---------------------|---------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `color` | [FieldColor](#fieldcolor) | No | TODO docs |
-| `custom` | [custom](#custom) | No | custom is specified by the PanelFieldConfig field
in panel plugin schemas. |
-| `decimals` | number | No | Significant digits (for display) |
-| `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
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 |
-| `filterable` | boolean | No | True if data source field supports ad-hoc filters |
-| `links` | | No | The behavior when clicking on a result |
-| `mappings` | [ValueMapping](#valuemapping)[] | No | Convert input values into a display string |
-| `max` | number | No | |
-| `min` | number | No | |
-| `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,
This will default to `${frame.meta.path}/${field.name}
When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results |
-| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | |
-| `unit` | string | No | Numeric Options |
-| `writeable` | boolean | No | True if data source can write a value to the path. Auth/authz are supported separately |
+| Property | Type | Required | Default | Description |
+|---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `color` | [FieldColor](#fieldcolor) | No | | TODO docs |
+| `custom` | [custom](#custom) | No | | custom is specified by the PanelFieldConfig field
in panel plugin schemas. |
+| `decimals` | number | No | | Significant digits (for display) |
+| `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
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 |
+| `filterable` | boolean | No | | True if data source field supports ad-hoc filters |
+| `links` | | No | | The behavior when clicking on a result |
+| `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string |
+| `max` | number | No | | |
+| `min` | number | No | | |
+| `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,
This will default to `${frame.meta.path}/${field.name}
When defined, this value can be used as an identifier within the datasource scope, and
may be used to update the results |
+| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | |
+| `unit` | string | No | | Numeric Options |
+| `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately |
### RangeMap
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------------------|----------|-------------|
-| `options` | [options](#options) | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------------------|----------|---------|-------------|
+| `options` | [options](#options) | **Yes** | | |
+| `type` | string | **Yes** | | |
### RegexMap
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------------------|----------|-------------|
-| `options` | [options](#options) | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------------------|----------|---------|-------------|
+| `options` | [options](#options) | **Yes** | | |
+| `type` | string | **Yes** | | |
### SpecialValueMap
TODO docs
-| Property | Type | Required | Description |
-|-----------|---------------------|----------|-------------|
-| `options` | [options](#options) | **Yes** | |
-| `type` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------|---------------------|----------|---------|-------------|
+| `options` | [options](#options) | **Yes** | | |
+| `type` | string | **Yes** | | |
### Target
@@ -442,64 +442,64 @@ with types derived from plugins in the Instance variant.
When working directly from CUE, importers can extend this
type directly to achieve the same effect.
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
### Datasource
The datasource used in all targets.
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `type` | string | No | |
-| `uid` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `type` | string | No | | |
+| `uid` | string | No | | |
### Options
options is specified by the PanelOptions field in panel
plugin schemas.
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
### RowPanel
Row panel
-| Property | Type | Required | Description |
-|--------------|-----------------------|----------|------------------------------------------|
-| `collapsed` | boolean | **Yes** | Default: `false`. |
-| `id` | uint32 | **Yes** | |
-| `panels` | [panels](#panels)[] | **Yes** | |
-| `type` | string | **Yes** | Possible values are: `row`. |
-| `datasource` | [object](#datasource) | No | Name of default datasource. |
-| `gridPos` | [GridPos](#gridpos) | No | |
-| `repeat` | string | No | Name of template variable to repeat for. |
-| `title` | string | No | |
+| Property | Type | Required | Default | Description |
+|--------------|-----------------------|----------|---------|------------------------------------------|
+| `collapsed` | boolean | **Yes** | `false` | |
+| `id` | uint32 | **Yes** | | |
+| `panels` | [panels](#panels)[] | **Yes** | | |
+| `type` | string | **Yes** | | Possible values are: `row`. |
+| `datasource` | [object](#datasource) | No | | Name of default datasource. |
+| `gridPos` | [GridPos](#gridpos) | No | | |
+| `repeat` | string | No | | Name of template variable to repeat for. |
+| `title` | string | No | | |
### Datasource
Name of default datasource.
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------|
-| `type` | string | No | |
-| `uid` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------|
+| `type` | string | No | | |
+| `uid` | string | No | | |
### Panels
-| Property | Type | Required | Description |
-|----------|------------------------------------------------------------------------------------------------|----------|-------------|
-| `object` | Possible types are: [Panel](#panel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
+| Property | Type | Required | Default | Description |
+|----------|------------------------------------------------------------------------------------------------|----------|---------|-------------|
+| `object` | Possible types are: [Panel](#panel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
### GraphPanel
Support for legacy graph and heatmap panels.
-| Property | Type | Required | Description |
-|----------|-------------------|----------|----------------------------------------------------|
-| `type` | string | **Yes** | Possible values are: `graph`. |
-| `legend` | [legend](#legend) | No | @deprecated this is part of deprecated graph panel |
+| Property | Type | Required | Default | Description |
+|----------|-------------------|----------|---------|----------------------------------------------------|
+| `type` | string | **Yes** | | Possible values are: `graph`. |
+| `legend` | [legend](#legend) | No | | @deprecated this is part of deprecated graph panel |
### Panel
@@ -507,40 +507,40 @@ Dashboard panels. Panels are canonically defined inline
because they share a version timeline with the dashboard
schema; they do not evolve independently.
-| Property | Type | Required | Description |
-|-------------------|---------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | |
-| `options` | [options](#options) | **Yes** | options is specified by the PanelOptions field in panel
plugin schemas. |
-| `repeatDirection` | string | **Yes** | Direction to repeat in if 'repeat' is set.
"h" for horizontal, "v" for vertical.
TODO this is probably optional
Possible values are: `h`, `v`. Default: `h`. |
-| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | |
-| `transparent` | boolean | **Yes** | Whether to display the panel without a background. Default: `false`. |
-| `type` | string | **Yes** | The panel plugin type id. May not be empty.
Constraint: `length >=1`. |
-| `datasource` | [datasource](#datasource) | No | The datasource used in all targets. |
-| `description` | string | No | Description. |
-| `gridPos` | [GridPos](#gridpos) | No | |
-| `id` | uint32 | No | TODO docs |
-| `interval` | string | No | TODO docs
TODO tighter constraint |
-| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | |
-| `links` | [DashboardLink](#dashboardlink)[] | No | Panel links.
TODO fill this out - seems there are a couple variants? |
-| `maxDataPoints` | number | No | TODO docs |
-| `pluginVersion` | string | No | FIXME this almost certainly has to be changed in favor of scuemata versions |
-| `repeatPanelId` | integer | No | Id of the repeating panel. |
-| `repeat` | string | No | Name of template variable to repeat for. |
-| `tags` | string[] | No | TODO docs |
-| `targets` | [Target](#target)[] | No | TODO docs |
-| `thresholds` | | No | TODO docs - seems to be an old field from old dashboard alerts? |
-| `timeFrom` | string | No | TODO docs
TODO tighter constraint |
-| `timeRegions` | | No | TODO docs |
-| `timeShift` | string | No | TODO docs
TODO tighter constraint |
-| `title` | string | No | Panel title. |
+| Property | Type | Required | Default | Description |
+|-------------------|---------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | |
+| `options` | [options](#options) | **Yes** | | options is specified by the PanelOptions field in panel
plugin schemas. |
+| `repeatDirection` | string | **Yes** | `h` | Direction to repeat in if 'repeat' is set.
"h" for horizontal, "v" for vertical.
TODO this is probably optional
Possible values are: `h`, `v`. |
+| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | |
+| `transparent` | boolean | **Yes** | `false` | Whether to display the panel without a background. |
+| `type` | string | **Yes** | | The panel plugin type id. May not be empty.
Constraint: `length >=1`. |
+| `datasource` | [datasource](#datasource) | No | | The datasource used in all targets. |
+| `description` | string | No | | Description. |
+| `gridPos` | [GridPos](#gridpos) | No | | |
+| `id` | uint32 | No | | TODO docs |
+| `interval` | string | No | | TODO docs
TODO tighter constraint |
+| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | |
+| `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links.
TODO fill this out - seems there are a couple variants? |
+| `maxDataPoints` | number | No | | TODO docs |
+| `pluginVersion` | string | No | | FIXME this almost certainly has to be changed in favor of scuemata versions |
+| `repeatPanelId` | integer | No | | Id of the repeating panel. |
+| `repeat` | string | No | | Name of template variable to repeat for. |
+| `tags` | string[] | No | | TODO docs |
+| `targets` | [Target](#target)[] | No | | TODO docs |
+| `thresholds` | | No | | TODO docs - seems to be an old field from old dashboard alerts? |
+| `timeFrom` | string | No | | TODO docs
TODO tighter constraint |
+| `timeRegions` | | No | | TODO docs |
+| `timeShift` | string | No | | TODO docs
TODO tighter constraint |
+| `title` | string | No | | Panel title. |
### Templating
TODO docs
-| Property | Type | Required | Description |
-|----------|-----------------------------------|----------|-------------|
-| `list` | [VariableModel](#variablemodel)[] | No | |
+| Property | Type | Required | Default | Description |
+|----------|-----------------------------------|----------|---------|-------------|
+| `list` | [VariableModel](#variablemodel)[] | No | | |
### VariableModel
@@ -549,57 +549,57 @@ TODO docs
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
-| Property | Type | Required | Description |
-|----------------|---------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `global` | boolean | **Yes** | Default: `false`. |
-| `hide` | integer | **Yes** | Possible values are: `0`, `1`, `2`. |
-| `id` | string | **Yes** | Default: `00000000-0000-0000-0000-000000000000`. |
-| `index` | int32 | **Yes** | Default: `-1`. |
-| `name` | string | **Yes** | |
-| `skipUrlSync` | boolean | **Yes** | Default: `false`. |
-| `state` | string | **Yes** | Possible values are: `NotStarted`, `Loading`, `Streaming`, `Done`, `Error`. |
-| `type` | string | **Yes** | FROM: packages/grafana-data/src/types/templateVars.ts
TODO docs
TODO this implies some wider pattern/discriminated union, probably?
Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. |
-| `datasource` | [DataSourceRef](#datasourceref) | No | Ref to a DataSource instance |
-| `description` | string | No | |
-| `error` | [object](#error) | No | |
-| `label` | string | No | |
-| `query` | | No | TODO: Move this into a separated QueryVariableModel type |
-| `rootStateKey` | string | No | |
+| Property | Type | Required | Default | Description |
+|----------------|---------------------------------|----------|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `global` | boolean | **Yes** | `false` | |
+| `hide` | integer | **Yes** | | Possible values are: `0`, `1`, `2`. |
+| `id` | string | **Yes** | `00000000-0000-0000-0000-000000000000` | |
+| `index` | int32 | **Yes** | `-1` | |
+| `name` | string | **Yes** | | |
+| `skipUrlSync` | boolean | **Yes** | `false` | |
+| `state` | string | **Yes** | | Possible values are: `NotStarted`, `Loading`, `Streaming`, `Done`, `Error`. |
+| `type` | string | **Yes** | | FROM: packages/grafana-data/src/types/templateVars.ts
TODO docs
TODO this implies some wider pattern/discriminated union, probably?
Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. |
+| `datasource` | [DataSourceRef](#datasourceref) | No | | Ref to a DataSource instance |
+| `description` | string | No | | |
+| `error` | [object](#error) | No | | |
+| `label` | string | No | | |
+| `query` | | No | | TODO: Move this into a separated QueryVariableModel type |
+| `rootStateKey` | string | No | | |
### DataSourceRef
Ref to a DataSource instance
-| Property | Type | Required | Description |
-|----------|--------|----------|------------------------------|
-| `type` | string | No | The plugin type-id |
-| `uid` | string | No | Specific datasource instance |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|------------------------------|
+| `type` | string | No | | The plugin type-id |
+| `uid` | string | No | | Specific datasource instance |
### Error
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
### Time
Time range for dashboard, e.g. last 6 hours, last 7 days, etc
-| Property | Type | Required | Description |
-|----------|--------|----------|--------------------|
-| `from` | string | **Yes** | Default: `now-6h`. |
-| `to` | string | **Yes** | Default: `now`. |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|----------|-------------|
+| `from` | string | **Yes** | `now-6h` | |
+| `to` | string | **Yes** | `now` | |
### Timepicker
TODO docs
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 |
-|---------------------|----------|----------|----------------------------------------------------------------------------------------|
-| `collapse` | boolean | **Yes** | Whether timepicker is collapsed or not. Default: `false`. |
-| `enable` | boolean | **Yes** | Whether timepicker is enabled or not. Default: `true`. |
-| `hidden` | boolean | **Yes** | Whether timepicker is visible or not. Default: `false`. |
-| `refresh_intervals` | string[] | **Yes** | Selectable intervals for auto-refresh. Default: `[5s 10s 30s 1m 5m 15m 30m 1h 2h 1d]`. |
-| `time_options` | string[] | **Yes** | TODO docs Default: `[5m 15m 1h 6h 12h 24h 2d 7d 30d]`. |
+| Property | Type | Required | Default | Description |
+|---------------------|----------|----------|---------------------------------------|-----------------------------------------|
+| `collapse` | boolean | **Yes** | `false` | Whether timepicker is collapsed or not. |
+| `enable` | boolean | **Yes** | `true` | Whether timepicker is enabled or not. |
+| `hidden` | boolean | **Yes** | `false` | Whether timepicker is visible or not. |
+| `refresh_intervals` | string[] | **Yes** | `[5s 10s 30s 1m 5m 15m 30m 1h 2h 1d]` | Selectable intervals for auto-refresh. |
+| `time_options` | string[] | **Yes** | `[5m 15m 1h 6h 12h 24h 2d 7d 30d]` | TODO docs |
diff --git a/docs/sources/developers/kinds/core/librarypanel/schema-reference.md b/docs/sources/developers/kinds/core/librarypanel/schema-reference.md
index 08181dabf7e..090c0ab163b 100644
--- a/docs/sources/developers/kinds/core/librarypanel/schema-reference.md
+++ b/docs/sources/developers/kinds/core/librarypanel/schema-reference.md
@@ -13,44 +13,44 @@ title: LibraryPanel kind
A standalone panel
-| Property | Type | Required | Description |
-|-----------------|-------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------|
-| `model` | [object](#model) | **Yes** | TODO: should be the same panel schema defined in dashboard
Typescript: Omit; |
-| `name` | string | **Yes** | Panel name (also saved in the model)
Constraint: `length >=1`. |
-| `type` | string | **Yes** | The panel type (from inside the model)
Constraint: `length >=1`. |
-| `uid` | string | **Yes** | Library element UID |
-| `version` | integer | **Yes** | panel version, incremented each time the dashboard is updated. |
-| `description` | string | No | Panel description |
-| `folderUid` | string | No | Folder UID |
-| `meta` | [LibraryElementDTOMeta](#libraryelementdtometa) | No | |
-| `schemaVersion` | uint16 | No | Dashboard version when this was saved (zero if unknown) |
+| Property | Type | Required | Default | Description |
+|-----------------|-------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
+| `model` | [object](#model) | **Yes** | | TODO: should be the same panel schema defined in dashboard
Typescript: Omit; |
+| `name` | string | **Yes** | | Panel name (also saved in the model)
Constraint: `length >=1`. |
+| `type` | string | **Yes** | | The panel type (from inside the model)
Constraint: `length >=1`. |
+| `uid` | string | **Yes** | | Library element UID |
+| `version` | integer | **Yes** | | panel version, incremented each time the dashboard is updated. |
+| `description` | string | No | | Panel description |
+| `folderUid` | string | No | | Folder UID |
+| `meta` | [LibraryElementDTOMeta](#libraryelementdtometa) | No | | |
+| `schemaVersion` | uint16 | No | | Dashboard version when this was saved (zero if unknown) |
### LibraryElementDTOMeta
-| Property | Type | Required | Description |
-|-----------------------|---------------------------------------------------------|----------|-------------|
-| `connectedDashboards` | integer | **Yes** | |
-| `createdBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | |
-| `created` | string | **Yes** | |
-| `folderName` | string | **Yes** | |
-| `folderUid` | string | **Yes** | |
-| `updatedBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | |
-| `updated` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-----------------------|---------------------------------------------------------|----------|---------|-------------|
+| `connectedDashboards` | integer | **Yes** | | |
+| `createdBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | |
+| `created` | string | **Yes** | | |
+| `folderName` | string | **Yes** | | |
+| `folderUid` | string | **Yes** | | |
+| `updatedBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | |
+| `updated` | string | **Yes** | | |
### LibraryElementDTOMetaUser
-| Property | Type | Required | Description |
-|-------------|---------|----------|-------------|
-| `avatarUrl` | string | **Yes** | |
-| `id` | integer | **Yes** | |
-| `name` | string | **Yes** | |
+| Property | Type | Required | Default | Description |
+|-------------|---------|----------|---------|-------------|
+| `avatarUrl` | string | **Yes** | | |
+| `id` | integer | **Yes** | | |
+| `name` | string | **Yes** | | |
### Model
TODO: should be the same panel schema defined in dashboard
Typescript: Omit;
-| Property | Type | Required | Description |
-|----------|------|----------|-------------|
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
diff --git a/docs/sources/developers/kinds/core/playlist/schema-reference.md b/docs/sources/developers/kinds/core/playlist/schema-reference.md
index 4defb1afeb7..a58544c41c8 100644
--- a/docs/sources/developers/kinds/core/playlist/schema-reference.md
+++ b/docs/sources/developers/kinds/core/playlist/schema-reference.md
@@ -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.
-| Property | Type | Required | Description |
-|------------|---------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `interval` | string | **Yes** | Interval sets the time between switching views in a playlist.
FIXME: Is this based on a standardized format or what options are available? Can datemath be used? Default: `5m`. |
-| `name` | string | **Yes** | Name of the playlist. |
-| `uid` | string | **Yes** | Unique playlist identifier. Generated on creation, either by the
creator of the playlist of by the application. |
-| `items` | [PlaylistItem](#playlistitem)[] | No | The ordered list of items that the playlist will iterate over.
FIXME! This should not be optional, but changing it makes the godegen awkward |
+| Property | Type | Required | Default | Description |
+|------------|---------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `interval` | string | **Yes** | `5m` | Interval sets the time between switching views in a playlist.
FIXME: Is this based on a standardized format or what options are available? Can datemath be used? |
+| `name` | string | **Yes** | | Name of the playlist. |
+| `uid` | string | **Yes** | | Unique playlist identifier. Generated on creation, either by the
creator of the playlist of by the application. |
+| `items` | [PlaylistItem](#playlistitem)[] | No | | The ordered list of items that the playlist will iterate over.
FIXME! This should not be optional, but changing it makes the godegen awkward |
### PlaylistItem
-| Property | Type | Required | Description |
-|----------|--------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `type` | string | **Yes** | Type of the item.
Possible values are: `dashboard_by_uid`, `dashboard_by_id`, `dashboard_by_tag`. |
-| `value` | string | **Yes** | Value depends on type and describes the playlist item.
- dashboard_by_id: The value is an internal numerical identifier set by Grafana. This
is not portable as the numerical identifier is non-deterministic between different instances.
Will be replaced by dashboard_by_uid in the future. (deprecated)
- dashboard_by_tag: The value is a tag which is set on any number of dashboards. All
dashboards behind the tag will be added to the playlist.
- dashboard_by_uid: The value is the dashboard UID |
-| `title` | string | No | Title is an unused property -- it will be removed in the future |
+| Property | Type | Required | Default | Description |
+|----------|--------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `type` | string | **Yes** | | Type of the item.
Possible values are: `dashboard_by_uid`, `dashboard_by_id`, `dashboard_by_tag`. |
+| `value` | string | **Yes** | | Value depends on type and describes the playlist item.
- dashboard_by_id: The value is an internal numerical identifier set by Grafana. This
is not portable as the numerical identifier is non-deterministic between different instances.
Will be replaced by dashboard_by_uid in the future. (deprecated)
- dashboard_by_tag: The value is a tag which is set on any number of dashboards. All
dashboards behind the tag will be added to the playlist.
- dashboard_by_uid: The value is the dashboard UID |
+| `title` | string | No | | Title is an unused property -- it will be removed in the future |
diff --git a/docs/sources/developers/kinds/core/preferences/schema-reference.md b/docs/sources/developers/kinds/core/preferences/schema-reference.md
index 2287688a6d8..1f487e05207 100644
--- a/docs/sources/developers/kinds/core/preferences/schema-reference.md
+++ b/docs/sources/developers/kinds/core/preferences/schema-reference.md
@@ -13,19 +13,19 @@ title: Preferences kind
The user or team frontend preferences
-| Property | Type | Required | Description |
-|--------------------|---------------------------------------------------|----------|---------------------------------------------------------------------------------|
-| `homeDashboardUID` | string | No | UID for the home dashboard |
-| `language` | string | No | Selected language (beta) |
-| `queryHistory` | [QueryHistoryPreference](#queryhistorypreference) | No | |
-| `theme` | string | No | light, dark, empty is default |
-| `timezone` | string | No | The timezone selection
TODO: this should use the timezone defined in common |
-| `weekStart` | string | No | day of the week (sunday, monday, etc) |
+| Property | Type | Required | Default | Description |
+|--------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------|
+| `homeDashboardUID` | string | No | | UID for the home dashboard |
+| `language` | string | No | | Selected language (beta) |
+| `queryHistory` | [QueryHistoryPreference](#queryhistorypreference) | No | | |
+| `theme` | string | No | | light, dark, empty is default |
+| `timezone` | string | No | | The timezone selection
TODO: this should use the timezone defined in common |
+| `weekStart` | string | No | | day of the week (sunday, monday, etc) |
### QueryHistoryPreference
-| Property | Type | Required | Description |
-|-----------|--------|----------|---------------------------------------------|
-| `homeTab` | string | No | one of: '' | 'query' | 'starred'; |
+| Property | Type | Required | Default | Description |
+|-----------|--------|----------|---------|---------------------------------------------|
+| `homeTab` | string | No | | one of: '' | 'query' | 'starred'; |
diff --git a/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md b/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md
index aca9d8f8e81..27134952937 100644
--- a/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md
+++ b/docs/sources/developers/kinds/core/publicdashboard/schema-reference.md
@@ -13,13 +13,13 @@ title: PublicDashboard kind
Public dashboard configuration
-| Property | Type | Required | Description |
-|------------------------|---------|----------|-----------------------------------------------------------------|
-| `annotationsEnabled` | boolean | **Yes** | Flag that indicates if annotations are enabled |
-| `dashboardUid` | string | **Yes** | Dashboard unique identifier referenced by this public dashboard |
-| `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 |
-| `uid` | string | **Yes** | Unique public dashboard identifier |
-| `accessToken` | string | No | Unique public access token |
+| Property | Type | Required | Default | Description |
+|------------------------|---------|----------|---------|-----------------------------------------------------------------|
+| `annotationsEnabled` | boolean | **Yes** | | Flag that indicates if annotations are enabled |
+| `dashboardUid` | string | **Yes** | | Dashboard unique identifier referenced by this public dashboard |
+| `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 |
+| `uid` | string | **Yes** | | Unique public dashboard identifier |
+| `accessToken` | string | No | | Unique public access token |
diff --git a/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md b/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md
index 5b6fde83b36..4d220d5513e 100644
--- a/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md
+++ b/docs/sources/developers/kinds/core/serviceaccount/schema-reference.md
@@ -13,19 +13,19 @@ title: ServiceAccount kind
system account
-| Property | Type | Required | Description |
-|-----------------|--------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
-| `avatarUrl` | string | **Yes** | AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front
of the service account. |
-| `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. |
-| `login` | string | **Yes** | Login 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. |
-| `role` | string | **Yes** | OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'.
Possible values are: `Admin`, `Editor`, `Viewer`. |
-| `tokens` | integer | **Yes** | Tokens is the number of active tokens for the service account.
Tokens are used to authenticate the service account against Grafana. |
-| `accessControl` | map[string]boolean | No | AccessControl metadata associated with a given resource. |
-| `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. |
-| `updated` | string | No | Updated indicates when the service account was updated. |
+| 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
of the service account. |
+| `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. |
+| `login` | string | **Yes** | | Login 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. |
+| `role` | string | **Yes** | | OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'.
Possible values are: `Admin`, `Editor`, `Viewer`. |
+| `tokens` | integer | **Yes** | | Tokens is the number of active tokens for the service account.
Tokens are used to authenticate the service account against Grafana. |
+| `accessControl` | map[string]boolean | No | | AccessControl metadata associated with a given resource. |
+| `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. |
+| `updated` | string | No | | Updated indicates when the service account was updated. |
diff --git a/docs/sources/developers/kinds/core/team/schema-reference.md b/docs/sources/developers/kinds/core/team/schema-reference.md
index 5de0fdcb3df..85543c78700 100644
--- a/docs/sources/developers/kinds/core/team/schema-reference.md
+++ b/docs/sources/developers/kinds/core/team/schema-reference.md
@@ -13,16 +13,16 @@ title: Team kind
A team is a named grouping of Grafana users to which access control rules may be assigned.
-| Property | Type | Required | Description |
-|-----------------|--------------------|----------|----------------------------------------------------------|
-| `created` | string | **Yes** | Created indicates when the team was created. |
-| `memberCount` | integer | **Yes** | MemberCount is the number of the team members. |
-| `name` | string | **Yes** | Name of the team. |
-| `orgId` | integer | **Yes** | OrgId is the ID of an organisation the team belongs to. |
-| `permission` | integer | **Yes** | Possible values are: `0`, `1`, `2`, `4`. |
-| `updated` | string | **Yes** | Updated indicates when the team was updated. |
-| `accessControl` | map[string]boolean | No | AccessControl metadata associated with a given resource. |
-| `avatarUrl` | string | No | AvatarUrl is the team's avatar URL. |
-| `email` | string | No | Email of the team. |
+| Property | Type | Required | Default | Description |
+|-----------------|--------------------|----------|---------|----------------------------------------------------------|
+| `created` | string | **Yes** | | Created indicates when the team was created. |
+| `memberCount` | integer | **Yes** | | MemberCount is the number of the team members. |
+| `name` | string | **Yes** | | Name of the team. |
+| `orgId` | integer | **Yes** | | OrgId is the ID of an organisation the team belongs to. |
+| `permission` | integer | **Yes** | | Possible values are: `0`, `1`, `2`, `4`. |
+| `updated` | string | **Yes** | | Updated indicates when the team was updated. |
+| `accessControl` | map[string]boolean | No | | AccessControl metadata associated with a given resource. |
+| `avatarUrl` | string | No | | AvatarUrl is the team's avatar URL. |
+| `email` | string | No | | Email of the team. |
diff --git a/pkg/codegen/jenny_docs.go b/pkg/codegen/jenny_docs.go
index d7f487465b5..d1cc8d4d547 100644
--- a/pkg/codegen/jenny_docs.go
+++ b/pkg/codegen/jenny_docs.go
@@ -371,7 +371,7 @@ func (md mdSection) write(w io.Writer) {
}
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.SetCenterSeparator("|")
table.SetAutoFormatHeaders(false)
@@ -558,15 +558,16 @@ func makeRows(s *schema) [][]string {
desc += "\nPossible values are: `" + strings.Join(vals, "`, `") + "`."
}
+ var defaultValue string
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
if alias == "" {
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.