Adobe InDesign CS6 Server (8.0) Object Model JS: MixedInk

InDesign Server CS6

Class

MixedInk

 A mixed ink swatch. Base Class: Swatch

QuickLinks

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

Hierarchy

Application | Document
Swatch
MixedInk
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
baseColorMixedInkGroup readonlyThe mixed ink group that a mixed ink swatch is based on.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the MixedInk.
indexnumber readonlyThe index of the MixedInk within its containing object.
inkListArray of Ink readonlyThe component inks.
inkPercentagesArray of number r/wThe array of tint percentages for inks in the ink list. Note: Specify a value for each ink.
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 MixedInk.
parentApplication
Document
readonlyThe parent of the MixedInk (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
spaceColorSpace:
ColorSpace.RGB
ColorSpace.CMYK
ColorSpace.LAB
ColorSpace.MIXEDINK
r/wThe color space.

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)

MixedInk duplicate ()
Duplicates the MixedInk.

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

ParameterTypeDescription
keystringThe key.

Array of MixedInk 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 MixedInk.

string toSpecifier ()
Retrieves the object specifier.

Element of

GradientStop.stopColor

Used in:

MixedInk MixedInks.nextItem (obj: MixedInk)

MixedInk MixedInks.previousItem (obj: MixedInk)

Return

MixedInk MixedInk.duplicate ()

Array of MixedInk MixedInk.getElements ()

MixedInk MixedInks.[] (index: number)

MixedInk MixedInks.add (inkList: varies, inkPercentages: Array of number[, withProperties: Object])

MixedInk MixedInks.anyItem ()

Array of MixedInk MixedInks.everyItem ()

MixedInk MixedInks.firstItem ()

MixedInk MixedInks.item (index: varies)

MixedInk MixedInks.itemByID (id: number)

MixedInk MixedInks.itemByName (name: string)

Array of MixedInk MixedInks.itemByRange (from: varies, to: varies)

MixedInk MixedInks.lastItem ()

MixedInk MixedInks.middleItem ()

MixedInk MixedInks.nextItem (obj: MixedInk)

MixedInk MixedInks.previousItem (obj: MixedInk)

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