# Class: PolygonAnnotation

## Annotations. PolygonAnnotation

#### new PolygonAnnotation()

  Represents a Polygon annotation.

### Extends

- Annotations.IPathAnnotation

### Methods

#### addPathPoint(x, y)

  Adds a point to the path

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `x` | number | The x coordinate of the point
  `y` | number | The y coordinate of the point

  Inherited From:
    - Annotations.IPathAnnotation#addPathPoint

#### adjustRect()

  Recalculate the width and height of the annotation

  Inherited From:
    - Annotations.IPathAnnotation#adjustRect

#### deserialize(element, pageMatrix)

  Deserializes the xml element into the annotation

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `element` | Element | an xml element representing the annotation
  `pageMatrix` | object | the page matrix used to convert PDF coordinates to XOD coordinates.

  Inherited From:
    - Annotations.Annotation#deserialize

#### draw(ctx, pageMatrix)

  Draws the annotation on the provide canvas context, relative to the page. The point (0,0) coresponds to the top left corner of the page.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `ctx` | CanvasRenderingContext2D | The canvas context prepared to be drawn on.
  `pageMatrix` | object | The page matrix for the page that the annotation is on. You can get this object by calling getPageMatrix on the document object.

  Inherited From:
    - Annotations.Annotation#draw

#### getBottom()

  Gets the bottommost y position measured in page coordinates.

  Inherited From:
    - Annotations.Annotation#getBottom
  Deprecated:
    - Since 1.7

  ##### Returns:

  Type
    number

#### getContents()

  Gets the text content for the annotation. Contents may be displayed in an annotation's popup or directly on the page (in the case of FreeTextAnnotation).

  Inherited From:
    - Annotations.Annotation#getContents

  ##### Returns:

  the text content for the annotation.

  Type
    string

#### getCustom()

  Gets the custom value set by setCustom

  Inherited From:
    - Annotations.Annotation#getCustom

  ##### Returns:

  The custom value

  Type
    *

#### getGroupedChildren()

  Gets the list of group children to this annotation.

  Inherited From:
    - Annotations.Annotation#getGroupedChildren

  ##### Returns:

  The list of group children

  Type
    Array

#### getHeight()

  Gets the height of the annotation.

  Inherited From:
    - Annotations.Annotation#getHeight

  ##### Returns:

  the height of the annotation.

  Type
    number

#### getLeft()

  Gets the leftmost x position measured in page coordinates.

  Inherited From:
    - Annotations.Annotation#getLeft
  Deprecated:
    - Since 1.7

  ##### Returns:

  Type
    number

#### getPageNumber()

  Gets the page number of the annotation. Note: page number starts from 1.

  Inherited From:
    - Annotations.Annotation#getPageNumber

  ##### Returns:

  The annotation's page number

  Type
    number

#### getPath()

  Gets the path array

  Inherited From:
    - Annotations.IPathAnnotation#getPath

  ##### Returns:

  The array of path points

  Type
    array

#### getPathPoint(index)

  Gets the point in the path at the specified index

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `index` | number | The index in the path array

  Inherited From:
    - Annotations.IPathAnnotation#getPathPoint

  ##### Returns:

  The path point as an object with x and y properties

  Type
    object

#### getRect()

  Get annotation bounding rectangle

  Inherited From:
    - Annotations.Annotation#getRect

  ##### Returns:

  Type
    Annotations.Rect

#### getRectPadding()

  Gets the padding that will be applied by default on the annotation's rectangle.

  Inherited From:
    - Annotations.Annotation#getRectPadding

  ##### Returns:

  The amount of padding

  Type
    number

#### getReplies()

  Gets the list of replies to this annotation.

  Inherited From:
    - Annotations.Annotation#getReplies

  ##### Returns:

  The list of replies

  Type
    Array

#### getRight()

  Gets the rightmost x position measured in page coordinates.

  Inherited From:
    - Annotations.Annotation#getRight
  Deprecated:
    - Since 1.7

  ##### Returns:

  Type
    number

#### getTop()

  Gets the topmost y position measured in page coordinates.

  Inherited From:
    - Annotations.Annotation#getTop
  Deprecated:
    - Since 1.7

  ##### Returns:

  Type
    number

#### getWidth()

  Gets the width of the annotation.

  Inherited From:
    - Annotations.Annotation#getWidth

  ##### Returns:

  the width of the annotation.

  Type
    number

#### getX()

  Gets the x position measured in page coordinates of an annotation.

  Inherited From:
    - Annotations.Annotation#getX

  ##### Returns:

  the x position

  Type
    number

#### getY()

  Gets the y position measured in page coordinates.

  Inherited From:
    - Annotations.Annotation#getY

  ##### Returns:

  Type
    number

#### isGrouped()

  Gets whether the annotation is a child of a group

  Inherited From:
    - Annotations.Annotation#isGrouped

  ##### Returns:

  Returns true if the annotation is a child of a group, false otherwise.

  Type
    boolean

#### isReply()

  Gets whether the annotation is a reply to another annotation.

  Inherited From:
    - Annotations.Annotation#isReply

  ##### Returns:

  Returns true if it does reply to another annotation, false otherwise.

  Type
    boolean

#### isVisible()

  Whether the annotation is visible on the document or not. If the Hidden or NoView flags are set, or if the annotation is a reply to another annotation then it won't be visible.

  Inherited From:
    - Annotations.Annotation#isVisible

  ##### Returns:

  Whether the annotation is visible on the document or not

  Type
    boolean

#### popPath()

  Removes the last point from the path

  Inherited From:
    - Annotations.IPathAnnotation#popPath

#### render(container, am, zoom)

  Render the element's other features, if any. This can be used, for example, for HTML rendering

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `container` |  |
  `am` |  |
  `zoom` |  |

  Inherited From:
    - Annotations.Annotation#render

#### resize(rect)

  Resize the annotation based on a new given Annotations.Rect. Use this method instead of setRect when internal properties (other than x, y, width and height) need to be modified on move/resize.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `rect` | Annotations.Rect | the new bounding rectangle

  Inherited From:
    - Annotations.Annotation#resize

#### resourcesLoaded()

  Resolves when all required resources have finished loading. Currently only applicable to stamp annotations that use images.

  Inherited From:
    - Annotations.Annotation#resourcesLoaded

  ##### Returns:

  A promise that resolves when the resources have finished loading

  Type
    Promise

#### serialize(element, pageMatrix)

  Serialize the annotation to an xml element

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `element` | Element | an xml element representing the annotation
  `pageMatrix` | object | the page matrix used to convert XOD coordinates to PDF coordinates.

  Inherited From:
    - Annotations.Annotation#serialize

  ##### Returns:

  the resulting xml element representing the annotation

  Type
    Element

#### setContents(value)

  Set the text content for the annotation. Note that this will not refresh the text in the UI.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | string | the text content to be set

  Inherited From:
    - Annotations.Annotation#setContents

#### setCustom(value)

  Sets a custom value on the annotation.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | * | Any custom value

  Inherited From:
    - Annotations.Annotation#setCustom

#### setHeight(value)

  Sets the height of the annotation.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | number | the height of the annotation.

  Inherited From:
    - Annotations.Annotation#setHeight

#### setPageNumber(value)

  Sets the page number of the annotation. Note: page numbers start from 1.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | number | the page number to be set

  Inherited From:
    - Annotations.Annotation#setPageNumber

#### setPathPoint(index, x, y)

  Sets the path point at a specific index

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `index` | number | The index in the path array to set
  `x` | number | The x coordinate of the point
  `y` | number | The y coordinate of the point

  Inherited From:
    - Annotations.IPathAnnotation#setPathPoint

#### setRect(rect)

  Sets the size and location of the annotation's bounding rectangle. Use this method instead of resize when only the x, y, width and height needs to be modified. Use setRectWithNormalization instead of setRect if you want to reverse any wrong-way-round coordinates instead of ignoring them.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `rect` | Annotations.Rect | the new bounding rectangle

  Inherited From:
    - Annotations.Annotation#setRect

#### setStyles(ctx, pageMatrix)

  Sets the annotation's styles for stroke, fill and opacity on the canvas context

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `ctx` | CanvasRenderingContext2D | A canvas context
  `pageMatrix` | object | The transformation matrix for the page that the annotation is on

  Inherited From:
    - Annotations.MarkupAnnotation#setStyles

#### setWidth(value)

  Sets the width of the annotation.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | number | the width of the annotation.

  Inherited From:
    - Annotations.Annotation#setWidth

#### setX(value)

  Sets the x position measured in page coordinates of an annotation.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `value` | number | the x position

  Inherited From:
    - Annotations.Annotation#setX

#### setY()

  Sets the y position measured in page coordinates.

  ##### Parameters:

  Type | Description
  --- | ---
  number |

  Inherited From:
    - Annotations.Annotation#setY

#### unrender()

  Destroys any non-canvas elements

  Inherited From:
    - Annotations.Annotation#unrender

#### Search results