grafana/docs/sources/developers/kinds/composable/statetimelinepanelcfg/schema-reference.md

keywords	title
grafana schema	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	Default	Description
PanelFieldConfig	object	Yes
PanelOptions	object	Yes

PanelFieldConfig

It extends HideableFieldConfig.

Property	Type	Required	Default	Description
fillOpacity	integer	No	70	Constraint: >=0 & <=100.
hideFrom	HideSeriesConfig	No		(Inherited from HideableFieldConfig) 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	No		TODO docs

PanelOptions

It extends OptionsWithLegend and OptionsWithTooltip and OptionsWithTimezones.

Property	Type	Required	Default	Description
legend	VizLegendOptions	Yes		(Inherited from OptionsWithLegend) TODO docs
rowHeight	number	Yes	0.9	Controls the row height
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	true	Merge equal consecutive values
timezone	string[]	No		(Inherited from OptionsWithTimezones)

OptionsWithLegend

TODO docs

Property	Type	Required	Default	Description
legend	VizLegendOptions	Yes		TODO docs

VizLegendOptions

TODO docs

Property	Type	Required	Default	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	Default	Description
timezone	string[]	No

OptionsWithTooltip

TODO docs

Property	Type	Required	Default	Description
tooltip	VizTooltipOptions	Yes		TODO docs

VizTooltipOptions

TODO docs

Property	Type	Required	Default	Description
mode	string	Yes		TODO docs Possible values are: single, multi, none.
sort	string	Yes		TODO docs Possible values are: asc, desc, none.