Adobe InDesign CS6 Server (8.0) Object Model JS: BevelAndEmbossSetting

InDesign Server CS6

Class

BevelAndEmbossSetting

 

Bevel and emboss effect settings. Base Class: Preference

Superclass of FindChangeBevelAndEmbossSetting

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

ContentTransparencySetting | FillTransparencySetting | StrokeTransparencySetting | TransparencySetting
Preference
BevelAndEmbossSetting
FindChangeBevelAndEmbossSetting
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
altitudenumber (range: 0 - 100) r/wThe altitude of the light source. (Range: 0 to 90)
anglenumber (range: -180 - 180) r/wThe angle of the light source. (Range: -180 to 180)
appliedbool r/wIf true, the bevel or emboss effect is applied.
depthnumber (range: 0 - 1000) r/wThe depth of the bevel or emboss (as a percentage). (Range: 0 to 1000)
directionBevelAndEmbossDirection:
BevelAndEmbossDirection.UP
BevelAndEmbossDirection.DOWN
r/wThe direction of the bevel or emboss.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
highlightBlendModeBlendMode:
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 highlight portion of the effect.
highlightColorSwatch r/wThe color applied to the highlight portion of the 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.
highlightOpacitynumber (range: 0 - 100) r/wThe opacity of the highlight portion of the effect (as a percentage). (Range: 0 to 100)
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentContentTransparencySetting
FillTransparencySetting
StrokeTransparencySetting
TransparencySetting
readonlyThe parent of the BevelAndEmbossSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).
propertiesObject r/wA property that allows setting of several properties at the same time.
shadowBlendModeBlendMode:
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 shadow portion of the effect.
shadowColorSwatch r/wThe color applied to the shadow portion of the 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.
shadowOpacitynumber (range: 0 - 100) r/wThe opacity of the shadow portion of the effect (as a percentage). (Range: 0 to 100)
sizeMeasurement Unit (Number or String) (range: 0 - 144) r/wThe size of the bevel or emboss.
softenMeasurement Unit (Number or String) (range: 0 - 144) r/wThe amount (in pixels) of softening.
styleBevelAndEmbossStyle:
BevelAndEmbossStyle.OUTER_BEVEL
BevelAndEmbossStyle.INNER_BEVEL
BevelAndEmbossStyle.EMBOSS
BevelAndEmbossStyle.PILLOW_EMBOSS
r/wThe style of bevel or emboss.
techniqueBevelAndEmbossTechnique:
BevelAndEmbossTechnique.SMOOTH_CONTOUR
BevelAndEmbossTechnique.CHISEL_HARD
BevelAndEmbossTechnique.CHISEL_SOFT
r/wThe edging technique of the bevel or emboss.
useGlobalLightbool r/wIf true, the global light source is used.

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 BevelAndEmbossSetting 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 BevelAndEmbossSetting.

string toSpecifier ()
Retrieves the object specifier.

Element of

ContentTransparencySetting.bevelAndEmbossSettings

FillTransparencySetting.bevelAndEmbossSettings

StrokeTransparencySetting.bevelAndEmbossSettings

TransparencySetting.bevelAndEmbossSettings

Return

Array of BevelAndEmbossSetting BevelAndEmbossSetting.getElements ()

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