Menu
Grafana Cloud
Enterprise
Open source
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 | Default | Description |
|---|---|---|---|---|
FieldConfig | object | Yes | ||
Options | 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 |
FieldConfig
It extends HideableFieldConfig and AxisConfig.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
axisBorderShow | boolean | No | (Inherited from AxisConfig) | |
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 | ||
lineStyle | LineStyle | No | TODO docs | |
lineWidth | integer | No | Constraint: >=0 & <=2147483647. | |
pointColor | ColorDimensionConfig | No | ||
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 | Default | Description |
|---|---|---|---|---|
axisBorderShow | boolean | No | ||
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 |
ScaleDistributionConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | TODO docs Possible values are: linear, log, ordinal, symlog. | |
linearThreshold | number | No | ||
log | number | No |
ColorDimensionConfig
It extends BaseDimensionConfig.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
field | string | No | (Inherited from BaseDimensionConfig) fixed: T – will be added by each element | |
fixed | string | No |
BaseDimensionConfig
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
field | string | No | fixed: T – will be added by each element |
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 |
LineStyle
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
dash | number[] | No | ||
fill | string | No | Possible values are: solid, dash, dot, square. |
ScaleDimensionConfig
It extends BaseDimensionConfig.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
max | number | Yes | ||
min | number | Yes | ||
field | string | No | (Inherited from BaseDimensionConfig) fixed: T – will be added by each element | |
fixed | number | No | ||
mode | string | No | Possible values are: linear, quad. |
TextDimensionConfig
It extends BaseDimensionConfig.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
mode | string | Yes | Possible values are: fixed, field, template. | |
field | string | No | (Inherited from BaseDimensionConfig) fixed: T – will be added by each element | |
fixed | string | No |
Options
It extends OptionsWithLegend and OptionsWithTooltip.
| Property | Type | Required | Default | 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 | 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 |
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. |
ScatterSeriesConfig
It extends FieldConfig.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
axisBorderShow | boolean | No | (Inherited from FieldConfig) | |
axisCenteredZero | boolean | No | (Inherited from FieldConfig) | |
axisColorMode | string | No | (Inherited from FieldConfig) TODO docs Possible values are: text, series. | |
axisGridShow | boolean | No | (Inherited from FieldConfig) | |
axisLabel | string | No | (Inherited from FieldConfig) | |
axisPlacement | string | No | (Inherited from FieldConfig) TODO docs Possible values are: auto, top, right, bottom, left, hidden. | |
axisSoftMax | number | No | (Inherited from FieldConfig) | |
axisSoftMin | number | No | (Inherited from FieldConfig) | |
axisWidth | number | No | (Inherited from FieldConfig) | |
hideFrom | HideSeriesConfig | No | (Inherited from FieldConfig) TODO docs | |
labelValue | TextDimensionConfig | No | (Inherited from FieldConfig) | |
label | string | No | (Inherited from FieldConfig) TODO docs Possible values are: auto, never, always. | |
lineColor | ColorDimensionConfig | No | (Inherited from FieldConfig) | |
lineStyle | LineStyle | No | (Inherited from FieldConfig) TODO docs | |
lineWidth | integer | No | (Inherited from FieldConfig) Constraint: >=0 & <=2147483647. | |
name | string | No | ||
pointColor | ColorDimensionConfig | No | (Inherited from FieldConfig) | |
pointSize | ScaleDimensionConfig | No | (Inherited from FieldConfig) | |
scaleDistribution | ScaleDistributionConfig | No | (Inherited from FieldConfig) TODO docs | |
show | string | No | (Inherited from FieldConfig) Possible values are: points, lines, points+lines. | |
x | string | No | ||
y | string | No |
XYDimensionConfig
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
frame | integer | Yes | Constraint: >=0 & <=2147483647. | |
exclude | string[] | No | ||
x | string | No |
Was this page helpful?
Related resources from Grafana Labs
Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Getting started with Grafana dashboard design (EMEA Timezone)
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Unify your data with Grafana plugins: Datadog, Splunk, MongoDB, and more
In this webinar, learn how to leverage Grafana's plugin ecosystem for access to 80+ data sources, including plugins for Datadog, Splunk, MongoDB, and more.