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

Explicitly set all front matter labels in the source files (#71548)

Browse Source 
* 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
2023-07-18 09:10:12 +01:00
committed by GitHub
co-authored by brendamuir Isabel
parent ec479b8d88
commit 7eb17bccca
687 changed files with 5085 additions and 2332 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/_index.md
+4
View File
@@ -1,6 +1,10 @@
---
aliases:
- plugins/developing/
labels:
products:
- enterprise
- oss
title: Developers
weight: 190
---
docs/sources/developers/angular_deprecation/_index.md
+4
View File
@@ -4,6 +4,10 @@ keywords:
- documentation
- developers
- resources
labels:
products:
- enterprise
- oss
title: Angular support deprecation
weight: 500
---
docs/sources/developers/angular_deprecation/angular-plugins.md
+4
View File
@@ -6,6 +6,10 @@ keywords:
- angular
- deprecation
- migration
labels:
products:
- enterprise
- oss
title: Plugins using AngularJS
---
docs/sources/developers/cla.md
+4
View File
@@ -3,6 +3,10 @@ aliases:
- ../project/cla/
- /docs/contributing/cla.html/
description: Contributor License Agreement (CLA)
labels:
products:
- enterprise
- oss
title: Contributor License Agreement (CLA)
weight: 400
---
docs/sources/developers/contribute.md
+4
View File
@@ -4,6 +4,10 @@ keywords:
- documentation
- developers
- resources
labels:
products:
- enterprise
- oss
title: Contribute to Grafana
weight: 300
---
docs/sources/developers/http_api/_index.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- documentation
- api
- overview
labels:
products:
- enterprise
- oss
title: HTTP API
weight: 100
---
docs/sources/developers/http_api/access_control.md
+4
View File
@@ -12,6 +12,10 @@ keywords:
- role-based-access-control
- acl
- enterprise
labels:
products:
- enterprise
- oss
title: RBAC HTTP API
---
docs/sources/developers/http_api/admin.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- admin
labels:
products:
- enterprise
- oss
title: 'Admin HTTP API '
---
docs/sources/developers/http_api/alerting.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- api
- alerting
- alerts
labels:
products:
- enterprise
- oss
title: Legacy Alerting API
---
docs/sources/developers/http_api/alerting_notification_channels.md
+4
View File
@@ -11,6 +11,10 @@ keywords:
- alerting
- alerts
- notifications
labels:
products:
- enterprise
- oss
title: Legacy Alerting Notification Channels API
---
docs/sources/developers/http_api/alerting_provisioning.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- api
- alerting
- alerts
labels:
products:
- enterprise
- oss
title: 'Alerting Provisioning HTTP API '
---
docs/sources/developers/http_api/annotations.md
+4
View File
@@ -11,6 +11,10 @@ keywords:
- annotation
- annotations
- comment
labels:
products:
- enterprise
- oss
title: Annotations HTTP API
---
docs/sources/developers/http_api/auth.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- documentation
- api
- authentication
labels:
products:
- enterprise
- oss
title: 'Authentication HTTP API '
---
docs/sources/developers/http_api/correlations.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- api
- correlations
- Glue
labels:
products:
- enterprise
- oss
title: 'Correlations HTTP API '
---
docs/sources/developers/http_api/create-api-tokens-for-org.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- Token
- Org
- Organization
labels:
products:
- enterprise
- oss
title: 'API Tutorial: Create API tokens and dashboards for an organization'
weight: 150
---
docs/sources/developers/http_api/curl-examples.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- curl
labels:
products:
- enterprise
- oss
title: cURL examples
---
docs/sources/developers/http_api/dashboard.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- dashboard
labels:
products:
- enterprise
- oss
title: Dashboard HTTP API
---
docs/sources/developers/http_api/dashboard_permissions.md
+4
View File
@@ -13,6 +13,10 @@ keywords:
- permission
- permissions
- acl
labels:
products:
- enterprise
- oss
title: Dashboard Permissions HTTP API
---
docs/sources/developers/http_api/dashboard_versions.md
+4
View File
@@ -11,6 +11,10 @@ keywords:
- api
- dashboard
- versions
labels:
products:
- enterprise
- oss
title: 'Dashboard Versions HTTP API '
---
docs/sources/developers/http_api/data_source.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- documentation
- api
- data source
labels:
products:
- enterprise
- oss
title: Data source HTTP API
---
docs/sources/developers/http_api/datasource_permissions.md
+4
View File
@@ -14,6 +14,10 @@ keywords:
- permissions
- acl
- enterprise
labels:
products:
- enterprise
- oss
title: Datasource Permissions HTTP API
---
docs/sources/developers/http_api/folder.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- folder
labels:
products:
- enterprise
- oss
title: Folder HTTP API
---
docs/sources/developers/http_api/folder_dashboard_search.md
+4
View File
@@ -11,6 +11,10 @@ keywords:
- search
- folder
- dashboard
labels:
products:
- enterprise
- oss
title: Folder/Dashboard Search HTTP API
---
docs/sources/developers/http_api/folder_permissions.md
+4
View File
@@ -13,6 +13,10 @@ keywords:
- permission
- permissions
- acl
labels:
products:
- enterprise
- oss
title: Folder Permissions HTTP API
---
docs/sources/developers/http_api/library_element.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- library-element
labels:
products:
- enterprise
- oss
title: 'Library Element HTTP API '
---
docs/sources/developers/http_api/licensing.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- api
- licensing
- enterprise
labels:
products:
- enterprise
- oss
title: Licensing HTTP API
---
docs/sources/developers/http_api/org.md
+4
View File
@@ -10,6 +10,10 @@ keywords:
- documentation
- api
- organization
labels:
products:
- enterprise
- oss
title: Organization HTTP API
---
docs/sources/developers/http_api/other.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- other
labels:
products:
- enterprise
- oss
title: 'Other HTTP API '
---
docs/sources/developers/http_api/playlist.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- playlist
labels:
products:
- enterprise
- oss
title: 'Playlist HTTP API '
---
docs/sources/developers/http_api/preferences.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- preferences
labels:
products:
- enterprise
- oss
title: 'HTTP Preferences API '
---
docs/sources/developers/http_api/query_and_resource_caching.md
+4
View File
@@ -14,6 +14,10 @@ keywords:
- query caching
- resource caching
- data source
labels:
products:
- enterprise
- oss
title: Query and Resource Caching HTTP API
---
docs/sources/developers/http_api/query_history.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- queryHistory
labels:
products:
- enterprise
- oss
title: 'Query History HTTP API '
---
docs/sources/developers/http_api/reporting.md
+4
View File
@@ -8,6 +8,10 @@ keywords:
- enterprise
- api
- reporting
labels:
products:
- enterprise
- oss
title: Reporting API
---
docs/sources/developers/http_api/serviceaccount.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- serviceaccount
labels:
products:
- enterprise
- oss
title: Service account HTTP API
---
docs/sources/developers/http_api/short_url.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- shortUrl
labels:
products:
- enterprise
- oss
title: 'Short URL HTTP API '
---
docs/sources/developers/http_api/snapshot.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- snapshot
labels:
products:
- enterprise
- oss
title: 'HTTP Snapshot API '
---
docs/sources/developers/http_api/team.md
+4
View File
@@ -11,6 +11,10 @@ keywords:
- team
- teams
- group
labels:
products:
- enterprise
- oss
title: Team HTTP API
---
docs/sources/developers/http_api/team_sync.md
+4
View File
@@ -14,6 +14,10 @@ keywords:
- group
- member
- enterprise
labels:
products:
- enterprise
- oss
title: Team Sync HTTP API
---
docs/sources/developers/http_api/user.md
+4
View File
@@ -9,6 +9,10 @@ keywords:
- documentation
- api
- user
labels:
products:
- enterprise
- oss
title: User HTTP API
---
docs/sources/developers/kinds/_index.md
+10 -5
View File
@@ -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.
docs/sources/developers/kinds/composable/_index.md
+4
View File
@@ -1,4 +1,8 @@
---
labels:
products:
- enterprise
- oss
title: Composable kinds
weight: 200
---
docs/sources/developers/kinds/composable/alertgroups/panelcfg/schema-reference.md
+10 -8
View File
@@ -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 |
docs/sources/developers/kinds/composable/alertgroupspanelcfg/schema-reference.md
+10 -8
View File
@@ -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 |
docs/sources/developers/kinds/composable/annotationslist/panelcfg/schema-reference.md
+10 -8
View File
@@ -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** | | |
docs/sources/developers/kinds/composable/annotationslistpanelcfg/schema-reference.md
+10 -8
View File
@@ -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** | | |
docs/sources/developers/kinds/composable/azuremonitor/dataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |
docs/sources/developers/kinds/composable/azuremonitordataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |
docs/sources/developers/kinds/composable/barchart/panelcfg/schema-reference.md
+35 -33
View File
@@ -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`. |
docs/sources/developers/kinds/composable/barchartpanelcfg/schema-reference.md
+35 -33
View File
@@ -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`. |
docs/sources/developers/kinds/composable/bargauge/panelcfg/schema-reference.md
+23 -21
View File
@@ -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 |
docs/sources/developers/kinds/composable/bargaugepanelcfg/schema-reference.md
+23 -21
View File
@@ -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 |
docs/sources/developers/kinds/composable/candlestick/panelcfg/schema-reference.md
+66 -64
View File
@@ -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: [](#), [](#). | | |
docs/sources/developers/kinds/composable/candlestickpanelcfg/schema-reference.md
+29 -25
View File
@@ -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 |
|----------|------|----------|-------------|
docs/sources/developers/kinds/composable/canvas/panelcfg/schema-reference.md
+25 -23
View File
@@ -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`. |
docs/sources/developers/kinds/composable/cloudwatch/dataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |
docs/sources/developers/kinds/composable/cloudwatchdataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |
docs/sources/developers/kinds/composable/dashboardlist/panelcfg/schema-reference.md
+10 -8
View File
@@ -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 | | |
docs/sources/developers/kinds/composable/dashboardlistpanelcfg/schema-reference.md
+10 -8
View File
@@ -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 | | |
docs/sources/developers/kinds/composable/datagrid/panelcfg/schema-reference.md
+10 -8
View File
@@ -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`. |
docs/sources/developers/kinds/composable/datagridpanelcfg/schema-reference.md
+10 -8
View File
@@ -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`. |
docs/sources/developers/kinds/composable/debug/panelcfg/schema-reference.md
+11 -9
View File
@@ -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** | | |
docs/sources/developers/kinds/composable/debugpanelcfg/schema-reference.md
+11 -9
View File
@@ -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** | | |
docs/sources/developers/kinds/composable/elasticsearch/dataquery/schema-reference.md
+94 -92
View File
@@ -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 | | |
docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
+94 -92
View File
@@ -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 | | |
docs/sources/developers/kinds/composable/gauge/panelcfg/schema-reference.md
+23 -21
View File
@@ -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 |
docs/sources/developers/kinds/composable/gaugepanelcfg/schema-reference.md
+23 -21
View File
@@ -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 |
docs/sources/developers/kinds/composable/geomap/panelcfg/schema-reference.md
+15 -13
View File
@@ -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`. |
docs/sources/developers/kinds/composable/geomappanelcfg/schema-reference.md
+15 -13
View File
@@ -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`. |
docs/sources/developers/kinds/composable/googlecloudmonitoring/dataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |
docs/sources/developers/kinds/composable/googlecloudmonitoringdataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |
docs/sources/developers/kinds/composable/grafanapyroscope/dataquery/schema-reference.md
+9 -7
View File
@@ -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 |
docs/sources/developers/kinds/composable/grafanapyroscopedataquery/schema-reference.md
+9 -7
View File
@@ -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 |
docs/sources/developers/kinds/composable/heatmap/panelcfg/schema-reference.md
+52 -50
View File
@@ -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** | | &#124; *{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
| `cellRadius` | number | No | | Controls cell radius |
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
| Property | Type | Required | Default | Description |
| -------------- | ------------------------------------------------------- | -------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options |
| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options |
| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options |
| `showValue` | string | **Yes** | | &#124; \*{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
| `cellRadius` | number | No | | Controls cell radius |
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
### HeatmapCalculationOptions
| Property | Type | Required | Default | Description |
|------------|-------------------------------------------------------------------|----------|---------|-------------|
| ---------- | ----------------------------------------------------------------- | -------- | ------- | ----------- |
| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
### HeatmapCalculationBucketConfig
| Property | Type | Required | Default | Description |
|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------|
| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------- |
| `mode` | string | No | | Possible values are: `size`, `count`. |
| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
| `value` | string | No | | The number of buckets to use for the axis in the heatmap |
@@ -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: [](#), [](#). | | |
docs/sources/developers/kinds/composable/heatmappanelcfg/schema-reference.md
+52 -50
View File
@@ -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** | | &#124; *{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
| `cellRadius` | number | No | | Controls cell radius |
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
| Property | Type | Required | Default | Description |
| -------------- | ------------------------------------------------------- | -------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `color` | [object](#color) | **Yes** | `map[exponent:0.5 fill:dark-orange reverse:false scheme:Oranges steps:64]` | Controls the color options |
| `exemplars` | [ExemplarConfig](#exemplarconfig) | **Yes** | | Controls exemplar options |
| `legend` | [HeatmapLegend](#heatmaplegend) | **Yes** | | Controls legend options |
| `showValue` | string | **Yes** | | &#124; \*{<br/> layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed<br/>}<br/>Controls the display of the value in the cell |
| `tooltip` | [HeatmapTooltip](#heatmaptooltip) | **Yes** | | Controls tooltip options |
| `yAxis` | [YAxisConfig](#yaxisconfig) | **Yes** | | Configuration options for the yAxis |
| `calculate` | boolean | No | `false` | Controls if the heatmap should be calculated from data |
| `calculation` | [HeatmapCalculationOptions](#heatmapcalculationoptions) | No | | |
| `cellGap` | integer | No | `1` | Controls gap between cells<br/>Constraint: `>=0 & <=25`. |
| `cellRadius` | number | No | | Controls cell radius |
| `cellValues` | [object](#cellvalues) | No | `map[]` | Controls cell value unit |
| `filterValues` | [object](#filtervalues) | No | `map[le:1e-09]` | Filters values between a given range |
| `rowsFrame` | [RowsHeatmapOptions](#rowsheatmapoptions) | No | | Controls frame rows options |
### HeatmapCalculationOptions
| Property | Type | Required | Default | Description |
|------------|-------------------------------------------------------------------|----------|---------|-------------|
| ---------- | ----------------------------------------------------------------- | -------- | ------- | ----------- |
| `xBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
| `yBuckets` | [HeatmapCalculationBucketConfig](#heatmapcalculationbucketconfig) | No | | |
### HeatmapCalculationBucketConfig
| Property | Type | Required | Default | Description |
|----------|-----------------------------------------------------|----------|---------|----------------------------------------------------------|
| -------- | --------------------------------------------------- | -------- | ------- | -------------------------------------------------------- |
| `mode` | string | No | | Possible values are: `size`, `count`. |
| `scale` | [ScaleDistributionConfig](#scaledistributionconfig) | No | | TODO docs |
| `value` | string | No | | The number of buckets to use for the axis in the heatmap |
@@ -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: [](#), [](#). | | |
docs/sources/developers/kinds/composable/histogram/panelcfg/schema-reference.md
+31 -29
View File
@@ -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`. |
docs/sources/developers/kinds/composable/histogrampanelcfg/schema-reference.md
+31 -29
View File
@@ -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`. |
docs/sources/developers/kinds/composable/logs/panelcfg/schema-reference.md
+10 -8
View File
@@ -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** | | |
docs/sources/developers/kinds/composable/logspanelcfg/schema-reference.md
+10 -8
View File
@@ -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** | | |
docs/sources/developers/kinds/composable/loki/dataquery/schema-reference.md
+9 -7
View File
@@ -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 &#124; 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. |
docs/sources/developers/kinds/composable/lokidataquery/schema-reference.md
+9 -7
View File
@@ -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 &#124; 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. |
docs/sources/developers/kinds/composable/news/panelcfg/schema-reference.md
+10 -8
View File
@@ -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` | |
docs/sources/developers/kinds/composable/newspanelcfg/schema-reference.md
+10 -8
View File
@@ -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` | |
docs/sources/developers/kinds/composable/nodegraph/panelcfg/schema-reference.md
+13 -11
View File
@@ -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 | | |
docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md
+13 -11
View File
@@ -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 | | |
docs/sources/developers/kinds/composable/parca/dataquery/schema-reference.md
+9 -7
View File
@@ -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 &#124; null |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
docs/sources/developers/kinds/composable/parcadataquery/schema-reference.md
+9 -7
View File
@@ -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 &#124; null |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
docs/sources/developers/kinds/composable/piechart/panelcfg/schema-reference.md
+39 -37
View File
@@ -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 |
docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md
+39 -37
View File
@@ -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 |
docs/sources/developers/kinds/composable/prometheus/dataquery/schema-reference.md
+9 -7
View File
@@ -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 &#124; 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 |
docs/sources/developers/kinds/composable/prometheusdataquery/schema-reference.md
+9 -7
View File
@@ -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 &#124; 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 |
docs/sources/developers/kinds/composable/stat/panelcfg/schema-reference.md
+23 -21
View File
@@ -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 |
docs/sources/developers/kinds/composable/statetimeline/panelcfg/schema-reference.md
+22 -20
View File
@@ -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`. |
docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md
+22 -20
View File
@@ -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`. |
docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md
+23 -21
View File
@@ -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 |
docs/sources/developers/kinds/composable/statushistory/panelcfg/schema-reference.md
+22 -20
View File
@@ -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`. |
docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md
+22 -20
View File
@@ -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`. |
docs/sources/developers/kinds/composable/table/panelcfg/schema-reference.md
+12 -10
View File
@@ -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: [](#), [](#). | | |
docs/sources/developers/kinds/composable/tablepanelcfg/schema-reference.md
+12 -10
View File
@@ -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: [](#), [](#). | | |
docs/sources/developers/kinds/composable/tempo/dataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |
docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md
+9 -7
View File
@@ -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 |
|----------|------|----------|---------|-------------|
| -------- | ---- | -------- | ------- | ----------- |

Some files were not shown because too many files have changed in this diff Show More