Tania
f0333ac41f
* Add constraints rendering * Generate docs * Fix constraint format * Add type alias * Compare numbers as strings * fixup! Compare numbers as strings * Add missing return
113 lines
6.8 KiB
Markdown
113 lines
6.8 KiB
Markdown
---
|
|
keywords:
|
|
- grafana
|
|
- schema
|
|
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 | Description |
|
|
|--------------------|-----------------------------|----------|-------------|
|
|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
|
|
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
|
|
|
|
### PanelFieldConfig
|
|
|
|
It extends [HideableFieldConfig](#hideablefieldconfig).
|
|
|
|
| Property | Type | Required | Description |
|
|
|---------------|---------------------------------------|----------|------------------------------------------------------------------------------|
|
|
| `fillOpacity` | integer | No | Default: `70`.<br/>Constraint: `>=0 & <=100`. |
|
|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | *(Inherited from [HideableFieldConfig](#hideablefieldconfig))*<br/>TODO docs |
|
|
| `lineWidth` | integer | No | Default: `0`.<br/>Constraint: `>=0 & <=10`. |
|
|
|
|
### HideSeriesConfig
|
|
|
|
TODO docs
|
|
|
|
| Property | Type | Required | Description |
|
|
|-----------|---------|----------|-------------|
|
|
| `legend` | boolean | **Yes** | |
|
|
| `tooltip` | boolean | **Yes** | |
|
|
| `viz` | boolean | **Yes** | |
|
|
|
|
### HideableFieldConfig
|
|
|
|
TODO docs
|
|
|
|
| Property | Type | Required | Description |
|
|
|------------|---------------------------------------|----------|-------------|
|
|
| `hideFrom` | [HideSeriesConfig](#hideseriesconfig) | No | TODO docs |
|
|
|
|
### PanelOptions
|
|
|
|
It extends [OptionsWithLegend](#optionswithlegend) and [OptionsWithTooltip](#optionswithtooltip) and [OptionsWithTimezones](#optionswithtimezones).
|
|
|
|
| Property | Type | Required | Description |
|
|
|---------------|-----------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------|
|
|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | *(Inherited from [OptionsWithLegend](#optionswithlegend))*<br/>TODO docs |
|
|
| `rowHeight` | number | **Yes** | Controls the row height Default: `0.9`. |
|
|
| `showValue` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `never`, `always`. |
|
|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | *(Inherited from [OptionsWithTooltip](#optionswithtooltip))*<br/>TODO docs |
|
|
| `alignValue` | string | No | Controls the value alignment in the TimelineChart component<br/>Possible values are: `center`, `left`, `right`. |
|
|
| `mergeValues` | boolean | No | Merge equal consecutive values Default: `true`. |
|
|
| `timezone` | string[] | No | *(Inherited from [OptionsWithTimezones](#optionswithtimezones))* |
|
|
|
|
### OptionsWithLegend
|
|
|
|
TODO docs
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------|---------------------------------------|----------|-------------|
|
|
| `legend` | [VizLegendOptions](#vizlegendoptions) | **Yes** | TODO docs |
|
|
|
|
### VizLegendOptions
|
|
|
|
TODO docs
|
|
|
|
| Property | Type | Required | 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 | Description |
|
|
|------------|----------|----------|-------------|
|
|
| `timezone` | string[] | No | |
|
|
|
|
### OptionsWithTooltip
|
|
|
|
TODO docs
|
|
|
|
| Property | Type | Required | Description |
|
|
|-----------|-----------------------------------------|----------|-------------|
|
|
| `tooltip` | [VizTooltipOptions](#viztooltipoptions) | **Yes** | TODO docs |
|
|
|
|
### VizTooltipOptions
|
|
|
|
TODO docs
|
|
|
|
| Property | Type | Required | 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`. |
|
|
|
|
|