Adobe InDesign CS5 (7.0) Object Model JS: Color

InDesign CS5

Class

Color

 

A color swatch. Base Class: Swatch

Superclass of Tint

QuickLinks

addEventListener, duplicate, extractLabel, getElements, insertLabel, merge, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Swatch
Color
Tint
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
colorValueArray of number r/wThe ink values that create the color, specified as a percentage for each ink. Note: The number of values required and the range depends on the color space. For RGB, specify three values, with each value in the range 0 to 255; for CMYK, specify four values representing C, M, Y, and K, with each value in the range 0 to 100; for LAB, specify three values representing L (Range: 0 to 100), A (Range: -128 to 127), and B (Range: -128 to 127); for mixed ink, specify values for each ink in the ink list, with each value in the range 0 to 100.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the Color.
indexnumber readonlyThe index of the Color within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
modelColorModel:
ColorModel.SPOT
ColorModel.PROCESS
ColorModel.REGISTRATION
ColorModel.MIXEDINKMODEL
r/wThe color model.
namestring r/wThe name of the Color.
parentApplication
Document
readonlyThe parent of the Color (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
spaceColorSpace:
ColorSpace.RGB
ColorSpace.CMYK
ColorSpace.LAB
ColorSpace.MIXEDINK
r/wThe color space.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Color duplicate ()
Duplicates the Color.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Color getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Swatch merge (with: varies)
Merges the specified swatches with the swatch.

ParameterTypeDescription
withArray of Swatches
String
Swatch
The swatches to merge. Can accept: Array of Swatches, Swatch or String.

void remove ([replacingWith: Swatch])
Deletes the swatch.

ParameterTypeDescription
replacingWithSwatchThe swatch to apply in place of the deleted swatch. (Optional)

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

GradientStop.stopColor

Tint.baseColor

Used in:

Color Colors.nextItem (obj: Color)

Color Colors.previousItem (obj: Color)

Tint Tints.add (baseColor: Color[, withProperties: Object])

Return

Color Application.importAdobeSwatchbookProcessColor (name: string)

Color Application.importAdobeSwatchbookSpotColor (name: string)

Color Color.duplicate ()

Array of Color Color.getElements ()

Color Colors.[] (index: number)

Color Colors.add ([withProperties: Object])

Color Colors.anyItem ()

Array of Color Colors.everyItem ()

Color Colors.firstItem ()

Color Colors.item (index: varies)

Color Colors.itemByID (id: number)

Color Colors.itemByName (name: string)

Array of Color Colors.itemByRange (from: varies, to: varies)

Color Colors.lastItem ()

Color Colors.middleItem ()

Color Colors.nextItem (obj: Color)

Color Colors.previousItem (obj: Color)

Color Document.importAdobeSwatchbookProcessColor (name: string)

Color Document.importAdobeSwatchbookSpotColor (name: string)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index