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

Chore: Hacky first pass on generating composable kinds within grafana/schema (#64723)

Browse Source 
* Super hacky first pass on gen types

* First sketchy pass at generated compo kinds in TS, grok-style

* Merge fix

* Create jenny for MajorsOrX for plugins

* Re-generate files with imports

* Delete invalid generated file

* Fix cue

* Update go.mod

* Update schemas

* Fix go-imports

* Regenerate cue files

---------

Co-authored-by: spinillos <selenepinillos@gmail.com>
This commit is contained in:
sam boyer
2023-05-30 08:56:18 -04:00
committed by GitHub
parent 12dc56ad0c
commit 09895c26b6
77 changed files with 6052 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/kinds/composable/nodegraph/panelcfg/schema-reference.md
+52
View File
@@ -0,0 +1,52 @@
---
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 | Default | Description |
|---------------|------------------------|----------|---------|-------------|
| `ArcOption` | [object](#arcoption) | **Yes** | | |
| `EdgeOptions` | [object](#edgeoptions) | **Yes** | | |
| `NodeOptions` | [object](#nodeoptions) | **Yes** | | |
| `Options` | [object](#options) | **Yes** | | |
### ArcOption
| 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 | 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 | 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. |
### Options
| Property | Type | Required | Default | Description |
|----------|-----------------------------|----------|---------|-------------|
| `edges` | [EdgeOptions](#edgeoptions) | No | | |
| `nodes` | [NodeOptions](#nodeoptions) | No | | |