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/barchartpanelcfg/schema-reference.md
+61
View File
@@ -0,0 +1,61 @@
---
keywords:
- grafana
- schema
title: BarChartPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
# BarChartPanelCfg kind
### Maturity: experimental
### Version: 0.0
## Properties
| Property | Type | Required | Description |
|--------------------|-----------------------------|----------|-------------|
| `PanelFieldConfig` | [object](#panelfieldconfig) | **Yes** | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
## PanelFieldConfig
### Properties
| Property | Type | Required | Description |
|-------------------|-----------------------------------------------------------|----------|--------------------------------------------------------------------|
| `fillOpacity` | integer | No | Controls the fill opacity of the bars. Default: `80`. |
| `gradientMode` | string | No | TODO docs Possible values are: `none`, `opacity`, `hue`, `scheme`. |
| `lineWidth` | integer | No | Controls line width of the bars. Default: `1`. |
| `thresholdsStyle` | [GraphThresholdsStyleConfig](#graphthresholdsstyleconfig) | No | TODO docs |
### GraphThresholdsStyleConfig
TODO docs
#### Properties
| Property | Type | Required | Description |
|----------|--------|----------|-------------------------------------------------------------------------------------------------------|
| `mode` | string | **Yes** | TODO docs Possible values are: `off`, `line`, `dashed`, `area`, `line+area`, `dashed+area`, `series`. |
## PanelOptions
### Properties
| Property | Type | Required | Description |
|-----------------------|---------|----------|------------------------------------------------------------------------------------------------------------------------------------|
| `barRadius` | number | No | TODO docs Default: `0`. |
| `barWidth` | number | No | Controls the width of bars. 1 = Max width, 0 = Min width. Default: `0.97`. |
| `colorByField` | string | No | TODO docs |
| `fullHighlight` | boolean | No | Enables mode which highlights the entire bar area and shows tooltip when cursor<br/>hovers over highlighted area Default: `false`. |
| `groupWidth` | number | No | Controls the width of groups. 1 = max with, 0 = min width. Default: `0.7`. |
| `orientation` | string | No | TODO docs Possible values are: `auto`, `vertical`, `horizontal`. |
| `showValue` | string | No | TODO docs Possible values are: `auto`, `never`, `always`. |
| `stacking` | string | No | TODO docs Possible values are: `none`, `normal`, `percent`. |
| `xField` | string | No | TODO docs |
| `xTickLabelMaxLength` | integer | No | TODO docs |
| `xTickLabelRotation` | integer | No | TODO docs Default: `0`. |
| `xTickLabelSpacing` | integer | No | TODO docs<br/>negative values indicate backwards skipping behavior Default: `0`. |