Class

MixedInkGroup

 A mixed ink group. Base Class: Swatch

QuickLinks

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

Hierarchy

Application | Document
Swatch
MixedInkGroup
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the MixedInkGroup.
indexnumber readonlyThe index of the MixedInkGroup within its containing object.
inkListArray of Ink readonlyThe component inks.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
modelColorModel:
ColorModel.SPOT
ColorModel.PROCESS
ColorModel.REGISTRATION
ColorModel.MIXEDINKMODEL
r/wThe color model.
namestring r/wThe name of the MixedInkGroup.
parentApplication
Document
readonlyThe parent of the MixedInkGroup (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

MixedInkGroup duplicate ()
Duplicates the MixedInkGroup.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of MixedInkGroup getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Swatch merge (with: varies)
Merges the specified swatches with the swatch.

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

void remove ([replacingWith: Swatch])
Deletes the swatch.

ParameterTypeDescription
replacingWithSwatchThe swatch to apply in place of the deleted swatch. (Optional)

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the MixedInkGroup.

string toSpecifier ()
Retrieves the object specifier.

Element of

MixedInk.baseColor

Used in:

MixedInkGroup MixedInkGroups.nextItem (obj: MixedInkGroup)

MixedInkGroup MixedInkGroups.previousItem (obj: MixedInkGroup)

Return

MixedInkGroup MixedInkGroup.duplicate ()

Array of MixedInkGroup MixedInkGroup.getElements ()

MixedInkGroup MixedInkGroups.[] (index: number)

MixedInkGroup MixedInkGroups.add (inkList: Array of Ink[, inkPercentages: Array of number][, repeatValues: Array of number][, incrementValues: Array of number][, withProperties: Object])

MixedInkGroup MixedInkGroups.anyItem ()

Array of MixedInkGroup MixedInkGroups.everyItem ()

MixedInkGroup MixedInkGroups.firstItem ()

MixedInkGroup MixedInkGroups.item (index: varies)

MixedInkGroup MixedInkGroups.itemByID (id: number)

MixedInkGroup MixedInkGroups.itemByName (name: string)

Array of MixedInkGroup MixedInkGroups.itemByRange (from: varies, to: varies)

MixedInkGroup MixedInkGroups.lastItem ()

MixedInkGroup MixedInkGroups.middleItem ()

MixedInkGroup MixedInkGroups.nextItem (obj: MixedInkGroup)

MixedInkGroup MixedInkGroups.previousItem (obj: MixedInkGroup)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index