opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-09-25 05:33:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md
Tania 5f93e67419 Codegen: Generate docs for composable kinds (#61719) 
* Generate docs for composable kinds

* Fix getting the kind schema

* Generate composable kinds docs

* Add disclaimer to the generated docs

* Change docs disclaimer
2023-01-22 18:58:49 -05:00

4.4 KiB
Raw Blame History

keywords title
grafana
schema
PieChartPanelCfg kind

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

PieChartPanelCfg kind

Maturity: experimental

Version: 0.0

Properties

Property Type Required Description
PanelFieldConfig HideableFieldConfig Yes TODO docs
PanelOptions 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

Properties

Property Type Required Description
hideFrom HideSeriesConfig No TODO docs

HideSeriesConfig

TODO docs

Properties

Property Type Required Description
legend boolean Yes
tooltip boolean Yes
viz boolean Yes

PanelOptions

Properties

Property Type Required Description
displayLabels string[] No
legend PieChartLegendOptions No
pieType string No Select the pie chart display style. Possible values are: pie, donut.

PieChartLegendOptions

Properties

Property Type Required Description
values string[] No

PieChartLegendOptions

Properties

Property Type Required Description
values string[] No