f3c0bc0749
kindsys: Adapt to new PanelCfg schema interface (#65297)
* kindsys: Adapt to new PanelCfg schema interface
* building locally
* Remove Panel prefix in cue files
* Regenerate
* Update imports
* fixup! Merge branch 'remove-panel-prefix' into sdboyer/redundant-panelcfg-prefixes
* Fix formatting
---------
Co-authored-by: Ryan McKinley <ryantxu@gmail.com>
Co-authored-by: Tania B <yalyna.ts@gmail.com>
(cherry picked from commit 33fd83f7e3)
# Conflicts:
# docs/sources/developers/kinds/core/dashboard/schema-reference.md
# docs/sources/developers/kinds/core/folder/schema-reference.md
# kinds/dashboard/dashboard_kind.cue
# packages/grafana-schema/src/raw/dashboard/x/dashboard_types.gen.ts
# pkg/kinds/dashboard/dashboard_spec_gen.go
# pkg/kinds/folder/folder_status_gen.go
Co-authored-by: sam boyer <sdboyer@grafana.com>
6.9 KiB
6.9 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 | 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 | 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 |
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 |
Controls the row height |
showValue |
string | Yes | Show timeline values on chart | |
tooltip |
VizTooltipOptions | Yes | (Inherited from OptionsWithTooltip) TODO docs |
|
alignValue |
string | No | Controls value alignment on the timelines | |
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. |