Swatch

Methods:

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

Objects:

Boolean, ColorGroup, EventListeners, Events, Number, Object, String

Hierarchy:

Class: Swatch

Subclasses: MixedInk | MixedInkGroup | Gradient | Color

Property Listing

Property	Type	Access	Description
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 Swatch.
index	Number	readonly	The index of the Swatch 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 Swatch.
parent	Application Document	readonly	The parent of the Swatch (a Application or Document).
parentColorGroup	ColorGroup	readonly	The color group that a swatch belongs to
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)

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)

Swatch duplicate ()

Duplicates the Swatch.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Swatch 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.

Swatch merge (with:Array of Varies Swatches Swatch String)

Merges the specified swatches with the swatch.

Parameter	Type	Description
with	Array of Swatches Swatch String	The swatches to merge. Can accept: Array of Swatches, Swatch or String.

Parameter

Type

Description

with

Array of Swatches

Swatch

String

The swatches to merge. Can accept: Array of Swatches, Swatch or String.

undefined remove (replacingWith:Swatch)

Deletes the swatch.

Parameter	Type	Description
replacingWith	Swatch	The swatch to apply in place of the deleted swatch. (Optional)

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)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

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

captures

Boolean