ObjectStyle

An object style.

Go to Property Listing | Method Listing

Methods:

duplicate, extractLabel, getElements, insertLabel, move, remove, toSource, toSpecifier

Preferences:

BaselineFrameGridOption, Boolean, StoryPreference, TextFramePreference, TextWrapPreference

Property Listing

Property	Type	Access	Description
anchoredObjectSettings	AnchoredObjectSetting	read/write	Anchored object settings.
appliedParagraphStyle	ParagraphStyle String	read/write	The paragraph style applied to the text. Can also accept: String.
applyNextParagraphStyle	Boolean	read/write	If true, applies paragraph styles using Next Paragraph Style settings, beginning with the Next Paragraph Style defined in the paragraph style associated with the object style (if any).
basedOn	ObjectStyle String	read/write	The style that this style is based on. Can return: ObjectStyle or String.
baselineFrameGridOptions	BaselineFrameGridOption	read/write	Baseline frame grid option settings.
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 blend mode used to combine the background with the color of the ObjectStyle.
cornerEffect	CornerEffects CornerEffects.BEVEL_CORNER CornerEffects.FANCY_CORNER CornerEffects.INSET_CORNER CornerEffects.INVERSE_ROUNDED_CORNER CornerEffects.NONE CornerEffects.ROUNDED_CORNER	read/write	The shape to apply to corner points in a path. Note: corner effect differs from end join in that you can set a radius for a corner effect, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadius	Number	read/write	The radius of the corner
defaultFrameGridObjectStyle	ObjectStyle String	read/write	The Default Frame Grid Object Style. Can return: ObjectStyle or String.
defaultObjectStyle	ObjectStyle String	read/write	The Default Object Style. Can return: ObjectStyle or String.
defaultTextObjectStyle	ObjectStyle String	read/write	The Default Text Object Style. Can return: ObjectStyle or String.
enableAnchoredObjectOptions	Boolean	read/write	If true, the object style will apply an anchored object setting.
enableDropshadowAndFeather	Boolean	read/write	If true, drop shadow and feather settings can be defined for the object style.
enableFill	Boolean	read/write	If true, the object style will apply a fill.
enableParagraphStyle	Boolean	read/write	If true, the object style will apply a paragraph style.
enableStoryOptions	Boolean	read/write	If true, the object style will apply story options.
enableStroke	Boolean	read/write	If true, the object style will apply a stroke.
enableStrokeAndCornerEffects	Boolean	read/write	If true, the object style will apply stroke effects and corner effects.
enableTextFrameBaselineOptions	Boolean	read/write	If true, the object style will apply baseline text frame options.
enableTextFrameGeneralOptions	Boolean	read/write	If true, the object style will apply general text frame options.
enableTextWrapAndOthers	Boolean	read/write	If true, the object style will apply text wrap, contour, and non-printing settings.
enableTransparency	Boolean	read/write	If true, the object style will apply transparency settings.
endCap	EndCap EndCap.BUTT_END_CAP EndCap.PROJECTING_END_CAP EndCap.ROUND_END_CAP	read/write	The end shape of an open path.
endJoin	EndJoin EndJoin.BEVEL_END_JOIN EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN	read/write	The corner join applied to the ObjectStyle.
featherCornerType	FeatherCornerType FeatherCornerType.DIFFUSION FeatherCornerType.ROUNDED FeatherCornerType.SHARP	read/write	The type of feathering.
featherMode	FeatherMode FeatherMode.NONE FeatherMode.STANDARD	read/write	The feather-enabling mode.
featherNoise	Number (range 0 - 100)	read/write	The amount (as a percentage) of noise to apply to the feather. (Range: 0 to 100)
featherWidth	Number String	read/write	The width of the feathering.
fillColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. . Can also accept: String.
fillTint	Number (range 0 - 100)	read/write	The percent of tint to use in the ObjectStyle's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
gapColor	Swatch	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTint	Number (range 0 - 100)	read/write	The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
gradientFillAngle	Number	read/write	The angle of a linear gradient applied to the fill of the ObjectStyle. (Range: -180 to 180)
gradientStrokeAngle	Number	read/write	The angle of a linear gradient applied to the stroke of the ObjectStyle. (Range: -180 to 180)
id	Number	readonly	The unique ID of the ObjectStyle.
index	Number	readonly	The index of the ObjectStyle within its containing object.
isolateBlending	Boolean	read/write	If true, the ObjectStyle blends in isolation.
knockoutGroup	Boolean	read/write	If true, the ObjectStyle is a knockout group.
label	String	read/write	A property that can be set to any string.
leftLineEnd	ArrowHead ArrowHead.BARBED_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD	read/write	The arrowhead applied to the start of the path.
miterLimit	Number (range 1 - 500)	read/write	The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (Range: 1 to 500)
name	String	read/write	The name of the ObjectStyle.
nonprinting	Boolean	read/write	If true, the ObjectStyle does not print.
opacity	Number (range 0 - 100)	read/write	The opacity of the ObjectStyle. (Range: 0 to 100)
overprintFill	Boolean	read/write	If true, the ObjectStyle's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap	Boolean	read/write	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke	Boolean	read/write	If true, the ObjectStyle's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
parent	Application Document	readonly	The parent of the ObjectStyle (a Document or Application).
properties	Object	read/write	A property that allows setting of several properties at the same time.
rightLineEnd	ArrowHead ArrowHead.BARBED_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD	read/write	The arrowhead applied to the end of the path.
shadowBlendMode	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 blend mode to use for drawing the shadow.
shadowBlurRadius	Number String	read/write	The radius of the shadow blur.
shadowColor	Swatch	read/write	The swatch (color or mixed ink) applied to the shadow.
shadowMode	ShadowMode ShadowMode.DROP ShadowMode.NONE	read/write	The shadow mode.
shadowNoise	Number (range 0 - 100)	read/write	The amount (as a percentage) of noise to apply to the shadow. (Range: 0 to 100)
shadowOpacity	Number (range 0 - 100)	read/write	The opacity of the shadow. (Range: 0 to 100)
shadowSpread	Number (range 0 - 100)	read/write	The amount (as a percentage) of the blur radius to use as the shadow footprint. (Range: 0 to 100) For information, see shadow blur radius.
shadowXOffset	Number String	read/write	The horizontal offset of the shadow.
shadowYOffset	Number String	read/write	The vertical offset of the shadow.
storyPreferences	StoryPreference	read/write	Story preference settings.
strokeAlignment	StrokeAlignment StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT	read/write	The stroke alignment applied to the ObjectStyle.
strokeColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ObjectStyle. Can also accept: String.
strokeCornerAdjustment	StrokeCornerAdjustment StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.DASHES_AND_GAPS StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.NONE	read/write	The corner adjustment applied to the ObjectStyle.
strokeDashAndGap	Array of Number Array of String	read/write	The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
strokeTint	Number (range 0 - 100)	read/write	The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeType	StrokeStyle	read/write	The stroke type
strokeWeight	Number String	read/write	The weight (in points) to apply to the ObjectStyle's stroke.
textFramePreferences	TextFramePreference	read/write	Text frame preference settings.
textWrapPreferences	TextWrapPreference	read/write	The text wrap preference properties that define the default formatting for wrapping text around objects.

Method Listing

ObjectStyle duplicate ()

Duplicates the ObjectStyle.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Object getElements ()

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

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

ObjectStyle move (to:LocationOptions, reference:ObjectStyle)

Moves the ObjectStyle to the specified location.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object.
reference	ObjectStyle	The reference object. Note: Required when the to value specifies before or after. (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

ObjectStyle

The reference object. Note: Required when the to value specifies before or after. (Optional)

undefined remove ()

Deletes the ObjectStyle.

String toSource ()

Generates a string which, if executed, will return the ObjectStyle.

String toSpecifier ()

Retrieves the object specifier.

ObjectStyle

Methods:

Objects:

Preferences:

Property Listing

Method Listing