SatinSetting

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

BlendMode, Boolean, EventListeners, Events, Number, Object, String, Swatch,

Hierarchy:

Superclass: Preference

Class: SatinSetting

Subclasses: FindChangeSatinSetting

Property Listing

Property	Type	Access	Description
angle	Number (range -180 - 180)	read/write	The light angle of the satin effect. (Range: -360 to 360)
applied	Boolean	read/write	If true, applies the satin effect.
blendMode	BlendMode BlendMode.COLOR BlendMode.COLOR_BURN BlendMode.COLOR_DODGE BlendMode.DARKEN BlendMode.DIFFERENCE BlendMode.EXCLUSION BlendMode.HARD_LIGHT BlendMode.HUE BlendMode.LIGHTEN BlendMode.LUMINOSITY BlendMode.MULTIPLY BlendMode.NORMAL BlendMode.OVERLAY BlendMode.SATURATION BlendMode.SCREEN BlendMode.SOFT_LIGHT	read/write	The blending mode for the satin effect.
distance	Number String	read/write	The distance (in pixels) from the SatinSetting to the satin effect.
effectColor	Swatch	read/write	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.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
invertEffect	Boolean	read/write	If true, inverts the satin effect.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
opacity	Number (range 0 - 100)	read/write	The opacity of the satin effect (as a percentage). (Range: 0 to 100)
parent	FillTransparencySetting StrokeTransparencySetting ContentTransparencySetting TransparencySetting	readonly	The parent of the SatinSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).
properties	Object	read/write	A property that allows setting of several properties at the same time.
size	Number String	read/write	The width (in pixels) of the satin effect.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

SatinSetting getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)