@add-on-hlapi-sdk / PageNode
Class: PageNode
A PageNode represents a page in the document. A page contains one or more artboards, representing "scenes" in a linear timeline sequence. Those artboards in turn contain all the visual content of the document.
Hierarchy
↳
PageNode
Implements
Readonly<IRectangularNode>
Table of contents
Accessors
- absoluteRotation
- absoluteTransform
- allChildren
- artboards
- blendMode
- height
- locked
- name
- opacity
- parent
- relativeRotation
- relativeTransform
- translateX
- translateY
- type
- width
Methods
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
| Name | Type |
|---|---|
value | number |
Returns
void
Inherited from
Node.absoluteRotation
absoluteTransform
• get absoluteTransform(): mat2d
The node's absolute (global) transform matrix.
Returns
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
artboards
• get artboards(): ArtboardList
The artboards or "scenes" of a page, ordered by timeline sequence.
Returns
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
Inherited from
Node.blendMode
• set blendMode(value): void
Parameters
| Name | Type |
|---|---|
value |
Returns
void
Inherited from
Node.blendMode
height
• get height(): number
The height of the node. All Artboards within a page share the same dimensions.
Returns
number
Implementation of
Readonly.height
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
| Name | Type |
|---|---|
locked | boolean |
Returns
void
Inherited from
Node.locked
name
• get name(): undefined | string
The page's name. Displayed as a user-editable label above the current artboard in the UI.
Returns
undefined | string
• set name(name): void
Parameters
| Name | Type |
|---|---|
name | undefined | string |
Returns
void
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
| Name | Type |
|---|---|
opacity | number |
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
| Name | Type |
|---|---|
value | number |
Returns
void
Inherited from
Node.relativeRotation
relativeTransform
• get relativeTransform(): mat2d
The node's transform matrix relative to its parent.
Returns
Inherited from
Node.relativeTransform
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
| Name | Type |
|---|---|
value | number |
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
| Name | Type |
|---|---|
value | number |
Returns
void
Inherited from
Node.translateY
type
• get type(): SceneNodeTypeValueID
The node's type.
Returns
Inherited from
Node.type
width
• get width(): number
The width of the node. All Artboards within a page share the same dimensions.
Returns
number
Implementation of
Readonly.width
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
