Class

Artboards

 A collection of artboards.

QuickLinks

[], add, getActiveArtboardIndex, getByName, remove, removeAll, setActiveArtboardIndex

Hierarchy

Object

Artboards

Properties

Property	Type	Access	Description
length	int	readonly	Number of elements in the collection.
parent	Object	readonly	The object's container.
typename	string	readonly	The class name of the object.

Methods

Instances

Artboard [] (index: uint)
Get an element in the collection with the provided index.

Parameter	Type	Description
index	uint

Artboard add (artboardRect: Rect)
Add artboard object.

Parameter	Type	Description
artboardRect	Rect	Size and position of artboard.

int getActiveArtboardIndex ()
Retrieves the index position of the active artboard in the document's list.

Artboard getByName (name: string)
Get the first element in the collection with the provided name.

Parameter	Type	Description
name	string

void remove (index: int)
Delete artboard object.

Parameter	Type	Description
index	int	Index of the crop area to be deleted.

void removeAll ()
Deletes all elements.

void setActiveArtboardIndex (index: int)
Makes a specific artboard active, and makes it current in the iteration order.

Parameter	Type	Description
index	int	The 0-based index position of the artboard in the document list.

Element of

Document.artboards

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index