opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 21:32:28 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/histogram/panelcfg/schema-reference.md
sam boyer 09895c26b6 Chore: Hacky first pass on generating composable kinds within grafana/schema (#64723) 
* Super hacky first pass on gen types

* First sketchy pass at generated compo kinds in TS, grok-style

* Merge fix

* Create jenny for MajorsOrX for plugins

* Re-generate files with imports

* Delete invalid generated file

* Fix cue

* Update go.mod

* Update schemas

* Fix go-imports

* Regenerate cue files

---------

Co-authored-by: spinillos <selenepinillos@gmail.com>
2023-05-30 05:56:18 -07:00

13 KiB
Raw Blame History

keywords title
grafana
schema
HistogramPanelCfg kind

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

HistogramPanelCfg

Maturity: experimental

Version: 0.0

Property Type Required Default Description
FieldConfig object Yes
Options object Yes

FieldConfig

It extends AxisConfig 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)
fillOpacity integer No 80 Controls the fill opacity of the bars.
Constraint: >=0 & <=100.
gradientMode string No Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
Gradient appearance is influenced by the Fill opacity setting.
hideFrom HideSeriesConfig No (Inherited from HideableFieldConfig)
TODO docs
lineWidth integer No 1 Controls line width of the bars.
Constraint: >=0 & <=10.
scaleDistribution ScaleDistributionConfig No (Inherited from AxisConfig)
TODO docs

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

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.

Property Type Required Default Description
legend VizLegendOptions Yes (Inherited from OptionsWithLegend)
TODO docs
tooltip VizTooltipOptions Yes (Inherited from OptionsWithTooltip)
TODO docs
bucketOffset int32 No 0 Offset buckets by this amount
bucketSize integer No Size of each bucket
combine boolean No Combines multiple series into a single histogram

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.