@add-on-hlapi-sdk / TextNode

Class: TextNode

A TextNode represents a text object in the scenegraph.

Hierarchy

• Node

  ↳ TextNode

Table of contents

Accessors

• absoluteRotation
• absoluteTransform
• allChildren
• blendMode
• locked
• opacity
• parent
• relativeRotation
• relativeTransform
• text
• textAlignment
• translateX
• translateY
• type

Methods

• removeFromParent

Accessors

absoluteRotation

• get absoluteRotation(): number

The node's absolute (global) rotation angle in degrees – includes any cumulative rotation from the node's parent containers.

Returns

number

Inherited from

Node.absoluteRotation

• set absoluteRotation(value): void

Parameters

Returns

void

Inherited from

Node.absoluteRotation

absoluteTransform

• get absoluteTransform(): mat2d

The node's absolute (global) transform matrix.

Returns

mat2d

Inherited from

Node.absoluteTransform

allChildren

• get allChildren(): Readonly<Iterable<Node>>

Returns a read-only list of all children of the node. General-purpose content containers such as ArtboardNode or GroupNode also provide a mutable children list. Other nodes with a more specific structure can hold children in various discrete "slots"; this allChildren list includes all such children and reflects their overall display z-order.

Returns

Readonly<Iterable<Node>>

Inherited from

Node.allChildren

blendMode

• get blendMode(): BlendModeValue

Blend mode determines how a node is composited onto the content below it. The default value is normal for most nodes, and passThrough for GroupNodes.

Returns

BlendModeValue

Inherited from

Node.blendMode

• set blendMode(value): void

Parameters

Returns

void

Inherited from

Node.blendMode

locked

• get locked(): boolean

The node's lock/unlock state. Locked nodes are excluded from the selection (see selection), and cannot be edited by the user unless they are unlocked first.

Returns

boolean

Inherited from

Node.locked

• set locked(locked): void

Parameters

Returns

void

Inherited from

Node.locked

opacity

• get opacity(): number

The node's opacity, from 0.0 to 1.0

Returns

number

Inherited from

Node.opacity

• set opacity(opacity): void

Parameters

Returns

void

Inherited from

Node.opacity

parent

• get parent(): undefined | Node

The node's parent. Undefined if the node is an orphan, or if the node is the artwork root.

Returns

undefined | Node

Inherited from

Node.parent

relativeRotation

• get relativeRotation(): number

The node's local rotation value in degrees, relative to its parent's axes. Modifying this value will also adjust the node's x & y translation such that the node's center is in the same location after the rotation – i.e. this setter rotates the node about its bounding box's center, not its origin.

Returns

number

Inherited from

Node.relativeRotation

• set relativeRotation(value): void

Parameters

Returns

void

Inherited from

Node.relativeRotation

relativeTransform

• get relativeTransform(): mat2d

The node's transform matrix relative to its parent.

Returns

mat2d

Inherited from

Node.relativeTransform

text

• get text(): string

The text string of the node

Returns

string

• set text(textContent): void

Parameters

Returns

void

textAlignment

• get textAlignment(): TextAlignmentValue

The horizontal text alignment of the text node. Alignment is always the same across this node's entire text content.

Returns

TextAlignmentValue

• set textAlignment(alignment): void

Parameters

Returns

void

translateX

• get translateX(): number

The translation of the node along its parent's x-axis.

Returns

number

Inherited from

Node.translateX

• set translateX(value): void

Parameters

Returns

void

Inherited from

Node.translateX

translateY

• get translateY(): number

The translation of the node along its parent's y-axis.

Returns

number

Inherited from

Node.translateY

• set translateY(value): void

Parameters

Returns

void

Inherited from

Node.translateY

type

• get type(): SceneNodeTypeValueID

The node's type.

Returns

SceneNodeTypeValueID

Inherited from

Node.type

Methods

removeFromParent

▸ removeFromParent(): void

Removes the node from its parent - for a basic ContainerNode, this is equivalent to node.parent.children.remove(node). For nodes with other slots, removes the child from whichever slot it resides in, if possible. Throws if the slot does not support removal. Also throws if node is the artwork root. No-op if node is already an orphan.

Returns

void

Inherited from

Node.removeFromParent

Last updated 8/25/2023

Was this helpful?

Yes

No