Nutrient Web SDK

v0.0.0-dev

Reference SerializersNoteAnnotationJSON

Interface NoteAnnotationJSON

Interface

Hierarchy

ModelsNoteAnnotationJSONNoteAnnotationJSON

Properties

action

Optional

    | | { subactions?: (CoreActionJSON)[]; type: "uri"; uri: string }
    | { pageIndex: number; subactions?: (CoreActionJSON)[]; type: "goTo" }
    | { … }
    | { … }
    | { … }
    | { … }
    | { … }
    | { filePath: string; subactions?: (CoreActionJSON)[]; type: "launch" }
    | { … }
    | { … }
    | { script: string; subactions?: (CoreActionJSON)[]; type: "javaScript" }
    | null

APStreamCache

Optional

{ cache: string } | { attach: string }

bbox

[left: number, top: number, width: number, height: number]

blendMode

Optional

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

color

Optional

string

createdAt

Optional

string | Date

creatorName

Optional

string | null

customData

Optional

Record<string, unknown> | null

flags

Optional

    | (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[]
    | null

group

Optional

string | null

icon

Optional

string

id

string

isAnonymous

Optional

boolean

isCommentThreadRoot

Optional

boolean

name

Optional

string | null

note

Optional

string | null

opacity

Optional

number

pageIndex

number

pdfObjectId

Optional

number | null

permissions

Optional

{ … }

Property	Description
delete
edit
fill
reply
setGroup

subject

Optional

string | null

text

Optional

{ format: "plain"; value: string }

Property	Description
format
value

type

"pspdfkit/note"

updatedAt

Optional

string | Date

v

number