Colors

A collection of colors.

Methods

Color add ([withProperties: Object])
Creates a new Color.

Parameter Type Description
withProperties Object Initial values for properties of the new Color (Optional)

Color anyItem ()
Returns any Color in the collection.

number count ()
Displays the number of elements in the Color.

Array of Color everyItem ()
Returns every Color in the collection.

Color firstItem ()
Returns the first Color in the collection.

Color item (index: any)
Returns the Color with the specified index or name.

Parameter Type Description
index Long Integer
String		 The index or name. Can accept: Long Integer or String.

Color itemByID (id: number)
Returns the Color with the specified ID.

Parameter Type Description
id number The ID.

Color itemByName (name: string)
Returns the Color with the specified name.

Parameter Type Description
name string The name.

Array of Color itemByRange (from: any, to: any)
Returns the Colors within the specified range.

Parameter Type Description
from Color
Long Integer
String		 The Color, index, or name at the beginning of the range. Can accept: Color, Long Integer or String.
to Color
Long Integer
String		 The Color, index, or name at the end of the range. Can accept: Color, Long Integer or String.

Color lastItem ()
Returns the last Color in the collection.

Color middleItem ()
Returns the middle Color in the collection.

Color nextItem (obj: Color)
Returns the Color whose index follows the specified Color in the collection.

Parameter Type Description
obj Color The Color whose index comes before the desired Color.

Color previousItem (obj: Color)
Returns the Color with the index previous to the specified index.

Parameter Type Description
obj Color The index of the Color that follows the desired Color.

string toSource ()
Generates a string which, if executed, will return the Color.

Element of:

Application.colors
Document.colors