@express-document-sdk

Class: PageList

PageList represents an ordered list of PageNodes, all of which are children of the root node of the document's "scenegraph" artwork tree (see ExpressRootNode). 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.

PageList also provides APIs for adding/removing pages from the document. PageList is never empty: it is illegal to remove the last remaining page from the list.

Extends

• RestrictedItemList<PageNode>

Indexable

[key: number]: object

Constructors

Constructor

new PageList(): PageList;

Returns

PageList

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

addPage()

addPage(inputGeometry): PageNode;

Create a new page containing a single empty artboard, and add it to the end of the list. The artboard is configured with the same defaults as in ArtboardList.addArtboard. The page's artboard becomes the default target for newly inserted content (Context.insertionParent) and the viewport switches to display this artboard.

Parameters

Returns

PageNode

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): PageNode | undefined;

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

Parameters

Returns

PageNode | undefined

Inherited from

RestrictedItemList.item

[iterator]()

iterator: Iterator<PageNode>;

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

Returns

Iterator<PageNode>

Inherited from

RestrictedItemList.[iterator]

toArray()

toArray(): readonly PageNode[];

All items in the list, as a static array. Mutations that occur later are not reflected in an array returned earlier.

Returns

readonly PageNode[]

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