public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Codegen: Generate docs for composable kinds (#61719)

Browse Source 
* Generate docs for composable kinds

* Fix getting the kind schema

* Generate composable kinds docs

* Add disclaimer to the generated docs

* Change docs disclaimer
This commit is contained in:
Tania
2023-01-23 00:58:49 +01:00
committed by GitHub
parent 65127d4913
commit 5f93e67419
20 changed files with 483 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/kinds/composable/piechartpanelcfg/schema-reference.md
+73
View File
@@ -0,0 +1,73 @@
---
keywords:
- grafana
- schema
title: 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](#hideablefieldconfig) | **Yes** | TODO docs |
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
| `PieChartLabels` | string | **Yes** | Select labels to display on the pie chart.<br/> - Name - The series or field name.<br/> - Percent - The percentage of the whole.<br/> - Value - The raw numerical value. Possible values are: `name`, `value`, `percent`. |
| `PieChartLegendOptions` | [object](#piechartlegendoptions) | **Yes** | |
| `PieChartLegendValues` | string | **Yes** | Select values to display in the legend.<br/> - Percent: The percentage of the whole.<br/> - 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](#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](#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 | |