ColorGroup

A color group

Methods:

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

Objects:

Boolean, ColorGroupSwatches, EventListeners, Events, Number, Object, String

Property Listing

Property

Type

Access

Description

colorGroupSwatches

ColorGroupSwatches

readonly

A collection of color group swatches.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the ColorGroup.

index

Number

readonly

The index of the ColorGroup within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the ColorGroup.

parent

Application

Document

readonly

The parent of the ColorGroup (a Application or Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

ColorGroup duplicate ()

Duplicates the ColorGroup.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

ColorGroup getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

undefined remove ()

Deletes the ColorGroup.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined ungroup ()

Ungroups a color group

Object of

MixedInk.parentColorGroup

MixedInkGroup.parentColorGroup

Gradient.parentColorGroup

Swatch.parentColorGroup

Color.parentColorGroup

Tint.parentColorGroup

ColorGroupSwatch.parent

Event.parent

EventListener.parent

MutationEvent.parent

Return

ColorGroups.add()

ColorGroup.duplicate()

ColorGroup.getElements()

ColorGroups.anyItem()

ColorGroups.everyItem()

ColorGroups.nextItem()

ColorGroups.previousItem()

ColorGroups.itemByID()

ColorGroups.item()

ColorGroups.[]()

ColorGroups.itemByName()

ColorGroups.itemByRange()

ColorGroups.firstItem()

ColorGroups.lastItem()

ColorGroups.middleItem()