@express-document-sdk

Class: ItemList<T>

ItemList represents an ordered list of API objects that are all children of the same parent node. It is most frequently encountered as ArtboardNode.children or GroupNode.children.

ItemList also provides APIs for manipulating the list by adding items to the parent or removing items from the parent.

Note that some parent nodes may have additional children that are not present in the main children ItemList (e.g. GroupNode.maskShape). Use the read-only Node.allChildren for a combined view of all children.

Extends

• RestrictedItemList<T>

Type Parameters

Constructors

Constructor

new ItemList<T>(): ItemList<T>;

Returns

ItemList<T>

Inherited from

RestrictedItemList.constructor

Accessors

length

Get Signature

get length(): number;

Number of items in this list.

Returns

number

Inherited from

RestrictedItemList.length

first

Get Signature

get first(): T | undefined;

First item in this list, or undefined if list is empty.

Returns

T | undefined

Inherited from

RestrictedItemList.first

last

Get Signature

get last(): T | undefined;

Last item in this list, or undefined if list is empty.

Returns

T | undefined

Inherited from

RestrictedItemList.last

Methods

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

Returns

void

clear()

clear(): void;

Remove all items from this list. No-op if list is already empty.

Returns

void

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

Returns

void

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

Returns

void

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

Returns

void

indexOf()

indexOf(item): number;

Get index of item in list.

Parameters

Returns

number

index number, or -1 if item isn't in this list.

Inherited from

RestrictedItemList.indexOf

item()

item(index): T | undefined;

Returns item at the given index, or undefined if index is out of range.

Parameters

Returns

T | undefined

Inherited from

RestrictedItemList.item

[iterator]()

iterator: Iterator<T>;

Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.

Returns

Iterator<T>

Inherited from

RestrictedItemList.[iterator]

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[]

Inherited from

RestrictedItemList.toArray

remove()

remove(...items): void;

Remove the items from the list. The items need not be contiguous.

Parameters

Returns

void

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.

Inherited from

RestrictedItemList.remove

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

Returns

void

Throws

An error if either argument is not contained in this list.

Inherited from

RestrictedItemList.moveBefore

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

Returns

void

Throws

An error if either argument is not contained in this list.

Inherited from

RestrictedItemList.moveAfter