InDesign2026
API 21.5.1.73
Object

GradientStop

A gradient stop in a gradient.

Hierarchy

Gradient

GradientStop

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The index of the GradientStop within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
Number 0–100 read/write The starting location (as a percentage of the gradient length) of the gradient stop on the gradient. (Range: 0 to 100).
Number 13–87 read/write The mid-point (as a percentage of the gradient length) of the gradient stop. (Range: 13 to 87)
Gradient readonly The parent of the GradientStop (a Gradient).
Object read/write A property that allows setting of several properties at the same time.
MixedInk | Color read/write The swatch (color, gradient, tint, or mixed ink) applied to the gradient stop. Can return: MixedInk or Color.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
GradientStop[]

Resolves the object specifier, creating an array of object references.

void

Deletes the GradientStop.

Boolean

Removes the event listener.

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

Generates a string which, if executed, will return the GradientStop.

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a GradientStop.

Parameter of 3

Method parameters that accept a GradientStop.

Return 12

Methods that return a GradientStop.