@express-document-sdk / ThreadedTextList
Class: ThreadedTextList
ReadOnlyItemList represents an ordered list of API objects that are all children of the same parent node.
Items in a bare ReadOnlyItemList cannot be added, removed, or reordered. The ItemList subclass adds more capabilities, and is most frequently encountered as ArtboardNode.children or GroupNode.children.
Extends
Accessors
first
• get first(): undefined | T
First item in this list, or undefined if list is empty.
Returns
undefined | T
last
• get last(): undefined | T
Last item in this list, or undefined if list is empty.
Returns
undefined | T
length
• get length(): number
Number of items in this list.
Returns
number
Methods
[iterator]()
• [iterator](): Iterator<ThreadedTextNode, any, any>
Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.
Returns
Iterator<ThreadedTextNode, any, any>
Inherited from
addFrame()
• addFrame(geometry?): ThreadedTextNode
IMPORTANT: This is currently experimental only and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the experimentalApis flag to true in the requirements section of the manifest.json.
Parameters
• geometry?: TextFrameAreaGeometry
The geometry of the threaded text node in pixels (width and height).
Returns
A new ThreadedTextNode that is part of a threaded text flow.
indexOf()
• indexOf(item): number
Get index of item in list.
Parameters
• item: ThreadedTextNode
Returns
number
index number, or -1 if item isn't in this list.
Inherited from
item()
• item(index): undefined | ThreadedTextNode
Returns item at the given index, or undefined if index is out of range.
Parameters
• index: number
Zero-based index
Returns
undefined | ThreadedTextNode
Inherited from
toArray()
• toArray(): readonly ThreadedTextNode[]
All items in the list, as a static array. Mutations that occur later are not reflected in an array returned earlier.
Returns
readonly ThreadedTextNode[]
