K4 InDesign Javascript API Documentation

PreferencesSatinSetting

Satin effect settings.

Extends

Instance Properties

Name Description Access
angle number The light angle of the satin effect. (Range: -360 to 360) read-write
applied bool If true, applies the satin effect. read-write
blendMode BlendMode The blending mode for the satin effect. read-write
distance Measurement Unit (Number or String)=any The distance (in pixels) from the SatinSetting to the satin effect. read-write
effectColor Swatch The color applied to the satin effect, specified as a swatch (color, gradient, tint, or mixed ink), a color library color, a hex value, 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; for HSB, specify three colors in the format [H,S,B], with H in the range 0 to 360 and S and B as percentages in the range 0 to 100. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
invertEffect bool If true, inverts the satin effect. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
opacity number The opacity of the satin effect (as a percentage). (Range: 0 to 100) read-write
parent The parent of the SatinSetting (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 width (in pixels) of the satin effect. read-write

Methods

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