K4 InDesign Javascript API Documentation

PreferencesInnerShadowSetting

Inner shadow effect settings.

Extends

Instance Properties

Name Description Access
angle number The angle at which the inner shadow is thrown. (Range: -360 to 360) read-write
applied bool If true, the inner shadow effect is applied. read-write
blendMode BlendMode The blending mode for the inner shadow effect. read-write
chokeAmount number The amount to choke the inner shadow (as a percentage of shadow size). (Range: 0 to 100) read-write
distance Measurement Unit (Number or String)=any The distance between the InnerShadowSetting and the shadow. read-write
effectColor Swatch 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. 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 number The amount (as a percentage) of noise to add to the shadow. (Range: 0 to 100) read-write
opacity number The opacity (as a percentage) of the inner shadow. (Range: 0 to 100) read-write
parent The parent of the InnerShadowSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting). read-only
properties Object A property that allows setting of several properties at the same time. read-write
size Measurement Unit (Number or String)=any The size of the inner shadow. read-write
useGlobalLight bool If true, the global light angle is used. read-write
xOffset Measurement Unit (Number or String)=any The horizontal offset of the shadow read-write
yOffset Measurement Unit (Number or String)=any The vertical offset of the shadow read-write

Methods

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