Skip to main content

Interface: ImageElement

Represents a raster image on the Papyrus canvas.

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

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

preserveAspectRatio?​

optional preserveAspectRatio?: string

https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio

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​

src: string

A src for the image. This will be used in place of the data URL in server environments and should be original image quality.

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

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