Menu
Grafana Cloud Enterprise Open source

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

CanvasPanelCfg

Maturity: experimental

Version: 0.0

PropertyTypeRequiredDefaultDescription
BackgroundConfigobjectYes
BackgroundImageSizestringYesPossible values are: original, contain, cover, fill, tile.
CanvasConnectionobjectYes
CanvasElementOptionsobjectYes
ConnectionCoordinatesobjectYes
ConnectionPathstringYesPossible values are: straight.
ConstraintobjectYes
HorizontalConstraintstringYesPossible values are: left, right, leftright, center, scale.
HttpRequestMethodstringYesPossible values are: GET, POST, PUT.
LineConfigobjectYes
OptionsobjectYes
PlacementobjectYes
VerticalConstraintstringYesPossible values are: top, bottom, topbottom, center, scale.

BackgroundConfig

PropertyTypeRequiredDefaultDescription
colorColorDimensionConfigNo
imageResourceDimensionConfigNoLinks to a resource (image/svg path)
sizestringNoPossible values are: original, contain, cover, fill, tile.

ColorDimensionConfig

It extends BaseDimensionConfig.

PropertyTypeRequiredDefaultDescription
fieldstringNo(Inherited from BaseDimensionConfig)
fixed: T – will be added by each element
fixedstringNo

BaseDimensionConfig

PropertyTypeRequiredDefaultDescription
fieldstringNofixed: T – will be added by each element

ResourceDimensionConfig

Links to a resource (image/svg path)

It extends BaseDimensionConfig.

PropertyTypeRequiredDefaultDescription
modestringYesPossible values are: fixed, field, mapping.
fieldstringNo(Inherited from BaseDimensionConfig)
fixed: T – will be added by each element
fixedstringNo

CanvasConnection

PropertyTypeRequiredDefaultDescription
pathstringYesPossible values are: straight.
sourceConnectionCoordinatesYes
targetConnectionCoordinatesYes
colorColorDimensionConfigNo
sizeScaleDimensionConfigNo
targetNamestringNo

ConnectionCoordinates

PropertyTypeRequiredDefaultDescription
xnumberYes
ynumberYes

ScaleDimensionConfig

It extends BaseDimensionConfig.

PropertyTypeRequiredDefaultDescription
maxnumberYes
minnumberYes
fieldstringNo(Inherited from BaseDimensionConfig)
fixed: T – will be added by each element
fixednumberNo
modestringNoPossible values are: linear, quad.

CanvasElementOptions

PropertyTypeRequiredDefaultDescription
namestringYes
typestringYes
backgroundBackgroundConfigNo
borderLineConfigNo
configNoTODO: figure out how to define this (element config(s))
connectionsCanvasConnection[]No
constraintConstraintNo
placementPlacementNo

Constraint

PropertyTypeRequiredDefaultDescription
horizontalstringNoPossible values are: left, right, leftright, center, scale.
verticalstringNoPossible values are: top, bottom, topbottom, center, scale.

LineConfig

PropertyTypeRequiredDefaultDescription
colorColorDimensionConfigNo
widthnumberNo

Placement

PropertyTypeRequiredDefaultDescription
bottomnumberNo
heightnumberNo
leftnumberNo
rightnumberNo
topnumberNo
widthnumberNo

Options

PropertyTypeRequiredDefaultDescription
inlineEditingbooleanYestrueEnable inline editing
panZoombooleanYestrueEnable pan and zoom
rootobjectYesThe root element of canvas (frame), where all canvas elements are nested
TODO: Figure out how to define a default value for this
showAdvancedTypesbooleanYestrueShow all available element types

Root

The root element of canvas (frame), where all canvas elements are nested TODO: Figure out how to define a default value for this

PropertyTypeRequiredDefaultDescription
elementsCanvasElementOptions[]YesThe list of canvas elements attached to the root element
namestringYesName of the root element
typestringYesType of root element (frame)
Possible values are: frame.