Class: NoteAnnotation
Experimental
A sticky note annotation
Extends
Constructors
Constructor
new NoteAnnotation(
options):NoteAnnotation
Experimental
Creates a new NoteAnnotation instance.
Parameters
options
Options used to initialize annotation.
Returns
NoteAnnotation
Overrides
Properties
icon
icon:
NoteAnnotationIcon
Experimental
Icon to be displayed
Accessors
author
Get Signature
get author():
string
Experimental
The author.
Returns
string
Set Signature
set author(
author):void
Experimental
Parameters
author
string
Returns
void
Inherited from
blendMode
Get Signature
get blendMode():
BlendMode
Experimental
blend mode
Returns
Set Signature
set blendMode(
blendMode):void
Experimental
Parameters
blendMode
Returns
void
Inherited from
boundingBox
Get Signature
get boundingBox():
Rectangle<PdfPoint>
Experimental
Represents the bounding box of the annotation, which defines its position and
size on the page. The bounding box is specified as a Rectangle of PdfPoint
coordinates.
Returns
Rectangle<PdfPoint>
Set Signature
set boundingBox(
rectangle):void
Experimental
Parameters
rectangle
Rectangle<PdfPoint>
Returns
void
Inherited from
content
Get Signature
get content():
string
Experimental
Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternative description of the annotation’s contents in human-readable form.
Returns
string
Set Signature
set content(
content):void
Experimental
Parameters
content
string
Returns
void
Inherited from
creationDate
Get Signature
get creationDate():
Date
Experimental
The date and time when the annotation was created.
This property retrieves the creation date from the annotation and converts it to a JavaScript Date object.
Returns
Date
The creation date as a JavaScript Date object, or null if no creation date is
available in the annotation.
Inherited from
dateModified
Get Signature
get dateModified():
Date
Experimental
The date and time when the annotation was most recently modified.
Returns
Date
Set Signature
set dateModified(
date):void
Experimental
Parameters
date
Date
Returns
void
Inherited from
fillColor
Get Signature
get fillColor():
NoteAnnotationColor
Experimental
Represents the fill color of the annotation in hexadecimal representation.
Returns
NoteAnnotationColor
Set Signature
set fillColor(
fillColor):void
Experimental
Parameters
fillColor
NoteAnnotationColor
Returns
void
hasChanges
Get Signature
get hasChanges():
boolean
Experimental
Indicates if the annotation has been changed since the document was opened
Returns
boolean
Inherited from
hidden
Get Signature
get hidden():
boolean
Experimental
If set to true, the annotation will not be displayed or printed, and it will not allow interaction with the user.
Returns
boolean
Set Signature
set hidden(
hidden):void
Experimental
Parameters
hidden
boolean
Returns
void
Inherited from
id
Get Signature
get id():
void
Experimental
A unique identifier for the annotation.
Returns
void
Inherited from
interactive
Get Signature
get interactive():
boolean
Experimental
Specifies whether the annotation allows user interaction.
Returns
boolean
Set Signature
set interactive(
interactive):void
Experimental
Parameters
interactive
boolean
Returns
void
Inherited from
isAdded
Get Signature
get isAdded():
boolean
Experimental
Indicates whether the annotation was added to a page
Returns
boolean
Inherited from
isMaintainingAspectRatio
Get Signature
get isMaintainingAspectRatio():
boolean
Experimental
Indicates if the annotation is maintaining its aspect ratio
Returns
boolean
Overrides
MarkupAnnotation.isMaintainingAspectRatio
isMarkupAnnotation
Get Signature
get isMarkupAnnotation():
boolean
Experimental
Indicates if the annotation is a markup annotation
Returns
boolean
Overrides
MarkupAnnotation.isMarkupAnnotation
isModified
Get Signature
get isModified():
boolean
Experimental
Indicates if the annotation has changes that have not yet been saved to the document
Returns
boolean
Inherited from
isMoveable
Get Signature
get isMoveable():
boolean
Experimental
Indicates if the annotation can be moved by the user
Returns
boolean
Overrides
isResizable
Get Signature
get isResizable():
boolean
Experimental
Indicates if the annotation can be resized by the user
Returns
boolean
Overrides
isRotatable
Get Signature
get isRotatable():
boolean
Experimental
Indicates if the annotation can be rotated by the user
Returns
boolean
Overrides
isSelectable
Get Signature
get isSelectable():
boolean
Experimental
Indicates if the annotation can be selected by the user
Returns
boolean
Overrides
isWidgetAnnotation
Get Signature
get isWidgetAnnotation():
boolean
Experimental
Indicates if the annotation is a widget annotation
Returns
boolean
Inherited from
MarkupAnnotation.isWidgetAnnotation
locked
Get Signature
get locked():
AnnotationLockedState
Experimental
Represents the locked state of the annotation.
Returns
Set Signature
set locked(
locked):void
Experimental
Parameters
locked
Returns
void
Inherited from
modificationDate
Get Signature
get modificationDate():
Date
Experimental
The date and time when the annotation was last modified.
This property will retrieve the modification date from the annotation and convert it to a JavaScript Date object.
Returns
Date
The modification date as a JavaScript Date object, or null if no modification
date is available in the annotation.
Inherited from
MarkupAnnotation.modificationDate
opacity
Get Signature
get opacity():
number
Experimental
Gets the annotation opacity.
Returns
number
Set Signature
set opacity(
o):void
Experimental
Sets the annotation opacity.
Parameters
o
number
Returns
void
Inherited from
page
Get Signature
get page():
Page
Experimental
Page in which the annotation is embedded.
Returns
Set Signature
set page(
page):void
Experimental
Set the page in which the annotation is embedded.
Parameters
page
The page to set as the annotation’s page.
Returns
void
Inherited from
pageNumber
Get Signature
get pageNumber():
number
Experimental
Number of the page in which the annotation is embedded.
Returns
number
Inherited from
privateData
Get Signature
get privateData():
string
Experimental
Custom data to be stored with the annotation. This can be used to store any additional information relevant to the annotation that is not covered by the standard properties.
Returns
string
Set Signature
set privateData(
privateData):void
Experimental
Parameters
privateData
string
Custom data to be stored with the annotation.
Returns
void
Inherited from
renderProperties
Get Signature
get renderProperties():
AnnotationRenderProperties
Experimental
Object which encapsulates the rendering properties of a PDF annotation, providing a set of flags that control its visibility, interactivity, and other rendering behaviors.
Returns
Set Signature
set renderProperties(
v):void
Experimental
Parameters
v
Returns
void
Inherited from
MarkupAnnotation.renderProperties
source
Get Signature
get source():
void
Experimental
Tag that identifies the source the annotation is coming from, if the source is
an input PDF or an input FDF. Newly created annotations always return null.
Returns
void
Inherited from
subject
Get Signature
get subject():
string
Experimental
The subject.
Returns
string
Set Signature
set subject(
subject):void
Experimental
Parameters
subject
string
Returns
void
Inherited from
topLeft
Get Signature
get topLeft():
PdfPoint
Experimental
Represents the top left point of the annotation on the page, specified as a
PdfPoint.
Returns
PdfPoint
Set Signature
set topLeft(
topLeft):void
Experimental
Parameters
topLeft
PdfPoint
Returns
void
type
Get Signature
get type():
AnnotationType
Experimental
The PDF annotation type
Returns
Overrides
Methods
dispose()
dispose():
void
Experimental
Disposes of the object, releasing any resources it holds.
The dispose method is responsible for performing cleanup operations and
releasing any resources acquired by the object. Once an object is disposed, it
should not be used, and attempts to do so may result in undefined behavior.
Returns
void