Skip to main content

Interface: FrameElement

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

dataHeight?​

optional dataHeight?: number

Assigns the 'data-frame-height' attribute to the frame element. The rasterizer we use has issues with images inside patterns. This is a workaround to ensure that the pattern is correctly sized.

dataWidth?​

optional dataWidth?: number

Assigns the 'data-frame-width' attribute to the frame element. The rasterizer we use has issues with images inside patterns. This is a workaround to ensure that the pattern is correctly sized.

disablePlaceholder?​

optional disablePlaceholder?: boolean

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

focalBlur?​

optional focalBlur?: boolean

focalBlurRadius?​

optional focalBlurRadius?: number

focalBlurStrength?​

optional focalBlurStrength?: number

forceImageContain?​

optional forceImageContain?: boolean

forceImageCover?​

optional forceImageCover?: boolean

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

invertThreshold?​

optional invertThreshold?: boolean

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

opacity?​

optional opacity?: number

path​

path: string

pattern?​

optional pattern?: Pattern

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

scaleX​

scaleX: number

scaleY​

scaleY: number

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

threshold?​

optional threshold?: number

thresholdSaturation?​

optional thresholdSaturation?: number

type​

type: LayoutElementType

The type of this element

Inherited from​

LayoutElement.type

useThreshold?​

optional useThreshold?: boolean

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