K4 InDesign Javascript API Documentation

ColorInk

An ink.

Instance Properties

Name Description Access
aliasInkName string The ink object to map this ink to. read-write
angle number The angle of the ink. (Range: 0 to 360) read-write
convertToProcess bool Converts spot inks to process inks. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
frequency number The frequency of the ink. (Range: 1 to 500) read-write
id number The unique ID of the Ink. read-only
index number The index of the Ink within its containing object. read-only
inkType InkTypes The trapping type of the ink. read-write
isProcessInk bool If true, the ink is a process ink. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the Ink. read-only
neutralDensity number The neutral density of the ink. (Range: 0.001 to 10.0) read-write
parent The parent of the Ink (a Application or Document). read-only
printInk bool If true, prints the ink. Only valid when printing separations. read-write
properties Object A property that allows setting of several properties at the same time. read-write
solidity number The solidity value of the ink. (Range: 0.0 to 1.0) read-only
trapOrder number The place of the ink in the trapping sequence. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → Ink
insertLabel(
key, value)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Ink
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Ink.
toSpecifier(
)
  → string
Retrieves the object specifier.