public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b5ef9628e85ff00a737f52a71d5681a48a65fa5f
grafana/docs/sources/developers/kinds/composable/nodegraphpanelcfg/schema-reference.md
Robert Horvath 0fcc864bbb Docs: Add Schema maturity docs (#61963) 
* 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>
2023-02-07 11:02:05 +01:00

5.1 KiB
Raw Blame History

keywords, title
keywords title
grafana
schema
NodeGraphPanelCfg kind

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

NodeGraphPanelCfg

Maturity: experimental

Version: 0.0

Property Type Required Description
ArcOption object Yes
EdgeOptions object Yes
NodeOptions object Yes
PanelOptions object 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[] 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 No
nodes 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[] 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.
Reference in New Issue View Git Blame Copy Permalink