@express-document-sdk / ItemList
Class: ItemList<T>
ItemList represents an ordered list of API objects, representing items that are all children of the same parent node. (The reverse is not necessarily true, however: this list might not include all children that exist in the parent node. See Node.allChildren for details).
ItemList also provides APIs for manipulating the list by adding items to the parent or removing items from the parent.
This class is used in different places for various types of items, including Nodes, Fills, and Strokes.
Extends
Type parameters
• T extends ListItem
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<T, any, any>
Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.
Returns
Iterator<T, any, any>
Inherited from
append()
• append(...items): void
Add one or more items to the end of the list. The last argument will become the last item in this list. Items are removed from their previous parent, if any – or if an item is already in this list, its index is simply changed.
Parameters
• ...items: T[]
Returns
void
Throws
- if item has a different parent and item is a ThreadedTextNode, or if item's children subtree contains a ThreadedTextNode.
clear()
• clear(): void
Remove all items from this list. No-op if list is already empty.
Returns
void
indexOf()
• indexOf(item): number
Get index of item in list.
Parameters
• item: T
Returns
number
index number, or -1 if item isn't in this list.
Inherited from
insertAfter()
• insertAfter(newItem, after): void
Insert newItem so it is immediately after after in this list: places newItem at the index one higher than after,
shifting all later items to higher indices (the index of after remains unchanged). newItem is removed from its previous parent,
if any – or if it's already in this list, its index is simply changed. No-op if both arguments are the same item.
Parameters
• newItem: T
• after: T
Returns
void
Throws
- if newItem has a different parent and it is a ThreadedTextNode, or if newItem's children subtree contains a ThreadedTextNode.
insertBefore()
• insertBefore(newItem, before): void
Insert newItem so it is immediately before before in this list: places newItem at the index that before used
to occupy, shifting before and all later items to higher indices. newItem is removed from its previous parent,
if any – or if it's already in this list, its index is simply changed. No-op if both arguments are the same item.
Parameters
• newItem: T
• before: T
Returns
void
Throws
- if newItem has a different parent and it is a ThreadedTextNode, or if newItem's children subtree contains a ThreadedTextNode.
item()
• item(index): undefined | T
Returns item at the given index, or undefined if index is out of range.
Parameters
• index: number
Zero-based index
Returns
undefined | T
Inherited from
moveAfter()
• moveAfter(item, after): void
Move item so it is immediately after after in this list: places item at the index one higher than after.
Depending on the position in the list item originally occupied, some other items in the list may shift to higher
or lower indices as a result. No-op if both arguments are the same item.
Parameters
• item: T
• after: T
Returns
void
Inherited from
Throws
An error if either argument is not contained in this list.
moveBefore()
• moveBefore(item, before): void
Move item so it is immediately before before in this list: places item at the index that before used
to occupy. Depending on the position in the list item originally occupied, some other items in the list may
shift to higher or lower indices as a result. No-op if both arguments are the same item.
Parameters
• item: T
• before: T
Returns
void
Inherited from
Throws
An error if either argument is not contained in this list.
remove()
• remove(...items): void
Remove the items from the list. The items need not be contiguous.
Parameters
• ...items: T[]
Returns
void
Inherited from
Throws
If any of the items are not in the list, or if it is illegal to remove any of the items from this parent.
replace()
• replace(oldItem, newItem): void
Replace oldItem with newItem in this list. Throws if oldItem is not a member of this list.
newItem is removed from its previous parent, if any – or if it's already in this list, its index is simply
changed. No-op if both arguments are the same item.
Parameters
• oldItem: T
• newItem: T
Returns
void
Throws
- if newItem has a different parent and newItem is a ThreadedTextNode, or if newItem's children subtree contains a ThreadedTextNode.
toArray()
• toArray(): readonly T[]
All items in the list, as a static array. Mutations that occur later are not reflected in an array returned earlier.
Returns
readonly T[]
