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
Indexable
[key: number]: object
Constructors
Constructor
new ThreadedTextList(): ThreadedTextList;
Returns
ThreadedTextList
Inherited from
Accessors
length
Get Signature
get length(): number;
Number of items in this list.
Returns
number
Inherited from
first
Get Signature
get first(): T | undefined;
First item in this list, or undefined if list is empty.
Returns
T | undefined
Inherited from
last
Get Signature
get last(): T | undefined;
Last item in this list, or undefined if list is empty.
Returns
T | undefined
Inherited from
Methods
item()
item(index): ThreadedTextNode | undefined;
Returns item at the given index, or undefined if index is out of range.
Parameters
indexnumberReturns
ThreadedTextNode | undefined
Inherited from
[iterator]()
iterator: Iterator<ThreadedTextNode>;
Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.
Returns
Iterator<ThreadedTextNode>
Inherited from
addFrame()
addFrame(geometry?): ThreadedTextNode;
Parameters
geometry?Returns
A new ThreadedTextNode that is part of a threaded text flow.
indexOf()
indexOf(item): number;
Get index of item in list.
Parameters
itemReturns
number
index number, or -1 if item isn't in this list.
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[]