InDesign Server2025
API 20.5.0.49
Object

Color

A color swatch.

Swatch Color
Extended byTint
Hierarchy

Application | Document

Color

Properties

NameType AccessDescription
Number[] 0–100 read/write The 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.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the Color.
Number readonly The index of the Color within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
ColorModel
read/write The color model.
String read/write The name of the Color.
Application | Document readonly The parent of the Color (a Application or Document).
ColorGroup readonly The color group that a swatch belongs to
Object read/write A property that allows setting of several properties at the same time.
ColorSpace
read/write The color space.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
Color

Duplicates the Color.

String

Gets the label value associated with the specified key.

key String The key.
Color[]

Resolves the object specifier, creating an array of object references.

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
Swatch

Merges the specified swatches with the swatch.

with Swatches[]<Swatch> | Swatch[] | String[] The swatches to merge. Can accept: Array of Swatches, Swatch or String.
void

Deletes the swatch.

replacingWith? Swatch The swatch to apply in place of the deleted swatch.
Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

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

String

Retrieves the object specifier.

Object of 5

Properties elsewhere that hold a Color.

Parameter of 4

Method parameters that accept a Color.

Return 19

Methods that return a Color.