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