opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-30 05:12:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/timeseriespanelcfg/schema-reference.md
sam boyer 33fd83f7e3 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>
2023-05-15 23:07:54 -04:00

25 KiB
Raw Blame History

keywords title
grafana
schema
TimeSeriesPanelCfg kind

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

TimeSeriesPanelCfg

Maturity: merged

Version: 0.0

Property Type Required Default Description
FieldConfig GraphFieldConfig Yes TODO docs
Options object Yes

GraphFieldConfig

TODO docs

It extends LineConfig and FillConfig and PointsConfig and AxisConfig and BarConfig and StackableFieldConfig and HideableFieldConfig.

Property Type Required Default 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)
barAlignment integer No (Inherited from BarConfig)
TODO docs
Possible values are: -1, 0, 1.
barMaxWidth number No (Inherited from BarConfig)
barWidthFactor number No (Inherited from BarConfig)
drawStyle string No TODO docs
Possible values are: line, bars, points.
fillBelowTo string No (Inherited from FillConfig)
fillColor string No (Inherited from FillConfig)
fillOpacity number No (Inherited from FillConfig)
gradientMode string No TODO docs
Possible values are: none, opacity, hue, scheme.
hideFrom HideSeriesConfig No (Inherited from HideableFieldConfig)
TODO docs
lineColor string No (Inherited from LineConfig)
lineInterpolation string No (Inherited from LineConfig)
TODO docs
Possible values are: linear, smooth, stepBefore, stepAfter.
lineStyle LineStyle No (Inherited from LineConfig)
TODO docs
lineWidth number No (Inherited from LineConfig)
pointColor string No (Inherited from PointsConfig)
pointSize number No (Inherited from PointsConfig)
pointSymbol string No (Inherited from PointsConfig)
scaleDistribution ScaleDistributionConfig No (Inherited from AxisConfig)
TODO docs
showPoints string No (Inherited from PointsConfig)
TODO docs
Possible values are: auto, never, always.
spanNulls No (Inherited from LineConfig)
Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds
stacking StackingConfig No (Inherited from StackableFieldConfig)
TODO docs
thresholdsStyle GraphThresholdsStyleConfig No TODO docs
transform string No TODO docs
Possible values are: constant, negative-Y.

AxisConfig

TODO docs

Property Type Required Default 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

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

BarConfig

TODO docs

Property Type Required Default Description
barAlignment integer No TODO docs
Possible values are: -1, 0, 1.
barMaxWidth number No
barWidthFactor number No

FillConfig

TODO docs

Property Type Required Default Description
fillBelowTo string No
fillColor string No
fillOpacity number No

GraphThresholdsStyleConfig

TODO docs

Property Type Required Default Description
mode string Yes TODO docs
Possible values are: off, line, dashed, area, line+area, dashed+area, series.

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

LineConfig

TODO docs

Property Type Required Default Description
lineColor string No
lineInterpolation string No TODO docs
Possible values are: linear, smooth, stepBefore, stepAfter.
lineStyle LineStyle No TODO docs
lineWidth number No
spanNulls No Indicate if null values should be treated as gaps or connected.
When the value is a number, it represents the maximum delta in the
X axis that should be considered connected. For timeseries, this is milliseconds

LineStyle

TODO docs

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

PointsConfig

TODO docs

Property Type Required Default Description
pointColor string No
pointSize number No
pointSymbol string No
showPoints string No TODO docs
Possible values are: auto, never, always.

StackableFieldConfig

TODO docs

Property Type Required Default Description
stacking StackingConfig No TODO docs

StackingConfig

TODO docs

Property Type Required Default Description
group string No
mode string No TODO docs
Possible values are: none, normal, percent.

Options

It extends OptionsWithTimezones.

Property Type Required Default Description
legend VizLegendOptions Yes TODO docs
tooltip VizTooltipOptions Yes TODO docs
timezone string[] No (Inherited from OptionsWithTimezones)

OptionsWithTimezones

TODO docs

Property Type Required Default Description
timezone string[] No

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

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.