Skip to main content

Interface: LayoutElement

Represents an element on the SVG canvas. This may comprise of multiple SVG elements when output such as path elements, defs, etc. All concrete elements must implement this interface.

Extends​

  • Layerable

Extended by​

Properties​

_renderingConfiguration?​

optional _renderingConfiguration?: RenderingConfiguration

Injected by the LayoutsProvider if required. Shouldn't be used by the user. This is a simple way to pass global rendering configuration to individual elements without having to set up a react context.

excludeFromExport?​

optional excludeFromExport?: boolean

When true, this element will be removed from SVGString output when the removeExcludedElements flag is set to true.

height​

height: number

The height in pixels of the element.

id​

id: string

The unique identifier for this element.

immutable?​

optional immutable?: boolean

The element is considered immutable and shouldn't be modifiable by the user.

layer?​

optional layer?: number

The layer that this element exists on. Elements on a higher layer can never be below an element on a lower layer. 0 by default.

Inherited from​

Layerable.layer

layerIndex?​

optional layerIndex?: number

The index of this element on the current layer, if no layer is present it is assumed to be 0. For the index 0 is lower, > 0 is higher

Inherited from​

Layerable.layerIndex

mask?​

optional mask?: string

Value to use as the mask attribute if the element does not correspond to a step.

productOverlay?​

optional productOverlay?: boolean

When true this element should be rendered on top of all other elements always.

rotation​

rotation: number

The rotation in degrees.

stepName?​

optional stepName?: string

If the element was made from a workflow step, this is its step name.

stepRegion?​

optional stepRegion?: Region

If the element was made from a workflow step, this is its region.

stepRegionIndex?​

optional stepRegionIndex?: number

If the element was made from a workflow step, this the index of the region.

type​

type: LayoutElementType

The type of this element

width​

width: number

The height in pixels of the element.

x​

x: number

Horizontal offset from top left origin point.

y​

y: number

Vertical offset from top left origin point.