Nutrient Web SDK

v0.0.0-dev

ReferenceSerializersTextAnnotationJSON

Interface TextAnnotationJSON

Interface

Hierarchy

ModelsTextAnnotationJSONTextAnnotationJSON

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
{ cache: string } | { attach: string }
string | null
[left: number, top: number, width: number, height: number]

blendMode

Optional

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

borderColor

Optional
string | null

borderStyle

Optional
"solid" | "dashed" | "beveled" | "inset" | "underline" | null

borderWidth

Optional
number | null

callout

Optional
{ … } | null
PropertyDescription
cap
end
innerRectInset
knee
start

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

font

Optional
string | null

fontColor

Optional
string | null

fontSize

Optional
number | null

fontStyle

Optional
string[] | null

group

Optional
string | null
"left" | "center" | "right"
string

isAnonymous

Optional
boolean
boolean

isFitting

Optional
boolean

lineSpacing

Optional
number | null

The spacing between lines of text, in PDF points. This is the total line height (baseline to baseline), independent of the font size.

name

Optional
string | null

note

Optional
string | null

opacity

Optional
number
number

pdfObjectId

Optional
number | null

permissions

Optional
{ … }
PropertyDescription
delete
edit
fill
reply
setGroup

rotation

Optional
number | null

subject

Optional
string | null
{ format: "xhtml" | "plain"; value: string }
PropertyDescription
format
value
"pspdfkit/text"

updatedAt

Optional
string | Date
number
"center" | "top" | "bottom"