Polygon

A polygon. Any shape that is not a rectangle, ellipse, or graphic line. When you add a polygon, InDesign creates a regular polygon based on the current polygon preferences settings.

Go to Property Listing | Method Listing

Preferences:

TextWrapPreference

Hierarchy:

Superclass: PageItem

Class: Polygon

Property Listing

Property	Type	Access	Description
absoluteHorizontalScale	Number	read/write	The horizontal scale of the Polygon relative to its containing object.
absoluteRotationAngle	Number	read/write	The rotation angle of the Polygon relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	Number	read/write	The skewing angle of the Polygon relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	Number	read/write	The vertical scale of the Polygon relative to its containing object.
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Polygon.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Polygon.
associatedXMLElement	XMLElement	readonly	Returns the associated XML element
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 Polygon.
contentType	ContentType ContentType.GRAPHIC_TYPE ContentType.TEXT_TYPE ContentType.UNASSIGNED	read/write	The type of content that a frame can contain.
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
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 Polygon.
epss	EPSs EPS	readonly	A collection of EPS files.
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.
featherWidth	Number	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 Polygon. . Can also accept: String.
fillTint	Number (range 0 - 100)	read/write	The percent of tint to use in the Polygon'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.)
geometricBounds	Array of Number Array of String	read/write	The bounds of the Polygon excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
gradientFillAngle	Number	read/write	The angle of a linear gradient applied to the fill of the Polygon. (Range: -180 to 180)
gradientFillLength	Number	read/write	Length of ramp for a linear gradient or radius of a radial gradient on the fill
gradientFillStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the Polygon, in the format [x, y].
gradientStrokeAngle	Number	read/write	The angle of a linear gradient applied to the stroke of the Polygon. (Range: -180 to 180)
gradientStrokeLength	Number	read/write	Length of ramp for a linear gradient or radius of a radial gradient on the stroke
gradientStrokeStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the stroke of the Polygon, in the format [x, y].
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
graphics	Graphics Graphic	readonly	A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
groups	Groups Group	readonly	A collection of groups.
horizontalScale	Number	read/write	The horizontal scaling applied to the Polygon.
id	Number	readonly	The unique ID of the Polygon.
images	Images Image	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
index	Number	readonly	The index of the Polygon within its containing object.
isolateBlending	Boolean	read/write	If true, the Polygon blends in isolation.
itemLayer	Layer	read/write	The layer that the Polygon is on.
knockoutGroup	Boolean	read/write	If true, the Polygon 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.
localDisplaySetting	DisplaySettingOptions DisplaySettingOptions.DEFAULT_VALUE DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.TYPICAL	read/write	Display performance options for the Polygon.
locked	Boolean	read/write	If true, the Polygon is locked.
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)
movies	Movies	readonly	A collection of movies.
nonprinting	Boolean	read/write	If true, the Polygon does not print.
opacity	Number	read/write	The opacity of the object
ovals	Ovals Oval	readonly	A collection of ellipses.
overprintFill	Boolean	read/write	If true, the Polygon'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 Polygon's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden	Boolean	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem	PageItem	readonly	An object that was originally on a master page but was subsequently overridden.
pageItems	PageItems PageItem	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
parent	Button Cell Document GraphicLine Group InsertionPoint Layer Line MasterSpread Oval Page PageItem Paragraph Polygon Rectangle State Story Table Text TextColumn TextFrame TextStyleRange Word Character Spread	readonly	The parent of the Polygon (a Spread, MasterSpread, PageItem, Oval, Rectangle, Polygon, GraphicLine, Group, State, Document, Layer, Button, TextFrame, Story, Text, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table, InsertionPoint, Page or Character).
paths	Paths Path	readonly	A collection of paths.
pdfs	PDFs PDF	readonly	A collection of PDF files.
picts	PICTs PICT	readonly	A collection of PICT graphics.
polygons	Polygons Polygon	readonly	A collection of polygons.
properties	Object	read/write	A property that allows setting of several properties at the same time.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
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.
rotationAngle	Number	read/write	The rotatation angle of the Polygon. (Range: -360 to 360)
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	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.
shadowOpacity	Number	read/write	The opacity of the shadow
shadowXOffset	Number	read/write	The horizontal offset of the shadow.
shadowYOffset	Number	read/write	The vertical offset of the shadow.
shearAngle	Number	read/write	The skewing angle applied to the Polygon. (Range: -360 to 360)
sounds	Sounds Sound	readonly	A collection of sound clips.
strokeAlignment	StrokeAlignment StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT	read/write	The stroke alignment applied to the Polygon.
strokeColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Polygon. Can also accept: String.
strokeCornerAdjustment	StrokeCornerAdjustment StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.DASHES_AND_GAPS StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.NONE	read/write	The corner adjustment applied to the Polygon.
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	read/write	The weight (in points) to apply to the Polygon's stroke.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textPaths	TextPaths TextPath	readonly	A collection of text paths.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
verticalScale	Number	read/write	The vertical scaling applied to the Polygon.
visibleBounds	Array of Number Array of String	read/write	The bounds of the Polygon including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
wmfs	WMFs WMF	readonly	A collection of WMF graphics.

Method Listing

PageItem addPath (with:Array of PageItem)

Creates a new page item by combining the Polygon with other objects. Deletes the objects if they do not intersect.

Parameter	Type	Description
with	Array of PageItem	The object(s) to add.

undefined bringForward ()

Brings the Polygon forward one level in its layer.

undefined bringToFront ()

Brings the Polygon to the front.

Polygon duplicate ()

Duplicates the Polygon.

PageItem excludeOverlapPath (with:Array of PageItem)

Creates a new page item by excluding the overlapping areas of the Polygon and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to exclude.

undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset)

Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat ExportFormat.EPS_TYPE ExportFormat.INCOPY ExportFormat.JPG ExportFormat.PDF_TYPE ExportFormat.RTF ExportFormat.SVG ExportFormat.SVG_COMPRESSED ExportFormat.TAGGED_TEXT ExportFormat.TEXT_TYPE ExportFormat.XML String	The export format. Can accept: ExportFormat enumerator or String.
to	File	The path of the export file.
showingOptions	Boolean	If true, prompts the user to select export options. (Optional) (default: false)
using	PDFExportPreset	The export style to use. (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

undefined fit (given:FitOptions)

Applies the specified fit option to content in a frame.

Parameter	Type	Description
given	FitOptions FitOptions.CENTER_CONTENT FitOptions.CONTENT_TO_FRAME FitOptions.FRAME_TO_CONTENT FitOptions.PROPORTIONALLY	The fit option to use.

Parameter

Type

Description

given

FitOptions

FitOptions.CENTER_CONTENT

FitOptions.CONTENT_TO_FRAME

FitOptions.FRAME_TO_CONTENT

FitOptions.PROPORTIONALLY

The fit option to use.

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.

PageItem intersectPath (with:Array of PageItem)

Creates a new page item by intersecting the Polygon with other objects. Returns an error if the objects do not intersect.

Parameter	Type	Description
with	Array of PageItem	The object(s) with which to intersect.

PageItem makeCompoundPath (with:Array of PageItem)

Creates a compound path by combining the path(s) of the Polygon with the paths of other objects.

Parameter	Type	Description
with	Array of PageItem	The other objects whose paths to include in the new compound path.

undefined markup (using:XMLElement)

Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

PageItem minusBack (with:Array of PageItem)

Creates a new page item by reverse subtracting the overlapping areas of the Polygon and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to reverse subtract.

undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)

Move Page Item to a new location. One of the To or By parameters is required.

Parameter	Type	Description
to	Array of 2 Units Page Spread Layer	The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Number Array of String	Amount by which to move the object relative to its current position (Optional)

Parameter

Type

Description

Array of 2 Units

Page

Spread

Layer

The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

Array of Number

Array of String

Amount by which to move the object relative to its current position (Optional)

PageItem override (destinationPage:Page)

Overrides a master page item and places it on the page

Parameter	Type	Description
destinationPage	Page	The document page on which the master page item will be overridden.

Varies place (fileName:File, placePoint:Array of Number String, destinationLayer:Array of Varies Layer Layers. , [showingOptions:Boolean=Boolean], [autoflowing:Boolean=Boolean], [retainingFormatting:Boolean=Boolean], [convertingQuotes:Boolean=Boolean], withProperties:Object)

Places a file in the document.

Parameter	Type	Description
fileName	File	The file to place.
placePoint	Array of Number Array of String	The point where to place the object (only applicable if you are telling a page or spread to place) (Optional)
destinationLayer	Layer Array of Layers.	The layer(s) to place the file on (only valid if you are telling a page or spread to place). Can accept: Layer or Array of Layers. (Optional)
showingOptions	Boolean	Whether to display the import options dialog (Optional) (default: false)
autoflowing	Boolean	Whether to autoflow placed text (Optional) (default: false)
retainingFormatting	Boolean	Whether to keep formatting of placed text files (Optional) (default: true)
convertingQuotes	Boolean	Whether to convert to typographer's quotes (Optional) (default: true)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

undefined placeXML (using:XMLElement)

Places XML content into the specified object. Note: Replaces any existing content.

Parameter	Type	Description
using	XMLElement	The XML element whose content you want to place.

PageItem releaseCompoundPath ()

Releases a compound path.

undefined remove ()

Deletes the Polygon.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resetScaling ()

Resets the Polygon's scaling to 100%. Note: This does not change the size of the Polygon. Instead, it makes the current size of the Polygon the basis for future scaling.

undefined resize (horizontalScale:Number, verticalScale:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentScale:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsScale:Boolean=Boolean])

Resize the page item. You must specify either horizontal scale or vertical scale or both.

Parameter	Type	Description
horizontalScale	Number	The percentage of horizontal scale (Optional)
verticalScale	Number	The percentage of vertical scale (Optional)
around	Array of 2 Units AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	The point to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentScale	Boolean	If true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContent	Boolean	If true then both the object and items within it are scaled (Optional) (default: true)
consideringParentsScale	Boolean	If true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false)

undefined rotate (by:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentRotation:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsRotation:Boolean=Boolean])

Rotate the page item

Parameter	Type	Description
by	Number	Angle by which to rotate the page item
around	Array of 2 Units AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	The point to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentRotation	Boolean	If true then the object's current rotation and new rotation will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContent	Boolean	If true then both the object and items within it are rotated (Optional) (default: true)
consideringParentsRotation	Boolean	If true then the object is rotated relative to its parent page item. If false it is rotated relative to the spread. Cannot rotate with considering current rotation and considering parents rotation both set at the same time. (Optional) (default: false)

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Select this object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE	How to handle the existing selection (Optional) (default: SelectionOptions.REPLACE)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE

How to handle the existing selection (Optional)

(default: SelectionOptions.REPLACE)

undefined sendBackward ()

Sends the Polygon back one level in its layer.

undefined sendToBack ()

Sends the Polygon to the back.

undefined shear (by:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentShear:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsShear:Boolean=Boolean])

Shear the page item

Parameter	Type	Description
by	Number	Angle by which to shear the object
around	Array of 2 Units AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	The point to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentShear	Boolean	If true then the object's current shear and new shear will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContent	Boolean	If true then both the object and items within it are sheared (Optional) (default: true)
consideringParentsShear	Boolean	If true then the object is sheared relative to its parent page item. If false it is sheared relative to the spread. Cannot shear with considering current shear and considering parents shear both set at the same time. (Optional) (default: false)