K4 InDesign Javascript API Documentation

PreferencesDirectionalFeatherSetting

Directional feather effect settings.

Extends

Instance Properties

Name Description Access
angle number The angle of the feather. (Range: 180 to -180) read-write
applied bool If true, the directional feather effect is applied. read-write
bottomWidth Measurement Unit (Number or String)=any The feather width (in pixels) on the bottom side of the object DirectionalFeatherSetting. (Range: .2 to 250) read-write
chokeAmount number The amount to choke the directional feather (as a percentage of the feather width). (Range: 0 to 100) read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
followShapeMode FollowShapeModeOptions The shape-following algorithm applied to the feather. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
leftWidth Measurement Unit (Number or String)=any The feather width (in pixels) on the left side of the DirectionalFeatherSetting. read-write
noise number The amount of noise (as a percentage) applied to the feather region. (Range: 0 to 100) read-write
parent The parent of the DirectionalFeatherSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting). read-only
properties Object A property that allows setting of several properties at the same time. read-write
rightWidth Measurement Unit (Number or String)=any The feather width (in pixels) on the right side of the DirectionalFeatherSetting. (Range: .2 to 250) read-write
topWidth Measurement Unit (Number or String)=any The feather width (in pixels) on the top side of the object DirectionalFeatherSetting. (Range: .2 to 250) read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → DirectionalFeatherSetting
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(
)
  → DirectionalFeatherSetting
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 DirectionalFeatherSetting.
toSpecifier(
)
  → string
Retrieves the object specifier.