Class EllipseAnnotation

The 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.

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.

Cloudy border inset.

For ellipse annotations with a cloudy border, it contains the values for the distances from the bounding box to bounding box wrapped by the inner, where the content fits.

Visual representation of the property:

Intensity of the cloudy border.

If not present or 0, the annotation will use a normal border.

The date of the annotation creation.

The ID of the user who created the annotation, as determined by the authenticated user (the user_id claim of the JWT) that created it.

Unlike creatorName, which the client supplies, this is assigned by Document Engine from the authenticated session, so a client cannot cause a different author to be recorded. Setting it on an annotation you construct yourself only affects your own copy: it is not serialized, so it never reaches Document Engine or the underlying document.

It requires Instant sync against Document Engine 1.18 or later, and is null on Standalone, on the deprecated REST provider, against earlier Document Engine versions, and for annotations created without an authenticated user. It is also null when the server holds an author it can no longer resolve to an upstream user id, which is indistinguishable from the cases above.

Setting isAnonymous does not clear it. With Collaboration Permissions configured it is hidden from other users only; without them it is not hidden at all, which matches how creatorName already behaves.

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.

A NutrientViewer.Color to fill the interior of closed shapes (ellipses, rectangles and polygons) or start and / or end line caps of open shapes (lines and polylines).

A method the returns the measurement value and label of the annotation.

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.

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.

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.

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.

The annotation flag that prevents the annotation from being modified.

The annotation flag that prevents the annotation content from being modified.

The compound (mixed-unit) chain persisted with the annotation, derived from its stored /Measure number format. Used to render the measurement label across reloads and viewers.

The NutrientViewer.MeasurementPrecision used to set the precision for the annotation.

The NutrientViewer.MeasurementScale used to set the scale for the annotation.

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 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.

A NutrientViewer.Color for the shape lines

Optional dash pattern used to draw the shape lines for dashed line style.

The width of the line in page size pixels. By default, we use values between 1 and 40 in the UI.

The stroke width will scale when you zoom in.

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.