Constructor
Free form text that will be rendered inside the bounding box.
Parameters:
Name | Type | Description |
---|---|---|
args |
Object | An object of the members. |
Example
Create a text annotation
const annotation = new PSPDFKit.Annotations.TextAnnotation({
pageIndex: 0,
text: "Welcome to\nPSPDFKit",
font: "Helvetica",
isBold: true,
horizontalAlign: "center",
boundingBox: new PSPDFKit.Geometry.Rect({ left: 10, top: 20, width: 30, height: 40 }),
fontColor: PSPDFKit.Color.RED
});
Extends
Members
Members
Optional background color that will fill the complete bounding box.
Type:
- Default Value:
- null
Position of this annotation on the page. It's necessary that this spans all visible points of the annotation, otherwise hit testing and other features may not work.
Type:
- Inherited From:
This property defines whether the user has permission to edit the group of this annotation.
It is only available when collaboration permissions is enabled on server-backed deployments.
Type:
- boolean
- Inherited From:
The date of the annotation creation.
Type:
- Date
- Inherited From:
The name of the creator of the annotation. This is a general purpose string which can easily be spoofed and might not reflect the actual creator of the annotation.
Type:
- string
- Inherited From:
Annotations can store additional user-specified data.
PSPDFKit will not use or evaluate customData
in the UI directly.
You have full control over this property. For new annotations, this defaults to null.
customData will be stored as JSON through JSON.serialize()
and JSON.parse()
, and
so must be a plain JSON-serializable object.
Type:
- Object
- Inherited From:
Example
Adding a new PSPDFKit.Annotations.EllipseAnnotation with custom data attached:
const annotation = new PSPDFKit.Annotations.EllipseAnnotation({
pageIndex: 0,
boundingBox: new PSPDFKit.Geometry.Rect({
top: 10,
left: 10,
width: 100,
height: 100
}),
customData: {
circleId: "my-circle"
}
});
The name of the font family that should be used.
Fonts are client specific and determined during runtime. If a font is not found, we will automatically fall back to 'sans-serif'.
We test the following list at runtime. The first available font will be used as the default for all new text annotations: Helvetica, Arial, Calibri, Century Gothic, Consolas, Courier, Dejavu Sans, Dejavu Serif, Georgia, Gill Sans, Impact, Lucida Sans, Myriad Pro, Open Sans, Palatino, Tahoma, Times New Roman, Trebuchet, Verdana, Zapfino, Comic Sans.
Type:
- string
- Default Value:
- "Helvetica"
A PSPDFKit.Color for the visible glyphs, or null
for transparent color.
Type:
- Default Value:
- Color.BLACK
The font size in page size pixels. Per default, we use values between 10 and 192 inclusive in the UI.
The text will scale when you zoom in.
Type:
- number
- Default Value:
- 18
This property is used to define the permission scope for this annotation.
It is only available when collaboration permissions is enabled on server-backed deployments.
Type:
- string
- Inherited From:
If set, do not display or print the annotation or allow it to interact with the user.
Type:
- boolean
- Inherited From:
- Default Value:
- false
The horizontal alignment of the text inside the bounding box. Can be either one of:
left
center
right
This is equal to the CSS text-align
property.
Type:
- "left" | "center" | "right"
- Default Value:
- "left"
A unique identifier to describe the annotation. When an annotation is created in the UI, the viewer has to generate a unique ID.
When changes are saved to the underlying annotation provider, we call PSPDFKit.Instance#ensureAnnotationSaved to make sure the annotation has been persisted from the provider.
Type:
- string
- Inherited From:
If true
, the font will be bold if the font family supports this.
Type:
- boolean
- Default Value:
- false
This property defines whether this annotation can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.
It is only available when collaboration permissions is enabled on server-backed deployments.
Type:
- boolean
- Inherited From:
This property defines whether this annotation can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.
It is only available when collaboration permissions is enabled on server-backed deployments.
Type:
- boolean
- Inherited From:
When the annotation is modified through PSPDFKit for Web, we will set this flag whenever the whole text fits the bounds of the annotation without overflowing.
Type:
- boolean
- Default Value:
If true
, the font will be italic if the font family supports this.
Type:
- boolean
- Default Value:
- false
An optional field that may be used to identify the annotation.
By default, we'll set that to the same value as the automatically generated PSPDFKit.Annotations.Annotation#id.
Type:
- string
- Inherited From:
The annotation flag that prevents the annotation from being printed.
Type:
- boolean
- Inherited From:
- Default Value:
- false
An optional note that can be set on any annotation.
This value is displayed in the PSPDFKit for Web UI for all annotations except NoteAnnotation, TextAnnotation and CommentMarkerAnnotation.
Type:
- string
- Inherited From:
The annotation flag that prevents the annotation from being rendered in the UI.
The annotation may still be part of the printed page, depending of the value of the PSPDFKit.Annotations.Annotation#noPrint flag.
Type:
- boolean
- Inherited From:
- Default Value:
- false
A transparency value that is applied to the complete annotation. The value is capped between 0 and 1 inclusive.
Type:
- number
- Inherited From:
- Default Value:
- 1
The page index on which the annotation is placed. It's important to notice that an annotation can only ever be on one page. If you create for example an ink annotation with lines on two pages, two annotation records will be created.
pageIndex
is zero-based and has a maximum value of totalPageCount - 1
.
Type:
- number
- Inherited From:
When the annotation is extracted directly from a PDF file, the pdfObjectId
refers to the
identifier that was used in the PDF document.
This ID is optional since newly created annotations using the SYNCProvider annotation provider
won't have a pdfObjectId
assigned.
Type:
- number
- Inherited From:
- Default Value:
- null
The counter-clockwise rotation value in degree relative to the rotated PDF page. Inserting an
annotation with a rotation value of 0
will make it appear in the same direction as the UI
appears, when no PSPDFKit.ViewState#pagesRotation is set.
Can either be 0°, 90°, 180°, or 270°. Multiple or negative values are normalized to this interval.
Note: Due to browser constraints, the rotation property is currently reset once the edit mode is enabled via the user interface.
Type:
- number
- Default Value:
- 0
The visible contents in plain text formats. We use a simple newline delimiter \n
for multi
line texts.
A trailing newline (e.g. foobar\n
) will result in an additional line.
We don't support rich text formatting in the text field.
Type:
- string
- Default Value:
- ""
The date of last annotation update.
Type:
- Date
- Inherited From:
The vertical alignment of the text inside the bounding box. Can be either one of:
top
center
bottom
Type:
- "top" | "center" | "bottom"
- Default Value:
- "top"