Class

SatinSetting

 

Satin effect settings. Base Class: Preference

Superclass of FindChangeSatinSetting

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

ContentTransparencySetting | FillTransparencySetting | StrokeTransparencySetting | TransparencySetting
Preference
SatinSetting
FindChangeSatinSetting
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
anglenumber (range: -180 - 180) r/wThe light angle of the satin effect. (Range: -360 to 360)
appliedbool r/wIf true, applies the satin effect.
blendModeBlendMode:
BlendMode.NORMAL
BlendMode.MULTIPLY
BlendMode.SCREEN
BlendMode.OVERLAY
BlendMode.SOFT_LIGHT
BlendMode.HARD_LIGHT
BlendMode.COLOR_DODGE
BlendMode.COLOR_BURN
BlendMode.DARKEN
BlendMode.LIGHTEN
BlendMode.DIFFERENCE
BlendMode.EXCLUSION
BlendMode.HUE
BlendMode.SATURATION
BlendMode.COLOR
BlendMode.LUMINOSITY
r/wThe blending mode for the satin effect.
distanceMeasurement Unit (Number or String) (range: 0 - 1000) r/wThe distance (in pixels) from the SatinSetting to the satin effect.
effectColorSwatch r/wThe 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.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
invertEffectbool r/wIf true, inverts the satin effect.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
opacitynumber (range: 0 - 100) r/wThe opacity of the satin effect (as a percentage). (Range: 0 to 100)
parentContentTransparencySetting
FillTransparencySetting
StrokeTransparencySetting
TransparencySetting
readonlyThe parent of the SatinSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).
propertiesObject r/wA property that allows setting of several properties at the same time.
sizeMeasurement Unit (Number or String) (range: 0 - 144) r/wThe width (in pixels) of the satin effect.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of SatinSetting getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the SatinSetting.

string toSpecifier ()
Retrieves the object specifier.

Element of

ContentTransparencySetting.satinSettings

FillTransparencySetting.satinSettings

StrokeTransparencySetting.satinSettings

TransparencySetting.satinSettings

Return

Array of SatinSetting SatinSetting.getElements ()

Jongware, 28-Apr-2012 v3.0.3hContents :: Index