InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Collection of GradientStop

GradientStops

A collection of gradient stops.

Properties

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

Methods

→ GradientStop

Returns the GradientStop with the specified index.

index Number The index.
→ GradientStop

Creates a new GradientStop.

withProperties? Object Initial values for properties of the new GradientStop
→ GradientStop

Returns any GradientStop in the collection.

→ Number

Displays the number of elements in the GradientStop.

→ GradientStop[]

Returns every GradientStop in the collection.

→ GradientStop

Returns the first GradientStop in the collection.

→ GradientStop

Returns the GradientStop with the specified index or name.

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

Returns the GradientStops within the specified range.

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

Returns the last GradientStop in the collection.

→ GradientStop

Returns the middle GradientStop in the collection.

→ GradientStop

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

obj GradientStop The GradientStop whose index comes before the desired GradientStop.
→ GradientStop

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

obj GradientStop The index of the GradientStop that follows the desired GradientStop.
→ String

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

Object of 1

Properties elsewhere that hold a GradientStops.

Gradient.gradientStops