Class
A collection of artboards. add, getActiveArtboardIndex, getByName, getByName, insert, remove, removeAll, setActiveArtboardIndex
Artboards
See also Artboard.
QuickLinks
Hierarchy
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
Class
Artboard add (artboardRect:
Rectangle)
Add artboard object.
| Parameter | Type | Description |
|---|---|---|
| artboardRect | Rectangle | Size and position of artboard. |
Instances
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 | string |
Artboard getByName (artboardName:
string)
Get the first Artboard with specified name.
| Parameter | Type | Description |
|---|---|---|
| artboardName | string | The name of the artboard. |
void insert (artboardRect:
Rectangle, index:
Int32)
Insert an Artboard at specified location.
| Parameter | Type | Description |
|---|---|---|
| artboardRect | Rectangle | Size and position of artboard. |
| index | Int32 | Index position where artboard should be inserted. |
void remove (index:
Int32)
Delete artboard object.
| Parameter | Type | Description |
|---|---|---|
| index | Int32 | Index of the crop area to be deleted. |
void removeAll ()
Deletes all elements.
void 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. |
Element of
Document.artboards
| Jongware, 25-Nov-2012 v3.0.3i | Contents :: Index |