Files
Agnès Toulet ac445a25d5 Kindsys: update generated doc and add check in CI (#71871)
* clean up docs

* fix Windows path issue

* add verify-gen-cue to doc pipeline

* fix linting error
2023-07-20 11:48:12 +02:00

6.8 KiB

keywords labels title
grafana
schema
products
cloud
enterprise
oss
StatusHistoryPanelCfg kind

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

StatusHistoryPanelCfg

Maturity: experimental

Version: 0.0

Property Type Required Default Description
FieldConfig object Yes
Options object Yes

FieldConfig

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 1 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

Options

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 Set the height of the rows
Constraint: >=0 & <=1.
showValue string Yes Show values on the columns
tooltip VizTooltipOptions Yes (Inherited from OptionsWithTooltip)
TODO docs
colWidth number No 0.9 Controls the column width
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.