IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-20 11:48:34 -06:00
Code Issues Packages Projects Releases Wiki Activity
850d5141cf
grafana/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md
Oscar Kilhed f3aa058886
XY Panel: Add and use schema for XY Panel configuration (#62148) 
* Add schema for XYChart

* Minor cleanup

* remove unessecary fields from ScatterFieldConfigVeneer, and cleaning up more

* Fix counts

Co-authored-by: sam boyer <sdboyer@grafana.com>
2023-01-25 22:29:07 +00:00

5.7 KiB
Raw Blame History

keywords title
grafana
schema
XYChartPanelCfg kind

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

XYChartPanelCfg kind

Maturity: experimental

Version: 0.0

Properties

Property Type Required Description
PanelOptions object Yes
ScatterFieldConfig object Yes
ScatterSeriesConfig object Yes
ScatterShow string Yes Possible values are: points, lines, points+lines.
SeriesMapping string Yes Possible values are: auto, manual.
XYDimensionConfig object Yes

PanelOptions

Properties

Property Type Required Description
dims XYDimensionConfig No
seriesMapping string No Possible values are: auto, manual.
series ScatterSeriesConfig[] No

ScatterSeriesConfig

Properties

Property Type Required Description
name string No
x string No
y string No

XYDimensionConfig

Properties

Property Type Required Description
frame integer Yes
exclude string[] No
x string No

ScatterFieldConfig

Properties

Property Type Required Description
labelValue TextDimensionConfig No
label string No TODO docs Possible values are: auto, never, always.
lineColor ColorDimensionConfig No This is actually an empty interface used mainly for naming?
lineStyle LineStyle No TODO docs
lineWidth integer No
pointColor ColorDimensionConfig No This is actually an empty interface used mainly for naming?
pointSize ScaleDimensionConfig No
show string No Possible values are: points, lines, points+lines.

ColorDimensionConfig

This is actually an empty interface used mainly for naming?

Property Type Required Description

ColorDimensionConfig

This is actually an empty interface used mainly for naming?

Property Type Required Description

LineStyle

TODO docs

Properties

Property Type Required Description
dash number[] No
fill string No Possible values are: solid, dash, dot, square.

ScaleDimensionConfig

Properties

Property Type Required Description
max integer No
min integer No

TextDimensionConfig

Properties

Property Type Required Description
mode string No Possible values are: fixed, field, template.

ScatterSeriesConfig

Properties

Property Type Required Description
name string No
x string No
y string No

XYDimensionConfig

Properties

Property Type Required Description
frame integer Yes
exclude string[] No
x string No