K4 InDesign Javascript API Documentation

PreferencesDropShadowSetting

Drop shadow settings.

Extends

Instance Properties

Name Description Access
angle number The angle at which the shadow is thrown read-write
blendMode BlendMode The blending mode for the drop shadow effect. read-write
distance Measurement Unit (Number or String)=any The distance between the item and its shadow read-write
effectColor Swatch The color applied to the drop 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
honorOtherEffects bool If true, the drop shadow will take into account other non-shadow effects. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
knockedOut bool If true, the layer will knock out the drop shadow. read-write
mode ShadowMode The shadow mode. read-write
noise number The amount (as a percentage) of noise applied to the shadow. (Range: 0 to 100) read-write
opacity number The opacity of the drop shadow (as a percentage). (Range: 0 to 100) read-write
parent The parent of the DropShadowSetting (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 radius (in pixels) of the blur applied to the drop shadow. (Range depends on the unit type. For points: 0 to 144; for picas: 0p0 to 12p0; for inches: 0 to 2; for mm: 0 to 50.08; for cm: 0 to 5.08; for ciceros: 0c0 to 11c3.128.) read-write
spread number The amount (as a percentage of the blur width) to spread the footprint of the drop shadow and reduce the radius of the blur. (Range: 0 to 100) read-write
useGlobalLight bool If true, uses the global light angle. read-write
xOffset Measurement Unit (Number or String)=any The horizontal offset of the drop shadow. Range depends on the unit type. For points: -1000 to 1000; for picas: -83p4 to 83p4; for inches: -13.8889 to 13.8889; for mm: -352.778 to 352.778; for cm: -35.277 to 35.277; for ciceros: -78c2.389 to 78c2.389. read-write
yOffset Measurement Unit (Number or String)=any The vertical offset of the drop shadow. (Range depends on the unit type. For points: -1000 to 1000; for picas: -83p4 to 83p4; for inches: -13.8889 to 13.8889; for mm: -352.778 to 352.778; for cm: -35.277 to 35.277; for ciceros: -78c2.389 to 78c2.389) read-write

Methods

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