Menu
Grafana Cloud
Enterprise
Open source
Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
PieChartPanelCfg
Maturity: experimental
Version: 0.0
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
FieldConfig | HideableFieldConfig | Yes | TODO docs | |
Options | object | Yes | ||
PieChartLabels | string | Yes | Select labels to display on the pie chart. - Name - The series or field name. - Percent - The percentage of the whole. - Value - The raw numerical value. Possible values are: name, value, percent. | |
PieChartLegendOptions | object | Yes | ||
PieChartLegendValues | string | Yes | Select values to display in the legend. - Percent: The percentage of the whole. - Value: The raw numerical value. Possible values are: value, percent. | |
PieChartType | string | Yes | Select the pie chart display style. Possible values are: pie, donut. |
HideableFieldConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
hideFrom | HideSeriesConfig | No | TODO docs |
HideSeriesConfig
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
legend | boolean | Yes | ||
tooltip | boolean | Yes | ||
viz | boolean | Yes |
Options
It extends OptionsWithTooltip and SingleStatBaseOptions.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
displayLabels | string[] | Yes | ||
legend | PieChartLegendOptions | Yes | ||
pieType | string | Yes | Select the pie chart display style. Possible values are: pie, donut. | |
tooltip | VizTooltipOptions | Yes | (Inherited from OptionsWithTooltip) TODO docs | |
orientation | string | No | (Inherited from SingleStatBaseOptions) TODO docs Possible values are: auto, vertical, horizontal. | |
reduceOptions | ReduceDataOptions | No | (Inherited from SingleStatBaseOptions) TODO docs | |
text | VizTextDisplayOptions | No | (Inherited from SingleStatBaseOptions) TODO docs |
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. | |
maxHeight | number | No | ||
maxWidth | number | No |
PieChartLegendOptions
It extends VizLegendOptions.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
calcs | string[] | Yes | (Inherited from VizLegendOptions) | |
displayMode | string | Yes | (Inherited from VizLegendOptions) TODO docs Note: “hidden” needs to remain as an option for plugins compatibility Possible values are: list, table, hidden. | |
placement | string | Yes | (Inherited from VizLegendOptions) TODO docs Possible values are: bottom, right. | |
showLegend | boolean | Yes | (Inherited from VizLegendOptions) | |
values | string[] | Yes | ||
asTable | boolean | No | (Inherited from VizLegendOptions) | |
isVisible | boolean | No | (Inherited from VizLegendOptions) | |
sortBy | string | No | (Inherited from VizLegendOptions) | |
sortDesc | boolean | No | (Inherited from VizLegendOptions) | |
width | number | No | (Inherited from VizLegendOptions) |
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 |
ReduceDataOptions
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
calcs | string[] | Yes | When !values, pick one value for the whole field | |
fields | string | No | Which fields to show. By default this is only numeric fields | |
limit | number | No | if showing all values limit | |
values | boolean | No | If true show each row value |
SingleStatBaseOptions
TODO docs
It extends OptionsWithTextFormatting.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
orientation | string | Yes | TODO docs Possible values are: auto, vertical, horizontal. | |
reduceOptions | ReduceDataOptions | Yes | TODO docs | |
text | VizTextDisplayOptions | No | (Inherited from OptionsWithTextFormatting) TODO docs |
OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
text | VizTextDisplayOptions | No | TODO docs |
VizTextDisplayOptions
TODO docs
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
titleSize | number | No | Explicit title text size | |
valueSize | number | No | Explicit value text size |
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
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.