GradientStop

A gradient stop in a gradient.

Methods:

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, Color, EventListeners, Events, MixedInk, Number, Object,

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

index

Number

readonly

The index of the GradientStop within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

location

Number (range 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).

midpoint

Number (range 13 - 87)

read/write

The mid-point (as a percentage of the gradient length) of the gradient stop. (Range: 13 to 87)

parent

Gradient

readonly

The parent of the GradientStop (a Gradient).

properties

Object

read/write

A property that allows setting of several properties at the same time.

stopColor

MixedInk

Color

read/write

The swatch (color, gradient, tint, or mixed ink) applied to the gradient stop. Can return: MixedInk or Color.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

GradientStop getElements ()

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

undefined remove ()

Deletes the GradientStop.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

GradientStops.add()

GradientStop.getElements()

GradientStops.anyItem()

GradientStops.everyItem()

GradientStops.nextItem()

GradientStops.previousItem()

GradientStops.item()

GradientStops.[]()

GradientStops.itemByRange()

GradientStops.firstItem()

GradientStops.lastItem()

GradientStops.middleItem()