Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/enterprise-licensing pages to have 'Enterprise' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/recorded-queries pages to have labels cloud,enterprise * Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/stats-and-license pages to have labels cloud,enterprise * Set alerting pages to have labels cloud,enterprise,oss * Set breaking-changes pages to have labels cloud,enterprise,oss * Set dashboards pages to have labels cloud,enterprise,oss * Set datasources pages to have labels cloud,enterprise,oss * Set explore pages to have labels cloud,enterprise,oss * Set fundamentals pages to have labels cloud,enterprise,oss * Set introduction/grafana-cloud pages to have labels cloud Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix introduction pages products Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set panels-visualizations pages to have labels cloud,enterprise,oss * Set release-notes pages to have labels cloud,enterprise,oss * Set search pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set troubleshooting pages to have labels cloud,enterprise,oss * Set whatsnew pages to have labels cloud,enterprise,oss * Apply updated labels from review Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
This commit is contained in:
Jack Baldry
co-authored by
brendamuir
Isabel
brendamuir
Isabel
parent
ec479b8d88
commit
7eb17bccca
@@ -1,8 +1,12 @@
|
||||
---
|
||||
title: Grafana schema
|
||||
weight: 200
|
||||
_build:
|
||||
list: false
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Grafana schema
|
||||
weight: 200
|
||||
---
|
||||
|
||||
# Grafana schema
|
||||
@@ -22,10 +26,11 @@ parts. Additionally, we must account for having Grafana continue to work as we m
|
||||
for every large-scale refactoring.
|
||||
|
||||
In the Grafana ecosystem, there are three basic Kind categories and associated schema categories:
|
||||
|
||||
- [Core Kinds]({{< relref "core/" >}})
|
||||
- Custom Kinds
|
||||
- [Composable Kinds]({{< relref "composable/" >}})
|
||||
|
||||
The schema authoring workflow for each varies, as does the path to maturity.
|
||||
[Grafana Kinds - From Zero to Maturity]({{< relref "maturity/" >}}) contains general reference material applicable to
|
||||
all Kind-writing, and links to the guides for each category of Kind.
|
||||
The schema authoring workflow for each varies, as does the path to maturity.
|
||||
[Grafana Kinds - From Zero to Maturity]({{< relref "maturity/" >}}) contains general reference material applicable to
|
||||
all Kind-writing, and links to the guides for each category of Kind.
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
---
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Composable kinds
|
||||
weight: 200
|
||||
---
|
||||
|
||||
@@ -1,28 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: AlertGroupsPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## AlertGroupsPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|---------|----------|---------|-------------------------------------------------------------|
|
||||
| -------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
|
||||
| `alertmanager` | string | **Yes** | | Name of the alertmanager used as a source for alerts |
|
||||
| `expandAll` | boolean | **Yes** | | Expand all alert groups by default |
|
||||
| `labels` | string | **Yes** | | Comma-separated list of values used to filter alert results |
|
||||
|
||||
|
||||
|
||||
@@ -1,28 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: AlertGroupsPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## AlertGroupsPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|---------|----------|---------|-------------------------------------------------------------|
|
||||
| -------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
|
||||
| `alertmanager` | string | **Yes** | | Name of the alertmanager used as a source for alerts |
|
||||
| `expandAll` | boolean | **Yes** | | Expand all alert groups by default |
|
||||
| `labels` | string | **Yes** | | Comma-separated list of values used to filter alert results |
|
||||
|
||||
|
||||
|
||||
+10
-8
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: AnnotationsListPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## AnnotationsListPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------------|----------|----------|---------|-------------|
|
||||
| ----------------------- | -------- | -------- | ------- | ----------- |
|
||||
| `limit` | uint32 | **Yes** | `10` | |
|
||||
| `navigateAfter` | string | **Yes** | `10m` | |
|
||||
| `navigateBefore` | string | **Yes** | `10m` | |
|
||||
@@ -31,5 +35,3 @@ title: AnnotationsListPanelCfg kind
|
||||
| `showTime` | boolean | **Yes** | `true` | |
|
||||
| `showUser` | boolean | **Yes** | `true` | |
|
||||
| `tags` | string[] | **Yes** | | |
|
||||
|
||||
|
||||
|
||||
+10
-8
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: AnnotationsListPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## AnnotationsListPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------------|----------|----------|---------|-------------|
|
||||
| ----------------------- | -------- | -------- | ------- | ----------- |
|
||||
| `limit` | uint32 | **Yes** | `10` | |
|
||||
| `navigateAfter` | string | **Yes** | `10m` | |
|
||||
| `navigateBefore` | string | **Yes** | `10m` | |
|
||||
@@ -31,5 +35,3 @@ title: AnnotationsListPanelCfg kind
|
||||
| `showTime` | boolean | **Yes** | `true` | |
|
||||
| `showUser` | boolean | **Yes** | `true` | |
|
||||
| `tags` | string[] | **Yes** | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: AzureMonitorDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## AzureMonitorDataQuery
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: AzureMonitorDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## AzureMonitorDataQuery
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: BarChartPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## BarChartPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,20 +27,20 @@ title: BarChartPanelCfg kind
|
||||
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
|
||||
| `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.<br/>Gradient appearance is influenced by the Fill opacity setting. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `1` | Controls line width of the bars.<br/>Constraint: `>=0 & <=10`. |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
|
||||
### AxisConfig
|
||||
@@ -44,7 +48,7 @@ It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldcon
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -60,7 +64,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -70,7 +74,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -78,7 +82,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -96,20 +100,20 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `barWidth` | number | **Yes** | `0.97` | Controls the width of bars. 1 = Max width, 0 = Min width.<br/>Constraint: `>=0 & <=1`. |
|
||||
| `fullHighlight` | boolean | **Yes** | `false` | Enables mode which highlights the entire bar area and shows tooltip when cursor<br/>hovers over highlighted area |
|
||||
| `groupWidth` | number | **Yes** | `0.7` | Controls the width of groups. 1 = max with, 0 = min width.<br/>Constraint: `>=0 & <=1`. |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `orientation` | string | **Yes** | | Controls the orientation of the bar chart, either vertical or horizontal. |
|
||||
| `showValue` | string | **Yes** | | This controls whether values are shown on top or to the left of bars. |
|
||||
| `stacking` | string | **Yes** | | Controls whether bars are stacked or not, either normally or in percent mode. |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `xTickLabelMaxLength` | integer | **Yes** | | Sets the max length that a label can have before it is truncated.<br/>Constraint: `>=0 & <=2147483647`. |
|
||||
| `xTickLabelRotation` | integer | **Yes** | `0` | Controls the rotation of the x axis labels.<br/>Constraint: `>=-90 & <=90`. |
|
||||
| `barRadius` | number | No | `0` | Controls the radius of each bar.<br/>Constraint: `>=0 & <=0.5`. |
|
||||
| `colorByField` | string | No | | Use the color value for a sibling field to color each bar value. |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
| `xField` | string | No | | Manually select which field from the dataset to represent the x field. |
|
||||
| `xTickLabelSpacing` | int32 | No | `0` | Controls the spacing between x axis labels.<br/>negative values indicate backwards skipping behavior |
|
||||
|
||||
@@ -118,7 +122,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -126,7 +130,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -142,7 +146,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -150,7 +154,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
@@ -159,7 +163,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -167,8 +171,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: BarChartPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## BarChartPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,20 +27,20 @@ title: BarChartPanelCfg kind
|
||||
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
|
||||
| `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.<br/>Gradient appearance is influenced by the Fill opacity setting. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `1` | Controls line width of the bars.<br/>Constraint: `>=0 & <=10`. |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
|
||||
### AxisConfig
|
||||
@@ -44,7 +48,7 @@ It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldcon
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -60,7 +64,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -70,7 +74,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -78,7 +82,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -96,20 +100,20 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `barWidth` | number | **Yes** | `0.97` | Controls the width of bars. 1 = Max width, 0 = Min width.<br/>Constraint: `>=0 & <=1`. |
|
||||
| `fullHighlight` | boolean | **Yes** | `false` | Enables mode which highlights the entire bar area and shows tooltip when cursor<br/>hovers over highlighted area |
|
||||
| `groupWidth` | number | **Yes** | `0.7` | Controls the width of groups. 1 = max with, 0 = min width.<br/>Constraint: `>=0 & <=1`. |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `orientation` | string | **Yes** | | Controls the orientation of the bar chart, either vertical or horizontal. |
|
||||
| `showValue` | string | **Yes** | | This controls whether values are shown on top or to the left of bars. |
|
||||
| `stacking` | string | **Yes** | | Controls whether bars are stacked or not, either normally or in percent mode. |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `xTickLabelMaxLength` | integer | **Yes** | | Sets the max length that a label can have before it is truncated.<br/>Constraint: `>=0 & <=2147483647`. |
|
||||
| `xTickLabelRotation` | integer | **Yes** | `0` | Controls the rotation of the x axis labels.<br/>Constraint: `>=-90 & <=90`. |
|
||||
| `barRadius` | number | No | `0` | Controls the radius of each bar.<br/>Constraint: `>=0 & <=0.5`. |
|
||||
| `colorByField` | string | No | | Use the color value for a sibling field to color each bar value. |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
| `xField` | string | No | | Manually select which field from the dataset to represent the x field. |
|
||||
| `xTickLabelSpacing` | int32 | No | `0` | Controls the spacing between x axis labels.<br/>negative values indicate backwards skipping behavior |
|
||||
|
||||
@@ -118,7 +122,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -126,7 +130,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -142,7 +146,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -150,7 +154,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
@@ -159,7 +163,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -167,8 +171,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: BarGaugePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## BarGaugePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
@@ -22,26 +26,26 @@ title: BarGaugePanelCfg kind
|
||||
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `displayMode` | string | **Yes** | | Enum expressing the possible display modes<br/>for the bar gauge component of Grafana UI<br/>Possible values are: `basic`, `lcd`, `gradient`. |
|
||||
| `minVizHeight` | uint32 | **Yes** | `10` | |
|
||||
| `minVizWidth` | uint32 | **Yes** | `0` | |
|
||||
| `showUnfilled` | boolean | **Yes** | `true` | |
|
||||
| `valueMode` | string | **Yes** | | Allows for the table cell gauge display type to set the gauge mode.<br/>Possible values are: `color`, `text`, `hidden`. |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### ReduceDataOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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
|
||||
|
||||
@@ -50,17 +54,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -68,8 +72,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: BarGaugePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## BarGaugePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
@@ -22,26 +26,26 @@ title: BarGaugePanelCfg kind
|
||||
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `displayMode` | string | **Yes** | | Enum expressing the possible display modes<br/>for the bar gauge component of Grafana UI<br/>Possible values are: `basic`, `lcd`, `gradient`. |
|
||||
| `minVizHeight` | uint32 | **Yes** | `10` | |
|
||||
| `minVizWidth` | uint32 | **Yes** | `0` | |
|
||||
| `showUnfilled` | boolean | **Yes** | `true` | |
|
||||
| `valueMode` | string | **Yes** | | Allows for the table cell gauge display type to set the gauge mode.<br/>Possible values are: `color`, `text`, `hidden`. |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### ReduceDataOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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
|
||||
|
||||
@@ -50,17 +54,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -68,8 +72,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: CandlestickPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## CandlestickPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|---------------------------------------|----------|---------|-------------------------------------------------------------|
|
||||
| --------------------- | ------------------------------------- | -------- | ------- | ----------------------------------------------------------- |
|
||||
| `CandleStyle` | string | **Yes** | | Possible values are: `candles`, `ohlcbars`. |
|
||||
| `CandlestickColors` | [object](#candlestickcolors) | **Yes** | | |
|
||||
| `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | | |
|
||||
@@ -26,7 +30,7 @@ title: CandlestickPanelCfg kind
|
||||
### CandlestickColors
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `down` | string | **Yes** | `red` | |
|
||||
| `flat` | string | **Yes** | `gray` | |
|
||||
| `up` | string | **Yes** | `green` | |
|
||||
@@ -34,7 +38,7 @@ title: CandlestickPanelCfg kind
|
||||
### CandlestickFieldMap
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- |
|
||||
| `close` | string | No | | Corresponds to the final (end) value of the given period |
|
||||
| `high` | string | No | | Corresponds to the highest value of the given period |
|
||||
| `low` | string | No | | Corresponds to the lowest value of the given period |
|
||||
@@ -47,45 +51,45 @@ TODO docs
|
||||
|
||||
It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
|
||||
### AxisConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -101,7 +105,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -111,7 +115,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|----------------------------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
|
||||
| `barAlignment` | integer | No | | TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | |
|
||||
| `barWidthFactor` | number | No | | |
|
||||
@@ -121,7 +125,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|-------------|
|
||||
| ------------- | ------ | -------- | ------- | ----------- |
|
||||
| `fillBelowTo` | string | No | | |
|
||||
| `fillColor` | string | No | | |
|
||||
| `fillOpacity` | number | No | | |
|
||||
@@ -131,7 +135,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -139,7 +143,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -149,27 +153,27 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### LineConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
|
||||
### LineStyle
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|--------------------------------------------------------|
|
||||
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|
||||
| `dash` | number[] | No | | |
|
||||
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
|
||||
|
||||
@@ -178,7 +182,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `pointColor` | string | No | | |
|
||||
| `pointSize` | number | No | | |
|
||||
| `pointSymbol` | string | No | | |
|
||||
@@ -189,7 +193,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-----------------------------------|----------|---------|-------------|
|
||||
| ---------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
|
||||
|
||||
### StackingConfig
|
||||
@@ -197,7 +201,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
|
||||
| `group` | string | No | | |
|
||||
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
|
||||
|
||||
@@ -206,12 +210,12 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|-----------------------------------------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ------------------ | --------------------------------------- | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `candleStyle` | string | **Yes** | | Sets the style of the candlesticks |
|
||||
| `colorStrategy` | string | **Yes** | | Sets the color strategy for the candlesticks |
|
||||
| `colors` | [CandlestickColors](#candlestickcolors) | **Yes** | | |
|
||||
| `fields` | [object](#fields) | **Yes** | `map[]` | Map fields to appropriate dimension |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `mode` | string | **Yes** | | Sets which dimensions are used for the visualization |
|
||||
| `includeAllFields` | boolean | No | `false` | When enabled, all fields will be sent to the graph |
|
||||
|
||||
@@ -220,7 +224,7 @@ It extends [OptionsWithLegend](#optionswithlegend).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -228,7 +232,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -244,7 +248,5 @@ TODO docs
|
||||
Map fields to appropriate dimension
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,27 +1,33 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: CandlestickPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
# CandlestickPanelCfg kind
|
||||
|
||||
## Maturity: experimental
|
||||
|
||||
## Version: 0.0
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|-----------------------|--------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `CandleStyle` | string | **Yes** | TODO docs Possible values are: `candles`, `ohlcbars`. |
|
||||
| `CandlestickColors` | [object](#candlestickcolors) | **Yes** | TODO docs |
|
||||
| `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | TODO docs |
|
||||
| `ColorStrategy` | string | **Yes** | TODO docs<br/>"open-close": up/down color depends on current close vs current open<br/>filled always<br/>"close-close": up/down color depends on current close vs prior close<br/>filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. |
|
||||
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
|
||||
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
|
||||
| `VizDisplayMode` | string | **Yes** | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. |
|
||||
| Property | Type | Required | Description |
|
||||
| --------------------- | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `CandleStyle` | string | **Yes** | TODO docs Possible values are: `candles`, `ohlcbars`. |
|
||||
| `CandlestickColors` | [object](#candlestickcolors) | **Yes** | TODO docs |
|
||||
| `CandlestickFieldMap` | [object](#candlestickfieldmap) | **Yes** | TODO docs |
|
||||
| `ColorStrategy` | string | **Yes** | TODO docs<br/>"open-close": up/down color depends on current close vs current open<br/>filled always<br/>"close-close": up/down color depends on current close vs prior close<br/>filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. |
|
||||
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
|
||||
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
|
||||
| `VizDisplayMode` | string | **Yes** | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. |
|
||||
|
||||
## CandlestickColors
|
||||
|
||||
@@ -30,7 +36,7 @@ TODO docs
|
||||
### Properties
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|--------|----------|-------------------|
|
||||
| -------- | ------ | -------- | ----------------- |
|
||||
| `down` | string | **Yes** | Default: `red`. |
|
||||
| `flat` | string | **Yes** | Default: `gray`. |
|
||||
| `up` | string | **Yes** | Default: `green`. |
|
||||
@@ -42,7 +48,7 @@ TODO docs
|
||||
### Properties
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|--------|----------|-------------|
|
||||
| -------- | ------ | -------- | ----------- |
|
||||
| `close` | string | No | |
|
||||
| `high` | string | No | |
|
||||
| `low` | string | No | |
|
||||
@@ -52,20 +58,20 @@ TODO docs
|
||||
## PanelFieldConfig
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|------|----------|-------------|
|
||||
| -------- | ---- | -------- | ----------- |
|
||||
|
||||
## PanelOptions
|
||||
|
||||
### Properties
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|--------------------|-----------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `candleStyle` | string | No | TODO docs Possible values are: `candles`, `ohlcbars`. |
|
||||
| `colorStrategy` | string | No | TODO docs<br/>"open-close": up/down color depends on current close vs current open<br/>filled always<br/>"close-close": up/down color depends on current close vs prior close<br/>filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. |
|
||||
| `colors` | [CandlestickColors](#candlestickcolors) | No | TODO docs |
|
||||
| `fields` | [object](#fields) | No | TODO docs Default: `map[]`. |
|
||||
| `includeAllFields` | boolean | No | When enabled, all fields will be sent to the graph Default: `false`. |
|
||||
| `mode` | string | No | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. |
|
||||
| Property | Type | Required | Description |
|
||||
| ------------------ | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `candleStyle` | string | No | TODO docs Possible values are: `candles`, `ohlcbars`. |
|
||||
| `colorStrategy` | string | No | TODO docs<br/>"open-close": up/down color depends on current close vs current open<br/>filled always<br/>"close-close": up/down color depends on current close vs prior close<br/>filled/hollow depends on current close vs current open Possible values are: `open-close`, `close-close`. |
|
||||
| `colors` | [CandlestickColors](#candlestickcolors) | No | TODO docs |
|
||||
| `fields` | [object](#fields) | No | TODO docs Default: `map[]`. |
|
||||
| `includeAllFields` | boolean | No | When enabled, all fields will be sent to the graph Default: `false`. |
|
||||
| `mode` | string | No | TODO docs Possible values are: `candles+volume`, `candles`, `volume`. |
|
||||
|
||||
### CandlestickColors
|
||||
|
||||
@@ -74,7 +80,7 @@ TODO docs
|
||||
#### Properties
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|--------|----------|-------------------|
|
||||
| -------- | ------ | -------- | ----------------- |
|
||||
| `down` | string | **Yes** | Default: `red`. |
|
||||
| `flat` | string | **Yes** | Default: `gray`. |
|
||||
| `up` | string | **Yes** | Default: `green`. |
|
||||
@@ -85,5 +91,3 @@ TODO docs
|
||||
The default value is: `map[]`.
|
||||
| Property | Type | Required | Description |
|
||||
|----------|------|----------|-------------|
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: CanvasPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## CanvasPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------------|----------------------------------|----------|---------|-----------------------------------------------------------------------|
|
||||
| ----------------------- | -------------------------------- | -------- | ------- | --------------------------------------------------------------------- |
|
||||
| `BackgroundConfig` | [object](#backgroundconfig) | **Yes** | | |
|
||||
| `BackgroundImageSize` | string | **Yes** | | Possible values are: `original`, `contain`, `cover`, `fill`, `tile`. |
|
||||
| `CanvasConnection` | [object](#canvasconnection) | **Yes** | | |
|
||||
@@ -31,7 +35,7 @@ title: CanvasPanelCfg kind
|
||||
### BackgroundConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------|
|
||||
| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------- |
|
||||
| `color` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
|
||||
| `image` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | Links to a resource (image/svg path) |
|
||||
| `size` | string | No | | Possible values are: `original`, `contain`, `cover`, `fill`, `tile`. |
|
||||
@@ -41,14 +45,14 @@ title: CanvasPanelCfg kind
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | string | No | | |
|
||||
|
||||
### BaseDimensionConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ----------------------------------------- |
|
||||
| `field` | string | No | | fixed: T -- will be added by each element |
|
||||
|
||||
### ResourceDimensionConfig
|
||||
@@ -58,15 +62,15 @@ Links to a resource (image/svg path)
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `mapping`. |
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | string | No | | |
|
||||
|
||||
### CanvasConnection
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|-------------------------------------------------|----------|---------|----------------------------------|
|
||||
| ------------ | ----------------------------------------------- | -------- | ------- | -------------------------------- |
|
||||
| `path` | string | **Yes** | | Possible values are: `straight`. |
|
||||
| `source` | [ConnectionCoordinates](#connectioncoordinates) | **Yes** | | |
|
||||
| `target` | [ConnectionCoordinates](#connectioncoordinates) | **Yes** | | |
|
||||
@@ -77,7 +81,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
### ConnectionCoordinates
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `x` | number | **Yes** | | |
|
||||
| `y` | number | **Yes** | | |
|
||||
|
||||
@@ -86,17 +90,17 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `max` | number | **Yes** | | |
|
||||
| `min` | number | **Yes** | | |
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | number | No | | |
|
||||
| `mode` | string | No | | Possible values are: `linear`, `quad`. |
|
||||
|
||||
### CanvasElementOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|-----------------------------------------|----------|---------|---------------------------------------------------------|
|
||||
| ------------- | --------------------------------------- | -------- | ------- | ------------------------------------------------------- |
|
||||
| `name` | string | **Yes** | | |
|
||||
| `type` | string | **Yes** | | |
|
||||
| `background` | [BackgroundConfig](#backgroundconfig) | No | | |
|
||||
@@ -109,21 +113,21 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
### Constraint
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|--------|----------|---------|-----------------------------------------------------------------------|
|
||||
| ------------ | ------ | -------- | ------- | --------------------------------------------------------------------- |
|
||||
| `horizontal` | string | No | | Possible values are: `left`, `right`, `leftright`, `center`, `scale`. |
|
||||
| `vertical` | string | No | | Possible values are: `top`, `bottom`, `topbottom`, `center`, `scale`. |
|
||||
|
||||
### LineConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `color` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
|
||||
| `width` | number | No | | |
|
||||
|
||||
### Placement
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `bottom` | number | No | | |
|
||||
| `height` | number | No | | |
|
||||
| `left` | number | No | | |
|
||||
@@ -134,7 +138,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `inlineEditing` | boolean | **Yes** | `true` | Enable inline editing |
|
||||
| `root` | [object](#root) | **Yes** | | The root element of canvas (frame), where all canvas elements are nested<br/>TODO: Figure out how to define a default value for this |
|
||||
| `showAdvancedTypes` | boolean | **Yes** | `true` | Show all available element types |
|
||||
@@ -145,9 +149,7 @@ The root element of canvas (frame), where all canvas elements are nested
|
||||
TODO: Figure out how to define a default value for this
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-------------------------------------------------|----------|---------|----------------------------------------------------------------|
|
||||
| ---------- | ----------------------------------------------- | -------- | ------- | -------------------------------------------------------------- |
|
||||
| `elements` | [CanvasElementOptions](#canvaselementoptions)[] | **Yes** | | The list of canvas elements attached to the root element |
|
||||
| `name` | string | **Yes** | | Name of the root element |
|
||||
| `type` | string | **Yes** | | Type of root element (frame)<br/>Possible values are: `frame`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: CloudWatchDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## CloudWatchDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: CloudWatchDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## CloudWatchDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
+10
-8
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: DashboardListPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## DashboardListPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------------|----------|----------|---------|-------------|
|
||||
| -------------------- | -------- | -------- | ------- | ----------- |
|
||||
| `includeVars` | boolean | **Yes** | `false` | |
|
||||
| `keepTime` | boolean | **Yes** | `false` | |
|
||||
| `maxItems` | integer | **Yes** | `10` | |
|
||||
@@ -31,5 +35,3 @@ title: DashboardListPanelCfg kind
|
||||
| `showStarred` | boolean | **Yes** | `true` | |
|
||||
| `tags` | string[] | **Yes** | | |
|
||||
| `folderId` | integer | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: DashboardListPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## DashboardListPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------------|----------|----------|---------|-------------|
|
||||
| -------------------- | -------- | -------- | ------- | ----------- |
|
||||
| `includeVars` | boolean | **Yes** | `false` | |
|
||||
| `keepTime` | boolean | **Yes** | `false` | |
|
||||
| `maxItems` | integer | **Yes** | `10` | |
|
||||
@@ -31,5 +35,3 @@ title: DashboardListPanelCfg kind
|
||||
| `showStarred` | boolean | **Yes** | `true` | |
|
||||
| `tags` | string[] | **Yes** | | |
|
||||
| `folderId` | integer | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +1,28 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: DatagridPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## DatagridPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|-----------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | --------------------------------- |
|
||||
| `selectedSeries` | integer | **Yes** | `0` | Constraint: `>=0 & <=2147483647`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +1,28 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: DatagridPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## DatagridPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|-----------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | --------------------------------- |
|
||||
| `selectedSeries` | integer | **Yes** | `0` | Constraint: `>=0 & <=2147483647`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: DebugPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## DebugPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|-------------------------|----------|---------|---------------------------------------------------------------------------|
|
||||
| -------------- | ----------------------- | -------- | ------- | ------------------------------------------------------------------------- |
|
||||
| `DebugMode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
| `UpdateConfig` | [object](#updateconfig) | **Yes** | | |
|
||||
@@ -22,16 +26,14 @@ title: DebugPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-------------------------------|----------|---------|---------------------------------------------------------------------------|
|
||||
| ---------- | ----------------------------- | -------- | ------- | ------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
|
||||
| `counters` | [UpdateConfig](#updateconfig) | No | | |
|
||||
|
||||
### UpdateConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|---------|----------|---------|-------------|
|
||||
| --------------- | ------- | -------- | ------- | ----------- |
|
||||
| `dataChanged` | boolean | **Yes** | | |
|
||||
| `render` | boolean | **Yes** | | |
|
||||
| `schemaChanged` | boolean | **Yes** | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: DebugPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## DebugPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|-------------------------|----------|---------|---------------------------------------------------------------------------|
|
||||
| -------------- | ----------------------- | -------- | ------- | ------------------------------------------------------------------------- |
|
||||
| `DebugMode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
| `UpdateConfig` | [object](#updateconfig) | **Yes** | | |
|
||||
@@ -22,16 +26,14 @@ title: DebugPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-------------------------------|----------|---------|---------------------------------------------------------------------------|
|
||||
| ---------- | ----------------------------- | -------- | ------- | ------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
|
||||
| `counters` | [UpdateConfig](#updateconfig) | No | | |
|
||||
|
||||
### UpdateConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|---------|----------|---------|-------------|
|
||||
| --------------- | ------- | -------- | ------- | ----------- |
|
||||
| `dataChanged` | boolean | **Yes** | | |
|
||||
| `render` | boolean | **Yes** | | |
|
||||
| `schemaChanged` | boolean | **Yes** | | |
|
||||
|
||||
|
||||
|
||||
+94
-92
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: ElasticsearchDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## ElasticsearchDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|-------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `alias` | string | No | | Alias pattern |
|
||||
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations |
|
||||
@@ -28,7 +32,7 @@ title: ElasticsearchDataQuery kind
|
||||
### BucketAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
|
||||
|
||||
### DateHistogram
|
||||
@@ -36,27 +40,27 @@ title: ElasticsearchDataQuery kind
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### BucketAggregationWithField
|
||||
|
||||
It extends [BaseBucketAggregation](#basebucketaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | |
|
||||
| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
|
||||
### BaseBucketAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|---------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | |
|
||||
| `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `settings` | | No | | |
|
||||
@@ -66,59 +70,59 @@ It extends [BaseBucketAggregation](#basebucketaggregation).
|
||||
It extends [BaseBucketAggregation](#basebucketaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
|
||||
### GeoHashGrid
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### Histogram
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### Nested
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### Terms
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### MetricAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ---------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
|
||||
|
||||
### Count
|
||||
@@ -126,15 +130,15 @@ It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
|
||||
### BaseMetricAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | |
|
||||
| `type` | string | **Yes** | | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | |
|
||||
@@ -142,7 +146,7 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
### PipelineMetricAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
|
||||
|
||||
### BucketScript
|
||||
@@ -150,11 +154,11 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
|
||||
| `id` | string | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
|
||||
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
|
||||
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
|
||||
| `id` | string | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
|
||||
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### PipelineMetricAggregationWithMultipleBucketPaths
|
||||
@@ -162,23 +166,23 @@ It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricagg
|
||||
It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | |
|
||||
|
||||
### PipelineVariable
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|-------------|
|
||||
| ------------- | ------ | -------- | ------- | ----------- |
|
||||
| `name` | string | **Yes** | | |
|
||||
| `pipelineAgg` | string | **Yes** | | |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
| `script` | | No | | |
|
||||
|
||||
### CumulativeSum
|
||||
@@ -186,12 +190,12 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### BasePipelineMetricAggregation
|
||||
@@ -199,11 +203,11 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
It extends [MetricAggregationWithField](#metricaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
|
||||
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
|
||||
| `pipelineAgg` | string | No | | |
|
||||
|
||||
### MetricAggregationWithField
|
||||
@@ -211,16 +215,16 @@ It extends [MetricAggregationWithField](#metricaggregationwithfield).
|
||||
It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | |
|
||||
| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `format` | string | No | | |
|
||||
|
||||
### Derivative
|
||||
@@ -228,18 +232,18 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `unit` | string | No | | |
|
||||
|
||||
### MovingAverage
|
||||
@@ -249,30 +253,28 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Meta
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|----------|----------|---------|-------------|
|
||||
| --------- | -------- | -------- | ------- | ----------- |
|
||||
| `metrics` | string[] | No | | |
|
||||
| `orderBy` | string | No | | |
|
||||
| `order` | string | No | | |
|
||||
|
||||
|
||||
|
||||
+94
-92
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: ElasticsearchDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## ElasticsearchDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|-------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `alias` | string | No | | Alias pattern |
|
||||
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations |
|
||||
@@ -28,7 +32,7 @@ title: ElasticsearchDataQuery kind
|
||||
### BucketAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
|
||||
|
||||
### DateHistogram
|
||||
@@ -36,27 +40,27 @@ title: ElasticsearchDataQuery kind
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### BucketAggregationWithField
|
||||
|
||||
It extends [BaseBucketAggregation](#basebucketaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | |
|
||||
| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
|
||||
### BaseBucketAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|---------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | |
|
||||
| `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `settings` | | No | | |
|
||||
@@ -66,59 +70,59 @@ It extends [BaseBucketAggregation](#basebucketaggregation).
|
||||
It extends [BaseBucketAggregation](#basebucketaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `settings` | | No | | *(Inherited from [BaseBucketAggregation](#basebucketaggregation))* |
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
|
||||
|
||||
### GeoHashGrid
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### Histogram
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### Nested
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### Terms
|
||||
|
||||
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))*<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| `settings` | | No | | *(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
|
||||
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
|
||||
|
||||
### MetricAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ---------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
|
||||
|
||||
### Count
|
||||
@@ -126,15 +130,15 @@ It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
|
||||
### BaseMetricAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | |
|
||||
| `type` | string | **Yes** | | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | |
|
||||
@@ -142,7 +146,7 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
### PipelineMetricAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
|
||||
|
||||
### BucketScript
|
||||
@@ -150,11 +154,11 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
|
||||
| `id` | string | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
|
||||
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | *(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))* |
|
||||
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
|
||||
| `id` | string | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
|
||||
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### PipelineMetricAggregationWithMultipleBucketPaths
|
||||
@@ -162,23 +166,23 @@ It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricagg
|
||||
It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | |
|
||||
|
||||
### PipelineVariable
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|-------------|
|
||||
| ------------- | ------ | -------- | ------- | ----------- |
|
||||
| `name` | string | **Yes** | | |
|
||||
| `pipelineAgg` | string | **Yes** | | |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
| `script` | | No | | |
|
||||
|
||||
### CumulativeSum
|
||||
@@ -186,12 +190,12 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### BasePipelineMetricAggregation
|
||||
@@ -199,11 +203,11 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
It extends [MetricAggregationWithField](#metricaggregationwithfield).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
|
||||
| `id` | string | No | | *(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))* |
|
||||
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
|
||||
| `id` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
|
||||
| `pipelineAgg` | string | No | | |
|
||||
|
||||
### MetricAggregationWithField
|
||||
@@ -211,16 +215,16 @@ It extends [MetricAggregationWithField](#metricaggregationwithfield).
|
||||
It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `type` | string | **Yes** | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | |
|
||||
| `hide` | boolean | No | | *(Inherited from [BaseMetricAggregation](#basemetricaggregation))* |
|
||||
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `format` | string | No | | |
|
||||
|
||||
### Derivative
|
||||
@@ -228,18 +232,18 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `unit` | string | No | | |
|
||||
|
||||
### MovingAverage
|
||||
@@ -249,30 +253,28 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `type` | string | **Yes** | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))*<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `hide` | boolean | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `id` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| `pipelineAgg` | string | No | | *(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
|
||||
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
|
||||
| `settings` | [object](#settings) | No | | |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Meta
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|----------|----------|---------|-------------|
|
||||
| --------- | -------- | -------- | ------- | ----------- |
|
||||
| `metrics` | string[] | No | | |
|
||||
| `orderBy` | string | No | | |
|
||||
| `order` | string | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GaugePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GaugePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
@@ -22,23 +26,23 @@ title: GaugePanelCfg kind
|
||||
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `showThresholdLabels` | boolean | **Yes** | `false` | |
|
||||
| `showThresholdMarkers` | boolean | **Yes** | `true` | |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### ReduceDataOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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
|
||||
|
||||
@@ -47,17 +51,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -65,8 +69,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GaugePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GaugePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
@@ -22,23 +26,23 @@ title: GaugePanelCfg kind
|
||||
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `showThresholdLabels` | boolean | **Yes** | `false` | |
|
||||
| `showThresholdMarkers` | boolean | **Yes** | `true` | |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### ReduceDataOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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
|
||||
|
||||
@@ -47,17 +51,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -65,8 +69,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GeomapPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GeomapPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|----------------------------|----------|---------|-----------------------------------------------|
|
||||
| ----------------- | -------------------------- | -------- | ------- | --------------------------------------------- |
|
||||
| `ControlsOptions` | [object](#controlsoptions) | **Yes** | | |
|
||||
| `MapCenterID` | string | **Yes** | | Possible values are: `zero`, `coords`, `fit`. |
|
||||
| `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | |
|
||||
@@ -25,7 +29,7 @@ title: GeomapPanelCfg kind
|
||||
### ControlsOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|---------|----------|---------|--------------------------|
|
||||
| ----------------- | ------- | -------- | ------- | ------------------------ |
|
||||
| `mouseWheelZoom` | boolean | No | | let the mouse wheel zoom |
|
||||
| `showAttribution` | boolean | No | | Lower right |
|
||||
| `showDebug` | boolean | No | | Show debug |
|
||||
@@ -36,7 +40,7 @@ title: GeomapPanelCfg kind
|
||||
### MapViewConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|---------|----------|---------|-------------|
|
||||
| ----------- | ------- | -------- | ------- | ----------- |
|
||||
| `id` | string | **Yes** | `zero` | |
|
||||
| `allLayers` | boolean | No | `true` | |
|
||||
| `lastOnly` | boolean | No | | |
|
||||
@@ -52,7 +56,7 @@ title: GeomapPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | |
|
||||
| `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | |
|
||||
| `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | |
|
||||
@@ -62,7 +66,7 @@ title: GeomapPanelCfg kind
|
||||
### MapLayerOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|---------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | string | **Yes** | | configured unique display name |
|
||||
| `type` | string | **Yes** | | |
|
||||
| `config` | | No | | Custom options depending on the type |
|
||||
@@ -74,7 +78,7 @@ title: GeomapPanelCfg kind
|
||||
### FrameGeometrySource
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|-------------------------------------------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ----------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Possible values are: `auto`, `geohash`, `coords`, `lookup`. |
|
||||
| `gazetteer` | string | No | | Path to Gazetteer |
|
||||
| `geohash` | string | No | | Field mappings |
|
||||
@@ -86,7 +90,5 @@ title: GeomapPanelCfg kind
|
||||
### TooltipOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Possible values are: `none`, `details`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GeomapPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GeomapPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|----------------------------|----------|---------|-----------------------------------------------|
|
||||
| ----------------- | -------------------------- | -------- | ------- | --------------------------------------------- |
|
||||
| `ControlsOptions` | [object](#controlsoptions) | **Yes** | | |
|
||||
| `MapCenterID` | string | **Yes** | | Possible values are: `zero`, `coords`, `fit`. |
|
||||
| `MapViewConfig` | [object](#mapviewconfig) | **Yes** | | |
|
||||
@@ -25,7 +29,7 @@ title: GeomapPanelCfg kind
|
||||
### ControlsOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|---------|----------|---------|--------------------------|
|
||||
| ----------------- | ------- | -------- | ------- | ------------------------ |
|
||||
| `mouseWheelZoom` | boolean | No | | let the mouse wheel zoom |
|
||||
| `showAttribution` | boolean | No | | Lower right |
|
||||
| `showDebug` | boolean | No | | Show debug |
|
||||
@@ -36,7 +40,7 @@ title: GeomapPanelCfg kind
|
||||
### MapViewConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|---------|----------|---------|-------------|
|
||||
| ----------- | ------- | -------- | ------- | ----------- |
|
||||
| `id` | string | **Yes** | `zero` | |
|
||||
| `allLayers` | boolean | No | `true` | |
|
||||
| `lastOnly` | boolean | No | | |
|
||||
@@ -52,7 +56,7 @@ title: GeomapPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `basemap` | [MapLayerOptions](#maplayeroptions) | **Yes** | | |
|
||||
| `controls` | [ControlsOptions](#controlsoptions) | **Yes** | | |
|
||||
| `layers` | [MapLayerOptions](#maplayeroptions)[] | **Yes** | | |
|
||||
@@ -62,7 +66,7 @@ title: GeomapPanelCfg kind
|
||||
### MapLayerOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|---------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | string | **Yes** | | configured unique display name |
|
||||
| `type` | string | **Yes** | | |
|
||||
| `config` | | No | | Custom options depending on the type |
|
||||
@@ -74,7 +78,7 @@ title: GeomapPanelCfg kind
|
||||
### FrameGeometrySource
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|-------------------------------------------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ----------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Possible values are: `auto`, `geohash`, `coords`, `lookup`. |
|
||||
| `gazetteer` | string | No | | Path to Gazetteer |
|
||||
| `geohash` | string | No | | Field mappings |
|
||||
@@ -86,7 +90,5 @@ title: GeomapPanelCfg kind
|
||||
### TooltipOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Possible values are: `none`, `details`. |
|
||||
|
||||
|
||||
|
||||
+9
-7
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GoogleCloudMonitoringDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GoogleCloudMonitoringDataQuery
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
+9
-7
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GoogleCloudMonitoringDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GoogleCloudMonitoringDataQuery
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
+9
-7
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GrafanaPyroscopeDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GrafanaPyroscopeDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|----------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `groupBy` | string[] | **Yes** | | Allows to group the results. |
|
||||
| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
|
||||
| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
|
||||
@@ -23,5 +27,3 @@ title: GrafanaPyroscopeDataQuery kind
|
||||
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
|
||||
| `maxNodes` | integer | No | | Sets the maximum number of nodes in the flamegraph. |
|
||||
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
|
||||
|
||||
|
||||
+9
-7
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: GrafanaPyroscopeDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## GrafanaPyroscopeDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|----------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `groupBy` | string[] | **Yes** | | Allows to group the results. |
|
||||
| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
|
||||
| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
|
||||
@@ -23,5 +27,3 @@ title: GrafanaPyroscopeDataQuery kind
|
||||
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
|
||||
| `maxNodes` | integer | No | | Sets the maximum number of nodes in the flamegraph. |
|
||||
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: HeatmapPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## HeatmapPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|--------------------------------|----------|---------|-------------------------------------------------------------------------------------------|
|
||||
| --------------------- | ------------------------------ | -------- | ------- | ----------------------------------------------------------------------------------------- |
|
||||
| `CellValues` | [object](#cellvalues) | **Yes** | | Controls cell value options |
|
||||
| `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | | Controls exemplar options |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
@@ -33,7 +37,7 @@ title: HeatmapPanelCfg kind
|
||||
Controls cell value options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|-------------------------------------------------|
|
||||
| ---------- | ------ | -------- | ------- | ----------------------------------------------- |
|
||||
| `decimals` | number | No | | Controls the number of decimals for cell values |
|
||||
| `unit` | string | No | | Controls the cell value unit |
|
||||
|
||||
@@ -42,7 +46,7 @@ Controls cell value options
|
||||
Controls exemplar options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|----------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | -------------------------------------- |
|
||||
| `color` | string | **Yes** | | Sets the color of the exemplar markers |
|
||||
|
||||
### FieldConfig
|
||||
@@ -50,8 +54,8 @@ Controls exemplar options
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------|
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -59,7 +63,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -69,7 +73,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### ScaleDistributionConfig
|
||||
@@ -77,7 +81,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -87,7 +91,7 @@ TODO docs
|
||||
Controls the value filter range
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `ge` | number | No | | Sets the filter range to values greater than or equal to the given value |
|
||||
| `le` | number | No | | Sets the filter range to values less than or equal to the given value |
|
||||
|
||||
@@ -96,7 +100,7 @@ Controls the value filter range
|
||||
Controls various color options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------|----------|---------|-------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- |
|
||||
| `exponent` | number | **Yes** | | Controls the exponent when scale is set to exponential |
|
||||
| `fill` | string | **Yes** | | Controls the color fill when in opacity mode |
|
||||
| `reverse` | boolean | **Yes** | | Reverses the color scheme |
|
||||
@@ -112,7 +116,7 @@ Controls various color options
|
||||
Controls legend options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|---------------------------------|
|
||||
| -------- | ------- | -------- | ------- | ------------------------------- |
|
||||
| `show` | boolean | **Yes** | | Controls if the legend is shown |
|
||||
|
||||
### HeatmapTooltip
|
||||
@@ -120,39 +124,39 @@ Controls legend options
|
||||
Controls tooltip options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|---------|----------|---------|----------------------------------------------------------------|
|
||||
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------- |
|
||||
| `show` | boolean | **Yes** | | Controls if the tooltip is shown |
|
||||
| `yHistogram` | boolean | No | | Controls if the tooltip shows a histogram of the y-axis values |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|---------------------------------------------------------|----------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options |
|
||||
| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options |
|
||||
| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options |
|
||||
| `showValue` | string | **Yes** | | | *{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
|
||||
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
|
||||
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
|
||||
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
|
||||
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
|
||||
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
|
||||
| `cellRadius` | number | No | | Controls cell radius |
|
||||
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
|
||||
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
|
||||
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
|
||||
| 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** | | | \*{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
|
||||
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
|
||||
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
|
||||
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
|
||||
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
|
||||
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
|
||||
| `cellRadius` | number | No | | Controls cell radius |
|
||||
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
|
||||
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
|
||||
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
|
||||
|
||||
### HeatmapCalculationOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-------------------------------------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ----------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
|
||||
| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
|
||||
|
||||
### HeatmapCalculationBucketConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------|
|
||||
| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------- |
|
||||
| `mode` | string | No | | Possible values are: `size`, `count`. |
|
||||
| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
|
||||
| `value` | string | No | | The number of buckets to use for the axis in the heatmap |
|
||||
@@ -162,7 +166,7 @@ Controls tooltip options
|
||||
Controls frame rows options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|----------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | -------------------------------------------------------- |
|
||||
| `layout` | string | No | | Possible values are: `le`, `ge`, `unknown`, `auto`. |
|
||||
| `value` | string | No | | Sets the name of the cell when not calculating from data |
|
||||
|
||||
@@ -173,20 +177,20 @@ Configuration options for the yAxis
|
||||
It extends [AxisConfig](#axisconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `decimals` | number | No | | Controls the number of decimals for yAxis values |
|
||||
| `max` | number | No | | Sets the maximum value for the yAxis |
|
||||
| `min` | number | No | | Sets the minimum value for the yAxis |
|
||||
| `reverse` | boolean | No | | Reverses the yAxis |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `unit` | string | No | | Sets the yAxis unit |
|
||||
|
||||
### AxisConfig
|
||||
@@ -194,7 +198,7 @@ It extends [AxisConfig](#axisconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -210,7 +214,7 @@ TODO docs
|
||||
Controls cell value unit
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
### Color
|
||||
@@ -218,7 +222,7 @@ Controls cell value unit
|
||||
Controls the color options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
### FilterValues
|
||||
@@ -226,7 +230,5 @@ Controls the color options
|
||||
Filters values between a given range
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: HeatmapPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## HeatmapPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|--------------------------------|----------|---------|-------------------------------------------------------------------------------------------|
|
||||
| --------------------- | ------------------------------ | -------- | ------- | ----------------------------------------------------------------------------------------- |
|
||||
| `CellValues` | [object](#cellvalues) | **Yes** | | Controls cell value options |
|
||||
| `ExemplarConfig` | [object](#exemplarconfig) | **Yes** | | Controls exemplar options |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
@@ -33,7 +37,7 @@ title: HeatmapPanelCfg kind
|
||||
Controls cell value options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|--------|----------|---------|-------------------------------------------------|
|
||||
| ---------- | ------ | -------- | ------- | ----------------------------------------------- |
|
||||
| `decimals` | number | No | | Controls the number of decimals for cell values |
|
||||
| `unit` | string | No | | Controls the cell value unit |
|
||||
|
||||
@@ -42,7 +46,7 @@ Controls cell value options
|
||||
Controls exemplar options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|----------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | -------------------------------------- |
|
||||
| `color` | string | **Yes** | | Sets the color of the exemplar markers |
|
||||
|
||||
### FieldConfig
|
||||
@@ -50,8 +54,8 @@ Controls exemplar options
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------|
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -59,7 +63,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -69,7 +73,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### ScaleDistributionConfig
|
||||
@@ -77,7 +81,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -87,7 +91,7 @@ TODO docs
|
||||
Controls the value filter range
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `ge` | number | No | | Sets the filter range to values greater than or equal to the given value |
|
||||
| `le` | number | No | | Sets the filter range to values less than or equal to the given value |
|
||||
|
||||
@@ -96,7 +100,7 @@ Controls the value filter range
|
||||
Controls various color options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------|----------|---------|-------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- |
|
||||
| `exponent` | number | **Yes** | | Controls the exponent when scale is set to exponential |
|
||||
| `fill` | string | **Yes** | | Controls the color fill when in opacity mode |
|
||||
| `reverse` | boolean | **Yes** | | Reverses the color scheme |
|
||||
@@ -112,7 +116,7 @@ Controls various color options
|
||||
Controls legend options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|---------------------------------|
|
||||
| -------- | ------- | -------- | ------- | ------------------------------- |
|
||||
| `show` | boolean | **Yes** | | Controls if the legend is shown |
|
||||
|
||||
### HeatmapTooltip
|
||||
@@ -120,39 +124,39 @@ Controls legend options
|
||||
Controls tooltip options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|---------|----------|---------|----------------------------------------------------------------|
|
||||
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------- |
|
||||
| `show` | boolean | **Yes** | | Controls if the tooltip is shown |
|
||||
| `yHistogram` | boolean | No | | Controls if the tooltip shows a histogram of the y-axis values |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|---------------------------------------------------------|----------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options |
|
||||
| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options |
|
||||
| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options |
|
||||
| `showValue` | string | **Yes** | | | *{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
|
||||
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
|
||||
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
|
||||
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
|
||||
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
|
||||
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
|
||||
| `cellRadius` | number | No | | Controls cell radius |
|
||||
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
|
||||
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
|
||||
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
|
||||
| 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** | | | \*{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
|
||||
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
|
||||
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
|
||||
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
|
||||
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
|
||||
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
|
||||
| `cellRadius` | number | No | | Controls cell radius |
|
||||
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
|
||||
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
|
||||
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
|
||||
|
||||
### HeatmapCalculationOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-------------------------------------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ----------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
|
||||
| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
|
||||
|
||||
### HeatmapCalculationBucketConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------|
|
||||
| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------- |
|
||||
| `mode` | string | No | | Possible values are: `size`, `count`. |
|
||||
| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
|
||||
| `value` | string | No | | The number of buckets to use for the axis in the heatmap |
|
||||
@@ -162,7 +166,7 @@ Controls tooltip options
|
||||
Controls frame rows options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|----------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | -------------------------------------------------------- |
|
||||
| `layout` | string | No | | Possible values are: `le`, `ge`, `unknown`, `auto`. |
|
||||
| `value` | string | No | | Sets the name of the cell when not calculating from data |
|
||||
|
||||
@@ -173,20 +177,20 @@ Configuration options for the yAxis
|
||||
It extends [AxisConfig](#axisconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `decimals` | number | No | | Controls the number of decimals for yAxis values |
|
||||
| `max` | number | No | | Sets the maximum value for the yAxis |
|
||||
| `min` | number | No | | Sets the minimum value for the yAxis |
|
||||
| `reverse` | boolean | No | | Reverses the yAxis |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `unit` | string | No | | Sets the yAxis unit |
|
||||
|
||||
### AxisConfig
|
||||
@@ -194,7 +198,7 @@ It extends [AxisConfig](#axisconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -210,7 +214,7 @@ TODO docs
|
||||
Controls cell value unit
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
### Color
|
||||
@@ -218,7 +222,7 @@ Controls cell value unit
|
||||
Controls the color options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
### FilterValues
|
||||
@@ -226,7 +230,5 @@ Controls the color options
|
||||
Filters values between a given range
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: HistogramPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## HistogramPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,27 +27,27 @@ title: HistogramPanelCfg kind
|
||||
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
|
||||
| `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.<br/>Gradient appearance is influenced by the Fill opacity setting. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `1` | Controls line width of the bars.<br/>Constraint: `>=0 & <=10`. |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
|
||||
### AxisConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -59,7 +63,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -69,7 +73,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -79,7 +83,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -87,9 +91,9 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| -------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `bucketOffset` | int32 | No | `0` | Offset buckets by this amount |
|
||||
| `bucketSize` | integer | No | | Size of each bucket |
|
||||
| `combine` | boolean | No | | Combines multiple series into a single histogram |
|
||||
@@ -99,7 +103,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -107,7 +111,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -123,7 +127,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -131,8 +135,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: HistogramPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## HistogramPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,27 +27,27 @@ title: HistogramPanelCfg kind
|
||||
It extends [AxisConfig](#axisconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `fillOpacity` | integer | No | `80` | Controls the fill opacity of the bars.<br/>Constraint: `>=0 & <=100`. |
|
||||
| `gradientMode` | string | No | | Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.<br/>Gradient appearance is influenced by the Fill opacity setting. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `1` | Controls line width of the bars.<br/>Constraint: `>=0 & <=10`. |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
|
||||
### AxisConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -59,7 +63,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -69,7 +73,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -79,7 +83,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -87,9 +91,9 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| -------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `bucketOffset` | int32 | No | `0` | Offset buckets by this amount |
|
||||
| `bucketSize` | integer | No | | Size of each bucket |
|
||||
| `combine` | boolean | No | | Combines multiple series into a single histogram |
|
||||
@@ -99,7 +103,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -107,7 +111,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -123,7 +127,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -131,8 +135,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: LogsPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## LogsPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------------|---------|----------|---------|---------------------------------------------------------------|
|
||||
| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `dedupStrategy` | string | **Yes** | | Possible values are: `none`, `exact`, `numbers`, `signature`. |
|
||||
| `enableLogDetails` | boolean | **Yes** | | |
|
||||
| `prettifyLogMessage` | boolean | **Yes** | | |
|
||||
@@ -29,5 +33,3 @@ title: LogsPanelCfg kind
|
||||
| `showTime` | boolean | **Yes** | | |
|
||||
| `sortOrder` | string | **Yes** | | Possible values are: `Descending`, `Ascending`. |
|
||||
| `wrapLogMessage` | boolean | **Yes** | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: LogsPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## LogsPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------------|---------|----------|---------|---------------------------------------------------------------|
|
||||
| -------------------- | ------- | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `dedupStrategy` | string | **Yes** | | Possible values are: `none`, `exact`, `numbers`, `signature`. |
|
||||
| `enableLogDetails` | boolean | **Yes** | | |
|
||||
| `prettifyLogMessage` | boolean | **Yes** | | |
|
||||
@@ -29,5 +33,3 @@ title: LogsPanelCfg kind
|
||||
| `showTime` | boolean | **Yes** | | |
|
||||
| `sortOrder` | string | **Yes** | | Possible values are: `Descending`, `Ascending`. |
|
||||
| `wrapLogMessage` | boolean | **Yes** | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: LokiDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## LokiDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `expr` | string | **Yes** | | The LogQL query. |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null |
|
||||
@@ -27,5 +31,3 @@ title: LokiDataQuery kind
|
||||
| `range` | boolean | No | | @deprecated, now use queryType. |
|
||||
| `resolution` | integer | No | | @deprecated, now use step. |
|
||||
| `step` | string | No | | Used to set step value for range queries. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: LokiDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## LokiDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `expr` | string | **Yes** | | The LogQL query. |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null |
|
||||
@@ -26,5 +30,3 @@ title: LokiDataQuery kind
|
||||
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
| `range` | boolean | No | | @deprecated, now use queryType. |
|
||||
| `resolution` | integer | No | | Used to scale the interval value. |
|
||||
|
||||
|
||||
|
||||
@@ -1,27 +1,29 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: NewsPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## NewsPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|---------|----------|---------|--------------------------------------------|
|
||||
| ----------- | ------- | -------- | ------- | ------------------------------------------ |
|
||||
| `feedUrl` | string | No | | empty/missing will default to grafana blog |
|
||||
| `showImage` | boolean | No | `true` | |
|
||||
|
||||
|
||||
|
||||
@@ -1,27 +1,29 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: NewsPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## NewsPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|---------|----------|---------|--------------------------------------------|
|
||||
| ----------- | ------- | -------- | ------- | ------------------------------------------ |
|
||||
| `feedUrl` | string | No | | empty/missing will default to grafana blog |
|
||||
| `showImage` | boolean | No | `true` | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: NodeGraphPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## NodeGraphPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `ArcOption` | [object](#arcoption) | **Yes** | | |
|
||||
| `EdgeOptions` | [object](#edgeoptions) | **Yes** | | |
|
||||
| `NodeOptions` | [object](#nodeoptions) | **Yes** | | |
|
||||
@@ -23,21 +27,21 @@ title: NodeGraphPanelCfg kind
|
||||
### ArcOption
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `color` | string | No | | The color of the arc. |
|
||||
| `field` | string | No | | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
|
||||
|
||||
### EdgeOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|--------|----------|---------|-----------------------------------------------------------------------------|
|
||||
| ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------- |
|
||||
| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
|
||||
| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
|
||||
|
||||
### NodeOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|---------------------------|----------|---------|-----------------------------------------------------------------------------------------|
|
||||
| ------------------- | ------------------------- | -------- | ------- | --------------------------------------------------------------------------------------- |
|
||||
| `arcs` | [ArcOption](#arcoption)[] | No | | Define which fields are shown as part of the node arc (colored circle around the node). |
|
||||
| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
|
||||
| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
|
||||
@@ -45,8 +49,6 @@ title: NodeGraphPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------- | -------- | ------- | ----------- |
|
||||
| `edges` | [EdgeOptions](#edgeoptions) | No | | |
|
||||
| `nodes` | [NodeOptions](#nodeoptions) | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: NodeGraphPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## NodeGraphPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `ArcOption` | [object](#arcoption) | **Yes** | | |
|
||||
| `EdgeOptions` | [object](#edgeoptions) | **Yes** | | |
|
||||
| `NodeOptions` | [object](#nodeoptions) | **Yes** | | |
|
||||
@@ -23,21 +27,21 @@ title: NodeGraphPanelCfg kind
|
||||
### ArcOption
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `color` | string | No | | The color of the arc. |
|
||||
| `field` | string | No | | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
|
||||
|
||||
### EdgeOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|--------|----------|---------|-----------------------------------------------------------------------------|
|
||||
| ------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------- |
|
||||
| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
|
||||
| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
|
||||
|
||||
### NodeOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|---------------------------|----------|---------|-----------------------------------------------------------------------------------------|
|
||||
| ------------------- | ------------------------- | -------- | ------- | --------------------------------------------------------------------------------------- |
|
||||
| `arcs` | [ArcOption](#arcoption)[] | No | | Define which fields are shown as part of the node arc (colored circle around the node). |
|
||||
| `mainStatUnit` | string | No | | Unit for the main stat to override what ever is set in the data frame. |
|
||||
| `secondaryStatUnit` | string | No | | Unit for the secondary stat to override what ever is set in the data frame. |
|
||||
@@ -45,8 +49,6 @@ title: NodeGraphPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------- | -------- | ------- | ----------- |
|
||||
| `edges` | [EdgeOptions](#edgeoptions) | No | | |
|
||||
| `nodes` | [NodeOptions](#nodeoptions) | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,25 +1,27 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: ParcaDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## ParcaDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
|
||||
| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null |
|
||||
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
|
||||
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
|
||||
|
||||
|
||||
@@ -1,25 +1,27 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: ParcaDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## ParcaDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `labelSelector` | string | **Yes** | `{}` | Specifies the query label selectors. |
|
||||
| `profileTypeId` | string | **Yes** | | Specifies the type of profile to query. |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null |
|
||||
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
|
||||
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: PieChartPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## PieChartPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------------------- | ------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `FieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | | TODO docs |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
| `PieChartLabels` | string | **Yes** | | Select labels to display on the pie chart.<br/> - Name - The series or field name.<br/> - Percent - The percentage of the whole.<br/> - Value - The raw numerical value.<br/>Possible values are: `name`, `value`, `percent`. |
|
||||
@@ -27,7 +31,7 @@ title: PieChartPanelCfg kind
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -35,7 +39,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -45,21 +49,21 @@ TODO docs
|
||||
It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `displayLabels` | string[] | **Yes** | | |
|
||||
| `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | |
|
||||
| `pieType` | string | **Yes** | | Select the pie chart display style.<br/>Possible values are: `pie`, `donut`. |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTooltip
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -67,7 +71,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
@@ -76,24 +80,24 @@ TODO docs
|
||||
It extends [VizLegendOptions](#vizlegendoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `displayMode` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*<br/>TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*<br/>TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
| `showLegend` | boolean | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| ------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `displayMode` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_<br/>TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_<br/>TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
| `showLegend` | boolean | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `values` | string[] | **Yes** | | |
|
||||
| `asTable` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `isVisible` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `sortBy` | string | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `sortDesc` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `width` | number | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `asTable` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `isVisible` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `sortBy` | string | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `sortDesc` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `width` | number | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
|
||||
### VizLegendOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -108,12 +112,12 @@ TODO docs
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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
|
||||
|
||||
@@ -122,17 +126,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -140,8 +144,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: PieChartPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## PieChartPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------------------- | ------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `FieldConfig` | [HideableFieldConfig](#hideablefieldconfig) | **Yes** | | TODO docs |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
| `PieChartLabels` | string | **Yes** | | Select labels to display on the pie chart.<br/> - Name - The series or field name.<br/> - Percent - The percentage of the whole.<br/> - Value - The raw numerical value.<br/>Possible values are: `name`, `value`, `percent`. |
|
||||
@@ -27,7 +31,7 @@ title: PieChartPanelCfg kind
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -35,7 +39,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -45,21 +49,21 @@ TODO docs
|
||||
It extends [OptionsWithTooltip](#optionswithtooltip) and [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `displayLabels` | string[] | **Yes** | | |
|
||||
| `legend` | [PieChartLegendOptions](#piechartlegendoptions) | **Yes** | | |
|
||||
| `pieType` | string | **Yes** | | Select the pie chart display style.<br/>Possible values are: `pie`, `donut`. |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTooltip
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -67,7 +71,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
@@ -76,24 +80,24 @@ TODO docs
|
||||
It extends [VizLegendOptions](#vizlegendoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `displayMode` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*<br/>TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))*<br/>TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
| `showLegend` | boolean | **Yes** | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| ------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `displayMode` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_<br/>TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_<br/>TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
| `showLegend` | boolean | **Yes** | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `values` | string[] | **Yes** | | |
|
||||
| `asTable` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `isVisible` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `sortBy` | string | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `sortDesc` | boolean | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `width` | number | No | | *(Inherited from [VizLegendOptions](#vizlegendoptions))* |
|
||||
| `asTable` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `isVisible` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `sortBy` | string | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `sortDesc` | boolean | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
| `width` | number | No | | _(Inherited from [VizLegendOptions](#vizlegendoptions))_ |
|
||||
|
||||
### VizLegendOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -108,12 +112,12 @@ TODO docs
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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
|
||||
|
||||
@@ -122,17 +126,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -140,8 +144,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: PrometheusDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## PrometheusDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `expr` | string | **Yes** | | The actual expression/query that will be evaluated by Prometheus |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null |
|
||||
@@ -27,5 +31,3 @@ title: PrometheusDataQuery kind
|
||||
| `legendFormat` | string | No | | Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname |
|
||||
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
| `range` | boolean | No | | Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: PrometheusDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## PrometheusDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `expr` | string | **Yes** | | The actual expression/query that will be evaluated by Prometheus |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null |
|
||||
@@ -27,5 +31,3 @@ title: PrometheusDataQuery kind
|
||||
| `legendFormat` | string | No | | Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname |
|
||||
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
| `range` | boolean | No | | Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: StatPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## StatPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
@@ -22,25 +26,25 @@ title: StatPanelCfg kind
|
||||
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `colorMode` | string | **Yes** | | TODO docs<br/>Possible values are: `value`, `background`, `background_solid`, `none`. |
|
||||
| `graphMode` | string | **Yes** | | TODO docs<br/>Possible values are: `none`, `line`, `area`. |
|
||||
| `justifyMode` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `center`. |
|
||||
| `textMode` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### ReduceDataOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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,17 +53,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -67,8 +71,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
+22
-20
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: StateTimelinePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## StateTimelinePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,9 +27,9 @@ title: StateTimelinePanelCfg kind
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
|
||||
| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -43,7 +47,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -51,21 +55,21 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| ------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `rowHeight` | number | **Yes** | `0.9` | Controls the row height |
|
||||
| `showValue` | string | **Yes** | | Show timeline values on chart |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `alignValue` | string | No | | Controls value alignment on the timelines |
|
||||
| `mergeValues` | boolean | No | `true` | Merge equal consecutive values |
|
||||
| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
|
||||
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
|
||||
|
||||
### OptionsWithLegend
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -73,7 +77,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -89,7 +93,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|----------|----------|---------|-------------|
|
||||
| ---------- | -------- | -------- | ------- | ----------- |
|
||||
| `timezone` | string[] | No | | |
|
||||
|
||||
### OptionsWithTooltip
|
||||
@@ -97,7 +101,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -105,8 +109,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
+22
-20
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: StateTimelinePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## StateTimelinePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,9 +27,9 @@ title: StateTimelinePanelCfg kind
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
|
||||
| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `0` | Constraint: `>=0 & <=10`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -43,7 +47,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -51,21 +55,21 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| ------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `rowHeight` | number | **Yes** | `0.9` | Controls the row height |
|
||||
| `showValue` | string | **Yes** | | Show timeline values on chart |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `alignValue` | string | No | | Controls value alignment on the timelines |
|
||||
| `mergeValues` | boolean | No | `true` | Merge equal consecutive values |
|
||||
| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
|
||||
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
|
||||
|
||||
### OptionsWithLegend
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -73,7 +77,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -89,7 +93,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|----------|----------|---------|-------------|
|
||||
| ---------- | -------- | -------- | ------- | ----------- |
|
||||
| `timezone` | string[] | No | | |
|
||||
|
||||
### OptionsWithTooltip
|
||||
@@ -97,7 +101,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -105,8 +109,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: StatPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## StatPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
@@ -22,25 +26,25 @@ title: StatPanelCfg kind
|
||||
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `colorMode` | string | **Yes** | | TODO docs<br/>Possible values are: `value`, `background`, `background_solid`, `none`. |
|
||||
| `graphMode` | string | **Yes** | | TODO docs<br/>Possible values are: `none`, `line`, `area`. |
|
||||
| `justifyMode` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `center`. |
|
||||
| `textMode` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. |
|
||||
| `orientation` | string | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
|
||||
| `orientation` | string | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))_<br/>TODO docs |
|
||||
|
||||
### ReduceDataOptions
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|---------------------------------------------------------------|
|
||||
| `calcs` | string[] | **Yes** | | When !values, pick one value for the whole field |
|
||||
| `fields` | string | No | | Which fields to show. By default this is only numeric fields |
|
||||
| `limit` | number | No | | if showing all values limit |
|
||||
| `values` | boolean | No | | If true show each row value |
|
||||
| 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,17 +53,17 @@ TODO docs
|
||||
It extends [OptionsWithTextFormatting](#optionswithtextformatting).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
|
||||
| `orientation` | string | **Yes** | | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
|
||||
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | | TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | _(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))_<br/>TODO docs |
|
||||
|
||||
### OptionsWithTextFormatting
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | | TODO docs |
|
||||
|
||||
### VizTextDisplayOptions
|
||||
@@ -67,8 +71,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|--------|----------|---------|--------------------------|
|
||||
| ----------- | ------ | -------- | ------- | ------------------------ |
|
||||
| `titleSize` | number | No | | Explicit title text size |
|
||||
| `valueSize` | number | No | | Explicit value text size |
|
||||
|
||||
|
||||
|
||||
+22
-20
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: StatusHistoryPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## StatusHistoryPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,9 +27,9 @@ title: StatusHistoryPanelCfg kind
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
|
||||
| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `1` | Constraint: `>=0 & <=10`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -43,7 +47,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -51,20 +55,20 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| ----------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `rowHeight` | number | **Yes** | `0.9` | Set the height of the rows<br/>Constraint: `>=0 & <=1`. |
|
||||
| `showValue` | string | **Yes** | | Show values on the columns |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `colWidth` | number | No | `0.9` | Controls the column width |
|
||||
| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
|
||||
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
|
||||
|
||||
### OptionsWithLegend
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -72,7 +76,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|----------|----------|---------|-------------|
|
||||
| ---------- | -------- | -------- | ------- | ----------- |
|
||||
| `timezone` | string[] | No | | |
|
||||
|
||||
### OptionsWithTooltip
|
||||
@@ -96,7 +100,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -104,8 +108,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
+22
-20
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: StatusHistoryPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## StatusHistoryPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|------------------------|----------|---------|-------------|
|
||||
| ------------- | ---------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -23,9 +27,9 @@ title: StatusHistoryPanelCfg kind
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|------------------------------------------------------------------------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------- |
|
||||
| `fillOpacity` | integer | No | `70` | Constraint: `>=0 & <=100`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | `1` | Constraint: `>=0 & <=10`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -33,7 +37,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -43,7 +47,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### Options
|
||||
@@ -51,20 +55,20 @@ TODO docs
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|-----------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| ----------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `rowHeight` | number | **Yes** | `0.9` | Set the height of the rows<br/>Constraint: `>=0 & <=1`. |
|
||||
| `showValue` | string | **Yes** | | Show values on the columns |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `colWidth` | number | No | `0.9` | Controls the column width |
|
||||
| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
|
||||
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
|
||||
|
||||
### OptionsWithLegend
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -72,7 +76,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|----------|----------|---------|-------------|
|
||||
| ---------- | -------- | -------- | ------- | ----------- |
|
||||
| `timezone` | string[] | No | | |
|
||||
|
||||
### OptionsWithTooltip
|
||||
@@ -96,7 +100,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -104,8 +108,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TablePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TablePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|---------------------------------------------------|----------|----------------------------------------------|--------------------------------------------------------------------|
|
||||
| --------------- | ------------------------------------------------- | -------- | -------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| `frameIndex` | number | **Yes** | `0` | Represents the index of the selected frame |
|
||||
| `showHeader` | boolean | **Yes** | `true` | Controls whether the panel should show the header |
|
||||
| `cellHeight` | string | No | | Controls the height of the rows |
|
||||
@@ -33,7 +37,7 @@ title: TablePanelCfg kind
|
||||
Sort by field state
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------|----------|---------|-----------------------------------------------|
|
||||
| ------------- | ------- | -------- | ------- | --------------------------------------------- |
|
||||
| `displayName` | string | **Yes** | | Sets the display name of the field to sort by |
|
||||
| `desc` | boolean | No | | Flag used to indicate descending sort order |
|
||||
|
||||
@@ -42,7 +46,5 @@ Sort by field state
|
||||
Controls footer options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +1,30 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TablePanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TablePanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|---------------------------------------------------|----------|----------------------------------------------|--------------------------------------------------------------------|
|
||||
| --------------- | ------------------------------------------------- | -------- | -------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| `frameIndex` | number | **Yes** | `0` | Represents the index of the selected frame |
|
||||
| `showHeader` | boolean | **Yes** | `true` | Controls whether the panel should show the header |
|
||||
| `cellHeight` | string | No | | Controls the height of the rows |
|
||||
@@ -33,7 +37,7 @@ title: TablePanelCfg kind
|
||||
Sort by field state
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------|----------|---------|-----------------------------------------------|
|
||||
| ------------- | ------- | -------- | ------- | --------------------------------------------- |
|
||||
| `displayName` | string | **Yes** | | Sets the display name of the field to sort by |
|
||||
| `desc` | boolean | No | | Flag used to indicate descending sort order |
|
||||
|
||||
@@ -42,7 +46,5 @@ Sort by field state
|
||||
Controls footer options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [](#), [](#). | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TempoDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TempoDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,19 +1,21 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TempoDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TempoDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
+17
-15
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TestDataDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TestDataDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|-------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------------- | ----------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `alias` | string | No | | |
|
||||
| `channel` | string | No | | |
|
||||
@@ -44,7 +48,7 @@ title: TestDataDataQuery kind
|
||||
### CSVWave
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|---------|----------|---------|-------------|
|
||||
| ----------- | ------- | -------- | ------- | ----------- |
|
||||
| `labels` | string | No | | |
|
||||
| `name` | string | No | | |
|
||||
| `timeStep` | integer | No | | |
|
||||
@@ -53,14 +57,14 @@ title: TestDataDataQuery kind
|
||||
### NodesQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|------------------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | ---------------------------------------------------------- |
|
||||
| `count` | integer | No | | |
|
||||
| `type` | string | No | | Possible values are: `random`, `response`, `random edges`. |
|
||||
|
||||
### PulseWaveQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------|----------|---------|-------------|
|
||||
| ---------- | ------- | -------- | ------- | ----------- |
|
||||
| `offCount` | integer | No | | |
|
||||
| `offValue` | number | No | | |
|
||||
| `onCount` | integer | No | | |
|
||||
@@ -70,7 +74,7 @@ title: TestDataDataQuery kind
|
||||
### SimulationQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------|----------|---------|-------------|
|
||||
| -------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `key` | [object](#key) | **Yes** | | |
|
||||
| `config` | [object](#config) | No | | |
|
||||
| `last` | boolean | No | | |
|
||||
@@ -79,12 +83,12 @@ title: TestDataDataQuery kind
|
||||
### Config
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Key
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `tick` | number | **Yes** | | |
|
||||
| `type` | string | **Yes** | | |
|
||||
| `uid` | string | No | | |
|
||||
@@ -92,7 +96,7 @@ title: TestDataDataQuery kind
|
||||
### StreamingQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|-------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | ----------------------------------------------- |
|
||||
| `noise` | integer | **Yes** | | |
|
||||
| `speed` | integer | **Yes** | | |
|
||||
| `spread` | integer | **Yes** | | |
|
||||
@@ -103,10 +107,8 @@ title: TestDataDataQuery kind
|
||||
### USAQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|-------------|
|
||||
| -------- | -------- | -------- | ------- | ----------- |
|
||||
| `fields` | string[] | No | | |
|
||||
| `mode` | string | No | | |
|
||||
| `period` | string | No | | |
|
||||
| `states` | string[] | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TestDataDataQuery kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TestDataDataQuery
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|-------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------------- | ----------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
|
||||
| `alias` | string | No | | |
|
||||
| `channel` | string | No | | |
|
||||
@@ -43,7 +47,7 @@ title: TestDataDataQuery kind
|
||||
### CSVWave
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|---------|----------|---------|-------------|
|
||||
| ----------- | ------- | -------- | ------- | ----------- |
|
||||
| `labels` | string | No | | |
|
||||
| `name` | string | No | | |
|
||||
| `timeStep` | integer | No | | |
|
||||
@@ -52,14 +56,14 @@ title: TestDataDataQuery kind
|
||||
### NodesQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|------------------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | ---------------------------------------------------------- |
|
||||
| `count` | integer | No | | |
|
||||
| `type` | string | No | | Possible values are: `random`, `response`, `random edges`. |
|
||||
|
||||
### PulseWaveQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------|----------|---------|-------------|
|
||||
| ---------- | ------- | -------- | ------- | ----------- |
|
||||
| `offCount` | integer | No | | |
|
||||
| `offValue` | number | No | | |
|
||||
| `onCount` | integer | No | | |
|
||||
@@ -69,7 +73,7 @@ title: TestDataDataQuery kind
|
||||
### SimulationQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------|----------|---------|-------------|
|
||||
| -------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `key` | [object](#key) | **Yes** | | |
|
||||
| `config` | [object](#config) | No | | |
|
||||
| `last` | boolean | No | | |
|
||||
@@ -78,12 +82,12 @@ title: TestDataDataQuery kind
|
||||
### Config
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Key
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `tick` | number | **Yes** | | |
|
||||
| `type` | string | **Yes** | | |
|
||||
| `uid` | string | No | | |
|
||||
@@ -91,7 +95,7 @@ title: TestDataDataQuery kind
|
||||
### StreamingQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|-------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | ----------------------------------------------- |
|
||||
| `noise` | integer | **Yes** | | |
|
||||
| `speed` | integer | **Yes** | | |
|
||||
| `spread` | integer | **Yes** | | |
|
||||
@@ -102,10 +106,8 @@ title: TestDataDataQuery kind
|
||||
### USAQuery
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|-------------|
|
||||
| -------- | -------- | -------- | ------- | ----------- |
|
||||
| `fields` | string[] | No | | |
|
||||
| `mode` | string | No | | |
|
||||
| `period` | string | No | | |
|
||||
| `states` | string[] | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TextPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TextPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|------------------------|----------|-------------|---------------------------------------------------------------------------------------------------------|
|
||||
| -------------- | ---------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
|
||||
| `CodeOptions` | [object](#codeoptions) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
@@ -23,7 +27,7 @@ title: TextPanelCfg kind
|
||||
### CodeOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|---------|----------|-------------|---------------------------------------------------------------------------------------------------------|
|
||||
| ----------------- | ------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
|
||||
| `showLineNumbers` | boolean | **Yes** | `false` | |
|
||||
| `showMiniMap` | boolean | **Yes** | `false` | |
|
||||
@@ -31,11 +35,9 @@ title: TextPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------|----------|--------------------------------------------------------------------------------|--------------------------------------------------|
|
||||
| --------- | --------------------------- | -------- | ------------------------------------------------------------------------------ | ------------------------------------------------ |
|
||||
| `content` | string | **Yes** | `# Title | |
|
||||
| | | | | |
|
||||
| | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | |
|
||||
| `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
|
||||
| `code` | [CodeOptions](#codeoptions) | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TextPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TextPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------------|------------------------|----------|-------------|---------------------------------------------------------------------------------------------------------|
|
||||
| -------------- | ---------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `CodeLanguage` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
|
||||
| `CodeOptions` | [object](#codeoptions) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
@@ -23,7 +27,7 @@ title: TextPanelCfg kind
|
||||
### CodeOptions
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|---------|----------|-------------|---------------------------------------------------------------------------------------------------------|
|
||||
| ----------------- | ------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `language` | string | **Yes** | `plaintext` | Possible values are: `plaintext`, `yaml`, `xml`, `typescript`, `sql`, `go`, `markdown`, `html`, `json`. |
|
||||
| `showLineNumbers` | boolean | **Yes** | `false` | |
|
||||
| `showMiniMap` | boolean | **Yes** | `false` | |
|
||||
@@ -31,11 +35,9 @@ title: TextPanelCfg kind
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------|----------|--------------------------------------------------------------------------------|--------------------------------------------------|
|
||||
| --------- | --------------------------- | -------- | ------------------------------------------------------------------------------ | ------------------------------------------------ |
|
||||
| `content` | string | **Yes** | `# Title | |
|
||||
| | | | | |
|
||||
| | | | For markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)` | |
|
||||
| `mode` | string | **Yes** | | Possible values are: `html`, `markdown`, `code`. |
|
||||
| `code` | [CodeOptions](#codeoptions) | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TimeSeriesPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TimeSeriesPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|-------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -24,45 +28,45 @@ TODO docs
|
||||
|
||||
It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
|
||||
### AxisConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -78,7 +82,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|----------------------------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
|
||||
| `barAlignment` | integer | No | | TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | |
|
||||
| `barWidthFactor` | number | No | | |
|
||||
@@ -98,7 +102,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|-------------|
|
||||
| ------------- | ------ | -------- | ------- | ----------- |
|
||||
| `fillBelowTo` | string | No | | |
|
||||
| `fillColor` | string | No | | |
|
||||
| `fillOpacity` | number | No | | |
|
||||
@@ -108,7 +112,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -116,7 +120,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -126,27 +130,27 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### LineConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
|
||||
### LineStyle
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|--------------------------------------------------------|
|
||||
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|
||||
| `dash` | number[] | No | | |
|
||||
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
|
||||
|
||||
@@ -155,7 +159,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `pointColor` | string | No | | |
|
||||
| `pointSize` | number | No | | |
|
||||
| `pointSymbol` | string | No | | |
|
||||
@@ -166,7 +170,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-----------------------------------|----------|---------|-------------|
|
||||
| ---------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
|
||||
|
||||
### StackingConfig
|
||||
@@ -174,7 +178,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
|
||||
| `group` | string | No | | |
|
||||
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
|
||||
|
||||
@@ -183,17 +187,17 @@ TODO docs
|
||||
It extends [OptionsWithTimezones](#optionswithtimezones).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-----------------------------------------|----------|---------|------------------------------------------------------------------|
|
||||
| ---------- | --------------------------------------- | -------- | ------- | ---------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
|
||||
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
|
||||
|
||||
### OptionsWithTimezones
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|----------|----------|---------|-------------|
|
||||
| ---------- | -------- | -------- | ------- | ----------- |
|
||||
| `timezone` | string[] | No | | |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -201,7 +205,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -217,8 +221,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TimeSeriesPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TimeSeriesPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|-------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
|
||||
@@ -24,45 +28,45 @@ TODO docs
|
||||
|
||||
It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
|
||||
### AxisConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -78,7 +82,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|----------------------------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
|
||||
| `barAlignment` | integer | No | | TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | |
|
||||
| `barWidthFactor` | number | No | | |
|
||||
@@ -98,7 +102,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|-------------|
|
||||
| ------------- | ------ | -------- | ------- | ----------- |
|
||||
| `fillBelowTo` | string | No | | |
|
||||
| `fillColor` | string | No | | |
|
||||
| `fillOpacity` | number | No | | |
|
||||
@@ -108,7 +112,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -116,7 +120,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -126,27 +130,27 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### LineConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
|
||||
### LineStyle
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|--------------------------------------------------------|
|
||||
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|
||||
| `dash` | number[] | No | | |
|
||||
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
|
||||
|
||||
@@ -155,7 +159,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `pointColor` | string | No | | |
|
||||
| `pointSize` | number | No | | |
|
||||
| `pointSymbol` | string | No | | |
|
||||
@@ -166,7 +170,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-----------------------------------|----------|---------|-------------|
|
||||
| ---------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
|
||||
|
||||
### StackingConfig
|
||||
@@ -174,7 +178,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
|
||||
| `group` | string | No | | |
|
||||
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
|
||||
|
||||
@@ -183,17 +187,17 @@ TODO docs
|
||||
It extends [OptionsWithTimezones](#optionswithtimezones).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-----------------------------------------|----------|---------|------------------------------------------------------------------|
|
||||
| ---------- | --------------------------------------- | -------- | ------- | ---------------------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
| `timezone` | string[] | No | | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
|
||||
| `timezone` | string[] | No | | _(Inherited from [OptionsWithTimezones](#optionswithtimezones))_ |
|
||||
|
||||
### OptionsWithTimezones
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|----------|----------|---------|-------------|
|
||||
| ---------- | -------- | -------- | ------- | ----------- |
|
||||
| `timezone` | string[] | No | | |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -201,7 +205,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -217,8 +221,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TrendPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TrendPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|----------------------------------------------------------------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | -------------------------------------------------------------------- |
|
||||
| `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs |
|
||||
| `Options` | [object](#options) | **Yes** | | Identical to timeseries... except it does not have timezone settings |
|
||||
|
||||
@@ -24,45 +28,45 @@ TODO docs
|
||||
|
||||
It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
|
||||
### AxisConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -78,7 +82,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|----------------------------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
|
||||
| `barAlignment` | integer | No | | TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | |
|
||||
| `barWidthFactor` | number | No | | |
|
||||
@@ -98,7 +102,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|-------------|
|
||||
| ------------- | ------ | -------- | ------- | ----------- |
|
||||
| `fillBelowTo` | string | No | | |
|
||||
| `fillColor` | string | No | | |
|
||||
| `fillOpacity` | number | No | | |
|
||||
@@ -108,7 +112,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -116,7 +120,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -126,27 +130,27 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### LineConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
|
||||
### LineStyle
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|--------------------------------------------------------|
|
||||
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|
||||
| `dash` | number[] | No | | |
|
||||
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
|
||||
|
||||
@@ -155,7 +159,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `pointColor` | string | No | | |
|
||||
| `pointSize` | number | No | | |
|
||||
| `pointSymbol` | string | No | | |
|
||||
@@ -166,7 +170,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-----------------------------------|----------|---------|-------------|
|
||||
| ---------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
|
||||
|
||||
### StackingConfig
|
||||
@@ -174,7 +178,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
|
||||
| `group` | string | No | | |
|
||||
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
|
||||
|
||||
@@ -183,7 +187,7 @@ TODO docs
|
||||
Identical to timeseries... except it does not have timezone settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------------------------------------------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
| `xField` | string | No | | Name of the x field to use (defaults to first number) |
|
||||
@@ -193,7 +197,7 @@ Identical to timeseries... except it does not have timezone settings
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -209,8 +213,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: TrendPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## TrendPanelCfg
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------------------------------------|----------|---------|----------------------------------------------------------------------|
|
||||
| ------------- | ------------------------------------- | -------- | ------- | -------------------------------------------------------------------- |
|
||||
| `FieldConfig` | [GraphFieldConfig](#graphfieldconfig) | **Yes** | | TODO docs |
|
||||
| `Options` | [object](#options) | **Yes** | | Identical to timeseries... except it does not have timezone settings |
|
||||
|
||||
@@ -24,45 +28,45 @@ TODO docs
|
||||
|
||||
It extends [LineConfig](#lineconfig) and [FillConfig](#fillconfig) and [PointsConfig](#pointsconfig) and [AxisConfig](#axisconfig) and [BarConfig](#barconfig) and [StackableFieldConfig](#stackablefieldconfig) and [HideableFieldConfig](#hideablefieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `barAlignment` | integer | No | | *(Inherited from [BarConfig](#barconfig))*<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `barWidthFactor` | number | No | | *(Inherited from [BarConfig](#barconfig))* |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillColor` | string | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `fillOpacity` | number | No | | *(Inherited from [FillConfig](#fillconfig))* |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `lineColor` | string | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `lineInterpolation` | string | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | *(Inherited from [LineConfig](#lineconfig))* |
|
||||
| `pointColor` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSize` | number | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `pointSymbol` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))* |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `showPoints` | string | No | | *(Inherited from [PointsConfig](#pointsconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | *(Inherited from [LineConfig](#lineconfig))*<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | *(Inherited from [StackableFieldConfig](#stackablefieldconfig))*<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | --------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `barAlignment` | integer | No | | _(Inherited from [BarConfig](#barconfig))_<br/>TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `barWidthFactor` | number | No | | _(Inherited from [BarConfig](#barconfig))_ |
|
||||
| `drawStyle` | string | No | | TODO docs<br/>Possible values are: `line`, `bars`, `points`. |
|
||||
| `fillBelowTo` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillColor` | string | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `fillOpacity` | number | No | | _(Inherited from [FillConfig](#fillconfig))_ |
|
||||
| `gradientMode` | string | No | | TODO docs<br/>Possible values are: `none`, `opacity`, `hue`, `scheme`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `lineColor` | string | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `lineInterpolation` | string | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | number | No | | _(Inherited from [LineConfig](#lineconfig))_ |
|
||||
| `pointColor` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSize` | number | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `pointSymbol` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_ |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `showPoints` | string | No | | _(Inherited from [PointsConfig](#pointsconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `spanNulls` | | No | | _(Inherited from [LineConfig](#lineconfig))_<br/>Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | _(Inherited from [StackableFieldConfig](#stackablefieldconfig))_<br/>TODO docs |
|
||||
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | | TODO docs |
|
||||
| `transform` | string | No | | TODO docs<br/>Possible values are: `constant`, `negative-Y`. |
|
||||
|
||||
### AxisConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -78,7 +82,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -88,7 +92,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------------|---------|----------|---------|----------------------------------------------------|
|
||||
| ---------------- | ------- | -------- | ------- | -------------------------------------------------- |
|
||||
| `barAlignment` | integer | No | | TODO docs<br/>Possible values are: `-1`, `0`, `1`. |
|
||||
| `barMaxWidth` | number | No | | |
|
||||
| `barWidthFactor` | number | No | | |
|
||||
@@ -98,7 +102,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|-------------|
|
||||
| ------------- | ------ | -------- | ------- | ----------- |
|
||||
| `fillBelowTo` | string | No | | |
|
||||
| `fillColor` | string | No | | |
|
||||
| `fillOpacity` | number | No | | |
|
||||
@@ -108,7 +112,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -116,7 +120,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -126,27 +130,27 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### LineConfig
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
| Property | Type | Required | Default | Description |
|
||||
| ------------------- | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lineColor` | string | No | | |
|
||||
| `lineInterpolation` | string | No | | TODO docs<br/>Possible values are: `linear`, `smooth`, `stepBefore`, `stepAfter`. |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | TODO docs |
|
||||
| `lineWidth` | number | No | | |
|
||||
| `spanNulls` | | No | | Indicate if null values should be treated as gaps or connected.<br/>When the value is a number, it represents the maximum delta in the<br/>X axis that should be considered connected. For timeseries, this is milliseconds |
|
||||
|
||||
### LineStyle
|
||||
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|--------------------------------------------------------|
|
||||
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|
||||
| `dash` | number[] | No | | |
|
||||
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
|
||||
|
||||
@@ -155,7 +159,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `pointColor` | string | No | | |
|
||||
| `pointSize` | number | No | | |
|
||||
| `pointSymbol` | string | No | | |
|
||||
@@ -166,7 +170,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|-----------------------------------|----------|---------|-------------|
|
||||
| ---------- | --------------------------------- | -------- | ------- | ----------- |
|
||||
| `stacking` | [StackingConfig](#stackingconfig) | No | | TODO docs |
|
||||
|
||||
### StackingConfig
|
||||
@@ -174,7 +178,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------- |
|
||||
| `group` | string | No | | |
|
||||
| `mode` | string | No | | TODO docs<br/>Possible values are: `none`, `normal`, `percent`. |
|
||||
|
||||
@@ -183,7 +187,7 @@ TODO docs
|
||||
Identical to timeseries... except it does not have timezone settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------------------------------------------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------------------------------------------------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
| `xField` | string | No | | Name of the x field to use (defaults to first number) |
|
||||
@@ -193,7 +197,7 @@ Identical to timeseries... except it does not have timezone settings
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -209,8 +213,6 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: XYChartPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## XYChartPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|--------------------------------|----------|---------|---------------------------------------------------------|
|
||||
| --------------------- | ------------------------------ | -------- | ------- | ------------------------------------------------------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
| `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | |
|
||||
@@ -27,16 +31,16 @@ title: XYChartPanelCfg kind
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | |
|
||||
| `label` | string | No | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
|
||||
@@ -44,7 +48,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon
|
||||
| `lineWidth` | integer | No | | Constraint: `>=0 & <=2147483647`. |
|
||||
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
|
||||
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `show` | string | No | | Possible values are: `points`, `lines`, `points+lines`. |
|
||||
|
||||
### AxisConfig
|
||||
@@ -52,7 +56,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -68,7 +72,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -78,14 +82,14 @@ TODO docs
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | string | No | | |
|
||||
|
||||
### BaseDimensionConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ----------------------------------------- |
|
||||
| `field` | string | No | | fixed: T -- will be added by each element |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -93,7 +97,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -103,7 +107,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### LineStyle
|
||||
@@ -111,7 +115,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|--------------------------------------------------------|
|
||||
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|
||||
| `dash` | number[] | No | | |
|
||||
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
|
||||
|
||||
@@ -120,10 +124,10 @@ TODO docs
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `max` | number | **Yes** | | |
|
||||
| `min` | number | **Yes** | | |
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | number | No | | |
|
||||
| `mode` | string | No | | Possible values are: `linear`, `quad`. |
|
||||
|
||||
@@ -132,9 +136,9 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `template`. |
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | string | No | | |
|
||||
|
||||
### Options
|
||||
@@ -142,11 +146,11 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-----------------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| --------------- | --------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `seriesMapping` | string | No | | Possible values are: `auto`, `manual`. |
|
||||
|
||||
### OptionsWithLegend
|
||||
@@ -154,7 +158,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -162,7 +166,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -178,7 +182,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -186,7 +190,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
@@ -195,35 +199,33 @@ TODO docs
|
||||
It extends [FieldConfig](#fieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs |
|
||||
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `label` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>Constraint: `>=0 & <=2147483647`. |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
|
||||
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `label` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Constraint: `>=0 & <=2147483647`. |
|
||||
| `name` | string | No | | |
|
||||
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs |
|
||||
| `show` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>Possible values are: `points`, `lines`, `points+lines`. |
|
||||
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
|
||||
| `show` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Possible values are: `points`, `lines`, `points+lines`. |
|
||||
| `x` | string | No | | |
|
||||
| `y` | string | No | | |
|
||||
|
||||
### XYDimensionConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|----------|----------|---------|-----------------------------------|
|
||||
| --------- | -------- | -------- | ------- | --------------------------------- |
|
||||
| `frame` | integer | **Yes** | | Constraint: `>=0 & <=2147483647`. |
|
||||
| `exclude` | string[] | No | | |
|
||||
| `x` | string | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: XYChartPanelCfg kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## XYChartPanelCfg
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|--------------------------------|----------|---------|---------------------------------------------------------|
|
||||
| --------------------- | ------------------------------ | -------- | ------- | ------------------------------------------------------- |
|
||||
| `FieldConfig` | [object](#fieldconfig) | **Yes** | | |
|
||||
| `Options` | [object](#options) | **Yes** | | |
|
||||
| `ScatterSeriesConfig` | [object](#scatterseriesconfig) | **Yes** | | |
|
||||
@@ -27,17 +31,17 @@ title: XYChartPanelCfg kind
|
||||
It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axisconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [AxisConfig](#axisconfig))* |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [AxisConfig](#axisconfig))_ |
|
||||
| `fillOpacity` | number | No | `0.5` | Constraint: `>=0 & <=1`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [HideableFieldConfig](#hideablefieldconfig))_<br/>TODO docs |
|
||||
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | |
|
||||
| `label` | string | No | | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
|
||||
@@ -46,7 +50,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon
|
||||
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | |
|
||||
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | |
|
||||
| `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | Links to a resource (image/svg path) |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [AxisConfig](#axisconfig))*<br/>TODO docs |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [AxisConfig](#axisconfig))_<br/>TODO docs |
|
||||
| `show` | string | No | | Possible values are: `points`, `lines`, `points+lines`. |
|
||||
|
||||
### AxisConfig
|
||||
@@ -54,7 +58,7 @@ It extends [HideableFieldConfig](#hideablefieldconfig) and [AxisConfig](#axiscon
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------|
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | |
|
||||
| `axisColorMode` | string | No | | TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | |
|
||||
@@ -70,7 +74,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|--------|----------|---------|--------------------------------------------------------------------------|
|
||||
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
|
||||
| `type` | string | **Yes** | | TODO docs<br/>Possible values are: `linear`, `log`, `ordinal`, `symlog`. |
|
||||
| `linearThreshold` | number | No | | |
|
||||
| `log` | number | No | | |
|
||||
@@ -80,14 +84,14 @@ TODO docs
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | string | No | | |
|
||||
|
||||
### BaseDimensionConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ----------------------------------------- |
|
||||
| `field` | string | No | | fixed: T -- will be added by each element |
|
||||
|
||||
### HideSeriesConfig
|
||||
@@ -95,7 +99,7 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------|----------|---------|-------------|
|
||||
| --------- | ------- | -------- | ------- | ----------- |
|
||||
| `legend` | boolean | **Yes** | | |
|
||||
| `tooltip` | boolean | **Yes** | | |
|
||||
| `viz` | boolean | **Yes** | | |
|
||||
@@ -105,7 +109,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------------|----------|---------|-------------|
|
||||
| ---------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | TODO docs |
|
||||
|
||||
### LineStyle
|
||||
@@ -113,7 +117,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------|----------|---------|--------------------------------------------------------|
|
||||
| -------- | -------- | -------- | ------- | ------------------------------------------------------ |
|
||||
| `dash` | number[] | No | | |
|
||||
| `fill` | string | No | | Possible values are: `solid`, `dash`, `dot`, `square`. |
|
||||
|
||||
@@ -124,9 +128,9 @@ Links to a resource (image/svg path)
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `mapping`. |
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | string | No | | |
|
||||
|
||||
### ScaleDimensionConfig
|
||||
@@ -134,10 +138,10 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `max` | number | **Yes** | | |
|
||||
| `min` | number | **Yes** | | |
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | number | No | | |
|
||||
| `mode` | string | No | | Possible values are: `linear`, `quad`. |
|
||||
|
||||
@@ -146,9 +150,9 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `mode` | string | **Yes** | | Possible values are: `fixed`, `field`, `template`. |
|
||||
| `field` | string | No | | *(Inherited from [BaseDimensionConfig](#basedimensionconfig))*<br/>fixed: T -- will be added by each element |
|
||||
| `field` | string | No | | _(Inherited from [BaseDimensionConfig](#basedimensionconfig))_<br/>fixed: T -- will be added by each element |
|
||||
| `fixed` | string | No | | |
|
||||
|
||||
### Options
|
||||
@@ -156,11 +160,11 @@ It extends [BaseDimensionConfig](#basedimensionconfig).
|
||||
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-----------------------------------------------|----------|---------|----------------------------------------------------------------------------|
|
||||
| --------------- | --------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
|
||||
| `dims` | [XYDimensionConfig](#xydimensionconfig) | **Yes** | | |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | _(Inherited from [OptionsWithLegend](#optionswithlegend))_<br/>TODO docs |
|
||||
| `series` | [ScatterSeriesConfig](#scatterseriesconfig)[] | **Yes** | | |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | _(Inherited from [OptionsWithTooltip](#optionswithtooltip))_<br/>TODO docs |
|
||||
| `seriesMapping` | string | No | | Possible values are: `auto`, `manual`. |
|
||||
|
||||
### OptionsWithLegend
|
||||
@@ -168,7 +172,7 @@ It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#opt
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ----------- |
|
||||
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizLegendOptions
|
||||
@@ -176,7 +180,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `calcs` | string[] | **Yes** | | |
|
||||
| `displayMode` | string | **Yes** | | TODO docs<br/>Note: "hidden" needs to remain as an option for plugins compatibility<br/>Possible values are: `list`, `table`, `hidden`. |
|
||||
| `placement` | string | **Yes** | | TODO docs<br/>Possible values are: `bottom`, `right`. |
|
||||
@@ -192,7 +196,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------------------------------------|----------|---------|-------------|
|
||||
| --------- | --------------------------------------- | -------- | ------- | ----------- |
|
||||
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | | TODO docs |
|
||||
|
||||
### VizTooltipOptions
|
||||
@@ -200,7 +204,7 @@ TODO docs
|
||||
TODO docs
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | TODO docs<br/>Possible values are: `single`, `multi`, `none`. |
|
||||
| `sort` | string | **Yes** | | TODO docs<br/>Possible values are: `asc`, `desc`, `none`. |
|
||||
|
||||
@@ -209,37 +213,35 @@ TODO docs
|
||||
It extends [FieldConfig](#fieldconfig).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-----------------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `axisCenteredZero` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisColorMode` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisLabel` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisPlacement` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisSoftMin` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `axisWidth` | number | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `fillOpacity` | number | No | `0.5` | *(Inherited from [FieldConfig](#fieldconfig))*<br/>Constraint: `>=0 & <=1`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs |
|
||||
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `label` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>Constraint: `>=0 & <=2147483647`. |
|
||||
| ------------------- | --------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `axisCenteredZero` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisColorMode` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `text`, `series`. |
|
||||
| `axisGridShow` | boolean | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisLabel` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisPlacement` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `top`, `right`, `bottom`, `left`, `hidden`. |
|
||||
| `axisSoftMax` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisSoftMin` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `axisWidth` | number | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `fillOpacity` | number | No | `0.5` | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Constraint: `>=0 & <=1`. |
|
||||
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
|
||||
| `labelValue` | [TextDimensionConfig](#textdimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `label` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
||||
| `lineColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `lineStyle` | [LineStyle](#linestyle) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
|
||||
| `lineWidth` | integer | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Constraint: `>=0 & <=2147483647`. |
|
||||
| `name` | string | No | | |
|
||||
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))* |
|
||||
| `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>Links to a resource (image/svg path) |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>TODO docs |
|
||||
| `show` | string | No | | *(Inherited from [FieldConfig](#fieldconfig))*<br/>Possible values are: `points`, `lines`, `points+lines`. |
|
||||
| `pointColor` | [ColorDimensionConfig](#colordimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `pointSize` | [ScaleDimensionConfig](#scaledimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_ |
|
||||
| `pointSymbol` | [ResourceDimensionConfig](#resourcedimensionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Links to a resource (image/svg path) |
|
||||
| `scaleDistribution` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>TODO docs |
|
||||
| `show` | string | No | | _(Inherited from [FieldConfig](#fieldconfig))_<br/>Possible values are: `points`, `lines`, `points+lines`. |
|
||||
| `x` | string | No | | |
|
||||
| `y` | string | No | | |
|
||||
|
||||
### XYDimensionConfig
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|----------|----------|---------|-----------------------------------|
|
||||
| --------- | -------- | -------- | ------- | --------------------------------- |
|
||||
| `frame` | integer | **Yes** | | Constraint: `>=0 & <=2147483647`. |
|
||||
| `exclude` | string[] | No | | |
|
||||
| `x` | string | No | | |
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
---
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Core kinds
|
||||
weight: 200
|
||||
---
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: AccessPolicy kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## AccessPolicy
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
Access rules for a scope+role. NOTE there is a unique constraint on role+scope
|
||||
Access rules for a scope+role. NOTE there is a unique constraint on role+scope
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,20 +66,20 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | --------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `role` | [RoleRef](#roleref) | **Yes** | | |
|
||||
| `rules` | [AccessRule](#accessrule)[] | **Yes** | | The set of rules to apply. Note that * is required to modify<br/>access policy rules, and that "none" will reject all actions |
|
||||
| `rules` | [AccessRule](#accessrule)[] | **Yes** | | The set of rules to apply. Note that \* is required to modify<br/>access policy rules, and that "none" will reject all actions |
|
||||
| `scope` | [ResourceRef](#resourceref) | **Yes** | | |
|
||||
|
||||
### AccessRule
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `kind` | string | **Yes** | | The kind this rule applies to (dashboars, alert, etc) |
|
||||
| `verb` | string | **Yes** | | READ, WRITE, CREATE, DELETE, ...<br/>should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" |
|
||||
| `target` | string | No | | Specific sub-elements like "alert.rules" or "dashboard.permissions"???? |
|
||||
@@ -81,14 +87,14 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### ResourceRef
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `kind` | string | **Yes** | | |
|
||||
| `name` | string | **Yes** | | |
|
||||
|
||||
### RoleRef
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `kind` | string | **Yes** | | Policies can apply to roles, teams, or users<br/>Applying policies to individual users is supported, but discouraged<br/>Possible values are: `Role`, `BuiltinRole`, `Team`, `User`. |
|
||||
| `name` | string | **Yes** | | |
|
||||
| `xname` | string | **Yes** | | |
|
||||
@@ -96,7 +102,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -105,12 +111,12 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -121,6 +127,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Dashboard kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## Dashboard
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
A Grafana dashboard.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,26 +66,26 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| 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).<br/>1 for shared crosshair.<br/>2 for shared crosshair AND shared tooltip.<br/>Possible values are: `0`, `1`, `2`. |
|
||||
| `schemaVersion` | uint16 | **Yes** | `36` | Version of the JSON schema, incremented each time a Grafana update brings<br/>changes to said schema. |
|
||||
| `style` | string | **Yes** | `dark` | Theme of dashboard.<br/>Default value: dark.<br/>Possible values are: `dark`, `light`. |
|
||||
| `annotations` | [AnnotationContainer](#annotationcontainer) | No | | Contains the list of annotations that are associated with the dashboard.<br/>Annotations are used to overlay event markers and overlay event tags on graphs.<br/>Grafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the HTTP API.<br/>See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/ |
|
||||
| `description` | string | No | | Description of dashboard. |
|
||||
| `fiscalYearStartMonth` | integer | No | `0` | The month that the fiscal year starts on. 0 = January, 11 = December<br/>Constraint: `>=0 & <12`. |
|
||||
| `fiscalYearStartMonth` | integer | No | `0` | The month that the fiscal year starts on. 0 = January, 11 = December<br/>Constraint: `>=0 & <12`. |
|
||||
| `gnetId` | string | No | | ID of a dashboard imported from the https://grafana.com/grafana/dashboards/ portal |
|
||||
| `id` | integer | No | | Unique numeric identifier for the dashboard.<br/>`id` is internal to a specific Grafana instance. `uid` should be used to identify a dashboard across Grafana instances. |
|
||||
| `links` | [DashboardLink](#dashboardlink)[] | No | | Links with references to other dashboards or external websites. |
|
||||
| `liveNow` | boolean | No | | When set to true, the dashboard will redraw panels at an interval matching the pixel width.<br/>This will keep data "moving left" regardless of the query refresh rate. This setting helps<br/>avoid dashboards presenting stale live data |
|
||||
| `panels` | [object](#panels)[] | No | | List of dashboard panels |
|
||||
| `refresh` | | No | | Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". |
|
||||
| `revision` | integer | No | | This property should only be used in dashboards defined by plugins. It is a quick check<br/>to see if the version has changed since the last time. |
|
||||
| `revision` | integer | No | | This property should only be used in dashboards defined by plugins. It is a quick check<br/>to see if the version has changed since the last time. |
|
||||
| `snapshot` | [Snapshot](#snapshot) | No | | A dashboard snapshot shares an interactive dashboard publicly.<br/>It is a read-only version of a dashboard, and is not editable.<br/>It is possible to create a snapshot of a snapshot.<br/>Grafana strips away all sensitive information from the dashboard.<br/>Sensitive information stripped: queries (metric, template,annotation) and panel links. |
|
||||
| `tags` | string[] | No | | Tags associated with dashboard. |
|
||||
| `templating` | [object](#templating) | No | | Configured template variables |
|
||||
@@ -99,7 +105,7 @@ Grafana comes with a native annotation store and the ability to add annotation e
|
||||
See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------|----------|---------|---------------------|
|
||||
| -------- | ------------------------------------- | -------- | ------- | ------------------- |
|
||||
| `list` | [AnnotationQuery](#annotationquery)[] | No | | List of annotations |
|
||||
|
||||
### AnnotationQuery
|
||||
@@ -108,7 +114,7 @@ TODO docs
|
||||
FROM: AnnotationQuery in grafana-data/src/types/annotations.ts
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|-------------------------------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ----------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `datasource` | [DataSourceRef](#datasourceref) | **Yes** | | Ref to a DataSource instance |
|
||||
| `enable` | boolean | **Yes** | `true` | When enabled the annotation query is issued with every dashboard refresh |
|
||||
| `iconColor` | string | **Yes** | | Color to use for the annotation event markers |
|
||||
@@ -121,7 +127,7 @@ FROM: AnnotationQuery in grafana-data/src/types/annotations.ts
|
||||
### AnnotationPanelFilter
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-----------|----------|---------|-----------------------------------------------------|
|
||||
| --------- | --------- | -------- | ------- | --------------------------------------------------- |
|
||||
| `ids` | integer[] | **Yes** | | Panel IDs that should be included or excluded |
|
||||
| `exclude` | boolean | No | `false` | Should the specified panels be included or excluded |
|
||||
|
||||
@@ -131,7 +137,7 @@ TODO: this should be a regular DataQuery that depends on the selected dashboard
|
||||
these match the properties of the "grafana" datasouce that is default in most dashboards
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|----------|----------|---------|-------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | -------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `limit` | integer | **Yes** | | Only required/valid for the grafana datasource...<br/>but code+tests is already depending on it so hard to change |
|
||||
| `matchAny` | boolean | **Yes** | | Only required/valid for the grafana datasource...<br/>but code+tests is already depending on it so hard to change |
|
||||
| `tags` | string[] | **Yes** | | Only required/valid for the grafana datasource...<br/>but code+tests is already depending on it so hard to change |
|
||||
@@ -142,7 +148,7 @@ these match the properties of the "grafana" datasouce that is default in most da
|
||||
Ref to a DataSource instance
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ---------------------------- |
|
||||
| `type` | string | No | | The plugin type-id |
|
||||
| `uid` | string | No | | Specific datasource instance |
|
||||
|
||||
@@ -151,7 +157,7 @@ Ref to a DataSource instance
|
||||
Links with references to other dashboards or external resources
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|----------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `asDropdown` | boolean | **Yes** | `false` | If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards |
|
||||
| `icon` | string | **Yes** | | Icon name to be displayed with the link |
|
||||
| `includeVars` | boolean | **Yes** | `false` | If true, includes current template variables values in the link as query params |
|
||||
@@ -172,7 +178,7 @@ Grafana strips away all sensitive information from the dashboard.
|
||||
Sensitive information stripped: queries (metric, template,annotation) and panel links.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------|----------|---------|--------------------------------------------------------------------------------|
|
||||
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------ |
|
||||
| `created` | string | **Yes** | | Time when the snapshot was created |
|
||||
| `expires` | string | **Yes** | | Time when the snapshot expires, default is never to expire |
|
||||
| `externalUrl` | string | **Yes** | | external url, if snapshot was shared in external grafana instance |
|
||||
@@ -188,7 +194,7 @@ Sensitive information stripped: queries (metric, template,annotation) and panel
|
||||
### Panels
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [Panel](#panel), [RowPanel](#rowpanel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
|
||||
|
||||
### DataTransformerConfig
|
||||
@@ -198,7 +204,7 @@ Using transformations you can: rename fields, join time series data, perform mat
|
||||
use the output of one transformation as the input to another transformation, etc.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | string | **Yes** | | Unique identifier of transformer |
|
||||
| `options` | | **Yes** | | Options to be passed to the transformer<br/>Valid options depend on the transformer id |
|
||||
| `disabled` | boolean | No | | Disabled transformations are skipped |
|
||||
@@ -210,7 +216,7 @@ Matcher is a predicate configuration. Based on the config a set of field(s) or v
|
||||
It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------|----------|---------|--------------------------------------------------------------------------------|
|
||||
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------ |
|
||||
| `id` | string | **Yes** | `` | The matcher id. This is used to find the matcher implementation from registry. |
|
||||
| `options` | | No | | The matcher options. This is specific to the matcher implementation. |
|
||||
|
||||
@@ -221,7 +227,7 @@ Each column within this structure is called a field. A field can represent a sin
|
||||
Field options allow you to change how the data is displayed in your visualizations.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|-----------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------- | --------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.<br/>Each column within this structure is called a field. A field can represent a single time series or table column.<br/>Field options allow you to change how the data is displayed in your visualizations. |
|
||||
| `overrides` | [object](#overrides)[] | **Yes** | | Overrides are the options applied to specific fields overriding the defaults. |
|
||||
|
||||
@@ -232,20 +238,20 @@ Each column within this structure is called a field. A field can represent a sin
|
||||
Field options allow you to change how the data is displayed in your visualizations.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `color` | [FieldColor](#fieldcolor) | No | | Map a field to a color. |
|
||||
| `custom` | [object](#custom) | No | | custom is specified by the FieldConfig field<br/>in panel plugin schemas. |
|
||||
| `decimals` | number | No | | Specify the number of decimals Grafana includes in the rendered value.<br/>If you leave this field blank, Grafana automatically truncates the number of decimals based on the value.<br/>For example 1.1234 will display as 1.12 and 100.456 will display as 100.<br/>To display all decimals, set the unit to `String`. |
|
||||
| `description` | string | No | | Human readable field metadata |
|
||||
| `displayNameFromDS` | string | No | | This can be used by data sources that return and explicit naming structure for values and labels<br/>When this property is configured, this value is used rather than the default naming strategy. |
|
||||
| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto |
|
||||
| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto |
|
||||
| `filterable` | boolean | No | | True if data source field supports ad-hoc filters |
|
||||
| `links` | | No | | The behavior when clicking on a result |
|
||||
| `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string |
|
||||
| `max` | number | No | | The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. |
|
||||
| `min` | number | No | | The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. |
|
||||
| `noValue` | string | No | | Alternative to empty string |
|
||||
| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results |
|
||||
| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results |
|
||||
| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | Thresholds configuration for the panel |
|
||||
| `unit` | string | No | | Unit a field should use. The unit you select is applied to all fields except time.<br/>You can use the units ID availables in Grafana or a custom unit.<br/>Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts<br/>As custom unit, you can use the following formats:<br/>`suffix:<suffix>` for custom unit that should go after value.<br/>`prefix:<prefix>` for custom unit that should go before value.<br/>`time:<format>` For custom date time formats type for example `time:YYYY-MM-DD`.<br/>`si:<base scale><unit characters>` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.<br/>`count:<unit>` for a custom count unit.<br/>`currency:<unit>` for custom a currency unit. |
|
||||
| `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately |
|
||||
@@ -255,7 +261,7 @@ Field options allow you to change how the data is displayed in your visualizatio
|
||||
Map a field to a color.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|--------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.<br/>Continuous color interpolates a color using the percentage of a value relative to min and max.<br/>Accepted values are:<br/>`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold<br/>`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations<br/>`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations<br/>`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode<br/>`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode<br/>`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode<br/>`continuous-YlRd`: Continuous Yellow-Red palette mode<br/>`continuous-BlPu`: Continuous Blue-Purple palette mode<br/>`continuous-YlBl`: Continuous Yellow-Blue palette mode<br/>`continuous-blues`: Continuous Blue palette mode<br/>`continuous-reds`: Continuous Red palette mode<br/>`continuous-greens`: Continuous Green palette mode<br/>`continuous-purples`: Continuous Purple palette mode<br/>`shades`: Shades of a single color. Specify a single color, useful in an override rule.<br/>`fixed`: Fixed color mode. Specify a single color, useful in an override rule.<br/>Possible values are: `thresholds`, `palette-classic`, `palette-classic-by-name`, `continuous-GrYlRd`, `continuous-RdYlGr`, `continuous-BlYlRd`, `continuous-YlRd`, `continuous-BlPu`, `continuous-YlBl`, `continuous-blues`, `continuous-reds`, `continuous-greens`, `continuous-purples`, `fixed`, `shades`. |
|
||||
| `fixedColor` | string | No | | The fixed color value for fixed or shades color modes. |
|
||||
| `seriesBy` | string | No | | Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.<br/>Possible values are: `min`, `max`, `last`. |
|
||||
@@ -265,7 +271,7 @@ Map a field to a color.
|
||||
Thresholds configuration for the panel
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `mode` | string | **Yes** | | Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).<br/>Possible values are: `absolute`, `percentage`. |
|
||||
| `steps` | [Threshold](#threshold)[] | **Yes** | | Must be sorted by 'value', first value is always -Infinity |
|
||||
|
||||
@@ -275,7 +281,7 @@ User-defined value for a metric that triggers visual changes in a panel when thi
|
||||
They are used to conditionally style and color visualizations based on query results , and can be applied to most visualizations.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|----------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | -------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `color` | string | **Yes** | | Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. |
|
||||
| `value` | number or null | **Yes** | | Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.<br/>Nulls currently appear here when serializing -Infinity to JSON. |
|
||||
|
||||
@@ -284,7 +290,7 @@ They are used to conditionally style and color visualizations based on query res
|
||||
Allow to transform the visual representation of specific data values in a visualization, irrespective of their original units
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [ValueMap](#valuemap), [RangeMap](#rangemap), [RegexMap](#regexmap), [SpecialValueMap](#specialvaluemap). | | |
|
||||
|
||||
### RangeMap
|
||||
@@ -293,7 +299,7 @@ Maps numerical ranges to a display text and color.
|
||||
For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-----------------------------------------------------------------------------------|
|
||||
| --------- | ------------------ | -------- | ------- | --------------------------------------------------------------------------------- |
|
||||
| `options` | [object](#options) | **Yes** | | Range to match against and the result to apply when the value is within the range |
|
||||
| `type` | string | **Yes** | | |
|
||||
|
||||
@@ -312,7 +318,7 @@ Range to match against and the result to apply when the value is within the rang
|
||||
Result used as replacement with text and color when the value matches
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|-----------------------------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
|
||||
| `color` | string | No | | Text to use when the value matches |
|
||||
| `icon` | string | No | | Icon to display when the value matches. Only specific visualizations. |
|
||||
| `index` | integer | No | | Position in the mapping array. Only used internally. |
|
||||
@@ -324,7 +330,7 @@ Maps regular expressions to replacement text and a color.
|
||||
For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|----------------------------------------------------------------------------------------------|
|
||||
| --------- | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------- |
|
||||
| `options` | [object](#options) | **Yes** | | Regular expression to match against and the result to apply when the value matches the regex |
|
||||
| `type` | string | **Yes** | | |
|
||||
|
||||
@@ -333,7 +339,7 @@ For example, if a value is www.example.com, you can configure a regex value mapp
|
||||
Regular expression to match against and the result to apply when the value matches the regex
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-------------------------------------------|----------|---------|-----------------------------------------------------------------------|
|
||||
| --------- | ----------------------------------------- | -------- | ------- | --------------------------------------------------------------------- |
|
||||
| `pattern` | string | **Yes** | | Regular expression to match against |
|
||||
| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | Result used as replacement with text and color when the value matches |
|
||||
|
||||
@@ -344,14 +350,14 @@ See SpecialValueMatch to see the list of special values.
|
||||
For example, you can configure a special value mapping so that null values appear as N/A.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------------------|----------|---------|-------------|
|
||||
| --------- | ------------------ | -------- | ------- | ----------- |
|
||||
| `options` | [object](#options) | **Yes** | | |
|
||||
| `type` | string | **Yes** | | |
|
||||
|
||||
### Options
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `match` | string | **Yes** | | Special value types supported by the `SpecialValueMap`<br/>Possible values are: `true`, `false`, `null`, `nan`, `null+nan`, `empty`. |
|
||||
| `result` | [ValueMappingResult](#valuemappingresult) | **Yes** | | Result used as replacement with text and color when the value matches |
|
||||
|
||||
@@ -361,7 +367,7 @@ Maps text values to a color or different display text and color.
|
||||
For example, you can configure a value mapping so that all instances of the value 10 appear as Perfection! rather than the number.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|------------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------|
|
||||
| --------- | ---------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `options` | map[string][ValueMappingResult](#valuemappingresult) | **Yes** | | Map with <value_to_match>: ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } |
|
||||
| `type` | string | **Yes** | | |
|
||||
|
||||
@@ -371,19 +377,19 @@ custom is specified by the FieldConfig field
|
||||
in panel plugin schemas.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Overrides
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|---------------------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `matcher` | [MatcherConfig](#matcherconfig) | **Yes** | | Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.<br/>It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. |
|
||||
| `properties` | [DynamicConfigValue](#dynamicconfigvalue)[] | **Yes** | | |
|
||||
|
||||
### DynamicConfigValue
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `id` | string | **Yes** | `` | |
|
||||
| `value` | | No | | |
|
||||
|
||||
@@ -393,7 +399,7 @@ Support for legacy graph panel.
|
||||
@deprecated this a deprecated panel type
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------|----------|---------|----------------------------------------------------|
|
||||
| -------- | ----------------- | -------- | ------- | -------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | Possible values are: `graph`. |
|
||||
| `legend` | [object](#legend) | No | | @deprecated this is part of deprecated graph panel |
|
||||
|
||||
@@ -402,7 +408,7 @@ Support for legacy graph panel.
|
||||
@deprecated this is part of deprecated graph panel
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------|----------|---------|-------------|
|
||||
| ---------- | ------- | -------- | ------- | ----------- |
|
||||
| `show` | boolean | **Yes** | `true` | |
|
||||
| `sortDesc` | boolean | No | | |
|
||||
| `sort` | string | No | | |
|
||||
@@ -412,7 +418,7 @@ Support for legacy graph panel.
|
||||
Position and dimensions of a panel in the grid
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------|----------|---------|-------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `h` | uint32 | **Yes** | `9` | Panel height. The height is the number of rows from the top edge of the panel. |
|
||||
| `w` | integer | **Yes** | `12` | Panel width. The width is the number of columns from the left edge of the panel.<br/>Constraint: `>0 & <=24`. |
|
||||
| `x` | integer | **Yes** | `0` | Panel x. The x coordinate is the number of columns from the left edge of the grid<br/>Constraint: `>=0 & <24`. |
|
||||
@@ -425,7 +431,7 @@ Support for legacy heatmap panel.
|
||||
@deprecated this a deprecated panel type
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------- |
|
||||
| `type` | string | **Yes** | | Possible values are: `heatmap`. |
|
||||
|
||||
### LibraryPanelRef
|
||||
@@ -435,7 +441,7 @@ When you make a change to a library panel, that change propagates to all instanc
|
||||
Library panels streamline reuse of panels across multiple dashboards.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------ |
|
||||
| `name` | string | **Yes** | | Library panel name |
|
||||
| `uid` | string | **Yes** | | Library panel uid |
|
||||
|
||||
@@ -444,7 +450,7 @@ Library panels streamline reuse of panels across multiple dashboards.
|
||||
Dashboard panels are the basic visualization building blocks.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------------- | ------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.<br/>Each column within this structure is called a field. A field can represent a single time series or table column.<br/>Field options allow you to change how the data is displayed in your visualizations. |
|
||||
| `options` | [object](#options) | **Yes** | | It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. |
|
||||
| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | List of transformations that are applied to the panel data before rendering.<br/>When there are multiple transformations, Grafana applies them in the order they are listed.<br/>Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. |
|
||||
@@ -454,7 +460,7 @@ Dashboard panels are the basic visualization building blocks.
|
||||
| `description` | string | No | | Panel description. |
|
||||
| `gridPos` | [GridPos](#gridpos) | No | | Position and dimensions of a panel in the grid |
|
||||
| `id` | uint32 | No | | Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. |
|
||||
| `interval` | string | No | | The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.<br/>This value must be formatted as a number followed by a valid time<br/>identifier like: "40s", "3d", etc.<br/>See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options |
|
||||
| `interval` | string | No | | The min time interval setting defines a lower limit for the $**interval and $**interval_ms variables.<br/>This value must be formatted as a number followed by a valid time<br/>identifier like: "40s", "3d", etc.<br/>See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options |
|
||||
| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | A library panel is a reusable panel that you can use in any dashboard.<br/>When you make a change to a library panel, that change propagates to all instances of where the panel is used.<br/>Library panels streamline reuse of panels across multiple dashboards. |
|
||||
| `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links. |
|
||||
| `maxDataPoints` | number | No | | The maximum number of data points that the panel queries are retrieving. |
|
||||
@@ -475,7 +481,7 @@ Each column within this structure is called a field. A field can represent a sin
|
||||
Field options allow you to change how the data is displayed in your visualizations.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|-----------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------- | --------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `defaults` | [FieldConfig](#fieldconfig) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.<br/>Each column within this structure is called a field. A field can represent a single time series or table column.<br/>Field options allow you to change how the data is displayed in your visualizations. |
|
||||
| `overrides` | [overrides](#overrides)[] | **Yes** | | Overrides are the options applied to specific fields overriding the defaults. |
|
||||
|
||||
@@ -486,20 +492,20 @@ Each column within this structure is called a field. A field can represent a sin
|
||||
Field options allow you to change how the data is displayed in your visualizations.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|---------------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `color` | [FieldColor](#fieldcolor) | No | | Map a field to a color. |
|
||||
| `custom` | [custom](#custom) | No | | custom is specified by the FieldConfig field<br/>in panel plugin schemas. |
|
||||
| `decimals` | number | No | | Specify the number of decimals Grafana includes in the rendered value.<br/>If you leave this field blank, Grafana automatically truncates the number of decimals based on the value.<br/>For example 1.1234 will display as 1.12 and 100.456 will display as 100.<br/>To display all decimals, set the unit to `String`. |
|
||||
| `description` | string | No | | Human readable field metadata |
|
||||
| `displayNameFromDS` | string | No | | This can be used by data sources that return and explicit naming structure for values and labels<br/>When this property is configured, this value is used rather than the default naming strategy. |
|
||||
| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto |
|
||||
| `displayName` | string | No | | The display value for this field. This supports template variables blank is auto |
|
||||
| `filterable` | boolean | No | | True if data source field supports ad-hoc filters |
|
||||
| `links` | | No | | The behavior when clicking on a result |
|
||||
| `mappings` | [ValueMapping](#valuemapping)[] | No | | Convert input values into a display string |
|
||||
| `max` | number | No | | The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. |
|
||||
| `min` | number | No | | The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. |
|
||||
| `noValue` | string | No | | Alternative to empty string |
|
||||
| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results |
|
||||
| `path` | string | No | | An explicit path to the field in the datasource. When the frame meta includes a path,<br/>This will default to `${frame.meta.path}/${field.name}<br/><br/>When defined, this value can be used as an identifier within the datasource scope, and<br/>may be used to update the results |
|
||||
| `thresholds` | [ThresholdsConfig](#thresholdsconfig) | No | | Thresholds configuration for the panel |
|
||||
| `unit` | string | No | | Unit a field should use. The unit you select is applied to all fields except time.<br/>You can use the units ID availables in Grafana or a custom unit.<br/>Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts<br/>As custom unit, you can use the following formats:<br/>`suffix:<suffix>` for custom unit that should go after value.<br/>`prefix:<prefix>` for custom unit that should go before value.<br/>`time:<format>` For custom date time formats type for example `time:YYYY-MM-DD`.<br/>`si:<base scale><unit characters>` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.<br/>`count:<unit>` for a custom count unit.<br/>`currency:<unit>` for custom a currency unit. |
|
||||
| `writeable` | boolean | No | | True if data source can write a value to the path. Auth/authz are supported separately |
|
||||
@@ -510,7 +516,7 @@ Maps numerical ranges to a display text and color.
|
||||
For example, if a value is within a certain range, you can configure a range value mapping to display Low or High rather than the number.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------------------|----------|---------|-----------------------------------------------------------------------------------|
|
||||
| --------- | ------------------- | -------- | ------- | --------------------------------------------------------------------------------- |
|
||||
| `options` | [options](#options) | **Yes** | | Range to match against and the result to apply when the value is within the range |
|
||||
| `type` | string | **Yes** | | |
|
||||
|
||||
@@ -520,7 +526,7 @@ Maps regular expressions to replacement text and a color.
|
||||
For example, if a value is www.example.com, you can configure a regex value mapping so that Grafana displays www and truncates the domain.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------------------|----------|---------|----------------------------------------------------------------------------------------------|
|
||||
| --------- | ------------------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
|
||||
| `options` | [options](#options) | **Yes** | | Regular expression to match against and the result to apply when the value matches the regex |
|
||||
| `type` | string | **Yes** | | |
|
||||
|
||||
@@ -531,7 +537,7 @@ See SpecialValueMatch to see the list of special values.
|
||||
For example, you can configure a special value mapping so that null values appear as N/A.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|---------------------|----------|---------|-------------|
|
||||
| --------- | ------------------- | -------- | ------- | ----------- |
|
||||
| `options` | [options](#options) | **Yes** | | |
|
||||
| `type` | string | **Yes** | | |
|
||||
|
||||
@@ -546,21 +552,21 @@ When working directly from CUE, importers can extend this
|
||||
type directly to achieve the same effect.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Options
|
||||
|
||||
It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### RowPanel
|
||||
|
||||
Row panel
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------|---------------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------ | ------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `collapsed` | boolean | **Yes** | `false` | Whether this row should be collapsed or not. |
|
||||
| `id` | uint32 | **Yes** | | Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. |
|
||||
| `panels` | [panels](#panels)[] | **Yes** | | List of panels in the row |
|
||||
@@ -573,7 +579,7 @@ Row panel
|
||||
### Panels
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ---------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [Panel](#panel), [GraphPanel](#graphpanel), [HeatmapPanel](#heatmappanel). | | |
|
||||
|
||||
### GraphPanel
|
||||
@@ -582,7 +588,7 @@ Support for legacy graph panel.
|
||||
@deprecated this a deprecated panel type
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------|----------|---------|----------------------------------------------------|
|
||||
| -------- | ----------------- | -------- | ------- | -------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | Possible values are: `graph`. |
|
||||
| `legend` | [legend](#legend) | No | | @deprecated this is part of deprecated graph panel |
|
||||
|
||||
@@ -591,7 +597,7 @@ Support for legacy graph panel.
|
||||
Dashboard panels are the basic visualization building blocks.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ----------------- | ------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `fieldConfig` | [FieldConfigSource](#fieldconfigsource) | **Yes** | | The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.<br/>Each column within this structure is called a field. A field can represent a single time series or table column.<br/>Field options allow you to change how the data is displayed in your visualizations. |
|
||||
| `options` | [options](#options) | **Yes** | | It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. |
|
||||
| `transformations` | [DataTransformerConfig](#datatransformerconfig)[] | **Yes** | | List of transformations that are applied to the panel data before rendering.<br/>When there are multiple transformations, Grafana applies them in the order they are listed.<br/>Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. |
|
||||
@@ -601,7 +607,7 @@ Dashboard panels are the basic visualization building blocks.
|
||||
| `description` | string | No | | Panel description. |
|
||||
| `gridPos` | [GridPos](#gridpos) | No | | Position and dimensions of a panel in the grid |
|
||||
| `id` | uint32 | No | | Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. |
|
||||
| `interval` | string | No | | The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.<br/>This value must be formatted as a number followed by a valid time<br/>identifier like: "40s", "3d", etc.<br/>See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options |
|
||||
| `interval` | string | No | | The min time interval setting defines a lower limit for the $**interval and $**interval_ms variables.<br/>This value must be formatted as a number followed by a valid time<br/>identifier like: "40s", "3d", etc.<br/>See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options |
|
||||
| `libraryPanel` | [LibraryPanelRef](#librarypanelref) | No | | A library panel is a reusable panel that you can use in any dashboard.<br/>When you make a change to a library panel, that change propagates to all instances of where the panel is used.<br/>Library panels streamline reuse of panels across multiple dashboards. |
|
||||
| `links` | [DashboardLink](#dashboardlink)[] | No | | Panel links. |
|
||||
| `maxDataPoints` | number | No | | The maximum number of data points that the panel queries are retrieving. |
|
||||
@@ -620,7 +626,7 @@ Dashboard panels are the basic visualization building blocks.
|
||||
Configured template variables
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------|----------|---------|----------------------------------------------------------------------------------------------|
|
||||
| -------- | --------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------- |
|
||||
| `list` | [VariableModel](#variablemodel)[] | No | | List of configured template variables with their saved values along with some other metadata |
|
||||
|
||||
### VariableModel
|
||||
@@ -628,12 +634,12 @@ Configured template variables
|
||||
A variable is a placeholder for a value. You can use variables in metric queries and in panel titles.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|-------------------------------------|----------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------- | ----------------------------------- | -------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `hide` | integer | **Yes** | | Determine if the variable shows on dashboard<br/>Accepted values are 0 (show label and value), 1 (show value only), 2 (show nothing).<br/>Possible values are: `0`, `1`, `2`. |
|
||||
| `id` | string | **Yes** | `00000000-0000-0000-0000-000000000000` | Unique numeric identifier for the variable. |
|
||||
| `name` | string | **Yes** | | Name of variable |
|
||||
| `skipUrlSync` | boolean | **Yes** | `false` | Whether the variable value should be managed by URL query params or not |
|
||||
| `type` | string | **Yes** | | Dashboard variable type<br/>`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.<br/>`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).<br/>`constant`: Define a hidden constant.<br/>`datasource`: Quickly change the data source for an entire dashboard.<br/>`interval`: Interval variables represent time spans.<br/>`textbox`: Display a free text input field with an optional default value.<br/>`custom`: Define the variable options manually using a comma-separated list.<br/>`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables<br/>Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. |
|
||||
| `type` | string | **Yes** | | Dashboard variable type<br/>`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.<br/>`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).<br/>`constant`: Define a hidden constant.<br/>`datasource`: Quickly change the data source for an entire dashboard.<br/>`interval`: Interval variables represent time spans.<br/>`textbox`: Display a free text input field with an optional default value.<br/>`custom`: Define the variable options manually using a comma-separated list.<br/>`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables<br/>Possible values are: `query`, `adhoc`, `constant`, `datasource`, `interval`, `textbox`, `custom`, `system`. |
|
||||
| `allFormat` | string | No | | Format to use while fetching all values from data source, eg: wildcard, glob, regex, pipe, etc. |
|
||||
| `current` | [VariableOption](#variableoption) | No | | Option to be selected in a variable. |
|
||||
| `datasource` | [DataSourceRef](#datasourceref) | No | | Ref to a DataSource instance |
|
||||
@@ -649,7 +655,7 @@ A variable is a placeholder for a value. You can use variables in metric queries
|
||||
Option to be selected in a variable.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------|----------|---------|---------------------------------------|
|
||||
| ---------- | ------- | -------- | ------- | ------------------------------------- |
|
||||
| `text` | | **Yes** | | Text to be displayed for the option |
|
||||
| `value` | | **Yes** | | Value of the option |
|
||||
| `selected` | boolean | No | | Whether the option is selected or not |
|
||||
@@ -660,7 +666,7 @@ Time range for dashboard.
|
||||
Accepted values are relative time strings like {from: 'now-6h', to: 'now'} or absolute time strings like {from: '2020-07-10T08:00:00.000Z', to: '2020-07-10T14:00:00.000Z'}.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|----------|-------------|
|
||||
| -------- | ------ | -------- | -------- | ----------- |
|
||||
| `from` | string | **Yes** | `now-6h` | |
|
||||
| `to` | string | **Yes** | `now` | |
|
||||
|
||||
@@ -669,7 +675,7 @@ Accepted values are relative time strings like {from: 'now-6h', to: 'now'} or ab
|
||||
Configuration of the time picker shown at the top of a dashboard.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|----------|----------|---------------------------------------|---------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | -------- | -------- | ------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `collapse` | boolean | **Yes** | `false` | Whether timepicker is collapsed or not. Has no effect on provisioned dashboard. |
|
||||
| `enable` | boolean | **Yes** | `true` | Whether timepicker is enabled or not. Has no effect on provisioned dashboard. |
|
||||
| `hidden` | boolean | **Yes** | `false` | Whether timepicker is visible or not. |
|
||||
@@ -679,7 +685,7 @@ Configuration of the time picker shown at the top of a dashboard.
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -688,12 +694,12 @@ Configuration of the time picker shown at the top of a dashboard.
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -704,6 +710,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Folder kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## Folder
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
A folder is a collection of resources that are grouped together and can share permissions.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | TODO:<br/>common metadata will soon support setting the parent folder in the metadata |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,7 +66,7 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
@@ -68,7 +74,7 @@ TODO:
|
||||
common metadata will soon support setting the parent folder in the metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|--------|----------|---------|--------------------------------------|
|
||||
| ------------- | ------ | -------- | ------- | ------------------------------------ |
|
||||
| `title` | string | **Yes** | | Folder title |
|
||||
| `uid` | string | **Yes** | | Unique folder id. (will be k8s name) |
|
||||
| `description` | string | No | | Description of the folder. |
|
||||
@@ -76,7 +82,7 @@ common metadata will soon support setting the parent folder in the metadata
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -85,12 +91,12 @@ common metadata will soon support setting the parent folder in the metadata
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -101,6 +107,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: LibraryPanel kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## LibraryPanel
|
||||
|
||||
#### Maturity: [experimental](../../../maturity/#experimental)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
A standalone panel
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|-------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `model` | [object](#model) | **Yes** | | TODO: should be the same panel schema defined in dashboard<br/>Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>; |
|
||||
| `name` | string | **Yes** | | Panel name (also saved in the model)<br/>Constraint: `length >=1`. |
|
||||
| `type` | string | **Yes** | | The panel type (from inside the model)<br/>Constraint: `length >=1`. |
|
||||
@@ -79,7 +85,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### LibraryElementDTOMeta
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------------|---------------------------------------------------------|----------|---------|-------------|
|
||||
| --------------------- | ------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `connectedDashboards` | integer | **Yes** | | |
|
||||
| `createdBy` | [LibraryElementDTOMetaUser](#libraryelementdtometauser) | **Yes** | | |
|
||||
| `created` | string | **Yes** | | |
|
||||
@@ -91,7 +97,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### LibraryElementDTOMetaUser
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-------------|---------|----------|---------|-------------|
|
||||
| ----------- | ------- | -------- | ------- | ----------- |
|
||||
| `avatarUrl` | string | **Yes** | | |
|
||||
| `id` | integer | **Yes** | | |
|
||||
| `name` | string | **Yes** | | |
|
||||
@@ -102,12 +108,12 @@ TODO: should be the same panel schema defined in dashboard
|
||||
Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -116,12 +122,12 @@ Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -132,6 +138,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Playlist kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## Playlist
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
A playlist is a series of dashboards that is automatically rotated in the browser, on a configurable interval.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `interval` | string | **Yes** | `5m` | Interval sets the time between switching views in a playlist.<br/>FIXME: Is this based on a standardized format or what options are available? Can datemath be used? |
|
||||
| `name` | string | **Yes** | | Name of the playlist. |
|
||||
| `uid` | string | **Yes** | | Unique playlist identifier. Generated on creation, either by the<br/>creator of the playlist of by the application. |
|
||||
@@ -74,7 +80,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### PlaylistItem
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | string | **Yes** | | Type of the item.<br/>Possible values are: `dashboard_by_uid`, `dashboard_by_id`, `dashboard_by_tag`. |
|
||||
| `value` | string | **Yes** | | Value depends on type and describes the playlist item.<br/><br/> - dashboard_by_id: The value is an internal numerical identifier set by Grafana. This<br/> is not portable as the numerical identifier is non-deterministic between different instances.<br/> Will be replaced by dashboard_by_uid in the future. (deprecated)<br/> - dashboard_by_tag: The value is a tag which is set on any number of dashboards. All<br/> dashboards behind the tag will be added to the playlist.<br/> - dashboard_by_uid: The value is the dashboard UID |
|
||||
| `title` | string | No | | Title is an unused property -- it will be removed in the future |
|
||||
@@ -82,7 +88,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -91,12 +97,12 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -107,6 +113,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Preferences kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## Preferences
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
The user or team frontend preferences
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|---------------------------------------------------|----------|---------|---------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------- |
|
||||
| `homeDashboardUID` | string | No | | UID for the home dashboard |
|
||||
| `language` | string | No | | Selected language (beta) |
|
||||
| `queryHistory` | [QueryHistoryPreference](#queryhistorypreference) | No | | |
|
||||
@@ -76,13 +82,13 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### QueryHistoryPreference
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|--------|----------|---------|---------------------------------------------|
|
||||
| --------- | ------ | -------- | ------- | ------------------------------------------- |
|
||||
| `homeTab` | string | No | | one of: '' | 'query' | 'starred'; |
|
||||
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -91,12 +97,12 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -107,6 +113,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: PublicDashboard kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## PublicDashboard
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
Public dashboard configuration
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| 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 |
|
||||
@@ -76,7 +82,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -85,12 +91,12 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -101,6 +107,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Role kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## Role
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
Roles represent a set of users+teams that should share similar access
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------|---------|----------|---------|-----------------------------------------------------------|
|
||||
| ------------- | ------- | -------- | ------- | --------------------------------------------------------- |
|
||||
| `hidden` | boolean | **Yes** | | Do not show this role |
|
||||
| `name` | string | **Yes** | | The role identifier `managed:builtins:editor:permissions` |
|
||||
| `description` | string | No | | Role description |
|
||||
@@ -75,7 +81,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -84,12 +90,12 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -100,6 +106,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: RoleBinding kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## RoleBinding
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
Role bindings links a user|team to a configured role
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,19 +66,19 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------|-------------------------------------------|----------|---------|----------------------------|
|
||||
| --------- | ----------------------------------------- | -------- | ------- | -------------------------- |
|
||||
| `role` | [object](#role) | **Yes** | | The role we are discussing |
|
||||
| `subject` | [RoleBindingSubject](#rolebindingsubject) | **Yes** | | |
|
||||
|
||||
### RoleBindingSubject
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------ |
|
||||
| `kind` | string | **Yes** | | Possible values are: `Team`, `User`. |
|
||||
| `name` | string | **Yes** | | The team/user identifier name |
|
||||
|
||||
@@ -81,27 +87,27 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
The role we are discussing
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-----------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | --------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [BuiltinRoleRef](#builtinroleref), [CustomRoleRef](#customroleref). | | |
|
||||
|
||||
### BuiltinRoleRef
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|---------------------------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------------------------------------- |
|
||||
| `kind` | string | **Yes** | | Possible values are: `BuiltinRole`. |
|
||||
| `name` | string | **Yes** | | Possible values are: `viewer`, `editor`, `admin`. |
|
||||
|
||||
### CustomRoleRef
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|------------------------------|
|
||||
| -------- | ------ | -------- | ------- | ---------------------------- |
|
||||
| `kind` | string | **Yes** | | Possible values are: `Role`. |
|
||||
| `name` | string | **Yes** | | |
|
||||
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -110,12 +116,12 @@ The role we are discussing
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -126,6 +132,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: ServiceAccount kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## ServiceAccount
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
system account
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,12 +66,12 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|-----------------|--------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| --------------- | ------------------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `avatarUrl` | string | **Yes** | | AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front<br/>of the service account. |
|
||||
| `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. |
|
||||
@@ -80,7 +86,7 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -89,12 +95,12 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -105,6 +111,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -1,20 +1,26 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- grafana
|
||||
- schema
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Team kind
|
||||
---
|
||||
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
## Team
|
||||
|
||||
#### Maturity: [merged](../../../maturity/#merged)
|
||||
|
||||
#### Version: 0.0
|
||||
|
||||
A team is a named grouping of Grafana users to which access control rules may be assigned.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `metadata` | [object](#metadata) | **Yes** | | metadata contains embedded CommonMetadata and can be extended with custom string fields<br/>TODO: use CommonMetadata instead of redefining here; currently needs to be defined here<br/>without external reference as using the CommonMetadata reference breaks thema codegen. |
|
||||
| `spec` | [object](#spec) | **Yes** | | |
|
||||
| `status` | [object](#status) | **Yes** | | |
|
||||
@@ -25,29 +31,29 @@ metadata contains embedded CommonMetadata and can be extended with custom string
|
||||
TODO: use CommonMetadata instead of redefining here; currently needs to be defined here
|
||||
without external reference as using the CommonMetadata reference breaks thema codegen.
|
||||
|
||||
It extends [_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
It extends [\_kubeObjectMetadata](#_kubeobjectmetadata).
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------- | ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `createdBy` | string | **Yes** | | |
|
||||
| `creationTimestamp` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `creationTimestamp` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `extraFields` | [object](#extrafields) | **Yes** | | extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata |
|
||||
| `finalizers` | string[] | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `labels` | map[string]string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `resourceVersion` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `uid` | string | **Yes** | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `finalizers` | string[] | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `labels` | map[string]string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `resourceVersion` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `uid` | string | **Yes** | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
| `updateTimestamp` | string | **Yes** | | |
|
||||
| `updatedBy` | string | **Yes** | | |
|
||||
| `deletionTimestamp` | string | No | | *(Inherited from [_kubeObjectMetadata](#_kubeobjectmetadata))* |
|
||||
| `deletionTimestamp` | string | No | | _(Inherited from [\_kubeObjectMetadata](#_kubeobjectmetadata))_ |
|
||||
|
||||
### _kubeObjectMetadata
|
||||
### \_kubeObjectMetadata
|
||||
|
||||
_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
\_kubeObjectMetadata is metadata found in a kubernetes object's metadata field.
|
||||
It is not exhaustive and only includes fields which may be relevant to a kind's implementation,
|
||||
As it is also intended to be generic enough to function with any API Server.
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|---------------------|-------------------|----------|---------|-------------|
|
||||
| ------------------- | ----------------- | -------- | ------- | ----------- |
|
||||
| `creationTimestamp` | string | **Yes** | | |
|
||||
| `finalizers` | string[] | **Yes** | | |
|
||||
| `labels` | map[string]string | **Yes** | | |
|
||||
@@ -60,19 +66,19 @@ As it is also intended to be generic enough to function with any API Server.
|
||||
extraFields is reserved for any fields that are pulled from the API server metadata but do not have concrete fields in the CUE metadata
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Spec
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|--------------------|
|
||||
| -------- | ------ | -------- | ------- | ------------------ |
|
||||
| `name` | string | **Yes** | | Name of the team. |
|
||||
| `email` | string | No | | Email of the team. |
|
||||
|
||||
### Status
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `additionalFields` | [object](#additionalfields) | No | | additionalFields is reserved for future use |
|
||||
| `operatorStates` | map[string][status.#OperatorState](#status.#operatorstate) | No | | operatorStates is a map of operator ID to operator state evaluations.<br/>Any operator which consumes this kind SHOULD add its state evaluation information to this field. |
|
||||
|
||||
@@ -81,12 +87,12 @@ extraFields is reserved for any fields that are pulled from the API server metad
|
||||
additionalFields is reserved for future use
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
### Status.#OperatorState
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|--------------------|--------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ------------------ | ------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `lastEvaluation` | string | **Yes** | | lastEvaluation is the ResourceVersion last evaluated |
|
||||
| `state` | string | **Yes** | | state describes the state of the lastEvaluation.<br/>It is limited to three possible states for machine evaluation.<br/>Possible values are: `success`, `in_progress`, `failed`. |
|
||||
| `descriptiveState` | string | No | | descriptiveState is an optional more descriptive state field which has no requirements on format |
|
||||
@@ -97,6 +103,4 @@ additionalFields is reserved for future use
|
||||
details contains any extra information that is operator-specific
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|------|----------|---------|-------------|
|
||||
|
||||
|
||||
| -------- | ---- | -------- | ------- | ----------- |
|
||||
|
||||
@@ -3,6 +3,10 @@ keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- maturity
|
||||
labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Grafana Kinds - From Zero to Maturity
|
||||
weight: 300
|
||||
---
|
||||
@@ -11,50 +15,50 @@ weight: 300
|
||||
|
||||
> Grafana’s schema, Kind, and related codegen systems are under intense development.
|
||||
|
||||
Fear of unknown impacts leads to defensive coding, slow PRs, circular arguments, and an overall hesitance to engage.
|
||||
That friction alone is sufficient to sink a large-scale project. This guide seeks to counteract this friction by
|
||||
Fear of unknown impacts leads to defensive coding, slow PRs, circular arguments, and an overall hesitance to engage.
|
||||
That friction alone is sufficient to sink a large-scale project. This guide seeks to counteract this friction by
|
||||
defining an end goal for all schemas: “mature.” This is the word we’re using to refer to the commonsense notion of “this
|
||||
software reached 1.0.”
|
||||
|
||||
In general, 1.0/mature suggests: “we’ve thought about this thing, done the necessary experimenting, know what it is, and
|
||||
feel confident about presenting it to the world.” In the context of schemas intended to act as a single source of truth
|
||||
feel confident about presenting it to the world.” In the context of schemas intended to act as a single source of truth
|
||||
driving many use cases, we can intuitively phrase maturity as:
|
||||
|
||||
- The schema follows general best practices (e.g. good comments, follows field type rules), and the team owning the
|
||||
schema believes that the fields described in the schema are accurate.
|
||||
- Automation propagates the schema as source of truth to every relevant
|
||||
[domain](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.67pop2k2f8fq)
|
||||
(for example: types in frontend, backend, as-code; plugins SDK; docs; APIs and storage; search indexing)
|
||||
- The schema follows general best practices (e.g. good comments, follows field type rules), and the team owning the
|
||||
schema believes that the fields described in the schema are accurate.
|
||||
- Automation propagates the schema as source of truth to every relevant
|
||||
[domain](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.67pop2k2f8fq)
|
||||
(for example: types in frontend, backend, as-code; plugins SDK; docs; APIs and storage; search indexing)
|
||||
|
||||
This intuitive definition gets us pointed in the right direction. But we can’t just jump straight there - we have to
|
||||
This intuitive definition gets us pointed in the right direction. But we can’t just jump straight there - we have to
|
||||
approach it methodically. To that end, this doc outlines four (ok five, but really, four) basic maturity milestones that
|
||||
we expect Kinds and their schemas to progress through:
|
||||
|
||||
- *(Planned - Put a Kind name on the official TODO list)*
|
||||
- _(Planned - Put a Kind name on the official TODO list)_
|
||||
- **Merged** - Get an initial schema written down. Not final. Not perfect.
|
||||
- **Experimental** - Kind schemas are the source of truth for basic working code.
|
||||
- **Stable** - Kind schemas are the source of truth for all target domains.
|
||||
- **Mature** - The operational transition path for the Kind is battle-tested and reliable.
|
||||
|
||||
These milestones have functional definitions, tied to code and enforced in CI. A Kind having reached a particular
|
||||
milestone corresponds to properties of the code that are enforced in CI; advancing to the next milestone likely has a
|
||||
These milestones have functional definitions, tied to code and enforced in CI. A Kind having reached a particular
|
||||
milestone corresponds to properties of the code that are enforced in CI; advancing to the next milestone likely has a
|
||||
direct impact on code generation and runtime behavior.
|
||||
|
||||
Finally, the above definitions imply that maturity for *individual Kinds/schemas* depends on *the Kind system* being
|
||||
mature, as well. This is by design: **Grafana Labs does not intend to publicize any single schema as mature until
|
||||
Finally, the above definitions imply that maturity for _individual Kinds/schemas_ depends on _the Kind system_ being
|
||||
mature, as well. This is by design: **Grafana Labs does not intend to publicize any single schema as mature until
|
||||
[certain schema system milestones are met](https://github.com/orgs/grafana/projects/133/views/8).**
|
||||
|
||||
## Schema Maturity Milestones
|
||||
|
||||
Maturity milestones are a linear progression. Each milestone implies that the conditions of its predecessors continue to
|
||||
be met.
|
||||
be met.
|
||||
|
||||
Reaching a particular milestone implies that the properties of all prior milestones are still met.
|
||||
|
||||
### (Milestone 0 - Planned) {#planned}
|
||||
|
||||
| **Goal** | Put a Kind name on the official TODO list: [Kind Schematization Progress Tracker](https://docs.google.com/spreadsheets/d/1DL6nZHyX42X013QraWYbKsMmHozLrtXDj8teLKvwYMY/edit#gid=0) |
|
||||
|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Reached when** | The planned Kind is listed in the relevant sheet of the progress tracker with a link to track / be able to see when exactly it is planned and who is responsible for doing it |
|
||||
| **Common hurdles** | Existing definitions may not correspond clearly to an object boundary - e.g. playlists are currently in denormalized SQL tables playlist and playlist_item |
|
||||
| **Public-facing guarantees** | None |
|
||||
@@ -63,7 +67,7 @@ Reaching a particular milestone implies that the properties of all prior milesto
|
||||
### Milestone 1 - Merged {#merged}
|
||||
|
||||
| **Goal** | Get an initial schema written down. Not final. Not perfect. |
|
||||
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Reached when** | A PR introducing the initial version of a schema has been merged. |
|
||||
| **Common hurdles** | Getting comfortable with Thema and CUE<br/>Figuring out where all the existing definitions of the Kind are<br/>Knowing whether it’s safe to omit possibly-crufty fields from the existing definitions when writing the schema |
|
||||
| **Public-facing guarantees** | None |
|
||||
@@ -72,51 +76,51 @@ Reaching a particular milestone implies that the properties of all prior milesto
|
||||
### Milestone 2 - Experimental {#experimental}
|
||||
|
||||
| **Goal** | Schemas are the source of truth for basic working code. |
|
||||
|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Reached when** | Go and TypeScript types generated from schema are used in all relevant production code, having replaced handwritten type definitions (if any). |
|
||||
| **Common hurdles** | Compromises on field definitions that seemed fine to reach “committed” start to feel unacceptable<br/>Ergonomics of generated code may start to bite<br/>Aligning with the look and feel of related schemas |
|
||||
| **Public-facing guarantees** | Kinds are available for as-code usage in [grok](https://github.com/grafana/grok), and in tools downstream of grok, following all of grok’s standard patterns. |
|
||||
| **Stage comms** | Internal users:- Start using the schema and give feedback internally to help move to the next stage.External users:- Align with the [experimental](https://docs.google.com/document/d/1lqp0hALax2PT7jSObsX52EbQmIDFnLFMqIbBrJ4EYCE/edit#heading=h.ehl5iy7pcjvq) stage in the release definition document. - Experimental schemas will be discoverable, and from a customer PoV should never be used in production, but they can be explored and we are more than happy to receive feedback |
|
||||
|
||||
|
||||
## Schema-writing guidelines
|
||||
|
||||
### Avoid anonymous nested structs
|
||||
|
||||
***Always name your sub-objects.***
|
||||
**_Always name your sub-objects._**
|
||||
|
||||
In CUE, nesting structs is like nesting objects in JSON, and just as easy:
|
||||
~~~ json
|
||||
|
||||
```json
|
||||
one: {
|
||||
two: {
|
||||
three: {
|
||||
}
|
||||
}
|
||||
~~~
|
||||
```
|
||||
|
||||
While these can be accurately represented in other languages, they aren’t especially friendly to work with:
|
||||
|
||||
~~~ typescript
|
||||
```typescript
|
||||
// TypeScript
|
||||
export interface One {
|
||||
two: {
|
||||
three: string;
|
||||
};
|
||||
}
|
||||
~~~
|
||||
```
|
||||
|
||||
~~~ go
|
||||
```go
|
||||
// Go
|
||||
type One struct {
|
||||
Two struct {
|
||||
Three string `json:"three"`
|
||||
} `json:"two"`
|
||||
}
|
||||
~~~
|
||||
```
|
||||
|
||||
Instead, within your schema, prefer to make root-level definitions with the appropriate attributes:
|
||||
|
||||
~~~ cue
|
||||
```cue
|
||||
// Cue
|
||||
one: {
|
||||
two: #Two
|
||||
@@ -124,9 +128,9 @@ one: {
|
||||
three: string
|
||||
} @cuetsy(kind="interface")
|
||||
}
|
||||
~~~
|
||||
```
|
||||
|
||||
~~~ Typescript
|
||||
```Typescript
|
||||
// TypeScript
|
||||
export interface Two {
|
||||
three: string;
|
||||
@@ -134,9 +138,9 @@ export interface Two {
|
||||
export interface One {
|
||||
two: Two;
|
||||
}
|
||||
~~~
|
||||
```
|
||||
|
||||
~~~ Go
|
||||
```Go
|
||||
// Go
|
||||
type One struct {
|
||||
Two Two `json:"two"`
|
||||
@@ -144,11 +148,11 @@ type One struct {
|
||||
type Two struct {
|
||||
Three string `json:"three"`
|
||||
}
|
||||
~~~
|
||||
```
|
||||
|
||||
### Use precise numeric types
|
||||
|
||||
***Use precise numeric types like `float64` or `uint32`. Never use `number`.***
|
||||
**_Use precise numeric types like `float64` or `uint32`. Never use `number`._**
|
||||
|
||||
Never use `number` for a numeric type in a schema.
|
||||
|
||||
@@ -160,7 +164,7 @@ like `uint32` or `int32`, unless the use case specifically requires a huge numer
|
||||
|
||||
### No explicit `null`
|
||||
|
||||
***Do not use `null` as a type in any schema.***
|
||||
**_Do not use `null` as a type in any schema._**
|
||||
|
||||
This one is tricky to think about, and requires some background.
|
||||
|
||||
@@ -169,9 +173,9 @@ This was problematic, because explicit `null` introduces an ambiguity: is a JSON
|
||||
with value null meaningfully different from the field being absent? That is, should a program behave differently
|
||||
if it encounters a null vs. an absent field?
|
||||
|
||||
In almost all cases, the answer is “no.” Thus, the ambiguity: if both explicit null and absence are *accepted*
|
||||
In almost all cases, the answer is “no.” Thus, the ambiguity: if both explicit null and absence are _accepted_
|
||||
by a system, it pushes responsibility onto anyone writing code in that system to decide, case-by-case,
|
||||
whether the two are *intended to be meaningfully different*, and therefore whether behavior should be different.
|
||||
whether the two are _intended to be meaningfully different_, and therefore whether behavior should be different.
|
||||
|
||||
CUE does have a `null` type, and only accepts data containing `nulls` as valid if the schema explicitly allows a `null`.
|
||||
That means, by default, using CUE for schemas removes the possibility of ambiguity in code that receives data validated
|
||||
@@ -179,11 +183,12 @@ by those schemas, even if the language they’re writing in still allows for amb
|
||||
|
||||
As a schema author, this means you’re being unambiguous by default - no `nulls`. That’s good! The only question is
|
||||
whether it’s worth explicitly allowing a `null` for some particular case:
|
||||
~~~ Cue
|
||||
someField: int32 | null
|
||||
~~~
|
||||
|
||||
The *only* time this *may* be a good idea is if your field needs to be able to represent a value
|
||||
```Cue
|
||||
someField: int32 | null
|
||||
```
|
||||
|
||||
The _only_ time this _may_ be a good idea is if your field needs to be able to represent a value
|
||||
that is not otherwise acceptable within the value space - for example, if `someField` needs to be able to contain
|
||||
[Infinity](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/POSITIVE_INFINITY).
|
||||
When such values are serialized to null by default, it can be convenient to accept null in the schema - but even then,
|
||||
@@ -201,39 +206,40 @@ Schematization is an opportunity to get rid of this ambiguity. Fix the accidenta
|
||||
information as `nil`, when MySQL and SQLite save it as `{}`. If we found it in the rest of the cases, it isn't necessary
|
||||
to set `?` in the field in the schema.
|
||||
|
||||
|
||||
## Schema Attributes
|
||||
|
||||
Grafana’s schema system relies on [CUE attributes](https://cuelang.org/docs/references/spec/#attributes)declared on
|
||||
properties within schemas to control some aspects of code generation behavior.
|
||||
Grafana’s schema system relies on [CUE attributes](https://cuelang.org/docs/references/spec/#attributes)declared on
|
||||
properties within schemas to control some aspects of code generation behavior.
|
||||
In a schema, an attribute is the whole of `@cuetsy(kind=”type”)`:
|
||||
|
||||
~~~ Cue
|
||||
```Cue
|
||||
field: string @cuetsy(kind="type")
|
||||
~~~
|
||||
```
|
||||
|
||||
CUE attributes are purely informational - they cannot influence CUE evaluation behavior, including the types being
|
||||
CUE attributes are purely informational - they cannot influence CUE evaluation behavior, including the types being
|
||||
expressed in a Thema schema.
|
||||
|
||||
CUE attributes have three parts. In `@cuetsy(kind=”type”)`, those are:
|
||||
|
||||
- name - `@cuetsy`
|
||||
- arg - `kind`
|
||||
- argval - `“type”`
|
||||
|
||||
Any given attribute may consist of `{name}`, `{name,arg}`, or `{name,arg,argval}`. These three levels form a tree
|
||||
(meaning of any argval is specific to its arg, which is specific to its name). The following documentation represents
|
||||
Any given attribute may consist of `{name}`, `{name,arg}`, or `{name,arg,argval}`. These three levels form a tree
|
||||
(meaning of any argval is specific to its arg, which is specific to its name). The following documentation represents
|
||||
this tree using a header hierarchy.
|
||||
|
||||
### @cuetsy
|
||||
|
||||
These attributes control the behavior of the [cuetsy code generator](https://github.com/grafana/cuetsy), which converts
|
||||
These attributes control the behavior of the [cuetsy code generator](https://github.com/grafana/cuetsy), which converts
|
||||
CUE to TypeScript. We include only the kind arg here for brevity; cuetsy’s README has the canonical documentation on all
|
||||
supported args and argvals, and their intended usage.
|
||||
|
||||
Notes:
|
||||
|
||||
- Only top-level fields in a Thema schema are scanned for `@cuetsy` attributes.
|
||||
- Grafana’s code generators hardcode that an interface (`@cuetsy(kind=”interface”)`) is generated to represent the root
|
||||
schema object, unless it is known to be a [grouped lineage](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.vx7stzpxtw4t).
|
||||
- Grafana’s code generators hardcode that an interface (`@cuetsy(kind=”interface”)`) is generated to represent the root
|
||||
schema object, unless it is known to be a [grouped lineage](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.vx7stzpxtw4t).
|
||||
|
||||
#### kind
|
||||
|
||||
@@ -259,21 +265,21 @@ in plugin code generators.
|
||||
#### TSVeneer
|
||||
|
||||
Applying a TSVeneer arg to a field in a schema indicates that the schema author wants to enrich the generated type
|
||||
(for example by adding generic type parameters), so code generation should expect a handwritten
|
||||
(for example by adding generic type parameters), so code generation should expect a handwritten
|
||||
[veneer](https://docs.google.com/document/d/13Rv395_T8WTLBgdL-2rbXKu0fx_TW-Q9yz9x6oBjm6g/edit#heading=h.bmtjq0bb1yxp).
|
||||
|
||||
TSVeneer requires at least one argval, each of which impacts TypeScript code generation in its own way.
|
||||
TSVeneer requires at least one argval, each of which impacts TypeScript code generation in its own way.
|
||||
Multiple argvals may be given, separated by `|`.
|
||||
|
||||
A TSVeneer arg has no effect if it is applied to a field that is not exported as a standalone TypeScript type
|
||||
A TSVeneer arg has no effect if it is applied to a field that is not exported as a standalone TypeScript type
|
||||
(which usually means a CUE field that also has an `@cuetsy(kind=)` attribute).
|
||||
|
||||
#### type
|
||||
|
||||
A handwritten veneer is needed to refine the raw generated TypeScript type, for example by adding generics.
|
||||
See [the dashboard types veneer](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/packages/grafana-schema/src/veneer/dashboard.types.ts)
|
||||
for an example, and [some](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L12)
|
||||
[corresponding](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L143)
|
||||
A handwritten veneer is needed to refine the raw generated TypeScript type, for example by adding generics.
|
||||
See [the dashboard types veneer](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/packages/grafana-schema/src/veneer/dashboard.types.ts)
|
||||
for an example, and [some](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L12)
|
||||
[corresponding](https://github.com/grafana/grafana/blob/5f93e67419e9587363d1fc1e6f1f4a8044eb54d0/kinds/dashboard/dashboard_kind.cue#L143)
|
||||
CUE attributes.
|
||||
|
||||
### @grafanamaturity
|
||||
@@ -286,7 +292,7 @@ Grafana code generators and CI enforce that schemas marked as mature MUST NOT ha
|
||||
|
||||
Indicates that a non-expert on that schema wrote the field, and was not fully confident in its type and/or docs.
|
||||
|
||||
Primarily useful on very large schemas, like the dashboard schema, for getting *something* written down for a given
|
||||
Primarily useful on very large schemas, like the dashboard schema, for getting _something_ written down for a given
|
||||
field that at least makes validation tests pass, but making clear that the field isn’t necessarily properly correct.
|
||||
|
||||
No argval is accepted. (Use a `//` comment to say more about the attention that’s needed.)
|
||||
|
||||
Reference in New Issue
Block a user