Reference NutrientViewer AnnotationstoSerializableObject

Function toSerializableObject

Function

Type Signature

toSerializableObject(
    annotation: NutrientViewer.Annotations.InkAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.LineAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.RectangleAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.EllipseAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.PolygonAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.PolylineAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.TextAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.NoteAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.StampAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.ImageAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.MediaAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.LinkAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.WidgetAnnotation,
): { … }
toSerializableObject(annotation: MarkupAnnotation): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.RedactionAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.CommentMarkerAnnotation,
): { … }
toSerializableObject(
    annotation: NutrientViewer.Annotations.UnknownAnnotation,
): { … }
toSerializableObject(annotation: AnnotationsUnion): AnnotationsBackendJSONUnion
toSerializableObject(
    annotation: AnnotationsUnion,
    options?: { widgetAppearanceNullKeys?: ReadonlySet<string> },
): AnnotationsBackendJSONUnion

Type Declaration
Parameters
annotationNutrientViewer.Annotations.InkAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    backgroundColor?: string;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    isDrawnNaturally?: boolean;
    isSignature?: boolean;
    lines?: { intensities: number[][]; points: [number, number][][] };
    lineWidth?: number;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    signatureFormFieldName?: string;
    strokeColor?: string;
    subject?: string;
    type: "pspdfkit/ink";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.LineAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    endPoint?: [number, number];
    fillColor?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    lineCaps?: {
        end?:
            | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
        start?: | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    };
    lines?: { intensities: number[][]; points: [number, number][][] };
    lineWidth?: number;
    measurementCompoundUnits?: {
        precision:
            | "whole"
            | "oneDp"
            | "twoDp"
            | "threeDp"
            | "fourDp"
            | "1/2"
            | "1/4"
            | "1/8"
            | "1/16";
        unitTo: "pt"
        | "in"
        | "mm"
        | "cm"
        | "ft"
        | "m"
        | "yd"
        | "km"
        | "mi";
    }[];
    measurementPrecision?: NonNullable<
        | "whole"
        | "oneDp"
        | "twoDp"
        | "threeDp"
        | "fourDp"
        | "1/2"
        | "1/4"
        | "1/8"
        | "1/16"
        | null
        | undefined,
    >;
    measurementScale?: {
        from: number;
        fromDescription?: string;
        to: number;
        toDescription?: string;
        unitFrom: "pt"
        | "in"
        | "mm"
        | "cm";
        unitTo: "pt" | "in" | "mm" | "cm" | "ft" | "m" | "yd" | "km" | "mi";
    };
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    startPoint?: [number, number];
    strokeColor?: string;
    strokeDashArray?: [number, number];
    strokeWidth?: number;
    subject?: string;
    type: "pspdfkit/shape/line";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.RectangleAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    cloudyBorderInset?: [
        left: number,
        top: number,
        right: number,
        bottom: number,
    ];
    cloudyBorderIntensity?: number;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    fillColor?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    lineWidth?: number;
    measurementCompoundUnits?: {
        precision:
            | "whole"
            | "oneDp"
            | "twoDp"
            | "threeDp"
            | "fourDp"
            | "1/2"
            | "1/4"
            | "1/8"
            | "1/16";
        unitTo: "pt"
        | "in"
        | "mm"
        | "cm"
        | "ft"
        | "m"
        | "yd"
        | "km"
        | "mi";
    }[];
    measurementPrecision?: NonNullable<
        | "whole"
        | "oneDp"
        | "twoDp"
        | "threeDp"
        | "fourDp"
        | "1/2"
        | "1/4"
        | "1/8"
        | "1/16"
        | null
        | undefined,
    >;
    measurementScale?: {
        from: number;
        fromDescription?: string;
        to: number;
        toDescription?: string;
        unitFrom: "pt"
        | "in"
        | "mm"
        | "cm";
        unitTo: "pt" | "in" | "mm" | "cm" | "ft" | "m" | "yd" | "km" | "mi";
    };
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    strokeColor?: string;
    strokeDashArray?: [number, number];
    strokeWidth?: number;
    subject?: string;
    type: "pspdfkit/shape/rectangle";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.EllipseAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    cloudyBorderInset?: [
        left: number,
        top: number,
        right: number,
        bottom: number,
    ];
    cloudyBorderIntensity?: number;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    fillColor?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    lineWidth?: number;
    measurementCompoundUnits?: {
        precision:
            | "whole"
            | "oneDp"
            | "twoDp"
            | "threeDp"
            | "fourDp"
            | "1/2"
            | "1/4"
            | "1/8"
            | "1/16";
        unitTo: "pt"
        | "in"
        | "mm"
        | "cm"
        | "ft"
        | "m"
        | "yd"
        | "km"
        | "mi";
    }[];
    measurementPrecision?: NonNullable<
        | "whole"
        | "oneDp"
        | "twoDp"
        | "threeDp"
        | "fourDp"
        | "1/2"
        | "1/4"
        | "1/8"
        | "1/16"
        | null
        | undefined,
    >;
    measurementScale?: {
        from: number;
        fromDescription?: string;
        to: number;
        toDescription?: string;
        unitFrom: "pt"
        | "in"
        | "mm"
        | "cm";
        unitTo: "pt" | "in" | "mm" | "cm" | "ft" | "m" | "yd" | "km" | "mi";
    };
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    strokeColor?: string;
    strokeDashArray?: [number, number];
    strokeWidth?: number;
    subject?: string;
    type: "pspdfkit/shape/ellipse";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.PolygonAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    cloudyBorderIntensity?: number;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    fillColor?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    lines?: { intensities: number[][]; points: [number, number][][] };
    lineWidth?: number;
    measurementCompoundUnits?: {
        precision:
            | "whole"
            | "oneDp"
            | "twoDp"
            | "threeDp"
            | "fourDp"
            | "1/2"
            | "1/4"
            | "1/8"
            | "1/16";
        unitTo: "pt"
        | "in"
        | "mm"
        | "cm"
        | "ft"
        | "m"
        | "yd"
        | "km"
        | "mi";
    }[];
    measurementPrecision?: NonNullable<
        | "whole"
        | "oneDp"
        | "twoDp"
        | "threeDp"
        | "fourDp"
        | "1/2"
        | "1/4"
        | "1/8"
        | "1/16"
        | null
        | undefined,
    >;
    measurementScale?: {
        from: number;
        fromDescription?: string;
        to: number;
        toDescription?: string;
        unitFrom: "pt"
        | "in"
        | "mm"
        | "cm";
        unitTo: "pt" | "in" | "mm" | "cm" | "ft" | "m" | "yd" | "km" | "mi";
    };
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    points?: [number, number][];
    strokeColor?: string;
    strokeDashArray?: [number, number];
    strokeWidth?: number;
    subject?: string;
    type: "pspdfkit/shape/polygon";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.PolylineAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    fillColor?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    lineCaps?: {
        end?:
            | "square"
            | "circle"
            | "diamond"
            | "openArrow"
            | "closedArrow"
            | "butt"
            | "reverseOpenArrow"
            | "reverseClosedArrow"
            | "slash"
            | null;
        start?: | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    };
    lines?: { intensities: number[][]; points: [number, number][][] };
    lineWidth?: number;
    measurementCompoundUnits?: {
        precision:
            | "whole"
            | "oneDp"
            | "twoDp"
            | "threeDp"
            | "fourDp"
            | "1/2"
            | "1/4"
            | "1/8"
            | "1/16";
        unitTo: "pt"
        | "in"
        | "mm"
        | "cm"
        | "ft"
        | "m"
        | "yd"
        | "km"
        | "mi";
    }[];
    measurementPrecision?: NonNullable<
        | "whole"
        | "oneDp"
        | "twoDp"
        | "threeDp"
        | "fourDp"
        | "1/2"
        | "1/4"
        | "1/8"
        | "1/16"
        | null
        | undefined,
    >;
    measurementScale?: {
        from: number;
        fromDescription?: string;
        to: number;
        toDescription?: string;
        unitFrom: "pt"
        | "in"
        | "mm"
        | "cm";
        unitTo: "pt" | "in" | "mm" | "cm" | "ft" | "m" | "yd" | "km" | "mi";
    };
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    points?: [number, number][];
    strokeColor?: string;
    strokeDashArray?: [number, number];
    strokeWidth?: number;
    subject?: string;
    type: "pspdfkit/shape/polyline";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.TextAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    backgroundColor?: string;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    borderColor?: string;
    borderStyle?: NonNullable<
        | "solid"
        | "dashed"
        | "beveled"
        | "inset"
        | "underline"
        | null
        | undefined,
    >;
    borderWidth?: number;
    callout?: {
        cap?: | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
        end: [number, number];
        innerRectInset?:
            | [left: number, top: number, right: number, bottom: number]
            | null;
        knee?: [number, number] | null;
        start: [number, number];
    };
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    font?: string;
    fontColor?: string;
    fontSize?: number;
    fontStyle?: string[];
    group?: string;
    horizontalAlign?: NonNullable<"left" | "center" | "right" | undefined>;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    isFitting?: NonNullable<boolean | undefined>;
    lineSpacing?: number;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    rotation?: number;
    subject?: string;
    text?: { format: "xhtml"
    | "plain"; value: string };
    type: "pspdfkit/text";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
    verticalAlign?: NonNullable<"center" | "top" | "bottom" | undefined>;
}
Optional
action?: NonNullable<(CoreActionJSON | null | undefined)>
Optional
APStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>
Optional
backgroundColor?: string
Optional
bbox?: [left: number, top: number, width: number, height: number]
Optional
blendMode?: NonNullable<
    | "normal"
    | "multiply"
    | "screen"
    | "overlay"
    | "darken"
    | "lighten"
    | "colorDodge"
    | "colorBurn"
    | "hardLight"
    | "softLight"
    | "difference"
    | "exclusion"
    | null
    | undefined,
>
Optional
borderColor?: string
Optional
borderStyle?: NonNullable<
    | "solid"
    | "dashed"
    | "beveled"
    | "inset"
    | "underline"
    | null
    | undefined,
>
Optional
borderWidth?: number
Optional
callout?: {
    cap?:
        | "square"
        | "circle"
        | "diamond"
        | "openArrow"
        | "closedArrow"
        | "butt"
        | "reverseOpenArrow"
        | "reverseClosedArrow"
        | "slash"
        | null;
    end: [number, number];
    innerRectInset?:
        | [left: number, top: number, right: number, bottom: number]
        | null;
    knee?: [number, number] | null;
    start: [number, number];
}
Optional
createdAt?: NonNullable<string | Date | undefined>
Optional
creatorName?: string
Optional
customData?: Record<string, unknown>
Optional
flags?: (
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "noZoom"
    | "noRotate"
)[]
Optional
font?: string
Optional
fontColor?: string
Optional
fontSize?: number
Optional
fontStyle?: string[]
Optional
group?: string
Optional
horizontalAlign?: NonNullable<"left" | "center" | "right" | undefined>
Optional
id?: string
Optional
isAnonymous?: NonNullable<boolean | undefined>
Optional
isCommentThreadRoot?: NonNullable<boolean | undefined>
Optional
isFitting?: NonNullable<boolean | undefined>
Optional
lineSpacing?: number
The spacing between lines of text, in PDF points. This is the total line height (baseline to baseline), independent of the font size.

Optional
name?: string
Optional
note?: string
Optional
opacity?: number
Optional
pageIndex?: number
Optional
pdfObjectId?: number
Optional
permissions?: {
    delete: boolean;
    edit: boolean;
    fill?: boolean;
    reply?: boolean;
    setGroup: boolean;
}
Optional
rotation?: number
Optional
subject?: string
Optional
text?: { format: "xhtml" | "plain"; value: string }
Optional
type?: "pspdfkit/text"
Optional
updatedAt?: NonNullable<string | Date | undefined>
Optional
v?: number
Optional
verticalAlign?: NonNullable<"center" | "top" | "bottom" | undefined>
bbox: [left: number, top: number, width: number, height: number]
id: string
pageIndex: number
type: "pspdfkit/text"
v: number
Type Declaration
Parameters
annotationNutrientViewer.Annotations.NoteAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    color?: string;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    icon?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    subject?: string;
    text?: { format: "plain"; value: string };
    type: "pspdfkit/note";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.StampAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    color: string;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    font?: string;
    fontColor?: string;
    fontSize?: number;
    fontStyle?: string[];
    group?: string;
    id: string;
    imageAttachmentId?: string;
    imageContentType?: string;
    imagePosition?: { align: "left"
    | "center"
    | "right"; row: number };
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    kind?: NonNullable<
        | "Approved"
        | "NotApproved"
        | "Draft"
        | "Final"
        | "Completed"
        | "Confidential"
        | "ForPublicRelease"
        | "NotForPublicRelease"
        | "ForComment"
        | "Void"
        | "PreliminaryResults"
        | "InformationOnly"
        | "Rejected"
        | "Accepted"
        | "InitialHere"
        | "SignHere"
        | "Witness"
        | "AsIs"
        | "Departmental"
        | "Experimental"
        | "Expired"
        | "Sold"
        | "TopSecret"
        | "Revised"
        | "RejectedWithText"
        | "Custom"
        | undefined,
    >;
    multiline?: NonNullable<boolean | null | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    rotation?: number;
    stampType?: NonNullable<
        | "Approved"
        | "NotApproved"
        | "Draft"
        | "Final"
        | "Completed"
        | "Confidential"
        | "ForPublicRelease"
        | "NotForPublicRelease"
        | "ForComment"
        | "Void"
        | "PreliminaryResults"
        | "InformationOnly"
        | "Rejected"
        | "Accepted"
        | "InitialHere"
        | "SignHere"
        | "Witness"
        | "AsIs"
        | "Departmental"
        | "Experimental"
        | "Expired"
        | "Sold"
        | "TopSecret"
        | "Revised"
        | "RejectedWithText"
        | "Custom",
    >;
    subject?: string;
    subtitle?: string;
    subTitle?: string;
    title?: string;
    type: "pspdfkit/stamp";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
    xfdfAppearanceStream?: string;
    xfdfAppearanceStreamOriginalPageRotation?: number;
}
Optional
action?: NonNullable<(CoreActionJSON | null | undefined)>
Optional
APStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>
Optional
bbox?: [left: number, top: number, width: number, height: number]
Optional
blendMode?: NonNullable<
    | "normal"
    | "multiply"
    | "screen"
    | "overlay"
    | "darken"
    | "lighten"
    | "colorDodge"
    | "colorBurn"
    | "hardLight"
    | "softLight"
    | "difference"
    | "exclusion"
    | null
    | undefined,
>
Optional
color?: string
Optional
createdAt?: NonNullable<string | Date | undefined>
Optional
creatorName?: string
Optional
customData?: Record<string, unknown>
Optional
flags?: (
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "noZoom"
    | "noRotate"
)[]
Optional
font?: string
Optional
fontColor?: string
Optional
fontSize?: number
Optional
fontStyle?: string[]
Optional
group?: string
Optional
id?: string
Optional
imageAttachmentId?: string
Optional
imageContentType?: string
Optional
imagePosition?: { align: "left" | "center" | "right"; row: number }
Optional
isAnonymous?: NonNullable<boolean | undefined>
Optional
isCommentThreadRoot?: NonNullable<boolean | undefined>
DeprecatedOptional
kind?: NonNullable<
    | "Approved"
    | "NotApproved"
    | "Draft"
    | "Final"
    | "Completed"
    | "Confidential"
    | "ForPublicRelease"
    | "NotForPublicRelease"
    | "ForComment"
    | "Void"
    | "PreliminaryResults"
    | "InformationOnly"
    | "Rejected"
    | "Accepted"
    | "InitialHere"
    | "SignHere"
    | "Witness"
    | "AsIs"
    | "Departmental"
    | "Experimental"
    | "Expired"
    | "Sold"
    | "TopSecret"
    | "Revised"
    | "RejectedWithText"
    | "Custom"
    | undefined,
>
Optional
multiline?: NonNullable<boolean | null | undefined>
Optional
name?: string
Optional
note?: string
Optional
opacity?: number
Optional
pageIndex?: number
Optional
pdfObjectId?: number
Optional
permissions?: {
    delete: boolean;
    edit: boolean;
    fill?: boolean;
    reply?: boolean;
    setGroup: boolean;
}
Optional
rotation?: number
Optional
stampType?: NonNullable<
    | "Approved"
    | "NotApproved"
    | "Draft"
    | "Final"
    | "Completed"
    | "Confidential"
    | "ForPublicRelease"
    | "NotForPublicRelease"
    | "ForComment"
    | "Void"
    | "PreliminaryResults"
    | "InformationOnly"
    | "Rejected"
    | "Accepted"
    | "InitialHere"
    | "SignHere"
    | "Witness"
    | "AsIs"
    | "Departmental"
    | "Experimental"
    | "Expired"
    | "Sold"
    | "TopSecret"
    | "Revised"
    | "RejectedWithText"
    | "Custom",
>
Optional
subject?: string
Optional
subtitle?: string
Optional
subTitle?: string
Optional
title?: string
Optional
type?: "pspdfkit/stamp"
Optional
updatedAt?: NonNullable<string | Date | undefined>
Optional
v?: number
Optional
xfdfAppearanceStream?: string
Optional
xfdfAppearanceStreamOriginalPageRotation?: number
bbox: [left: number, top: number, width: number, height: number]
color: string
id: string
pageIndex: number
type: "pspdfkit/stamp"
v: number
Type Declaration
Parameters
annotationNutrientViewer.Annotations.ImageAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    contentType?: string;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    description?: string;
    fileName?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    imageAttachmentId?: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    isSignature?: NonNullable<boolean | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    rotation?: number;
    signatureFormFieldName?: string;
    subject?: string;
    type: "pspdfkit/image";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
    xfdfAppearanceStream?: string;
    xfdfAppearanceStreamOriginalPageRotation?: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.MediaAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    contentType?: string;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    description?: string;
    fileName?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    mediaAttachmentId?: string;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    subject?: string;
    type: "pspdfkit/media";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.LinkAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    borderColor?: string;
    borderStyle?: NonNullable<
        | "solid"
        | "dashed"
        | "beveled"
        | "inset"
        | "underline"
        | null
        | undefined,
    >;
    borderWidth?: number;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    subject?: string;
    type: "pspdfkit/link";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.WidgetAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    additionalActions?: {
        [key: string]: { type: string; [key: string]: unknown } | undefined;
    };
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    backgroundColor?: string;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    borderColor?: string;
    borderDashArray?: number[];
    borderStyle?: NonNullable<
        | "solid"
        | "dashed"
        | "beveled"
        | "inset"
        | "underline"
        | null
        | undefined,
    >;
    borderWidth?: number;
    buttonIconUpdatedAt?: number;
    contentType?: string;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    font?: string;
    fontColor?: string;
    fontSize?: NonNullable<number | "auto" | null | undefined>;
    fontStyle?: string[];
    formFieldName?: string;
    group?: string;
    horizontalAlign?: NonNullable<
        "left"
        | "center"
        | "right"
        | null
        | undefined,
    >;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    lineSpacing?: number;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    rotation?: number;
    subject?: string;
    type: "pspdfkit/widget";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
    verticalAlign?: NonNullable<"center" | "top" | "bottom" | null | undefined>;
    widgetAttachmentId?: string;
}
Optional
action?: NonNullable<(CoreActionJSON | null | undefined)>
Optional
additionalActions?: { [key: string]: { type: string; [key: string]: unknown } | undefined }
Optional
APStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>
Optional
backgroundColor?: string
Optional
bbox?: [left: number, top: number, width: number, height: number]
Optional
blendMode?: NonNullable<
    | "normal"
    | "multiply"
    | "screen"
    | "overlay"
    | "darken"
    | "lighten"
    | "colorDodge"
    | "colorBurn"
    | "hardLight"
    | "softLight"
    | "difference"
    | "exclusion"
    | null
    | undefined,
>
Optional
borderColor?: string
Optional
borderDashArray?: number[]
Optional
borderStyle?: NonNullable<
    | "solid"
    | "dashed"
    | "beveled"
    | "inset"
    | "underline"
    | null
    | undefined,
>
Optional
borderWidth?: number
Optional
buttonIconUpdatedAt?: number
Optional
contentType?: string
Optional
createdAt?: NonNullable<string | Date | undefined>
Optional
creatorName?: string
Optional
customData?: Record<string, unknown>
Optional
flags?: (
    | "noView"
    | "noPrint"
    | "locked"
    | "lockedContents"
    | "readOnly"
    | "hidden"
    | "noZoom"
    | "noRotate"
)[]
Optional
font?: string
Optional
fontColor?: string
Optional
fontSize?: NonNullable<number | "auto" | null | undefined>
Optional
fontStyle?: string[]
Optional
formFieldName?: string
Optional
group?: string
Optional
horizontalAlign?: NonNullable<"left" | "center" | "right" | null | undefined>
Optional
id?: string
Optional
isAnonymous?: NonNullable<boolean | undefined>
Optional
isCommentThreadRoot?: NonNullable<boolean | undefined>
Optional
lineSpacing?: number
The spacing between lines of text in multiline text widgets, in PDF points. This is the total line height (baseline to baseline), independent of the font size.

Optional
name?: string
Optional
note?: string
Optional
opacity?: number
Optional
pageIndex?: number
Optional
pdfObjectId?: number
Optional
permissions?: {
    delete: boolean;
    edit: boolean;
    fill?: boolean;
    reply?: boolean;
    setGroup: boolean;
}
Optional
rotation?: number
Optional
subject?: string
Optional
type?: "pspdfkit/widget"
Optional
updatedAt?: NonNullable<string | Date | undefined>
Optional
v?: number
Optional
verticalAlign?: NonNullable<"center" | "top" | "bottom" | null | undefined>
Optional
widgetAttachmentId?: string
bbox: [left: number, top: number, width: number, height: number]
id: string
pageIndex: number
type: "pspdfkit/widget"
v: number
Type Declaration
Parameters
annotationMarkupAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    color?: string;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    rects?: [number, number, number, number][];
    subject?: string;
    type: NonNullable<
        | "pspdfkit/markup/highlight"
        | "pspdfkit/markup/squiggly"
        | "pspdfkit/markup/strikeout"
        | "pspdfkit/markup/underline"
        | "pspdfkit/markup/redaction",
    >;
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.RedactionAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    color?: string;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    fillColor?: string;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    fontSize?: number;
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    outlineColor?: string;
    overlayText?: string;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    rects?: [number, number, number, number][];
    repeatOverlayText?: NonNullable<boolean | null | undefined>;
    rotation?: number;
    subject?: string;
    type: "pspdfkit/markup/redaction";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.CommentMarkerAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    subject?: string;
    type: "pspdfkit/comment-marker";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationNutrientViewer.Annotations.UnknownAnnotation
Returns
{ … }{
    action?: NonNullable<(CoreActionJSON | null | undefined)>;
    APStreamCache?: NonNullable<
        { cache: string }
        | { attach: string }
        | undefined,
    >;
    bbox: [left: number, top: number, width: number, height: number];
    blendMode?: NonNullable<
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
        | null
        | undefined,
    >;
    createdAt?: NonNullable<string | Date | undefined>;
    creatorName?: string;
    customData?: Record<string, unknown>;
    flags?: (
        | "noView"
        | "noPrint"
        | "locked"
        | "lockedContents"
        | "readOnly"
        | "hidden"
        | "noZoom"
        | "noRotate"
    )[];
    group?: string;
    id: string;
    isAnonymous?: NonNullable<boolean | undefined>;
    isCommentThreadRoot?: NonNullable<boolean | undefined>;
    name?: string;
    note?: string;
    opacity?: number;
    pageIndex: number;
    pdfObjectId?: number;
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    };
    subject?: string;
    type: "pspdfkit/unknown";
    updatedAt?: NonNullable<string | Date | undefined>;
    v: number;
}
Type Declaration
Parameters
annotationAnnotationsUnion
Returns
AnnotationsBackendJSONUnion
Type Declaration
Parameters
annotationAnnotationsUnion
options{ widgetAppearanceNullKeys?: ReadonlySet<string> }
Optional
Returns
AnnotationsBackendJSONUnion

Function toSerializableObject

Type Declaration

Parameters

Returns

Type Declaration

Parameters

Returns

Type Declaration

Parameters

Returns

Type Declaration

Parameters

Returns

Type Declaration

Parameters

Returns

Type Declaration

Parameters

Returns

Type Declaration

Parameters

Returns

Optionalaction?: NonNullable<(CoreActionJSON | null | undefined)>

OptionalAPStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>

OptionalbackgroundColor?: string

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

OptionalblendMode?: NonNullable< | "normal" | "multiply" | "screen" | "overlay" | "darken" | "lighten" | "colorDodge" | "colorBurn" | "hardLight" | "softLight" | "difference" | "exclusion" | null | undefined,>

OptionalborderColor?: string

OptionalborderStyle?: NonNullable< | "solid" | "dashed" | "beveled" | "inset" | "underline" | null | undefined,>

OptionalborderWidth?: number

OptionalcreatedAt?: NonNullable<string | Date | undefined>

OptionalcreatorName?: string

OptionalcustomData?: Record<string, unknown>

Optionalflags?: ( | "noView" | "noPrint" | "locked" | "lockedContents" | "readOnly" | "hidden" | "noZoom" | "noRotate")[]

Optionalfont?: string

OptionalfontColor?: string

OptionalfontSize?: number

OptionalfontStyle?: string[]

Optionalgroup?: string

OptionalhorizontalAlign?: NonNullable<"left" | "center" | "right" | undefined>

Optionalid?: string

OptionalisAnonymous?: NonNullable<boolean | undefined>

OptionalisCommentThreadRoot?: NonNullable<boolean | undefined>

OptionalisFitting?: NonNullable<boolean | undefined>

OptionallineSpacing?: number

Optionalname?: string

Optionalnote?: string

Optionalopacity?: number

OptionalpageIndex?: number

OptionalpdfObjectId?: number

Optionalpermissions?: { delete: boolean; edit: boolean; fill?: boolean; reply?: boolean; setGroup: boolean;}

Optionalrotation?: number

Optionalsubject?: string

Optionaltext?: { format: "xhtml" | "plain"; value: string }

Optionaltype?: "pspdfkit/text"

OptionalupdatedAt?: NonNullable<string | Date | undefined>

Optionalv?: number

OptionalverticalAlign?: NonNullable<"center" | "top" | "bottom" | undefined>

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

id: string

pageIndex: number

type: "pspdfkit/text"

v: number

Type Declaration

Parameters

Returns

Type Declaration

Parameters

Returns

Optionalaction?: NonNullable<(CoreActionJSON | null | undefined)>

OptionalAPStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>

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

OptionalblendMode?: NonNullable< | "normal" | "multiply" | "screen" | "overlay" | "darken" | "lighten" | "colorDodge" | "colorBurn" | "hardLight" | "softLight" | "difference" | "exclusion" | null | undefined,>

Optionalcolor?: string

OptionalcreatedAt?: NonNullable<string | Date | undefined>

OptionalcreatorName?: string

OptionalcustomData?: Record<string, unknown>

Optionalflags?: ( | "noView" | "noPrint" | "locked" | "lockedContents" | "readOnly" | "hidden" | "noZoom" | "noRotate")[]

Optionalfont?: string

OptionalfontColor?: string

Optional
action?: NonNullable<(CoreActionJSON | null | undefined)>

Optional
APStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>

Optional
backgroundColor?: string

Optional
bbox?: [left: number, top: number, width: number, height: number]

Optional
blendMode?: NonNullable<
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion"
| null
| undefined,
>

Optional
borderColor?: string

Optional
borderStyle?: NonNullable<
| "solid"
| "dashed"
| "beveled"
| "inset"
| "underline"
| null
| undefined,
>

Optional
borderWidth?: number

Optional
createdAt?: NonNullable<string | Date | undefined>

Optional
creatorName?: string

Optional
customData?: Record<string, unknown>

Optional
flags?: (
| "noView"
| "noPrint"
| "locked"
| "lockedContents"
| "readOnly"
| "hidden"
| "noZoom"
| "noRotate"
)[]

Optional
font?: string

Optional
fontColor?: string

Optional
fontSize?: number

Optional
fontStyle?: string[]

Optional
group?: string

Optional
horizontalAlign?: NonNullable<"left" | "center" | "right" | undefined>

Optional
id?: string

Optional
isAnonymous?: NonNullable<boolean | undefined>

Optional
isCommentThreadRoot?: NonNullable<boolean | undefined>

Optional
isFitting?: NonNullable<boolean | undefined>

Optional
lineSpacing?: number

Optional
name?: string

Optional
note?: string

Optional
opacity?: number

Optional
pageIndex?: number

Optional
pdfObjectId?: number

Optional
permissions?: {
delete: boolean;
edit: boolean;
fill?: boolean;
reply?: boolean;
setGroup: boolean;
}

Optional
rotation?: number

Optional
subject?: string

Optional
text?: { format: "xhtml" | "plain"; value: string }

Optional
type?: "pspdfkit/text"

Optional
updatedAt?: NonNullable<string | Date | undefined>

Optional
v?: number

Optional
verticalAlign?: NonNullable<"center" | "top" | "bottom" | undefined>

Optional
action?: NonNullable<(CoreActionJSON | null | undefined)>

Optional
APStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>

Optional
bbox?: [left: number, top: number, width: number, height: number]

Optional
blendMode?: NonNullable<
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion"
| null
| undefined,
>

Optional
color?: string

Optional
createdAt?: NonNullable<string | Date | undefined>

Optional
creatorName?: string

Optional
customData?: Record<string, unknown>

Optional
flags?: (
| "noView"
| "noPrint"
| "locked"
| "lockedContents"
| "readOnly"
| "hidden"
| "noZoom"
| "noRotate"
)[]

Optional
font?: string

Optional
fontColor?: string

Optional
fontSize?: number

Optional
fontStyle?: string[]

Optional
group?: string

Optional
id?: string

Optional
imageAttachmentId?: string

Optional
imageContentType?: string

Optional
imagePosition?: { align: "left" | "center" | "right"; row: number }

Optional
isAnonymous?: NonNullable<boolean | undefined>

Optional
isCommentThreadRoot?: NonNullable<boolean | undefined>

Optional
multiline?: NonNullable<boolean | null | undefined>

Optional
name?: string

Optional
note?: string

Optional
opacity?: number

Optional
pageIndex?: number

Optional
pdfObjectId?: number

Optional
permissions?: {
delete: boolean;
edit: boolean;
fill?: boolean;
reply?: boolean;
setGroup: boolean;
}

Optional
rotation?: number

Optional
subject?: string

Optional
subtitle?: string

Optional
subTitle?: string

Optional
title?: string

Optional
type?: "pspdfkit/stamp"

Optional
updatedAt?: NonNullable<string | Date | undefined>

Optional
v?: number

Optional
xfdfAppearanceStream?: string

Optional
xfdfAppearanceStreamOriginalPageRotation?: number

Optional
action?: NonNullable<(CoreActionJSON | null | undefined)>

Optional
additionalActions?: { [key: string]: { type: string; [key: string]: unknown } | undefined }

Optional
APStreamCache?: NonNullable<{ cache: string } | { attach: string } | undefined>

Optional
backgroundColor?: string

Optional
bbox?: [left: number, top: number, width: number, height: number]

Optional
blendMode?: NonNullable<
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion"
| null
| undefined,
>

Optional
borderColor?: string