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>
82 lines
5.1 KiB
Markdown
82 lines
5.1 KiB
Markdown
---
|
|
keywords:
|
|
- grafana
|
|
- schema
|
|
title: NodeGraphPanelCfg kind
|
|
---
|
|
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
|
|
|
## NodeGraphPanelCfg
|
|
|
|
#### Maturity: [experimental](../../../maturity/#experimental)
|
|
#### Version: 0.0
|
|
|
|
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------------|-------------------------|----------|-------------|
|
|
| `ArcOption` | [object](#arcoption) | **Yes** | |
|
|
| `EdgeOptions` | [object](#edgeoptions) | **Yes** | |
|
|
| `NodeOptions` | [object](#nodeoptions) | **Yes** | |
|
|
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
|
|
|
|
### ArcOption
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------|--------|----------|-----------------------------------------------------------------------------------------------------|
|
|
| `color` | string | No | The color of the arc. |
|
|
| `field` | string | No | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
|
|
|
|
### EdgeOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|---------------------|--------|----------|-----------------------------------------------------------------------------|
|
|
| `mainStatUnit` | string | No | Unit for the main stat to override what ever is set in the data frame. |
|
|
| `secondaryStatUnit` | string | No | Unit for the secondary stat to override what ever is set in the data frame. |
|
|
|
|
### NodeOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------|
|
|
| `arcs` | [ArcOption](#arcoption)[] | No | Define which fields are shown as part of the node arc (colored circle around the node). |
|
|
| `mainStatUnit` | string | No | Unit for the main stat to override what ever is set in the data frame. |
|
|
| `secondaryStatUnit` | string | No | Unit for the secondary stat to override what ever is set in the data frame. |
|
|
|
|
### ArcOption
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------|--------|----------|-----------------------------------------------------------------------------------------------------|
|
|
| `color` | string | No | The color of the arc. |
|
|
| `field` | string | No | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
|
|
|
|
### PanelOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------|-----------------------------|----------|-------------|
|
|
| `edges` | [EdgeOptions](#edgeoptions) | No | |
|
|
| `nodes` | [NodeOptions](#nodeoptions) | No | |
|
|
|
|
### EdgeOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|---------------------|--------|----------|-----------------------------------------------------------------------------|
|
|
| `mainStatUnit` | string | No | Unit for the main stat to override what ever is set in the data frame. |
|
|
| `secondaryStatUnit` | string | No | Unit for the secondary stat to override what ever is set in the data frame. |
|
|
|
|
### NodeOptions
|
|
|
|
| Property | Type | Required | Description |
|
|
|---------------------|---------------------------|----------|-----------------------------------------------------------------------------------------|
|
|
| `arcs` | [ArcOption](#arcoption)[] | No | Define which fields are shown as part of the node arc (colored circle around the node). |
|
|
| `mainStatUnit` | string | No | Unit for the main stat to override what ever is set in the data frame. |
|
|
| `secondaryStatUnit` | string | No | Unit for the secondary stat to override what ever is set in the data frame. |
|
|
|
|
### ArcOption
|
|
|
|
| Property | Type | Required | Description |
|
|
|----------|--------|----------|-----------------------------------------------------------------------------------------------------|
|
|
| `color` | string | No | The color of the arc. |
|
|
| `field` | string | No | Field from which to get the value. Values should be less than 1, representing fraction of a circle. |
|
|
|
|
|