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

Docs: Add Default column to generated schema docs (#64550)

Browse Source 
Docs: Add  column to generated schema docs
This commit is contained in:
Tania
2023-03-22 18:42:28 +01:00
committed by GitHub
parent 3cd952b8ba
commit 0409cfd116
36 changed files with 1591 additions and 1565 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md
+23 -23
View File
@@ -13,40 +13,40 @@ title: NodeGraphPanelCfg kind
| Property | Type | Required | Description |
|----------------|-------------------------|----------|-------------|
| `ArcOption` | [object](#arcoption) | **Yes** | |
| `EdgeOptions` | [object](#edgeoptions) | **Yes** | |
| `NodeOptions` | [object](#nodeoptions) | **Yes** | |
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
| Property | Type | Required | Default | 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. |
| Property | Type | Required | Default | 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. |
| Property | Type | Required | Default | 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. |
| Property | Type | Required | Default | 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. |
### PanelOptions
| Property | Type | Required | Description |
|----------|-----------------------------|----------|-------------|
| `edges` | [EdgeOptions](#edgeoptions) | No | |
| `nodes` | [NodeOptions](#nodeoptions) | No | |
| Property | Type | Required | Default | Description |
|----------|-----------------------------|----------|---------|-------------|
| `edges` | [EdgeOptions](#edgeoptions) | No | | |
| `nodes` | [NodeOptions](#nodeoptions) | No | | |