Optionaloptions: Partial<OptionalAPThe blend mode defines how the color of the annotation will be applied to its background.
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.
OptionalcanOptional ReadonlycanThis 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.
The content type of the connected attachment binary data.
We currently support:
image/jpegimage/pngapplication/pdfThe date of the annotation creation.
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.
Annotations can store additional user-specified data.
NutrientViewer 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.
Adding a new EllipseAnnotation with custom data attached:
const annotation = new NutrientViewer.Annotations.EllipseAnnotation({
pageIndex: 0,
boundingBox: new NutrientViewer.Geometry.Rect({
top: 10,
left: 10,
width: 100,
height: 100
}),
customData: {
circleId: "my-circle"
}
});
A description of the image content.
The file name of the attached file.
OptionalgroupThis property is used to define the permission scope for this annotation.
It is only available when collaboration permissions is enabled on Server-Backed deployments.
If set, do not display or print the annotation or allow it to interact with the user.
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 Instance#ensureChangesSaved to make sure the annotation has been persisted from the provider.
The attachment identifier of the image. It holds the image data as binary.
Optional ReadonlyisThis 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.
Optional ReadonlyisThis 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.
When an image annotation is created via the signature UI, this flag is set to true.
The annotation flag that prevents the annotation from being modified.
The annotation flag that prevents the annotation content from being modified.
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 Annotation#id.
The annotation flag that prevents the annotation from being printed.
An optional note that can be set on any annotation.
This value is displayed in the Nutrient Web SDK UI for all annotations except NoteAnnotation, TextAnnotation, WidgetAnnotation and CommentMarkerAnnotation.
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 Annotations.Annotation#noPrint flag.
A transparency value that is applied to the complete annotation. The value is capped between 0 and 1 inclusive.
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.
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.
The annotation flag that makes the annotation read only.
The counter-clockwise rotation value in degrees 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 ViewState#pagesRotation is set.
Can either be 0°, 90°, 180°, or 270°. Multiple or negative values are normalized to this interval.
The name of the signature form field this signature annotation fills.
An optional annotation subject, representing a short description of the subject being addressed by the annotation. This property has no effect on the annotation rendering.
The date of last annotation update.
StaticreadableReturns a new instance of this Record type with all values set to their default values.
Returns a new instance of this Record type with the value for the specific key set to its default value.
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.
If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.
OptionalnotSetValue: unknownDeeply converts this Record to equivalent native JavaScript Object.
Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.
Shallowly converts this Record to equivalent native JavaScript Object.
Image annotations are images that are added to a PDF document.
It is also possible to import the first page of a PDF by setting the appropriate
contentType, however the imported PDF won't include the annotations unless they are flattened in advance.Example
Create an image annotation
See