Skip to main content

Interface: IllustrationElement

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​

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.

Inherited from​

LayoutElement._renderingConfiguration

cachedObjectURL?​

optional cachedObjectURL?: string

A cached image representation of this SVG, to be used for faster rendering in performance critical code.

colors​

colors: object

A map of ID to color code, used to store color selections in the SVG.

Index Signature​

[key: string]: ColorDefinition

excludeFromExport?​

optional excludeFromExport?: boolean

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

Inherited from​

LayoutElement.excludeFromExport

height​

height: number

The height in pixels of the element.

Inherited from​

LayoutElement.height

id​

id: string

The unique identifier for this element.

Inherited from​

LayoutElement.id

immutable?​

optional immutable?: boolean

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

Inherited from​

LayoutElement.immutable

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​

LayoutElement.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​

LayoutElement.layerIndex

mask?​

optional mask?: string

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

Inherited from​

LayoutElement.mask

productOverlay?​

optional productOverlay?: boolean

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

Inherited from​

LayoutElement.productOverlay

rotation​

rotation: number

The rotation in degrees.

Inherited from​

LayoutElement.rotation

src?​

optional src?: string

When provided a src will be used to rehyrdrate the svg field. On serialization the svg field will be dropped and only src will remain.

stepName?​

optional stepName?: string

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

Inherited from​

LayoutElement.stepName

stepRegion?​

optional stepRegion?: Region

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

Inherited from​

LayoutElement.stepRegion

stepRegionIndex?​

optional stepRegionIndex?: number

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

Inherited from​

LayoutElement.stepRegionIndex

svg?​

optional svg?: string

The string representation of the SVG element. A valid SVG document.

type​

type: LayoutElementType

The type of this element

Inherited from​

LayoutElement.type

width​

width: number

The height in pixels of the element.

Inherited from​

LayoutElement.width

x​

x: number

Horizontal offset from top left origin point.

Inherited from​

LayoutElement.x

y​

y: number

Vertical offset from top left origin point.

Inherited from​

LayoutElement.y