K4 InDesign Javascript API Documentation

PreferencesFeatherSetting

Feather effect settings.

Extends

Instance Properties

Name Description Access
chokeAmount number The amount to choke the feather (as a percentage of the feather width). (Range: 0 to 100) read-write
cornerType FeatherCornerType The corner effect applied to the feather. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
mode FeatherMode The feather mode. read-write
noise number The amount (as a percentage) of noise applied to the feather. (Range: 0 to 100) read-write
parent The parent of the FeatherSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting). read-only
properties Object A property that allows setting of several properties at the same time. read-write
width Measurement Unit (Number or String)=any The feather width. (Range depends on the unit type. For points: 0 to 1000; for picas: 0 to 83p4; for inches: 0 to 13.8889; for mm: 0 to 352.778; for cm: 0 to 35.277; for ciceros: 0 to 78c2.389.) read-write

Methods

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