Robert Horvath
0fcc864bbb
* Docs: Add Schema maturity docs * Remove 'which category' section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Maturity process guides from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Defaults and Field optionality from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove MaybeRemove section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Milestone 3 and 4 from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Rearrange schema maturity docs * Regenerate schema docs after merge with main * Update Maturity docs headers, keep single h1 * Update wording in Schema docs Co-authored-by: Tania <yalyna.ts@gmail.com> * Regenerate docs after merge with main --------- Co-authored-by: sam boyer <sdboyer@grafana.com> Co-authored-by: Tania <yalyna.ts@gmail.com>
9.5 KiB
9.5 KiB
keywords, title
| keywords | title | ||
|---|---|---|---|
|
StateTimelinePanelCfg kind |
Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
StateTimelinePanelCfg
Maturity: experimental
Version: 0.0
| Property | Type | Required | Description |
|---|---|---|---|
PanelFieldConfig |
object | Yes | |
PanelOptions |
object | Yes |
PanelFieldConfig
It extends HideableFieldConfig.
| Property | Type | Required | Description |
|---|---|---|---|
fillOpacity |
integer | No | Default: 70. |
hideFrom |
HideSeriesConfig | No | (Inherited from HideableFieldConfig) TODO docs |
lineWidth |
integer | No | Default: 0. |
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 | No | TODO docs |
HideSeriesConfig
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
legend |
boolean | Yes | |
tooltip |
boolean | Yes | |
viz |
boolean | Yes |
PanelOptions
It extends OptionsWithLegend and OptionsWithTooltip and OptionsWithTimezones.
| Property | Type | Required | Description |
|---|---|---|---|
legend |
VizLegendOptions | Yes | (Inherited from OptionsWithLegend) TODO docs |
rowHeight |
number | Yes | Controls the row height Default: 0.9. |
showValue |
string | Yes | TODO docs Possible values are: auto, never, always. |
tooltip |
VizTooltipOptions | Yes | (Inherited from OptionsWithTooltip) TODO docs |
alignValue |
string | No | Controls the value alignment in the TimelineChart component Possible values are: center, left, right. |
mergeValues |
boolean | No | Merge equal consecutive values Default: true. |
timezone |
string[] | No | (Inherited from OptionsWithTimezones) |
OptionsWithLegend
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
legend |
VizLegendOptions | Yes | TODO docs |
VizLegendOptions
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
calcs |
string[] | Yes | |
displayMode |
string | Yes | TODO docs Note: "hidden" needs to remain as an option for plugins compatibility Possible values are: list, table, hidden. |
placement |
string | Yes | TODO docs Possible values are: bottom, right. |
showLegend |
boolean | Yes | |
asTable |
boolean | No | |
isVisible |
boolean | No | |
sortBy |
string | No | |
sortDesc |
boolean | No | |
width |
number | No |
OptionsWithTimezones
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
timezone |
string[] | No |
OptionsWithTooltip
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
tooltip |
VizTooltipOptions | Yes | TODO docs |
VizTooltipOptions
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
mode |
string | Yes | TODO docs Possible values are: single, multi, none. |
sort |
string | Yes | TODO docs Possible values are: asc, desc, none. |
VizLegendOptions
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
calcs |
string[] | Yes | |
displayMode |
string | Yes | TODO docs Note: "hidden" needs to remain as an option for plugins compatibility Possible values are: list, table, hidden. |
placement |
string | Yes | TODO docs Possible values are: bottom, right. |
showLegend |
boolean | Yes | |
asTable |
boolean | No | |
isVisible |
boolean | No | |
sortBy |
string | No | |
sortDesc |
boolean | No | |
width |
number | No |
VizTooltipOptions
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
mode |
string | Yes | TODO docs Possible values are: single, multi, none. |
sort |
string | Yes | TODO docs Possible values are: asc, desc, none. |