Tania
25756b49a3
* Remove duplicated sections * Regenerate docs * Refactor schema.sections func (#63079) * Refactor schema.sections func * Small refactors --------- Co-authored-by: Joan López de la Franca Beltran <5459617+joanlopez@users.noreply.github.com>
15 KiB
15 KiB
keywords, title
| keywords | title | ||
|---|---|---|---|
|
BarChartPanelCfg kind |
Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
BarChartPanelCfg
Maturity: experimental
Version: 0.0
| Property | Type | Required | Description |
|---|---|---|---|
PanelFieldConfig |
object | Yes | |
PanelOptions |
object | Yes |
PanelFieldConfig
It extends AxisConfig and HideableFieldConfig.
| 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) |
fillOpacity |
integer | No | Controls the fill opacity of the bars. Default: 80. |
gradientMode |
string | No | TODO docs Possible values are: none, opacity, hue, scheme. |
hideFrom |
HideSeriesConfig | No | (Inherited from HideableFieldConfig) TODO docs |
lineWidth |
integer | No | Controls line width of the bars. Default: 1. |
scaleDistribution |
ScaleDistributionConfig | No | (Inherited from AxisConfig) TODO docs |
thresholdsStyle |
GraphThresholdsStyleConfig | No | TODO docs |
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 |
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 |
GraphThresholdsStyleConfig
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
mode |
string | Yes | TODO docs Possible values are: off, line, dashed, area, line+area, dashed+area, series. |
HideSeriesConfig
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
legend |
boolean | Yes | |
tooltip |
boolean | Yes | |
viz |
boolean | Yes |
HideableFieldConfig
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
hideFrom |
HideSeriesConfig | No | TODO docs |
PanelOptions
It extends OptionsWithLegend and OptionsWithTooltip and OptionsWithTextFormatting.
| Property | Type | Required | Description |
|---|---|---|---|
barWidth |
number | Yes | Controls the width of bars. 1 = Max width, 0 = Min width. Default: 0.97. |
fullHighlight |
boolean | Yes | Enables mode which highlights the entire bar area and shows tooltip when cursor hovers over highlighted area Default: false. |
groupWidth |
number | Yes | Controls the width of groups. 1 = max with, 0 = min width. Default: 0.7. |
legend |
VizLegendOptions | Yes | (Inherited from OptionsWithLegend) TODO docs |
orientation |
string | Yes | TODO docs Possible values are: auto, vertical, horizontal. |
showValue |
string | Yes | TODO docs Possible values are: auto, never, always. |
stacking |
string | Yes | TODO docs Possible values are: none, normal, percent. |
tooltip |
VizTooltipOptions | Yes | (Inherited from OptionsWithTooltip) TODO docs |
xTickLabelMaxLength |
integer | Yes | Sets the max length that a label can have before it is truncated. |
xTickLabelRotation |
integer | Yes | Controls the rotation of the x axis labels. Default: 0. |
barRadius |
number | No | Controls the radius of each bar. Default: 0. |
colorByField |
string | No | Use the color value for a sibling field to color each bar value. |
text |
VizTextDisplayOptions | No | (Inherited from OptionsWithTextFormatting) TODO docs |
xField |
string | No | Manually select which field from the dataset to represent the x field. |
xTickLabelSpacing |
integer | No | Controls the spacing between x axis labels. negative values indicate backwards skipping behavior Default: 0. |
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 |
OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
text |
VizTextDisplayOptions | No | TODO docs |
VizTextDisplayOptions
TODO docs
| Property | Type | Required | Description |
|---|---|---|---|
titleSize |
number | No | Explicit title text size |
valueSize |
number | No | Explicit value text size |
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. |