mirror of
https://github.com/grafana/grafana.git
synced 2025-09-24 15:24:15 +08:00
25756b49a3
* Remove duplicated sections * Regenerate docs * Refactor schema.sections func (#63079) * Refactor schema.sections func * Small refactors --------- Co-authored-by: Joan López de la Franca Beltran <5459617+joanlopez@users.noreply.github.com>
75 lines
4.7 KiB
Markdown
75 lines
4.7 KiB
Markdown
---
|
|
keywords:
|
|
- grafana
|
|
- schema
|
|
title: StatPanelCfg kind
|
|
---
|
|
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
|
|
|
## StatPanelCfg
|
|
|
|
#### Maturity: [experimental](../../../maturity/#experimental)
|
|
#### Version: 0.0
|
|
|
|
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------------|-------------------------|----------|-------------|
|
|
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
|
|
|
|
### PanelOptions
|
|
|
|
It extends [SingleStatBaseOptions](#singlestatbaseoptions).
|
|
|
|
| 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 |
|
|
|
|
|