Skip to main content

Interface: TextboxElement

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

algorithm?​

optional algorithm?: TextAlgorithm

The algorithm to use when laying out text.

align?​

optional align?: string

Horizontal alignment of text. eg. left, center, right.

curved?​

optional curved?: boolean

When true the text will be rendered using the provided curve.

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

fill​

fill: string

Fill color of this text. Any value that can be parsed by css fill should work here.

fillSpotColorDefinition?​

optional fillSpotColorDefinition?: SpotColorDefinition

fontData​

fontData: FontData | undefined

Information about the font family used to render this text.

fontSize​

fontSize: number

The font size.

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

input?​

optional input?: string

Per element user input. Not used by the layout engine. Instead used to store user input for textbox to preserve newlines.

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

lineHeight?​

optional lineHeight?: number

The height between text lines.

mask?​

optional mask?: string

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

Inherited from​

LayoutElement.mask

paths?​

optional paths?: string[]

The curve to use when curved = true. Ignored otherwise.

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

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

strokeColor?​

optional strokeColor?: ColorDefinition

strokeThickness?​

optional strokeThickness?: string

text?​

optional text?: string

Text computed for this textbox.

textFillImage?​

optional textFillImage?: TextFillImage

An image to use as the fill instead of a color.

type​

type: LayoutElementType

The type of this element

Inherited from​

LayoutElement.type

vertical?​

optional vertical?: boolean

Should the text layout top to bottom.

verticalAlign​

verticalAlign: string

The alignment of text vertically, top center or bottom.

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