InDesign2026
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 21.5.1.73
Object

ColorGroupSwatch

A color group swatch.

Hierarchy

ColorGroup

ColorGroupSwatch

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the ColorGroupSwatch.
Number readonly The index of the ColorGroupSwatch within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
ColorGroup readonly The parent of the ColorGroupSwatch (a ColorGroup).
Object read/write A property that allows setting of several properties at the same time.
Swatch readonly The underlying swatch item

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.
→ ColorGroupSwatch[]

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

→ 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 ColorGroupSwatch.

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a ColorGroupSwatch.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a ColorGroupSwatch.

ColorGroupSwatches.itemByRange(from)ColorGroupSwatches.nextItem(obj)ColorGroupSwatches.previousItem(obj)

Return 13

Methods that return a ColorGroupSwatch.

ColorGroupSwatch.getElements()ColorGroupSwatches.[]()ColorGroupSwatches.add()ColorGroupSwatches.anyItem()ColorGroupSwatches.everyItem()ColorGroupSwatches.firstItem()ColorGroupSwatches.item()ColorGroupSwatches.itemByID()ColorGroupSwatches.itemByRange()ColorGroupSwatches.lastItem()ColorGroupSwatches.middleItem()ColorGroupSwatches.nextItem()ColorGroupSwatches.previousItem()