Robert Horvath
0fcc864bbb
* Docs: Add Schema maturity docs * Remove 'which category' section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Maturity process guides from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Defaults and Field optionality from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove MaybeRemove section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Milestone 3 and 4 from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Rearrange schema maturity docs * Regenerate schema docs after merge with main * Update Maturity docs headers, keep single h1 * Update wording in Schema docs Co-authored-by: Tania <yalyna.ts@gmail.com> * Regenerate docs after merge with main --------- Co-authored-by: sam boyer <sdboyer@grafana.com> Co-authored-by: Tania <yalyna.ts@gmail.com>
5.9 KiB
5.9 KiB
keywords, title
| keywords | title | ||
|---|---|---|---|
|
StatPanelCfg kind |
Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
StatPanelCfg
Maturity: experimental
Version: 0.0
| Property | Type | Required | Description |
|---|---|---|---|
PanelOptions |
object | Yes |
PanelOptions
It extends SingleStatBaseOptions.
| Property | Type | Required | Description |
|---|---|---|---|
colorMode |
string | Yes | TODO docs Possible values are: value, background, none. |
graphMode |
string | Yes | TODO docs Possible values are: none, line, area. |
justifyMode |
string | Yes | TODO docs Possible values are: auto, center. |
textMode |
string | Yes | TODO docs Possible values are: auto, value, value_and_name, name, none. |
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 |
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.
| Property | Type | Required | 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 | Description |
|---|---|---|---|
text |
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 |