ColorGroups
A collection of color groups.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
ColorGroup [] (index:Number)
Returns the ColorGroup with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
ColorGroup add (name:String, swatchList:Array of Swatch, withProperties:Object)
Creates a new ColorGroup
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The color group name (Optional) |
|
|
swatchList |
The swatches to add in color group. (Optional) |
|
|
withProperties |
Initial values for properties of the new ColorGroup (Optional) |
ColorGroup anyItem ()
Returns any ColorGroup in the collection.
Number count ()
Displays the number of elements in the ColorGroup.
ColorGroup everyItem ()
Returns every ColorGroup in the collection.
ColorGroup firstItem ()
Returns the first ColorGroup in the collection.
ColorGroup item (index:Varies LongInteger String)
Returns the ColorGroup with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
ColorGroup itemByID (id:Number)
Returns the ColorGroup with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
ColorGroup itemByName (name:String)
Returns the ColorGroup with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
ColorGroup itemByRange (from:Varies ColorGroup LongInteger String, to:Varies ColorGroup LongInteger String)
Returns the ColorGroups within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The ColorGroup, index, or name at the beginning of the range. Can accept: ColorGroup, Long Integer or String. |
|
to |
LongInteger |
The ColorGroup, index, or name at the end of the range. Can accept: ColorGroup, Long Integer or String. |
ColorGroup lastItem ()
Returns the last ColorGroup in the collection.
ColorGroup middleItem ()
Returns the middle ColorGroup in the collection.
ColorGroup nextItem (obj:ColorGroup)
Returns the ColorGroup whose index follows the specified ColorGroup in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The ColorGroup whose index comes before the desired ColorGroup. |
ColorGroup previousItem (obj:ColorGroup)
Returns the ColorGroup with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the ColorGroup that follows the desired ColorGroup. |
String toSource ()
Generates a string which, if executed, will return the ColorGroup.
Object of
Application.colorGroups
Document.colorGroups