Nutrient Web SDK
    Preparing search index...

    Function toSerializableObject

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/ink";
          v: number;
      }

    • Parameters

      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;
          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: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/shape/line";
          v: number;
      }

    • Parameters

      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;
          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: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/shape/rectangle";
          v: number;
      }

    • Parameters

      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;
          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: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/shape/ellipse";
          v: number;
      }

    • Parameters

      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;
          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: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/shape/polygon";
          v: number;
      }

    • Parameters

      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;
          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: "in"
              | "mm"
              | "cm"
              | "pt";
              unitTo: "in" | "mm" | "cm" | "pt" | "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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/shape/polyline";
          v: number;
      }

    • Parameters

      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>;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/text";
          v: number;
      }

      • 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
      • Optionalcallout?: {
            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];
        }
      • 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

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

      • 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

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/note";
          v: number;
      }

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          color: string;
          id: string;
          pageIndex: number;
          type: "pspdfkit/stamp";
          v: number;
      }

      • 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
      • OptionalfontSize?: number
      • OptionalfontStyle?: string[]
      • Optionalgroup?: string
      • Optionalid?: string
      • OptionalimageAttachmentId?: string
      • OptionalimageContentType?: string
      • OptionalimagePosition?: { align: "left" | "center" | "right"; row: number }
      • OptionalisAnonymous?: NonNullable<boolean | undefined>
      • OptionalisCommentThreadRoot?: NonNullable<boolean | undefined>
      • Optionalkind?: 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,
        >
      • Optionalmultiline?: NonNullable<boolean | null | undefined>
      • Optionalname?: string
      • Optionalnote?: string
      • Optionalopacity?: number
      • OptionalpageIndex?: number
      • OptionalpdfObjectId?: number
      • Optionalpermissions?: {
            delete: boolean;
            edit: boolean;
            fill?: boolean;
            reply?: boolean;
            setGroup: boolean;
        }
      • Optionalrotation?: number
      • OptionalstampType?: 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",
        >
      • Optionalsubject?: string
      • Optionalsubtitle?: string
      • OptionalsubTitle?: string
      • Optionaltitle?: string
      • Optionaltype?: "pspdfkit/stamp"
      • OptionalupdatedAt?: NonNullable<string | Date | undefined>
      • Optionalv?: number
      • OptionalxfdfAppearanceStream?: string
      • OptionalxfdfAppearanceStreamOriginalPageRotation?: number
      • bbox: [left: number, top: number, width: number, height: number]
      • color: string
      • id: string
      • pageIndex: number
      • type: "pspdfkit/stamp"
      • v: number

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/image";
          v: number;
      }

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/media";
          v: number;
      }

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/link";
          v: number;
      }

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/widget";
          v: number;
      }

      • Optionalaction?: NonNullable<(CoreActionJSON | null | undefined)>
      • OptionaladditionalActions?: { [key: string]: { type: string; [key: string]: unknown } | 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
      • OptionalborderDashArray?: number[]
      • OptionalborderStyle?: NonNullable<
            | "solid"
            | "dashed"
            | "beveled"
            | "inset"
            | "underline"
            | null
            | undefined,
        >
      • OptionalborderWidth?: number
      • OptionalbuttonIconUpdatedAt?: number
      • OptionalcontentType?: 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
      • OptionalfontSize?: NonNullable<number | "auto" | null | undefined>
      • OptionalfontStyle?: string[]
      • OptionalformFieldName?: string
      • Optionalgroup?: string
      • OptionalhorizontalAlign?: NonNullable<"left" | "center" | "right" | null | undefined>
      • Optionalid?: string
      • OptionalisAnonymous?: NonNullable<boolean | undefined>
      • OptionalisCommentThreadRoot?: NonNullable<boolean | undefined>
      • OptionallineSpacing?: 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.

      • 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
      • Optionaltype?: "pspdfkit/widget"
      • OptionalupdatedAt?: NonNullable<string | Date | undefined>
      • Optionalv?: number
      • OptionalverticalAlign?: NonNullable<"center" | "top" | "bottom" | null | undefined>
      • OptionalwidgetAttachmentId?: string
      • bbox: [left: number, top: number, width: number, height: number]
      • id: string
      • pageIndex: number
      • type: "pspdfkit/widget"
      • v: number

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: NonNullable<
              | "pspdfkit/markup/highlight"
              | "pspdfkit/markup/squiggly"
              | "pspdfkit/markup/strikeout"
              | "pspdfkit/markup/underline"
              | "pspdfkit/markup/redaction",
          >;
          v: number;
      }

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/markup/redaction";
          v: number;
      }

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/comment-marker";
          v: number;
      }

    • Parameters

      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;
      } & {
          bbox: [left: number, top: number, width: number, height: number];
          id: string;
          pageIndex: number;
          type: "pspdfkit/unknown";
          v: number;
      }

    • Parameters

      Returns AnnotationsBackendJSONUnion

    • Parameters

      Returns AnnotationsBackendJSONUnion

    Settings

    Member Visibility