Class Annotations.Annotation
Represents an annotation.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
The base class for all annotations
|
| Field Attributes | Field Name and Description |
|---|---|
|
Gets or sets the height of the annotation
|
|
|
True if the annotation has been mirrored horizontally.
|
|
|
True if the annotation has been mirrored vertically.
|
|
|
Gets or sets whether or not the annotation can be moved
|
|
|
Gets or sets if this annotation can be resized by the user.
|
|
|
Gets or sets if this annotation scales with the page.
|
|
|
Gets or sets the page number of a document that the annotation appears on.
|
|
|
Represents the subject of the annotation.
|
|
|
If true, coordinates are relative to the page during the draw event.
|
|
|
Gets or sets the width of the annotation
|
|
|
Gets or sets the annotation's x-axis position.
|
|
|
Gets or sets the annotation's y-axis position.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Gets the height of the annotation.
|
|
|
Gets the annotation mirrored horizontally value.
|
|
|
Gets the annotation mirrored vertically value.
|
|
|
Gets the page number of the annotation.
|
|
|
Gets the popup text for the annotation.
|
|
|
GetWidth()
Gets the width of the annotation.
|
|
|
GetX()
Gets the x position measured in page coordinates of an annotation.
|
|
|
GetY()
Gets the y position measured in page coordinates.
|
|
|
SetHeight(value)
sets the height of the annotation.
|
|
|
SetMirroredHorizontally(value)
Sets the annotation mirrored horizontally value.
|
|
|
SetMirroredVertically(value)
Sets the annotation mirrored vertically value.
|
|
|
SetPageNumber(value)
sets the page number of the annotation.
|
|
|
SetPopupComment(the)
Set the popup text for the annotation.
|
|
|
SetWidth(value)
Sets the width of the annotation.
|
|
|
SetX(value)
Sets the x position measured in page coordinates of an annotation.
|
|
|
SetY()
Sets the y position measured in page coordinates.
|
| Event Attributes | Event Name and Description |
|---|---|
|
draw(ctx)
The event triggered when this annotation is to be drawn.
|
Field Detail
{number}
Height
Gets or sets the height of the annotation
{boolean}
MirroredHorizontally
True if the annotation has been mirrored horizontally.
{boolean}
MirroredVertically
True if the annotation has been mirrored vertically.
{boolean}
NoMove
Gets or sets whether or not the annotation can be moved
{boolean}
NoResize
Gets or sets if this annotation can be resized by the user.
{boolean}
NoZoom
Gets or sets if this annotation scales with the page.
{number}
PageNumber
Gets or sets the page number of a document that the annotation appears on.
{string}
Subject
Represents the subject of the annotation. Default is the annotation's type.
{boolean}
UsePageCoordinates
If true, coordinates are relative to the page during the draw event. This field is false by default, where the coordinates are relative to the annotation's (X,Y) position.
{number}
Width
Gets or sets the width of the annotation
{number}
X
Gets or sets the annotation's x-axis position.
{number}
Y
Gets or sets the annotation's y-axis position.
Method Detail
{number}
GetHeight()
Gets the height of the annotation.
- Returns:
- {number} the height of the annotation.
{boolean}
GetMirroredHorizontally()
Gets the annotation mirrored horizontally value.True if the annotation has been mirrored horizontally.
- Returns:
- {boolean} true if annotation is mirrored horizontally, false otherwise.
{boolean}
GetMirroredVertically()
Gets the annotation mirrored vertically value.True if the annotation has been mirrored vertically.
- Returns:
- {boolean} true if annotation is mirrored vertically, false otherwise.
{number}
GetPageNumber()
Gets the page number of the annotation.Note: page number starts from 1.
- Returns:
- {number}
{string}
GetPopupComment()
Gets the popup text for the annotation.This is the text that is displayed when you open the annotation's popup.
- Returns:
- {string} the popup text for the annotation.
{number}
GetWidth()
Gets the width of the annotation.
- Returns:
- {number} the width of the annotation.
{number}
GetX()
Gets the x position measured in page coordinates of an annotation.
- Returns:
- {number} the x position
{number}
GetY()
Gets the y position measured in page coordinates.
- Returns:
- {number}
SetHeight(value)
sets the height of the annotation.
- Parameters:
- {number} value
- the height of the annotation.
SetMirroredHorizontally(value)
Sets the annotation mirrored horizontally value.True if the annotation has been mirrored horizontally.
- Parameters:
- {boolean} value
- true if annotation is mirrored horizontally, false otherwise.
SetMirroredVertically(value)
Sets the annotation mirrored vertically value.True if the annotation has been mirrored vertically.
- Parameters:
- {boolean} value
- true if the annotation is mirrored vertically, false otherwise
SetPageNumber(value)
sets the page number of the annotation.Note: page numbers start from 1.
- Parameters:
- {number} value
- the page number to be set
SetPopupComment(the)
Set the popup text for the annotation.Note that this will not refresh the text in the UI.
- Parameters:
- {string} the
- popup comment to be set
SetWidth(value)
Sets the width of the annotation.
- Parameters:
- {number} value
- the width of the annotation.
SetX(value)
Sets the x position measured in page coordinates of an annotation.
- Parameters:
- {number} value
- the x position
SetY()
Sets the y position measured in page coordinates.
- Parameters:
- {number}
Event Detail
draw(ctx)
The event triggered when this annotation is to be drawn.When UsePageCoordinates is false, the canvas context is transformed into annotation coordinates.This means that the canvas's (0,0) point maps to (X,Y) on the page, where X,Y is the annotation's X and Y value.When UsePageCoordinates is true, the canvas context is relative to the page coordinates.This means that the canvas's (0,0) point maps to (0,0) on the page.
- Parameters:
- {object} ctx
- The canvas context prepared to be drawn on.