K4 InDesign Javascript API Documentation

ColorColorGroupSwatch

A color group swatch.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the ColorGroupSwatch. read-only
index number The index of the ColorGroupSwatch within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent ColorGroup The parent of the ColorGroupSwatch (a ColorGroup). read-only
properties Object A property that allows setting of several properties at the same time. read-write
swatchItemRef Swatch The underlying swatch item read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → ColorGroupSwatch
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)
getElements(
)
  → ColorGroupSwatch
Resolves the object specifier, creating an array of object references.
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 ColorGroupSwatch.
toSpecifier(
)
  → string
Retrieves the object specifier.