@express-document-sdk

Class: ArtboardList

ArtboardList represents an ordered list of ArtboardNodes, which are the children of one PageNode. If multiple artboards are present, each represents a keyframe "scene" in the page's animation timeline.

ArtboardList also provides APIs for adding/removing artboards from the page. ArtboardList is never empty: it is illegal to remove the last remaining artboard from the list.

Extends

• RestrictedItemList<ArtboardNode>

Indexable

[key: number]: object

Constructors

Constructor

new ArtboardList(): ArtboardList;

Returns

ArtboardList

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

addArtboard()

addArtboard(): ArtboardNode;

Create a new artboard and add it to the end of the list. The artboard size is the same as others on this page. The artboard background is set to default fill color DEFAULT_ARTBOARD_FILL_COLOR. The new artboard becomes the default target for newly inserted content (see insertionParent) and the timeline advances to show this artboard in the current viewport.

Returns

ArtboardNode

the newly added artboard.

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

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

Parameters

Returns

ArtboardNode | undefined

Inherited from

RestrictedItemList.item

[iterator]()

iterator: Iterator<ArtboardNode>;

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

Returns

Iterator<ArtboardNode>

Inherited from

RestrictedItemList.[iterator]

toArray()

toArray(): readonly ArtboardNode[];

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

Returns

readonly ArtboardNode[]

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