K4 InDesign Javascript API Documentation

PreferencesInnerGlowSetting

Inner glow effect settings.

Extends

Instance Properties

Name Description Access
applied bool If true, the inner glow effect is applied. read-write
blendMode BlendMode The blending mode for the inner glow effect. read-write
effectColor Swatch The color applied to the inner glow, 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 applied to the inner glow. (Range: 0 to 100) read-write
opacity number The opacity of the inner glow (as a percentage). (Range: 0 to 100) read-write
parent The parent of the InnerGlowSetting (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 glow. read-write
source InnerGlowSource The light source of the inner glow effect. read-write
spread number The amount of spread (as a percentage of the inner glow size). (Range: 0 to 100) read-write
technique GlowTechnique The technique used for the inner glow. read-write

Methods

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