SatinSetting
Satin effect settings. Base Class: Preference
Superclass of FindChangeSatinSetting
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| angle | number (range: -180 - 180) | r/w | The light angle of the satin effect. (Range: -360 to 360) |
| applied | bool | r/w | If true, applies the satin effect. |
| blendMode | BlendMode: 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/w | The blending mode for the satin effect. |
| distance | Measurement Unit (Number or String) (range: 0 - 1000) | r/w | The distance (in pixels) from the SatinSetting to the satin effect. |
| effectColor | Swatch | r/w | 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 | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| invertEffect | bool | r/w | If true, inverts the satin effect. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| opacity | number (range: 0 - 100) | r/w | The opacity of the satin effect (as a percentage). (Range: 0 to 100) |
| parent | ContentTransparencySetting FillTransparencySetting StrokeTransparencySetting TransparencySetting |
readonly | The parent of the SatinSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| size | Measurement Unit (Number or String) (range: 0 - 144) | r/w | The width (in pixels) of the satin effect. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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, 20-Jun-2010 v3.0.3d | Contents :: Index |