A collection of artboards.
Go to Property Listing | Method Listing
add, getActiveArtboardIndex, getByName, getByName, insert, remove, removeAll, setActiveArtboardIndex
Property |
Type |
Access |
Description |
---|---|---|---|
Int |
readonly |
Number of elements in the collection. |
|
readonly |
The object's container. |
||
readonly |
The class name of the object. |
Artboard add (artboardRect:Rect)
Add artboard object.
Parameter |
Type |
Description |
---|---|---|
artboardRect |
Rect |
Size and position of artboard. |
Int32 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 |
Artboard getByName (artboardName:String)
Get the first Artboard with specified name.
Parameter |
Type |
Description |
---|---|---|
artboardName |
The name of the artboard. |
undefined insert (artboardRect:Rect, index:Int32)
Insert an Artboard at specified location.
Parameter |
Type |
Description |
---|---|---|
artboardRect |
Rect |
Size and position of artboard. |
index |
Int32 |
Index position where artboard should be inserted. |
undefined remove (index:Int32)
Delete artboard object.
Parameter |
Type |
Description |
---|---|---|
index |
Int32 |
Index of the crop area to be deleted. |
undefined removeAll ()
Deletes all elements.
undefined setActiveArtboardIndex (index:Int32)
Makes a specific artboard active, and makes it current in the iteration order.
Parameter |
Type |
Description |
---|---|---|
index |
Int32 |
The 0-based index position of the artboard in the document list. |
Document.artboards