K4 InDesign Javascript API Documentation

ColorGradientStop

A gradient stop in a gradient.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the GradientStop within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
location number The starting location (as a percentage of the gradient length) of the gradient stop on the gradient. (Range: 0 to 100). read-write
midpoint number The mid-point (as a percentage of the gradient length) of the gradient stop. (Range: 13 to 87) read-write
parent Gradient The parent of the GradientStop (a Gradient). read-only
properties Object A property that allows setting of several properties at the same time. read-write
stopColor The swatch (color, gradient, tint, or mixed ink) applied to the gradient stop. Can return: MixedInk or Color. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → GradientStop
remove(
)
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)
getElements(
)
  → GradientStop
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the GradientStop.
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 GradientStop.
toSpecifier(
)
  → string
Retrieves the object specifier.