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

Kindsys: Extend DocsJenny with support for 'allOf' (#62558)

Browse Source 
* Kindsys: Extend DocsJenny with support for 'allOf'

* Update generated docs

* Multiple refinements

* Minor fixes

* Undo undesired changes

* Fix

* Fix linter complains

---------

Co-authored-by: Tania B <yalyna.ts@gmail.com>
This commit is contained in:
Joan López de la Franca Beltran
2023-02-02 16:12:31 +01:00
committed by GitHub
parent 4d564f8b0a
commit 19ed9181e1
28 changed files with 2213 additions and 504 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/kinds/composable/statpanelcfg/schema-reference.md
+84 -12
View File
@@ -6,26 +6,98 @@ title: StatPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
# StatPanelCfg kind
## StatPanelCfg
#### Maturity: experimental
#### Version: 0.0
## Maturity: experimental
## Version: 0.0
## Properties
| Property | Type | Required | Description |
|----------------|-------------------------|----------|-------------|
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
## PanelOptions
### PanelOptions
### Properties
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
| Property | Type | Required | Description |
|---------------|--------|----------|-----------------------------------------------------------------------------------|
| `colorMode` | string | No | TODO docs Possible values are: `value`, `background`, `none`. |
| `graphMode` | string | No | TODO docs Possible values are: `none`, `line`, `area`. |
| `justifyMode` | string | No | TODO docs Possible values are: `auto`, `center`. |
| `textMode` | string | No | TODO docs Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. |
| Property | Type | Required | Description |
|-----------------|-------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `colorMode` | string | **Yes** | TODO docs<br/>Possible values are: `value`, `background`, `none`. |
| `graphMode` | string | **Yes** | TODO docs<br/>Possible values are: `none`, `line`, `area`. |
| `justifyMode` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `center`. |
| `textMode` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `value`, `value_and_name`, `name`, `none`. |
| `orientation` | string | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [SingleStatBaseOptions](#singlestatbaseoptions))*<br/>TODO docs |
### ReduceDataOptions
TODO docs
| Property | Type | Required | 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](#optionswithtextformatting).
| Property | Type | Required | Description |
|-----------------|-------------------------------------------------|----------|------------------------------------------------------------------------------------------|
| `orientation` | string | **Yes** | TODO docs<br/>Possible values are: `auto`, `vertical`, `horizontal`. |
| `reduceOptions` | [ReduceDataOptions](#reducedataoptions) | **Yes** | TODO docs |
| `text` | [VizTextDisplayOptions](#viztextdisplayoptions) | No | *(Inherited from [OptionsWithTextFormatting](#optionswithtextformatting))*<br/>TODO docs |
### OptionsWithTextFormatting
TODO docs
| Property | Type | Required | Description |
|----------|-------------------------------------------------|----------|-------------|
| `text` | [VizTextDisplayOptions](#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 |
### ReduceDataOptions
TODO docs
| Property | Type | Required | 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 |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Description |
|-------------|--------|----------|--------------------------|
| `titleSize` | number | No | Explicit title text size |
| `valueSize` | number | No | Explicit value text size |
### VizTextDisplayOptions
TODO docs
| Property | Type | Required | Description |
|-------------|--------|----------|--------------------------|
| `titleSize` | number | No | Explicit title text size |
| `valueSize` | number | No | Explicit value text size |