K4 InDesign Javascript API Documentation

ColorColor

A color swatch.

Extends

Instance Properties

Name Description Access
colorValue number 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. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the Color. read-only
index number The index of the Color within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
model ColorModel The color model. read-write
name string The name of the Color. read-write
parent The parent of the Color (a Application or Document). read-only
parentColorGroup ColorGroup The color group that a swatch belongs to read-only
properties Object A property that allows setting of several properties at the same time. read-write
space ColorSpace The color space. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → Color
extractLabel(
key)
  → string
getElements(
)
  → Color
insertLabel(
key, value)
merge(
with)
  → Swatch
remove(
[replacingWith])
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
duplicate(
)
  → Color
Duplicates the Color.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Color
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
merge(
with)
  → Swatch
Merges the specified swatches with the swatch.
with The swatches to merge. Can accept: Array of Swatches, Swatch or String.
remove(
[replacingWith])
Deletes the swatch.
replacingWith Swatch The swatch to apply in place of the deleted swatch. (Optional)
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Color.
toSpecifier(
)
  → string
Retrieves the object specifier.