K4 InDesign Javascript API Documentation

PreferencesGradientFeatherSetting

Gradient feather effect settings.

Extends

Instance Properties

Name Description Access
angle number The angle of the gradient feather. read-write
applied bool If true, the gradient feather effect is applied. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
gradientStart Measurement Unit (Number or String)=any The center point (for a radial gradient) or starting point (for a linear gradient) applied to the fill, as page coordinates in the format [x, y]. read-write
hiliteAngle number The hilite angle of the radial gradient feather. read-write
hiliteLength Measurement Unit (Number or String)=any The hilite length of the radial gradient feather. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
length Measurement Unit (Number or String)=any The length of the axial gradient, or radius of the radial gradient. read-write
opacityGradientStops OpacityGradientStops A collection of opacity gradient stops. read-only
parent The parent of the GradientFeatherSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting). read-only
properties Object A property that allows setting of several properties at the same time. read-write
type GradientType The type of gradient. read-write

Methods

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