K4 InDesign Javascript API Documentation

PreferencesFindChangeInnerShadowSetting

Inner shadow effect settings.

Extends

Instance Properties

Name Description Access
angle The angle at which the inner shadow is thrown. (Range: -360 to 360). Can return: Real (-180 - 180) or NothingEnum enumerator. read-write
applied If true, the inner shadow effect is applied. Can return: Boolean or NothingEnum enumerator. read-write
blendMode The blending mode for the inner shadow effect. Can return: BlendMode enumerator or NothingEnum enumerator. read-write
chokeAmount The amount to choke the inner shadow (as a percentage of shadow size). (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. read-write
distance The distance between the FindChangeInnerShadowSetting and the shadow. . Can return: Unit (0 - 1000 points) or NothingEnum enumerator. read-write
effectColor The color applied to the inner shadow, specified as a swatch (color, gradient, tint, or mixed ink), or as an array of color values. The color mode dictates the array values: for RGB, specify three values, each in the range 0 to 255, in the format [R,G,B]; for CMYK, specify four values, each as a percentage and each in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify three values in the format [L,A,B], with L in the range 0 to 100 and A and B in the range -128 to 127. . Can return: Swatch or NothingEnum enumerator. 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
noise The amount (as a percentage) of noise to add to the shadow. (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. read-write
opacity The opacity (as a percentage) of the inner shadow. (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. read-write
parent The parent of the FindChangeInnerShadowSetting (a FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). read-only
properties Object A property that allows setting of several properties at the same time. read-write
size The size of the inner shadow. Can return: Unit (0 - 144 points) or NothingEnum enumerator. read-write
useGlobalLight If true, the global light angle is used. Can return: Boolean or NothingEnum enumerator. read-write
xOffset The horizontal offset of the shadow. Can return: Unit (-1000 - 1000 points) or NothingEnum enumerator. read-write
yOffset The vertical offset of the shadow. Can return: Unit (-1000 - 1000 points) or NothingEnum enumerator. read-write

Methods

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