Nutrient Web SDK
    Preparing search index...

    Interface TextAnnotationJSON

    interface TextAnnotationJSON {
        action?:
            | null
            | | { subactions?: (CoreActionJSON)[]; type: "uri"; uri: string }
            | { pageIndex: number; subactions?: (CoreActionJSON)[]; type: "goTo" }
            | {
                newWindow: boolean;
                relativePath: string;
                subactions?: (CoreActionJSON)[];
                targetType: "parent" | "child";
                type: "goToEmbedded";
            }
            | {
                namedDestination: string;
                relativePath: string;
                subactions?: (CoreActionJSON)[];
                type: "goToRemote";
            }
            | {
                annotationReferences: AnnotationReference[];
                hide: boolean;
                subactions?: (CoreActionJSON)[];
                type: "hide";
            }
            | {
                fields: null
                | AnnotationReference[];
                flags: null | string;
                subactions?: (CoreActionJSON)[];
                type: "resetForm";
            }
            | {
                fields: null
                | string[];
                flags: null | ActionFlags[];
                subactions?: (CoreActionJSON)[];
                type: "submitForm";
                uri: string;
            }
            | { filePath: string; subactions?: (CoreActionJSON)[]; type: "launch" }
            | {
                action: Omit<string, "custom">;
                subactions?: (CoreActionJSON)[];
                type: "named";
            }
            | {
                action: "custom";
                customAction: NamedCustomAction;
                subactions?: (CoreActionJSON)[];
                type: "named";
            }
            | { script: string; subactions?: (CoreActionJSON)[]; type: "javaScript" };
        APStreamCache?: { cache: string } | { attach: string };
        backgroundColor?: null | string;
        bbox: [left: number, top: number, width: number, height: number];
        blendMode?:
            | null
            | | "normal"
            | "multiply"
            | "screen"
            | "overlay"
            | "darken"
            | "lighten"
            | "colorDodge"
            | "colorBurn"
            | "hardLight"
            | "softLight"
            | "difference"
            | "exclusion";
        borderColor?: null
        | string;
        borderStyle?: null | "solid" | "dashed" | "beveled" | "inset" | "underline";
        borderWidth?: null | number;
        callout?:
            | null
            | {
                cap?: | null
                | | "square"
                | "circle"
                | "diamond"
                | "openArrow"
                | "closedArrow"
                | "butt"
                | "reverseOpenArrow"
                | "reverseClosedArrow"
                | "slash";
                end: [number, number];
                innerRectInset?:
                    | null
                    | [left: number, top: number, right: number, bottom: number];
                knee?: null | [number, number];
                start: [number, number];
            };
        createdAt?: string
        | Date;
        creatorName?: null | string;
        customData?: null | Record<string, unknown>;
        flags?:
            | null
            | (
                | "noView"
                | "noPrint"
                | "locked"
                | "lockedContents"
                | "readOnly"
                | "hidden"
                | "noZoom"
                | "noRotate"
            )[];
        font?: null
        | string;
        fontColor?: null | string;
        fontSize?: null | number;
        fontStyle?: null | string[];
        group?: IGroup;
        horizontalAlign?: "left" | "center" | "right";
        id: string;
        isAnonymous?: boolean;
        isCommentThreadRoot?: boolean;
        isFitting?: boolean;
        lineHeightFactor?: null | number;
        name?: null | string;
        note?: null | string;
        opacity?: number;
        pageIndex: number;
        pdfObjectId?: null | number;
        permissions?: {
            delete: boolean;
            edit: boolean;
            fill?: boolean;
            reply?: boolean;
            setGroup: boolean;
        };
        rotation?: null
        | number;
        subject?: null | string;
        text: { format: "xhtml" | "plain"; value: string };
        type: "pspdfkit/text";
        updatedAt?: string | Date;
        v: number;
        verticalAlign?: "center" | "top" | "bottom";
    }

    Hierarchy

    • Omit<BaseAnnotationJSON, "type">
      • TextAnnotationJSON
    Index

    Properties

    action?:
        | null
        | | { subactions?: (CoreActionJSON)[]; type: "uri"; uri: string }
        | { pageIndex: number; subactions?: (CoreActionJSON)[]; type: "goTo" }
        | {
            newWindow: boolean;
            relativePath: string;
            subactions?: (CoreActionJSON)[];
            targetType: "parent" | "child";
            type: "goToEmbedded";
        }
        | {
            namedDestination: string;
            relativePath: string;
            subactions?: (CoreActionJSON)[];
            type: "goToRemote";
        }
        | {
            annotationReferences: AnnotationReference[];
            hide: boolean;
            subactions?: (CoreActionJSON)[];
            type: "hide";
        }
        | {
            fields: null
            | AnnotationReference[];
            flags: null | string;
            subactions?: (CoreActionJSON)[];
            type: "resetForm";
        }
        | {
            fields: null
            | string[];
            flags: null | ActionFlags[];
            subactions?: (CoreActionJSON)[];
            type: "submitForm";
            uri: string;
        }
        | { filePath: string; subactions?: (CoreActionJSON)[]; type: "launch" }
        | {
            action: Omit<string, "custom">;
            subactions?: (CoreActionJSON)[];
            type: "named";
        }
        | {
            action: "custom";
            customAction: NamedCustomAction;
            subactions?: (CoreActionJSON)[];
            type: "named";
        }
        | { script: string; subactions?: (CoreActionJSON)[]; type: "javaScript" }
    APStreamCache?: { cache: string } | { attach: string }
    backgroundColor?: null | string
    bbox: [left: number, top: number, width: number, height: number]
    blendMode?:
        | null
        | | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
    borderColor?: null | string
    borderStyle?: null | "solid" | "dashed" | "beveled" | "inset" | "underline"
    borderWidth?: null | number
    callout?:
        | null
        | {
            cap?: | null
            | | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash";
            end: [number, number];
            innerRectInset?:
                | null
                | [left: number, top: number, right: number, bottom: number];
            knee?: null | [number, number];
            start: [number, number];
        }
    createdAt?: string | Date
    creatorName?: null | string
    customData?: null | Record<string, unknown>
    flags?:
        | null
        | (
            | "noView"
            | "noPrint"
            | "locked"
            | "lockedContents"
            | "readOnly"
            | "hidden"
            | "noZoom"
            | "noRotate"
        )[]
    font?: null | string
    fontColor?: null | string
    fontSize?: null | number
    fontStyle?: null | string[]
    group?: IGroup
    horizontalAlign?: "left" | "center" | "right"
    id: string
    isAnonymous?: boolean
    isCommentThreadRoot?: boolean
    isFitting?: boolean
    lineHeightFactor?: null | number
    name?: null | string
    note?: null | string
    opacity?: number
    pageIndex: number
    pdfObjectId?: null | number
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    }
    rotation?: null | number
    subject?: null | string
    text: { format: "xhtml" | "plain"; value: string }
    type: "pspdfkit/text"
    updatedAt?: string | Date
    v: number
    verticalAlign?: "center" | "top" | "bottom"