Artboards
Artboards
Section titled “Artboards”artboards
Description
Section titled “Description”A collection of Artboard objects.
Properties
Section titled “Properties”Artboards.length
Section titled “Artboards.length”artboards.length
Description
Section titled “Description”The number of datasets in the collection
Number; read-only.
Artboards.parent
Section titled “Artboards.parent”artboards.parent
Description
Section titled “Description”The name of the object that contains this dataset
Artboard; read-only.
Artboards.typename
Section titled “Artboards.typename”artboards.typename
Description
Section titled “Description”The class name of the referenced object.
String; read-only.
Methods
Section titled “Methods”Artboards.add()
Section titled “Artboards.add()”artboards.add(artboardRect)
Description
Section titled “Description”Creates a new Artboard object.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
artboardRect | Rect | Artboard dimensions |
Returns
Section titled “Returns”Artboards.getActiveArtboardIndex()
Section titled “Artboards.getActiveArtboardIndex()”artboards.getActiveArtboardIndex()
Description
Section titled “Description”Retrieves the index position of the active artboard in the document’s list.
Returns the 0-based index.
Returns
Section titled “Returns”Number (long)
Artboards.getByName()
Section titled “Artboards.getByName()”artboards.getByName(name)
Description
Section titled “Description”Gets the first element in the collection with the specified name.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
name | String | Name of element to get |
Returns
Section titled “Returns”Artboards.insert()
Section titled “Artboards.insert()”artboards.insert(artboardRect, index)
Description
Section titled “Description”Creates a new Artboard object and inserts it at the given index in the list.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
artboardRect | Rect | Artboard dimensions |
index | Number (long) | Index to insert artboard at |
Returns
Section titled “Returns”Nothing.
Artboards.remove()
Section titled “Artboards.remove()”artboards.remove(index)
Description
Section titled “Description”Deletes an artboard object. You cannot remove the last artboard in a document.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
index | Number (long) | Index of artboard to remove |
Returns
Section titled “Returns”Nothing.
Artboards.setActiveArtboardIndex()
Section titled “Artboards.setActiveArtboardIndex()”artboards.setActiveArtboardIndex(index)
Description
Section titled “Description”Makes a specific artboard active and makes it current in the iteration order.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
index | Number (long) | Index of artboard to set active |
Returns
Section titled “Returns”Nothing.