new FreeHandAnnotation()
Represents a FreeHand annotation.
Properties:
Name | Type | Description |
---|---|---|
LeftMost |
number | The leftmost point of the annotation. |
RightMost |
number | The rightmost point of the annotation. |
TopMost |
number | The topmost point of the annotation. |
BottomMost |
number | The bottommost point of the annotation. |
shouldSimplifyPath |
boolean | Whether to simplify the path points or not. (defaults to true) |
Extends
Methods
-
addPathPoint(x, y, pathIndex)
-
Adds a point to the specified path. This method will create a new path if the specified path index is equal to the total number of existings paths, and set the x and y value as its first point.
Parameters:
Name Type Description x
number The x coordinate of the point
y
number The y coordinate of the point
pathIndex
number The index of the path, defaults to 0
- Overrides:
-
adjustRect()
-
Recalculate the width and height of the annotation
- Inherited From:
-
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:
-
draw(ctx)
-
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.
- Inherited From:
-
getBottom()
-
Gets the bottommost y position measured in page coordinates.
- Inherited From:
- 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:
Returns:
the text content for the annotation.
- Type
- string
-
getCustom()
-
Gets the custom value set by setCustom
- Inherited From:
Returns:
The custom value
- Type
- *
-
getFlag(flag)
-
Determine if the give flag is marked flagged
Parameters:
Name Type Description flag
number - Inherited From:
Returns:
- Type
- boolean
-
getHeight()
-
Gets the height of the annotation.
- Inherited From:
Returns:
the height of the annotation.
- Type
- number
-
getLeft()
-
Gets the leftmost x position measured in page coordinates.
- Inherited From:
- Deprecated:
-
- Since 1.7
Returns:
- Type
- number
-
getPageNumber()
-
Gets the page number of the annotation. Note: page number starts from 1.
- Inherited From:
Returns:
The annotation's page number
- Type
- number
-
getPath(pathIndex)
-
Gets the specified path in the path array.
Parameters:
Name Type Description pathIndex
number The index of the path, defaults to 0
- Overrides:
Returns:
The array of path points
- Type
- array
-
getPathPoint(index, pathIndex)
-
Gets the specified point in the path at the specified index.
Parameters:
Name Type Description index
number The index of the point in the specified path
pathIndex
number The index of the path, defaults to 0
- Overrides:
Returns:
The path point as an object with x and y properties
- Type
- Annotations.Point
-
getRect()
-
Get annotation bounding rectangle
- Inherited From:
Returns:
- Type
- Annotations.Rect
-
getRectPadding()
-
Gets the padding that will be applied by default on the annotation's rectangle.
- Inherited From:
Returns:
The amount of padding
- Type
- number
-
getReplies()
-
Gets the list of replies to this annotation.
- Inherited From:
Returns:
The list of replies
- Type
- Array
-
getRight()
-
Gets the rightmost x position measured in page coordinates.
- Inherited From:
- Deprecated:
-
- Since 1.7
Returns:
- Type
- number
-
getTop()
-
Gets the topmost y position measured in page coordinates.
- Inherited From:
- Deprecated:
-
- Since 1.7
Returns:
- Type
- number
-
getWidth()
-
Gets the width of the annotation.
- Inherited From:
Returns:
the width of the annotation.
- Type
- number
-
getX()
-
Gets the x position measured in page coordinates of an annotation.
- Inherited From:
Returns:
the x position
- Type
- number
-
getY()
-
Gets the y position measured in page coordinates.
- Inherited From:
Returns:
- Type
- number
-
isReply()
-
Gets whether the annotation is a reply to another annotation.
- Inherited From:
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:
Returns:
Whether the annotation is visible on the document or not
- Type
- boolean
-
popPath(pathIndex)
-
Removes the last point from the specified path.
Parameters:
Name Type Description pathIndex
number The index of the path, defaults to 0
- Overrides:
Returns:
The point that was removed from the path.
- Type
- Annotations.Point
-
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:
-
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:
-
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:
Returns:
the resulting xml element representing the annotation
- Type
- Element
-
setContents(the)
-
Set the text content for the annotation. Note that this will not refresh the text in the UI.
Parameters:
Name Type Description the
string text content to be set
- Inherited From:
-
setCustom(value)
-
Sets a custom value on the annotation.
Parameters:
Name Type Description value
* Any custom value
- Inherited From:
-
setFlag(flag, value)
-
Set the value of given Flag.
Parameters:
Name Type Description flag
number value
boolean - Inherited From:
-
setHeight(value)
-
Sets the height of the annotation.
Parameters:
Name Type Description value
number the height of the annotation.
- Inherited From:
-
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:
-
setPath(path, pathIndex)
-
Sets a path in the path array.
Parameters:
Name Type Description path
array An array of Annotation.Point objects.
pathIndex
number The index of the path, defaults to 0
-
setPathPoint(index, x, y, pathIndex)
-
Sets a point at the specified path. This method will create a new path if the specified path index is equal to the total number of existings paths, and set the x and y value as its first point.
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
pathIndex
number The index of the path, defaults to 0
- Overrides:
-
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:
-
setWidth(value)
-
Sets the width of the annotation.
Parameters:
Name Type Description value
number the width of the annotation.
- Inherited From:
-
setX(value)
-
Sets the x position measured in page coordinates of an annotation.
Parameters:
Name Type Description value
number the x position
- Inherited From:
-
setY()
-
Sets the y position measured in page coordinates.
Parameters:
Type Description number - Inherited From:
-
unrender()
-
Destroys any non-canvas elements
- Inherited From: