Class
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. Base Class: SplineItem addEventListener, addPath, applyObjectStyle, autoTag, bringForward, bringToFront, changeObject, checkIn, checkOut, clearFrameFittingOptions, clearObjectStyleOverrides, clearTransformations, convertShape, detach, duplicate, excludeOverlapPath, exportFile, extractLabel, findObject, fit, flipItem, getElements, insertLabel, intersectPath, makeCompoundPath, markup, minusBack, move, override, place, placeXML, redefineScaling, reframe, releaseCompoundPath, remove, removeEventListener, removeOverride, resize, resolve, revert, sendBackward, sendToBack, store, subtractPath, toSource, toSpecifier, transform, transformValuesOf
Polygon
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| absoluteFlip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | Indicates whether the Polygon has been flipped independently of its parent object and, if yes, the direction in which the Polygon was flipped. |
| absoluteHorizontalScale | number | r/w | The horizontal scale of the Polygon relative to its containing object. |
| absoluteRotationAngle | number | r/w | The rotation angle of the Polygon relative to its containing object. (Range: -360 to 360) |
| absoluteShearAngle | number | r/w | The skewing angle of the Polygon relative to its containing object. (Range: -360 to 360) |
| absoluteVerticalScale | number | r/w | The vertical scale of the Polygon relative to its containing object. |
| allArticles | Array of Article | readonly | The list of all articles this page item is part of |
| 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. |
| allowOverrides | bool | r/w | If true, the master page item can be overridden. |
| anchoredObjectSettings | AnchoredObjectSetting | readonly | Anchored object settings. |
| animationSettings | AnimationSetting | readonly | The page item animation settings. |
| appliedObjectStyle | ObjectStyle | r/w | The object style applied to the Polygon. |
| associatedXMLElement | XMLItem | readonly | The XML element associated with the Polygon. |
| bottomLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom left corner of rectangular shapes. |
| bottomLeftCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
| bottomRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom right corner of rectangular shapes. |
| bottomRightCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
| buttons | Buttons Button | readonly | A collection of buttons. |
| contentTransparencySettings | ContentTransparencySetting | readonly | Transparency settings for the content of the Polygon. |
| contentType | ContentType: ContentType.UNASSIGNED ContentType.GRAPHIC_TYPE ContentType.TEXT_TYPE |
r/w | The type of content that a frame can contain. |
| endCap | EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP |
r/w | The end shape of an open path. |
| endJoin | EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN |
r/w | The corner join applied to the Polygon. |
| epss | EPSs EPS | readonly | A collection of EPS files. |
| epstexts | EPSTexts EPSText | readonly | EPSTexts |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Polygon. . Can also accept: String. |
| fillTint | number | r/w | 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.) |
| fillTransparencySettings | FillTransparencySetting | readonly | Transparency settings for the fill applied to the Polygon. |
| flip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | The direction in which to flip the printed image. |
| formFields | FormFields FormField | readonly | A collection of form fields. |
| frameFittingOptions | FrameFittingOption | readonly | The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application. |
| gapColor | Swatch | r/w | 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 | r/w | 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 Measurement Unit (Number or String) | r/w | 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 | r/w | The angle of a linear gradient applied to the fill of the Polygon. (Range: -180 to 180) |
| gradientFillLength | Measurement Unit (Number or String) | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Polygon. |
| gradientFillStart | Array of Measurement Unit (Number or String) | r/w | The starting point (in page coordinates) of a gradient applied to the fill of the Polygon, in the format [x, y]. |
| gradientStrokeAngle | number | r/w | The angle of a linear gradient applied to the stroke of the Polygon. (Range: -180 to 180) |
| gradientStrokeLength | Measurement Unit (Number or String) | r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Polygon. |
| gradientStrokeStart | Array of Measurement Unit (Number or String) | r/w | 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 | r/w | 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). |
| importedPages | ImportedPages ImportedPage | readonly | Imported InDesign pages. |
| incopyExportOptions | InCopyExportOption | readonly | Export options for InCopy INCX document format. |
| index | number | readonly | The index of the Polygon within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| itemLayer | Layer | r/w | The layer that the Polygon is on. |
| label | string | r/w | A property that can be set to any string. |
| leftLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
r/w | The arrowhead applied to the start of the path. |
| lockState | LockStateValues: LockStateValues.NONE LockStateValues.UNMANAGED_STORY LockStateValues.CHECKED_IN_STORY LockStateValues.CHECKED_OUT_STORY LockStateValues.LOCKED_STORY LockStateValues.EMBEDDED_STORY LockStateValues.MISSING_LOCK_STATE LockStateValues.MIXED_LOCK_STATE |
readonly | The lock state. |
| locked | bool | r/w | If true, the Polygon is locked. |
| mediaItems | MediaItems MediaItem | readonly | The media items collection. |
| miterLimit | number (range: 1 - 500) | r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4) |
| movies | Movies Movie | readonly | A collection of movies. |
| multiStateObjects | MultiStateObjects MultiStateObject | readonly | A collection of multi-state objects. |
| name | string | r/w | The name of the Polygon. |
| nonprinting | bool | r/w | If true, the Polygon does not print. |
| objectExportOptions | ObjectExportOption | readonly | Export options for the object |
| ovals | Ovals Oval | readonly | A collection of ellipses. |
| overprintFill | bool | r/w | If true, the Polygon's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
| overprintGap | bool | r/w | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
| overprintStroke | bool | r/w | If true, the Polygon's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
| overridden | bool | 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 | Graphic Guide Movie PageItem Sound |
readonly | An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. |
| 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 | Character GraphicLine Group MasterSpread Oval PlaceGun Polygon Rectangle Snippet SplineItem Spread State |
readonly | The parent of the Polygon (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet). |
| parentPage | Page | readonly | The page on which this page item appears. |
| 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. |
| preferences | Preferences Preference | readonly | A collection of preferences objects. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rectangles | Rectangles Rectangle | readonly | A collection of rectangles. |
| rightLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
r/w | The arrowhead applied to the end of the path. |
| rotationAngle | number | r/w | The rotatation angle of the Polygon. (Range: -360 to 360) |
| shearAngle | number | r/w | The skewing angle applied to the Polygon. (Range: -360 to 360) |
| sounds | Sounds Sound | readonly | A collection of sound clips. |
| splineItems | SplineItems SplineItem | readonly | The spline items collection. |
| storyTitle | string | r/w | Title for this InCopy story. |
| strokeAlignment | StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
r/w | The stroke alignment applied to the Polygon. |
| strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Polygon. Can also accept: String. |
| strokeCornerAdjustment | StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS |
r/w | The corner adjustment applied to the Polygon. |
| strokeDashAndGap | Array of Measurement Unit (Number or String) | r/w | 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 | r/w | 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.) |
| strokeTransparencySettings | StrokeTransparencySetting | readonly | Transparency settings for the stroke. |
| strokeType | String StrokeStyle |
r/w | The name of the stroke style to apply. Can also accept: String. |
| strokeWeight | Measurement Unit (Number or String) | r/w | 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. |
| timingSettings | TimingSetting | readonly | The object timing settings. |
| topLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. |
| topLeftCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes |
| topRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the top right corner of rectangular shapes |
| topRightCornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
| transparencySettings | TransparencySetting | readonly | Transparency settings. |
| verticalScale | number | r/w | The vertical scaling applied to the Polygon. |
| visible | bool | r/w | If true, the Polygon is visible. |
| visibleBounds | Array of Measurement Unit (Number or String) | r/w | 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. |
Class
| Property | Type | Access | Description |
|---|---|---|---|
| AFTER_PLACE | string | readonly | Dispatched after a Polygon is placed. This event bubbles. This event is not cancelable. (default: afterPlace) |
| BEFORE_PLACE | string | readonly | Dispatched before a Polygon is placed. This event bubbles. This event is cancelable. (default: beforePlace) |
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) |
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. |
void applyObjectStyle (using:
ObjectStyle[, clearingOverrides:
bool=true][, clearingOverridesThroughRootObjectStyle:
bool=false])
Applies the specified object style.
| Parameter | Type | Description |
|---|---|---|
| using | ObjectStyle | The object style to apply. |
| clearingOverrides | bool | If true, clears the Polygon's existing attributes before applying the style. (Optional) (default: true) |
| clearingOverridesThroughRootObjectStyle | bool | If true, clears attributes and formatting applied to the Polygon that are not defined in the object style. (Optional) (default: false) |
void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.
void bringForward ()
Brings the Polygon forward one level in its layer.
void bringToFront ([reference:
PageItem])
Brings the Polygon to the front of its layer or in front of a particular item.
| Parameter | Type | Description |
|---|---|---|
| reference | PageItem | The reference object to bring the object in front of (must have same parent) (Optional) |
Array of PageItem changeObject ([reverseOrder:
bool])
Finds objects that match the find what value and replace the objects with the change to value.
| Parameter | Type | Description |
|---|---|---|
| reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
bool checkIn ([versionComments:
string][, forceSave:
bool=false])
Checks in the story or stories.
| Parameter | Type | Description |
|---|---|---|
| versionComments | string | The comment for this version. (Optional) |
| forceSave | bool | If true, forcibly saves a version. (Optional) (default: false) |
bool checkOut ()
Checks out the story.
void clearFrameFittingOptions ()
Removes the frame fittings options and resets it to the initial state.
void clearObjectStyleOverrides ()
Clear overrides for object style
void clearTransformations ()
Clears transformations from the Polygon. Transformations include rotation, scaling, flipping, fitting, and shearing.
void convertShape (given:
ConvertShapeOptions[, numberOfSides:
number][, insetPercentage:
number][, cornerRadius:
Measurement Unit (Number or String)])
Converts the Polygon to a different shape.
| Parameter | Type | Description |
|---|---|---|
| given | ConvertShapeOptions: ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_TRIANGLE ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_CLOSED_PATH | The Polygon's new shape. |
| numberOfSides | number (range: 3 - 100) | The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) |
| insetPercentage | number (range: 0 - 100) | The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) |
| cornerRadius | Measurement Unit (Number or String) (range: 0 - 800) | The corner radius of the resulting rectangle. (Optional) |
void detach ()
Detaches an overridden master page item from the master page.
PageItem duplicate ([to:
varies][, by:
Array of Measurement Unit (Number or String)])
Duplicates the Polygon at the specified location or offset.
| Parameter | Type | Description |
|---|---|---|
| to | Array of 2 Units Layer Page Spread | The location of the new Polygon, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) |
| by | Array of Measurement Unit (Number or String) | Amount by which to offset the new Polygon from the original Polygon's position. (Optional) |
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. |
void exportFile (format:
varies, to:
File[, using:
PDFExportPreset][, versionComments:
string][, forceSave:
bool=false])
Exports the object(s) to a file.
| Parameter | Type | Description |
|---|---|---|
| format | ExportFormat String | The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. |
| to | File | The path to the export file. |
| using | PDFExportPreset | The export style. (Optional) |
| versionComments | string | The comment for this version. (Optional) |
| forceSave | bool | If true, forcibly saves a version. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of PageItem findObject ([reverseOrder:
bool])
Finds objects that match the find what value.
| Parameter | Type | Description |
|---|---|---|
| reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.
| Parameter | Type | Description |
|---|---|---|
| given | FitOptions: FitOptions.CONTENT_TO_FRAME FitOptions.CENTER_CONTENT FitOptions.PROPORTIONALLY FitOptions.FRAME_TO_CONTENT FitOptions.FILL_PROPORTIONALLY FitOptions.APPLY_FRAME_FITTING_OPTIONS | The fit option to use. |
void flipItem (given:
Flip[, around:
varies])
Flips the Polygon.
| Parameter | Type | Description |
|---|---|---|
| given | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH | The axis around which to flip the Polygon. |
| around | AnchorPoint Array of 2 Units | The point around which to flip the Polygon. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) |
Array of Polygon getElements ()
Resolves the object specifier, creating an array of object references.
void 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. |
void 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. |
void move ([to:
varies][, by:
Array of Measurement Unit (Number or String)])
Moves the Polygon to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.
| Parameter | Type | Description |
|---|---|---|
| to | Array of 2 Units Layer Page Spread | The new location of the Polygon,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) |
| by | Array of Measurement Unit (Number or String) | The amount (in measurement units) to move the Polygon relative to its current position, in the format (x, y). (Optional) |
any override (destinationPage:
Page)
Overrides a master page item and places the item on the document page as a new object.
| Parameter | Type | Description |
|---|---|---|
| destinationPage | Page | The document page that contains the master page item to override. |
Array of any place (fileName:
File[, withProperties:
Object])
Places a file
| Parameter | Type | Description |
|---|---|---|
| fileName | File | The file to place |
| withProperties | Object | Initial values for properties of the placed object(s) (Optional) |
void 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. |
void redefineScaling ([to:
Array of number])
Apply an item's scaling to its content if possible.
| Parameter | Type | Description |
|---|---|---|
| to | Array of number | The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) |
void reframe (in:
varies, opposingCorners:
Array of varies)
Move the bounding box of the page item
| Parameter | Type | Description |
|---|---|---|
| in | boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces | The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
| opposingCorners | Array of any | Opposing corners of new bounding box in the given coordinate space |
Array of PageItem releaseCompoundPath ()
Releases a compound path.
void remove ()
Deletes the Polygon.
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) |
void removeOverride ()
Removes the override from a previously overridden master page item.
void resize (in:
varies, from:
varies, by:
ResizeMethods, values:
Array of varies[, resizeIndividually:
bool=true][, consideringRulerUnits:
bool=false])
Resize the page item.
| Parameter | Type | Description |
|---|---|---|
| in | BoundingBoxLimits boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces | The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
| from | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
| by | ResizeMethods: ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH ResizeMethods.RESHAPING_AREA_TO_RATIO ResizeMethods.RESHAPING_BORDER_TO_RATIO | How the current dimensions are affected by the given values |
| values | Array of : Array of Reals CoordinateSpaces ResizeConstraints | The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. |
| resizeIndividually | bool | If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) (default: true) |
| consideringRulerUnits | bool | If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
any resolve (location:
varies, in:
CoordinateSpaces[, consideringRulerUnits:
bool=false])
Get the coordinates of the given location in the specified coordinate system.
| Parameter | Type | Description |
|---|---|---|
| location | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use. |
| consideringRulerUnits | bool | If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
bool revert ()
Reverts the document to its state at the last save operation.
void sendBackward ()
Sends the Polygon back one level in its layer.
void sendToBack ([reference:
PageItem])
Sends the Polygon to the back of its layer or behind a particular item (must have same parent).
| Parameter | Type | Description |
|---|---|---|
| reference | PageItem | The reference object to send the object behind (Optional) |
Asset store (using:
Library[, withProperties:
Object])
Stores the object in the specified library.
| Parameter | Type | Description |
|---|---|---|
| using | Library | The library in which to store the object. |
| withProperties | Object | Initial values for properties of the new Polygon (Optional) |
PageItem subtractPath (with:
Array of PageItem)
Creates a new page item by subtracting the overlapping areas of the Polygon and other objects.
| Parameter | Type | Description |
|---|---|---|
| with | Array of PageItem | The object(s) to subtract. |
string toSource ()
Generates a string which, if executed, will return the Polygon.
string toSpecifier ()
Retrieves the object specifier.
void transform (in:
CoordinateSpaces, from:
varies, withMatrix:
varies[, replacingCurrent:
varies][, consideringRulerUnits:
bool=false])
Transform the page item.
| Parameter | Type | Description |
|---|---|---|
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
| from | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
| withMatrix | Array of 6 Reals TransformationMatrix | Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. |
| replacingCurrent | Array of MatrixContent Long Integer MatrixContent | Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) |
| consideringRulerUnits | bool | If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
Array of TransformationMatrix transformValuesOf (in:
CoordinateSpaces)
Get the transformation values of the page item.
| Parameter | Type | Description |
|---|---|---|
| in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
Element of
AssignedStory.storyReference
InCopyExportOption.parent
Used in:
Polygon Polygons.nextItem (obj: Polygon)
Polygon Polygons.previousItem (obj: Polygon)
Return
Array of Polygon Polygon.getElements ()
Polygon Polygons.[] (index: number)
Polygon Polygons.add ([layer: Layer][, numberOfSides: number][, insetPercentage: number][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Polygon Polygons.anyItem ()
Array of Polygon Polygons.everyItem ()
Polygon Polygons.firstItem ()
Polygon Polygons.item (index: varies)
Polygon Polygons.itemByID (id: number)
Polygon Polygons.itemByName (name: string)
Array of Polygon Polygons.itemByRange (from: varies, to: varies)
Polygon Polygons.lastItem ()
Polygon Polygons.middleItem ()
Polygon Polygons.nextItem (obj: Polygon)
Polygon Polygons.previousItem (obj: Polygon)
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |