Ink

An ink.

Methods:

addEventListener, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, InkTypes, Number, Object, String

Property Listing

Property

Type

Access

Description

aliasInkName

String

read/write

The ink object to map this ink to.

angle

Number (range 0 - 360)

read/write

The angle of the ink. (Range: 0 to 360)

convertToProcess

Boolean

read/write

Converts spot inks to process inks.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

frequency

Number (range 1 - 500)

read/write

The frequency of the ink. (Range: 1 to 500)

id

Number

readonly

The unique ID of the Ink.

index

Number

readonly

The index of the Ink within its containing object.

inkType

InkTypes

InkTypes.NORMAL

InkTypes.OPAQUE

InkTypes.OPAQUE_IGNORE

InkTypes.TRANSPARENT

read/write

The trapping type of the ink.

isProcessInk

Boolean

readonly

If true, the ink is a process ink.

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

readonly

The name of the Ink.

neutralDensity

Number (range 0.001 - 10)

read/write

The neutral density of the ink. (Range: 0.001 to 10.0)

parent

Application

Document

readonly

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

printInk

Boolean

read/write

If true, prints the ink. Only valid when printing separations.

properties

Object

read/write

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

solidity

Number (range 0 - 1)

readonly

The solidity value of the ink. (Range: 0.0 to 1.0)

trapOrder

Number

read/write

The place of the ink in the trapping sequence.

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)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

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

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

String toSpecifier ()

Retrieves the object specifier.

Object of

MixedInk.inkList

MixedInkGroup.inkList

Event.parent

EventListener.parent

MutationEvent.parent

Return

Ink.getElements()

Inks.anyItem()

Inks.everyItem()

Inks.nextItem()

Inks.previousItem()

Inks.itemByID()

Inks.item()

Inks.[]()

Inks.itemByName()

Inks.itemByRange()

Inks.firstItem()

Inks.lastItem()

Inks.middleItem()