@express-document-sdk / ArtboardList
Class: ArtboardList
ArtboardList represents an ordered list of ArtboardNodes arranged in a timeline sequence, where they are called "scenes." All items in the list are children of a single PageNode.
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.
Hierarchy
RestrictedItemList<ArtboardNode>↳
ArtboardList
Accessors
first
• get first(): undefined | T
First item in this list, or undefined if list is empty.
Returns
undefined | T
Inherited from
RestrictedItemList.first
last
• get last(): undefined | T
Last item in this list, or undefined if list is empty.
Returns
undefined | T
Inherited from
RestrictedItemList.last
length
• get length(): number
Number of items in this list.
Returns
number
Inherited from
RestrictedItemList.length
Methods
[iterator]
▸ [iterator](): Iterator<ArtboardNode, any, undefined>
Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.
Returns
Iterator<ArtboardNode, any, undefined>
Inherited from
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
the newly added artboard.
indexOf
▸ indexOf(item): number
Get index of item in list.
Parameters
| Name | Type |
|---|---|
item |
Returns
number
index number, or -1 if item isn't in this list.
Inherited from
item
▸ item(index): undefined | ArtboardNode
Returns item at the given index, or undefined if index is out of range.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | Zero-based index |
Returns
undefined | ArtboardNode
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.
Throws
An error if either argument is not contained in this list.
Parameters
| Name | Type |
|---|---|
item | |
after |
Returns
void
Inherited from
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.
Throws
An error if either argument is not contained in this list.
Parameters
| Name | Type |
|---|---|
item | |
before |
Returns
void
Inherited from
remove
▸ remove(...items): void
Remove the items from the list. The items need not be contiguous.
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.
Parameters
| Name | Type |
|---|---|
...items |
Returns
void
Inherited from
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[]
