Menu
Grafana Cloud Enterprise Open source

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

StateTimelinePanelCfg

Maturity: experimental

Version: 0.0

PropertyTypeRequiredDefaultDescription
FieldConfigobjectYes
OptionsobjectYes

FieldConfig

It extends HideableFieldConfig.

PropertyTypeRequiredDefaultDescription
fillOpacityintegerNo70Constraint: >=0 & <=100.
hideFromHideSeriesConfigNo(Inherited from HideableFieldConfig)
TODO docs
lineWidthintegerNo0Constraint: >=0 & <=10.

HideSeriesConfig

TODO docs

PropertyTypeRequiredDefaultDescription
legendbooleanYes
tooltipbooleanYes
vizbooleanYes

HideableFieldConfig

TODO docs

PropertyTypeRequiredDefaultDescription
hideFromHideSeriesConfigNoTODO docs

Options

It extends OptionsWithLegend and OptionsWithTooltip and OptionsWithTimezones.

PropertyTypeRequiredDefaultDescription
legendVizLegendOptionsYes(Inherited from OptionsWithLegend)
TODO docs
rowHeightnumberYes0.9Controls the row height
showValuestringYesShow timeline values on chart
tooltipVizTooltipOptionsYes(Inherited from OptionsWithTooltip)
TODO docs
alignValuestringNoControls value alignment on the timelines
mergeValuesbooleanNotrueMerge equal consecutive values
timezonestring[]No(Inherited from OptionsWithTimezones)

OptionsWithLegend

TODO docs

PropertyTypeRequiredDefaultDescription
legendVizLegendOptionsYesTODO docs

VizLegendOptions

TODO docs

PropertyTypeRequiredDefaultDescription
calcsstring[]Yes
displayModestringYesTODO docs
Note: “hidden” needs to remain as an option for plugins compatibility
Possible values are: list, table, hidden.
placementstringYesTODO docs
Possible values are: bottom, right.
showLegendbooleanYes
asTablebooleanNo
isVisiblebooleanNo
sortBystringNo
sortDescbooleanNo
widthnumberNo

OptionsWithTimezones

TODO docs

PropertyTypeRequiredDefaultDescription
timezonestring[]No

OptionsWithTooltip

TODO docs

PropertyTypeRequiredDefaultDescription
tooltipVizTooltipOptionsYesTODO docs

VizTooltipOptions

TODO docs

PropertyTypeRequiredDefaultDescription
modestringYesTODO docs
Possible values are: single, multi, none.
sortstringYesTODO docs
Possible values are: asc, desc, none.
maxHeightnumberNo
maxWidthnumberNo