public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
bceb1bb96d4e4c0a87f1ecb1cf8bc938db147b8f
grafana/docs/sources/developers/kinds/composable/xychartpanelcfg/schema-reference.md
T
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

21 KiB
Raw Blame History

keywords, title
keywords title
grafana
schema
XYChartPanelCfg kind

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

XYChartPanelCfg

Maturity: experimental

Version: 0.0

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

It extends OptionsWithLegend and OptionsWithTooltip.

Property Type Required Description
dims XYDimensionConfig Yes
legend VizLegendOptions Yes (Inherited from OptionsWithLegend)
TODO docs
series ScatterSeriesConfig[] Yes
tooltip VizTooltipOptions Yes (Inherited from OptionsWithTooltip)
TODO docs
seriesMapping string No Possible values are: auto, manual.

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

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.

ScatterSeriesConfig

It extends ScatterFieldConfig.

Property Type Required Description
axisCenteredZero boolean No (Inherited from ScatterFieldConfig)
axisColorMode string No (Inherited from ScatterFieldConfig)
TODO docs
Possible values are: text, series.
axisGridShow boolean No (Inherited from ScatterFieldConfig)
axisLabel string No (Inherited from ScatterFieldConfig)
axisPlacement string No (Inherited from ScatterFieldConfig)
TODO docs
Possible values are: auto, top, right, bottom, left, hidden.
axisSoftMax number No (Inherited from ScatterFieldConfig)
axisSoftMin number No (Inherited from ScatterFieldConfig)
axisWidth number No (Inherited from ScatterFieldConfig)
hideFrom HideSeriesConfig No (Inherited from ScatterFieldConfig)
TODO docs
labelValue TextDimensionConfig No (Inherited from ScatterFieldConfig)
label string No (Inherited from ScatterFieldConfig)
TODO docs
Possible values are: auto, never, always.
lineColor ColorDimensionConfig No (Inherited from ScatterFieldConfig)
This is actually an empty interface used mainly for naming?
lineStyle LineStyle No (Inherited from ScatterFieldConfig)
TODO docs
lineWidth integer No (Inherited from ScatterFieldConfig)
Constraint: >=0 & <=2147483647.
name string No
pointColor ColorDimensionConfig No (Inherited from ScatterFieldConfig)
This is actually an empty interface used mainly for naming?
pointSize ScaleDimensionConfig No (Inherited from ScatterFieldConfig)
scaleDistribution ScaleDistributionConfig No (Inherited from ScatterFieldConfig)
TODO docs
show string No (Inherited from ScatterFieldConfig)
Possible values are: points, lines, points+lines.
x string No
y string No

ColorDimensionConfig

This is actually an empty interface used mainly for naming?

It extends BaseDimensionConfig.

Property Type Required Description
fixed Yes (Inherited from BaseDimensionConfig)
field string No (Inherited from BaseDimensionConfig)

BaseDimensionConfig

Property Type Required Description
fixed Yes
field string No

HideSeriesConfig

TODO docs

Property Type Required Description
legend boolean Yes
tooltip boolean Yes
viz boolean Yes

LineStyle

TODO docs

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

ScaleDimensionConfig

It extends BaseDimensionConfig.

Property Type Required Description
fixed Yes (Inherited from BaseDimensionConfig)
max integer Yes
min integer Yes
field string No (Inherited from BaseDimensionConfig)

ScaleDistributionConfig

TODO docs

Property Type Required Description
type string Yes TODO docs
Possible values are: linear, log, ordinal, symlog.
linearThreshold number No
log number No

ScatterFieldConfig

It extends HideableFieldConfig and AxisConfig.

Property Type Required Description
axisCenteredZero boolean No (Inherited from AxisConfig)
axisColorMode string No (Inherited from AxisConfig)
TODO docs
Possible values are: text, series.
axisGridShow boolean No (Inherited from AxisConfig)
axisLabel string No (Inherited from AxisConfig)
axisPlacement string No (Inherited from AxisConfig)
TODO docs
Possible values are: auto, top, right, bottom, left, hidden.
axisSoftMax number No (Inherited from AxisConfig)
axisSoftMin number No (Inherited from AxisConfig)
axisWidth number No (Inherited from AxisConfig)
hideFrom HideSeriesConfig No (Inherited from HideableFieldConfig)
TODO docs
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 Constraint: >=0 & <=2147483647.
pointColor ColorDimensionConfig No This is actually an empty interface used mainly for naming?
pointSize ScaleDimensionConfig No
scaleDistribution ScaleDistributionConfig No (Inherited from AxisConfig)
TODO docs
show string No Possible values are: points, lines, points+lines.

AxisConfig

TODO docs

Property Type Required Description
axisCenteredZero boolean No
axisColorMode string No TODO docs
Possible values are: text, series.
axisGridShow boolean No
axisLabel string No
axisPlacement string No TODO docs
Possible values are: auto, top, right, bottom, left, hidden.
axisSoftMax number No
axisSoftMin number No
axisWidth number No
scaleDistribution ScaleDistributionConfig No TODO docs

HideableFieldConfig

TODO docs

Property Type Required Description
hideFrom HideSeriesConfig No TODO docs

TextDimensionConfig

It extends BaseDimensionConfig.

Property Type Required Description
fixed Yes (Inherited from BaseDimensionConfig)
mode string Yes Possible values are: fixed, field, template.
field string No (Inherited from BaseDimensionConfig)

XYDimensionConfig

Property Type Required Description
frame integer Yes Constraint: >=0 & <=2147483647.
exclude string[] No
x string No
Reference in New Issue View Git Blame Copy Permalink