Nutrient Web SDK

ReferenceNutrientViewerAnnotationsInkAnnotation

Class InkAnnotation

Ink annotations are used for free hand drawings on a page. They can contain multiple segments (see the definition of lines below). Points within the same segment are connected to a line.

Ink annotations are only selectable around their visible lines. This means that you can create a page full of line annotations while annotations behind the ink annotation are still selectable.

Right now, ink annotations are implemented using SVG images. This behavior is object to change.

Class

Example

Create an ink annotation that displays a cross

const annotation = new NutrientViewer.Annotations.InkAnnotation({
  pageIndex: 0,
  lines: NutrientViewer.Immutable.List([
    NutrientViewer.Immutable.List([
      new NutrientViewer.Geometry.DrawingPoint({ x: 5,  y: 5 }),
      new NutrientViewer.Geometry.DrawingPoint({ x: 95, y: 95}),
    ]),
    NutrientViewer.Immutable.List([
      new NutrientViewer.Geometry.DrawingPoint({ x: 95, y: 5 }),
      new NutrientViewer.Geometry.DrawingPoint({ x: 5,  y: 95}),
    ])
  ]),
  boundingBox: new NutrientViewer.Geometry.Rect({
    left: 0,
    top: 0,
    width: 100,
    height: 100,
  }),
});

See Also

Hierarchy

AnnotationInkAnnotation

Constructors

new InkAnnotation(options)

  • Parameters

    options
    Partial<{ … }>
    Optional

Properties

additionalActions

Readonly
{ … } | null
PropertyDescription
onPageClose
onPageHidden
onPageOpen
onPageVisible
onPointerDown
onPointerEnter
onPointerLeave
onPointerUp

APStreamCache

OptionalReadonly
{ cache: string } | { attach: string }

backgroundColor

Readonly
NutrientViewer.Color | null

Optional background color that will fill the complete bounding box.

Default Value

null

blendMode

Readonly

    | "normal"
    | "multiply"
    | "screen"
    | "overlay"
    | "darken"
    | "lighten"
    | "colorDodge"
    | "colorBurn"
    | "hardLight"
    | "softLight"
    | "difference"
    | "exclusion"

The blend mode defines how the color of the annotation will be applied to its background.

Default Value

"normal"

boundingBox

Readonly
NutrientViewer.Geometry.Rect

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.

canReply

OptionalReadonly
boolean

canSetGroup

OptionalReadonly
boolean

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.

createdAt

Readonly
Date

The date of the annotation creation.

createdBy

Readonly
string | null

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.

creatorName

Readonly
string | null

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.

customData

Readonly
Record<string, unknown> | null

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.

Example

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"
  }
});

group

OptionalReadonly
string | null

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.

hidden

Readonly
boolean

If set, do not display or print the annotation or allow it to interact with the user.

Default Value

false

id

Readonly
string

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.

isAnonymous

Readonly
boolean

isCommentThreadRoot

Readonly
boolean

isDeletable

OptionalReadonly
boolean

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.

isDrawnNaturally

Readonly
boolean

NutrientViewer's Natural Drawing mode. This value will currently not effect rendering on NutrientViewer for Web.

Default Value

false

isEditable

OptionalReadonly
boolean

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.

isSignature

Readonly
boolean

When an ink annotation is created via the signature UI, this flag is set to true.

Default Value

false

lines

Readonly
NutrientViewer.Immutable.List<
    NutrientViewer.Immutable.List<NutrientViewer.Geometry.DrawingPoint>,
>

A list of line segments. Every segment consists again of a list of points with additional intensity information.

The two nested lists are required since one ink annotation can consist of multiple lines. Within one segment, points will be connected using lines or curves.

We use NutrientViewer.Geometry.DrawingPoint for an additional intensity value (usually the pressure of a pointer device) that is used to reconstruct the naturally drawn image. If a device without intensity is used, the default intensity of 0.5 will be used.

If no lines are present, the annotation will not be visible.

Default Value

NutrientViewer.Immutable.List() Empty list

lineWidth

Readonly
number

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

The line width will scale when you zoom in.

Default Value

5

locked

Readonly
boolean

The annotation flag that prevents the annotation from being modified.

Default Value

false

lockedContents

Readonly
boolean

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

Default Value

false

name

Readonly
string | null

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.

noPrint

Readonly
boolean

The annotation flag that prevents the annotation from being printed.

Default Value

false

noRotate

Readonly
boolean

note

Readonly
string | null

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.

noView

Readonly
boolean

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.

Default Value

false

noZoom

Readonly
boolean

opacity

Readonly
number

A transparency value that is applied to the complete annotation. The value is capped between 0 and 1 inclusive.

Default Value

1

pageIndex

Readonly
number

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.

pdfObjectId

Readonly
number | null

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.

Default Value

null

readOnly

Readonly
boolean

The annotation flag that makes the annotation read only.

Default Value

false

rotation

Readonly
number

signatureFormFieldName

Readonly
string | null

The name of the signature form field this signature annotation fills.

Default Value

null

strokeColor

Readonly
NutrientViewer.Color | null

A NutrientViewer.Color for the visible line

Default Value

Color.BLUE

subject

Readonly
string | null

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.

updatedAt

Readonly
Date

The date of last annotation update.

readableName

Static
string

Methods

entries

  • Returns the record's [key, value] pairs, in the order its fields were defined.

    Returns

    IterableIterator<[string, unknown]>

    An iterator over the record's fields.

Immutable Record API

27

[iterator]

  • Iterates the record's [key, value] pairs, in the order its fields were defined.

    Returns

    IterableIterator<[string, unknown]>

clear

  • Returns a record with every key reset to the default it was defined with.

    Returns

    this

    A new record holding only default values.

delete

  • Returns a record with key reset to the default it was defined with.

    Type Parameters

    K
    extends keyof { … }

    Parameters

    keyK & (
    | "lines"
    | "lineWidth"
    | "strokeColor"
    | "backgroundColor"
    | "isDrawnNaturally"
    | "isSignature"
    | "signatureFormFieldName"
    | "id"
    | "name"
    | "subject"
    | "pdfObjectId"
    | "pageIndex"
    | "boundingBox"
    | "opacity"
    | "note"
    | "creatorName"
    | "createdBy"
    | "createdAt"
    | "updatedAt"
    | "customData"
    | "enrichment"
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "group"
    | "isEditable"
    | "isDeletable"
    | "canSetGroup"
    | "canReply"
    | "rotation"
    | "additionalActions"
    | "noZoom"
    | "noRotate"
    | "isCommentThreadRoot"
    | "isAnonymous"
    | "APStreamCache"
    | "blendMode"
    | "action"
    )

    One of the keys this record was defined with.

    Returns

    this

    A new record, or this one when the value already equals the default.

deleteIn

  • Returns a record with the value at keyPath removed. A field of this record is reset to its default; a key of a nested collection or plain object is deleted.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    Returns

    this

    A new record, or this one when nothing was removed.

equals

Deprecated

  • Reports whether other is a record holding the same keys with equal values, whatever its class.

    Parameters

    otherunknown

    The value to compare against.

    Returns

    boolean

    true when both hold the same keys and every value matches.

    Deprecated

    Records of different classes with identical values compare equal. Use isEqual(), which also requires both records to be of the same class.

get

  • Returns the value stored under key.

    Type Parameters

    K
    extends keyof { … }
    N = never

    Parameters

    keyK & (
    | "lines"
    | "lineWidth"
    | "strokeColor"
    | "backgroundColor"
    | "isDrawnNaturally"
    | "isSignature"
    | "signatureFormFieldName"
    | "id"
    | "name"
    | "subject"
    | "pdfObjectId"
    | "pageIndex"
    | "boundingBox"
    | "opacity"
    | "note"
    | "creatorName"
    | "createdBy"
    | "createdAt"
    | "updatedAt"
    | "customData"
    | "enrichment"
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "group"
    | "isEditable"
    | "isDeletable"
    | "canSetGroup"
    | "canReply"
    | "rotation"
    | "additionalActions"
    | "noZoom"
    | "noRotate"
    | "isCommentThreadRoot"
    | "isAnonymous"
    | "APStreamCache"
    | "blendMode"
    | "action"
    )

    One of the keys this record was defined with.

    notSetValueN
    Optional

    Returned when the record does not define key.

    Returns

    N | { … }[K]

    The current value for that key.

getIn

  • Returns the value at keyPath, walking nested records and collections.

    A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    Returns

    unknown

    The value at that path, or undefined when it does not resolve.

  • Returns the value at keyPath, walking nested records and collections.

    A literal key path is checked against the record's fields and gives the value's type; a computed one gives unknown.

    Type Parameters

    N

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    notSetValueN

    Returned when the path does not resolve.

    Returns

    unknown

    The value at that path, or notSetValue.

has

  • Reports whether key is one of the keys this record was defined with.

    A literal key must name a field; a key typed as string is narrowed to the field names.

    Parameters

    keystring

    The key to look for.

    Returns

    key is
    | "lines"
    | "lineWidth"
    | "strokeColor"
    | "backgroundColor"
    | "isDrawnNaturally"
    | "isSignature"
    | "signatureFormFieldName"
    | "id"
    | "name"
    | "subject"
    | "pdfObjectId"
    | "pageIndex"
    | "boundingBox"
    | "opacity"
    | "note"
    | "creatorName"
    | "createdBy"
    | "createdAt"
    | "updatedAt"
    | "customData"
    | "enrichment"
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "group"
    | "isEditable"
    | "isDeletable"
    | "canSetGroup"
    | "canReply"
    | "rotation"
    | "additionalActions"
    | "noZoom"
    | "noRotate"
    | "isCommentThreadRoot"
    | "isAnonymous"
    | "APStreamCache"
    | "blendMode"
    | "action"

    true when the record defines that key, even if its value is null.

hashCode

  • Computes a hash of this record from its contents, the same way Immutable.js does. Equal records have equal hashes; records with equal hashes are not necessarily equal. Plain objects, functions and symbols hash by identity, so a hash is only meaningful within the page that computed it.

    Returns

    number

    An integer hash.

hasIn

  • Reports whether keyPath resolves, walking nested records and collections.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    Returns

    boolean

    true when every key along the path is present.

isEqual

  • Reports whether other is a record of the same class holding equal values. Only the two records' own classes are compared; nested records compare as equals() does.

    Parameters

    otherunknown

    The value to compare against.

    Returns

    boolean

    true when both are the same class and every value matches.

merge

  • Returns a record with the entries of each collection applied in order.

    Keys the record was not defined with are ignored.

    Parameters

    ...collections
    (Partial<{ … }> | Iterable<readonly [string, unknown]>)[]

    Plain objects or key/value iterables to apply.

    Returns

    this

    A new record, or this one when no value changed.

mergeDeep

  • Returns a record with the entries of each collection merged in, recursing into nested collections and plain objects instead of replacing them.

    Keys the record was not defined with are ignored.

    Parameters

    ...collections
    (Partial<{ … }> | Iterable<readonly [string, unknown]>)[]

    Plain objects or key/value iterables to merge in.

    Returns

    this

    A new record, or this one when no value changed.

mergeDeepIn

  • Returns a record with each collection merged deeply into the value at keyPath.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    ...collectionsunknown[]

    Collections or plain objects to merge into the value there.

    Returns

    this

    A new record, or this one when the value is unchanged.

mergeDeepWith

  • Returns a record with the entries of each collection merged in deeply, calling merger where a nested value is not a collection to decide the value that is kept.

    Keys the record was not defined with are ignored.

    Parameters

    merger(previous: unknown, next: unknown, key: unknown) => unknown

    Receives the current value, the incoming value and the key.

    ...collections
    (Partial<{ … }> | Iterable<readonly [string, unknown]>)[]

    Plain objects or key/value iterables to merge in.

    Returns

    this

    A new record, or this one when no value changed.

mergeIn

  • Returns a record with each collection merged into the value at keyPath, one level at a time.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    ...collectionsunknown[]

    Collections or plain objects to merge into the value there.

    Returns

    this

    A new record, or this one when the value is unchanged.

mergeWith

  • Returns a record with the entries of each collection merged in, calling merger for each key the record already holds to decide the value that is kept.

    Keys the record was not defined with are ignored.

    Parameters

    merger
    <K extends string | number | symbol>(
    previous: { … }[K],
    next: { … }[K],
    key: K
    ) => { … }[K]

    Receives the current value, the incoming value and the key.

    ...collections
    (Partial<{ … }> | Iterable<readonly [string, unknown]>)[]

    Plain objects or key/value iterables to merge in.

    Returns

    this

    A new record, or this one when no value changed.

remove

  • An alias for delete.

    Type Parameters

    K
    extends keyof { … }

    Parameters

    keyK & (
    | "lines"
    | "lineWidth"
    | "strokeColor"
    | "backgroundColor"
    | "isDrawnNaturally"
    | "isSignature"
    | "signatureFormFieldName"
    | "id"
    | "name"
    | "subject"
    | "pdfObjectId"
    | "pageIndex"
    | "boundingBox"
    | "opacity"
    | "note"
    | "creatorName"
    | "createdBy"
    | "createdAt"
    | "updatedAt"
    | "customData"
    | "enrichment"
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "group"
    | "isEditable"
    | "isDeletable"
    | "canSetGroup"
    | "canReply"
    | "rotation"
    | "additionalActions"
    | "noZoom"
    | "noRotate"
    | "isCommentThreadRoot"
    | "isAnonymous"
    | "APStreamCache"
    | "blendMode"
    | "action"
    )

    One of the keys this record was defined with.

    Returns

    this

    A new record, or this one when the value already equals the default.

removeIn

  • An alias for deleteIn.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    Returns

    this

    A new record, or this one when nothing was removed.

set

  • Returns a record with key set to value.

    Setting a key to the value it already holds returns the same instance, so a record can be compared by reference to detect a change.

    Type Parameters

    K
    extends keyof { … }

    Parameters

    keyK & (
    | "lines"
    | "lineWidth"
    | "strokeColor"
    | "backgroundColor"
    | "isDrawnNaturally"
    | "isSignature"
    | "signatureFormFieldName"
    | "id"
    | "name"
    | "subject"
    | "pdfObjectId"
    | "pageIndex"
    | "boundingBox"
    | "opacity"
    | "note"
    | "creatorName"
    | "createdBy"
    | "createdAt"
    | "updatedAt"
    | "customData"
    | "enrichment"
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "group"
    | "isEditable"
    | "isDeletable"
    | "canSetGroup"
    | "canReply"
    | "rotation"
    | "additionalActions"
    | "noZoom"
    | "noRotate"
    | "isCommentThreadRoot"
    | "isAnonymous"
    | "APStreamCache"
    | "blendMode"
    | "action"
    )

    One of the keys this record was defined with.

    value
    { … }[K]

    The value to store.

    Returns

    this

    A new record, or this one when the value is unchanged or the key is not defined.

setIn

  • Returns a record with value written at keyPath.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    valueunknown

    The value to store.

    Returns

    this

    A new record, or this one when the value is unchanged.

toJS

  • Converts this record and everything nested inside it to plain JavaScript values.

    Returns

    { … }

    A plain object holding this record's values, converted all the way down.

toJSON

  • An alias for toObject, called by JSON.stringify.

    Returns

    { … }

    A plain object holding this record's values.

toObject

  • Converts this record to a plain object, one level deep. Nested records are left as they are.

    Returns

    { … }

    A plain object holding this record's values.

update

  • Returns a record with key replaced by the result of applying updater to its current value.

    Type Parameters

    K
    extends keyof { … }

    Parameters

    keyK & (
    | "lines"
    | "lineWidth"
    | "strokeColor"
    | "backgroundColor"
    | "isDrawnNaturally"
    | "isSignature"
    | "signatureFormFieldName"
    | "id"
    | "name"
    | "subject"
    | "pdfObjectId"
    | "pageIndex"
    | "boundingBox"
    | "opacity"
    | "note"
    | "creatorName"
    | "createdBy"
    | "createdAt"
    | "updatedAt"
    | "customData"
    | "enrichment"
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "group"
    | "isEditable"
    | "isDeletable"
    | "canSetGroup"
    | "canReply"
    | "rotation"
    | "additionalActions"
    | "noZoom"
    | "noRotate"
    | "isCommentThreadRoot"
    | "isAnonymous"
    | "APStreamCache"
    | "blendMode"
    | "action"
    )

    One of the keys this record was defined with.

    updater
    (value: { … }[K]) => { … }[K]

    Receives the current value and returns the new one.

    Returns

    this

    A new record, or this one when the value is unchanged.

updateIn

  • Returns a record with the value at keyPath replaced by the result of updater.

    Type Parameters

    N

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    notSetValueN
    updater(value: unknown) => unknown

    Receives the current value and returns the new one.

    Returns

    this

    A new record, or this one when the value is unchanged.

  • Returns a record with the value at keyPath replaced by the result of updater.

    Parameters

    keyPathIterable<unknown>

    The keys to follow, outermost first.

    updater(value: unknown) => unknown

    Receives the current value and returns the new one.

    Returns

    this

    A new record, or this one when the value is unchanged.

withMutations

  • Applies several changes as one, so only a single new record is allocated.

    The record handed to mutator may be written to with set; it is frozen again once mutator returns.

    Parameters

    mutator(mutable: this) => unknown

    Receives a temporarily writable copy of this record.

    Returns

    this

    A new record holding the applied changes, or this one when nothing changed.