InDesign2026
API 21.5.1.73
Collection of OpacityGradientStop

OpacityGradientStops

A collection of opacity gradient stops.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

OpacityGradientStop

Creates a new OpacityGradientStop.

withProperties? Object Initial values for properties of the new OpacityGradientStop
Number

Displays the number of elements in the OpacityGradientStop.

OpacityGradientStop

Returns the OpacityGradientStop with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
OpacityGradientStop[]

Returns the OpacityGradientStops within the specified range.

from LongInteger | OpacityGradientStop | String The OpacityGradientStop, index, or name at the beginning of the range. Can accept: OpacityGradientStop, Long Integer or String.
to LongInteger | OpacityGradientStop | String The OpacityGradientStop, index, or name at the end of the range. Can accept: OpacityGradientStop, Long Integer or String.
OpacityGradientStop

Returns the middle OpacityGradientStop in the collection.

OpacityGradientStop

Returns the OpacityGradientStop whose index follows the specified OpacityGradientStop in the collection.

obj OpacityGradientStop The OpacityGradientStop whose index comes before the desired OpacityGradientStop.
OpacityGradientStop

Returns the OpacityGradientStop with the index previous to the specified index.

obj OpacityGradientStop The index of the OpacityGradientStop that follows the desired OpacityGradientStop.
String

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

Object of 2

Properties elsewhere that hold a OpacityGradientStops.