opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-01 09:52:12 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/statushistorypanelcfg/schema-reference.md
Tania f0333ac41f Codegen: Render constraints in generated docs (#63196) 
* Add constraints rendering

* Generate docs

* Fix constraint format

* Add type alias

* Compare numbers as strings

* fixup! Compare numbers as strings

* Add missing return
2023-02-10 06:40:50 -05:00

6.3 KiB
Raw Blame History

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

PanelFieldConfig

It extends HideableFieldConfig.

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

PanelOptions

It extends OptionsWithLegend and OptionsWithTooltip and OptionsWithTimezones.

Property Type Required Description
legend VizLegendOptions Yes (Inherited from OptionsWithLegend)
TODO docs
rowHeight number Yes Set the height of the rows Default: 0.9.
Constraint: >=0 & <=1.
showValue string Yes TODO docs
Possible values are: auto, never, always.
tooltip VizTooltipOptions Yes (Inherited from OptionsWithTooltip)
TODO docs
colWidth number No Controls the column width Default: 0.9.
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.