PDF Web Viewer
    Preparing search index...

    Interface IDocumentModel

    Represents an open PDF document and provides methods for manipulation.

    Extends IDocumentCommandsBase which contains all command methods (addPage, deletePage, etc.).

    const doc = result.ui.pdfWebService.documentModel;
    console.log(doc.name, doc.id);
    await doc.drawPage({ pageIndex: 0, dpr: 2 });
    interface IDocumentModel {
        acroforms: any[];
        attachments: any[];
        author?: string;
        bookmarks: any;
        bookmarksCount: number;
        createDate?: Date;
        creator?: string;
        fonts?: IOpenFileResponseFonts;
        hasRedo: boolean;
        hasUndo: boolean;
        id: string;
        isModified: boolean;
        isReadOnly: boolean;
        isSigned: boolean;
        keywords: string[];
        layers: any[];
        modifyDate?: Date;
        name: string;
        onBookmarksChanged: Observable<void>;
        onCommandExecuted: Observable<
            { claims: string; id: string; name: string; result: any },
        >;
        onCommandExecuting: Observable<
            { claims: string; id: string; name: string },
        >;
        onCommandFailed: Observable<
            {
                claims: string;
                error: any;
                errorMessage: string;
                id: string;
                name: string;
            },
        >;
        onIsModifiedChanged: Observable<boolean>;
        onPageChanged: Observable<
            { boxes: [number, number, number, number][]; index: number },
        >;
        onPagesChanged: Observable<void>;
        onReadOnlyChanged: Observable<boolean>;
        onUndoRedoChanged: Observable<IDocumentHistory>;
        pageDirection: PDPageDirection;
        pageLayout?: PageLayout;
        pageMode?: PageMode;
        permissions: string;
        producer?: string;
        security: IDocumentSecurity;
        signatures: any[];
        size: number;
        subject?: string;
        title?: string;
        undoRedoHistory: IDocumentHistory;
        addAttachment(data: IAddAttachmentData): Promise<IUndoResponse>;
        addBookmark(data: IAddBookmarkData): Promise<IUndoResponse>;
        applyRedactions(): Promise<IUndoResponse>;
        autoOrderAnnotation(data: IAutoOrderAnnotationData): Promise<IUndoResponse>;
        bookmarkAddAfter(
            pageIndex: number,
            parentIndex: number[],
            title?: string,
        ): Promise<IUndoResponse>;
        bookmarkAddBefore(
            pageIndex: number,
            parentIndex: number[],
            title?: string,
        ): Promise<IUndoResponse>;
        bookmarkAddChild(
            pageIndex: number,
            parentIndex: number[],
            title?: string,
        ): Promise<IUndoResponse>;
        bringBackTextBlocks(data: IChangeTextBlockZOrder): Promise<IUndoResponse>;
        bringBackwardTextBlocks(
            data: IChangeTextBlockZOrder,
        ): Promise<IUndoResponse>;
        bringForwardTextBlocks(
            data: IChangeTextBlockZOrder,
        ): Promise<IUndoResponse>;
        bringFrontTextBlocks(data: IChangeTextBlockZOrder): Promise<IUndoResponse>;
        canChangeAnnotZOrder(data: ICanChangeAnnotZOrderData): Promise<any>;
        canChangeElementZOrder(data: ICanChangeElementZOrderData): Promise<any>;
        canChangeTextBlockZOrder(data: IChangeTextBlockZOrder): Promise<any>;
        changeAcroformValue(data: IChangeAcroformValueData): Promise<IUndoResponse>;
        changeAnnotationProperties(
            annotIndex: number,
            pageIndex: number,
            properties: any,
            type: AnnotsTypes,
        ): Promise<IChangeAnnotationPropertiesResponse>;
        changeAnnotationProperties(
            data: IChangeAnnotationPropertiesData,
            type: AnnotsTypes,
        ): Promise<IChangeAnnotationPropertiesResponse>;
        changeAnnotOrder(data: IChangeAnnotOrderData): Promise<IUndoResponse>;
        changeDocName(name: string): void;
        changeDocumentHistory(
            data: IChangeDocumentHistoryData,
        ): Promise<IUndoResponse>;
        changeDocumentProperties(
            data: IChangePropertiesData,
        ): Promise<IUndoResponse>;
        changeElementMatrix(data: IChangeElementMatrixData): Promise<IUndoResponse>;
        changeElementOrder(data: IChangeElementOrderData): Promise<IUndoResponse>;
        changeFontAttributes(
            data: IChangeFontAttributesData,
        ): Promise<IUndoResponse>;
        changeListStyle(data: IChangeListStyleData): Promise<IUndoResponse>;
        changePagesBackground(data: ISetBackgroundData): Promise<IUndoResponse>;
        changePagesMargin(data: IChangeMarginData): Promise<IUndoResponse>;
        changeParaAttrs(data: IChangeParaAttrsData): Promise<IUndoResponse>;
        changeTextBlockZOrder(
            data: IChangeTextBlockZOrderData,
        ): Promise<IUndoResponse>;
        clearDocumentHistory(): Promise<IUndoResponse>;
        compress(mode: PDOptSaveImageQuality): Promise<Uint8Array<ArrayBufferLike>>;
        convertToImages(dpi?: number): Promise<File>;
        convertToText(pageSeparator?: string): Promise<File>;
        copyContentElement(data: ICopyContentElementData): Promise<any>;
        copyTextBlock(data: ICopyTextBlockData): Promise<any>;
        createAnnotation(
            data: ICreateAnnotationUnifiedData,
        ): Promise<IUndoResponse>;
        createClip(data: ICreateClipData): Promise<IUndoResponse>;
        createMeasurementCalibration(
            data: ICreateMeasurementCalibrationData,
        ): Promise<any>;
        createTextBlock(data: ICreateTextBlockData): Promise<IUndoResponse>;
        createWidgetAnnotation(
            data: ICreateWidgetAnnotationData,
        ): Promise<IUndoResponse>;
        cropImage(data: ICropImageData): Promise<IUndoResponse>;
        deleteAllBookmarks(): Promise<IUndoResponse>;
        deleteAnnotations(data: IDeleteAnnotationData): Promise<IUndoResponse>;
        deleteAttachment(data: IDeleteAttachmentData): Promise<IUndoResponse>;
        deleteBatesNumbering(): Promise<IUndoResponse>;
        deleteBookmark(data: IDeleteBookmarkData): Promise<IUndoResponse>;
        deleteClip(data: IDeleteClipData): Promise<IUndoResponse>;
        deleteContentElements(
            data: IDeleteContentElementData,
        ): Promise<IUndoResponse>;
        deleteHeader(data: IDeleteHeaderData): Promise<IUndoResponse>;
        deletePageNumber(data: IDeletePageNumberData): Promise<IUndoResponse>;
        deletePages(data: IDeletePagesData): Promise<IUndoResponse>;
        deleteTextBlocks(data: IDeleteTextBlockData): Promise<IUndoResponse>;
        deleteWatermark(data: IDeleteWatermarkData): Promise<IUndoResponse>;
        dispose(): Promise<void>;
        documentExportStampAppearance(
            data: IExportAppearanceStampData,
        ): Promise<any>;
        doTransactionAsync(action: Observable<any>): Promise<void>;
        editPageText(data: IEditPageTextData): Promise<IUndoResponse>;
        editTextParagraphs(data: IEditTextParagraphs): Promise<IUndoResponse>;
        exportAcroformsFdfData(): Promise<any>;
        exportAllAttachments(): Promise<Uint8Array<ArrayBufferLike>>;
        exportAttachment(
            attachmentIndex: number,
        ): Promise<Uint8Array<ArrayBufferLike>>;
        exportComments(): Promise<any>;
        exportDocument(
            params: IExportFileFromWorkerParams,
        ): Promise<IExportFileResponse>;
        exportFillSignAsset(data: IExportFillSignSignAsset): Promise<any>;
        extractImage(data: IExtractImageData): Promise<any>;
        extractImages(data: IExtractImagesData): Promise<any>;
        extractPages(data: IExtractData): Promise<any>;
        fillSignCreate(data: IFillSignCreateData): Promise<IUndoResponse>;
        fillSignDelete(data: IFillSignDeleteData): Promise<IUndoResponse>;
        fillSignUpdate(data: IFillSignPatchData): Promise<IUndoResponse>;
        forgetContentElement(data: IForgetContentElementData): Promise<string>;
        getMeasurementViewports(data: IGetMeasurementViewportsData): Promise<any>;
        getNumPages(): number;
        getPage(index: number): PageModel;
        getPageContentBox(
            pageIndex: number,
        ): Promise<[number, number, number, number]>;
        getPageIndex(page: any): number;
        getPagePreview(data: IDrawPageData): Promise<Readonly<IDrawPageResponse>>;
        getPages(): PageModel[];
        getTextAsTable(data: Readonly<IGetTextAsTableData>): Promise<any>;
        importAcroformsFdfData(data: File): Promise<IUndoResponse>;
        insertBatesNumbering(
            data: IInsertBatesNumberingData,
        ): Promise<IUndoResponse>;
        insertBlankPages(data: IInsertBlankPagesData): Promise<IUndoResponse>;
        insertChar(data: IInsertCharData): Promise<IUndoResponse>;
        insertDuplicatePages(
            data: IInsertDuplicatePagesData,
        ): Promise<IUndoResponse>;
        insertHeader(data: IInsertHeaderData): Promise<IUndoResponse>;
        insertImageContentElement(data: IInsertImageData): Promise<IUndoResponse>;
        insertPageNumber(data: IInsertPageNumberData): Promise<IUndoResponse>;
        insertPagesFromFile(data: IInsertPagesFromFileData): Promise<IUndoResponse>;
        insertWatermark(data: IInsertWatermarkData): Promise<IUndoResponse>;
        isDocPermittedForESign(checkDocSecurity: boolean): boolean;
        isOperationPermitted(obj: BLPermReqObj, op: BLPermReqOp): boolean;
        listDocumentClaims(): Promise<string[]>;
        loadPageContent(page: PageModel): Promise<void>;
        moveBookmark(data: IMoveBookmarkData): Promise<IUndoResponse>;
        movePages(data: IMovePagesData): Promise<IUndoResponse>;
        orderAnnotation(data: IOrderAnnotationData): Promise<IUndoResponse>;
        ownerAuthorization(password: string): Promise<IDocumentSecurity>;
        pasteContentElement(data: IPasteContentElementData): Promise<IUndoResponse>;
        pasteTextBlock(data: IPasteTextBlockData): Promise<IUndoResponse>;
        patchBookmark(data: IBookmarkRequestData): Promise<IUndoResponse>;
        redo(): Promise<IUndoResponse>;
        removeMetadata(): Promise<Uint8Array<ArrayBufferLike>>;
        replaceText(data: IReplaceTextData): Promise<IUndoResponse>;
        replaceWithBlankPages(
            data: IReplaceWithBlankPagesData,
        ): Promise<IUndoResponse>;
        replaceWithDuplicatePages(
            data: IReplaceWithDuplicatePagesData,
        ): Promise<IUndoResponse>;
        replaceWithPagesFromFile(
            data: IReplaceWithPagesFromFileData,
        ): Promise<IUndoResponse>;
        resetAcroformsFdfData(): Promise<IUndoResponse>;
        resizePages(data: IChangeSizeData): Promise<IUndoResponse>;
        reversePage(data: IReversePages): Promise<IUndoResponse>;
        rotatePages(data: IRotatePagesData): Promise<IUndoResponse>;
        sanitize(): Promise<Uint8Array<ArrayBufferLike>>;
        saveAttachment(data: ISaveAttachmentData): Promise<IUndoResponse>;
        setOCGroupState(data: IChangeLayerStateData): Promise<IUndoResponse>;
        setReadOnly(readOnly: boolean): void;
        setSecurityPermissions(
            data: ISecuritySaveSettingsData,
        ): Promise<IUndoResponse>;
        transformClip(data: ITransformClipData): Promise<IUndoResponse>;
        transformContent(data: IDeskewData): Promise<IUndoResponse>;
        transformTextBlock(data: ITransformTextBlockData): Promise<IUndoResponse>;
        undo(): Promise<IUndoResponse>;
        updateLayerStates(data: any): void;
        whiteoutPage(data: IDoWhiteoutData): Promise<IUndoResponse>;
    }

    Hierarchy

    • IDocumentCommandsBase
      • IDocumentModel
    Index

    Properties

    acroforms attachments author? bookmarks bookmarksCount createDate? creator? fonts? hasRedo hasUndo id isModified isReadOnly isSigned keywords layers modifyDate? name onBookmarksChanged onCommandExecuted onCommandExecuting onCommandFailed onIsModifiedChanged onPageChanged onPagesChanged onReadOnlyChanged onUndoRedoChanged pageDirection pageLayout? pageMode? permissions producer? security signatures size subject? title? undoRedoHistory

    Methods

    addAttachment addBookmark applyRedactions autoOrderAnnotation bookmarkAddAfter bookmarkAddBefore bookmarkAddChild bringBackTextBlocks bringBackwardTextBlocks bringForwardTextBlocks bringFrontTextBlocks canChangeAnnotZOrder canChangeElementZOrder canChangeTextBlockZOrder changeAcroformValue changeAnnotationProperties changeAnnotOrder changeDocName changeDocumentHistory changeDocumentProperties changeElementMatrix changeElementOrder changeFontAttributes changeListStyle changePagesBackground changePagesMargin changeParaAttrs changeTextBlockZOrder clearDocumentHistory compress convertToImages convertToText copyContentElement copyTextBlock createAnnotation createClip createMeasurementCalibration createTextBlock createWidgetAnnotation cropImage deleteAllBookmarks deleteAnnotations deleteAttachment deleteBatesNumbering deleteBookmark deleteClip deleteContentElements deleteHeader deletePageNumber deletePages deleteTextBlocks deleteWatermark dispose documentExportStampAppearance doTransactionAsync editPageText editTextParagraphs exportAcroformsFdfData exportAllAttachments exportAttachment exportComments exportDocument exportFillSignAsset extractImage extractImages extractPages fillSignCreate fillSignDelete fillSignUpdate forgetContentElement getMeasurementViewports getNumPages getPage getPageContentBox getPageIndex getPagePreview getPages getTextAsTable importAcroformsFdfData insertBatesNumbering insertBlankPages insertChar insertDuplicatePages insertHeader insertImageContentElement insertPageNumber insertPagesFromFile insertWatermark isDocPermittedForESign isOperationPermitted listDocumentClaims loadPageContent moveBookmark movePages orderAnnotation ownerAuthorization pasteContentElement pasteTextBlock patchBookmark redo removeMetadata replaceText replaceWithBlankPages replaceWithDuplicatePages replaceWithPagesFromFile resetAcroformsFdfData resizePages reversePage rotatePages sanitize saveAttachment setOCGroupState setReadOnly setSecurityPermissions transformClip transformContent transformTextBlock undo updateLayerStates whiteoutPage

    Properties

    acroforms: any[]

    AcroForm fields.

    attachments: any[]

    File attachments.

    author?: string

    Document author.

    bookmarks: any

    Bookmarks/outlines tree.

    bookmarksCount: number

    Number of bookmarks.

    createDate?: Date

    Document creation date.

    creator?: string

    Application that created the document.

    fonts?: IOpenFileResponseFonts

    Document and system fonts.

    hasRedo: boolean

    True if redo is available.

    hasUndo: boolean

    True if undo is available.

    id: string

    Unique identifier for this document instance.

    isModified: boolean

    Whether the document has unsaved changes.

    isReadOnly: boolean

    Whether the document is in read-only mode (no editing allowed).

    isSigned: boolean

    Whether the document has digital signatures.

    keywords: string[]

    Document keywords.

    layers: any[]

    Optional content layers.

    modifyDate?: Date

    Document last modification date.

    name: string

    Filename of the document.

    onBookmarksChanged: Observable<void>

    Fires when bookmarks change.

    onCommandExecuted: Observable<
        { claims: string; id: string; name: string; result: any },
    >

    Fires after a command completes successfully.

    onCommandExecuting: Observable<{ claims: string; id: string; name: string }>

    Fires before a command starts executing.

    onCommandFailed: Observable<
        {
            claims: string;
            error: any;
            errorMessage: string;
            id: string;
            name: string;
        },
    >

    Fires when a command fails.

    onIsModifiedChanged: Observable<boolean>

    Fires when document modification state changes.

    onPageChanged: Observable<
        { boxes: [number, number, number, number][]; index: number },
    >

    Fires when a specific page is modified.

    onPagesChanged: Observable<void>

    Fires when page structure changes (add/delete).

    onReadOnlyChanged: Observable<boolean>

    Fires when read-only state changes.

    onUndoRedoChanged: Observable<IDocumentHistory>

    Fires when undo/redo state changes.

    pageDirection: PDPageDirection

    Page reading direction (LTR or RTL).

    pageLayout?: PageLayout

    PDF page layout (single page, continuous, etc.).

    pageMode?: PageMode

    PDF page mode (thumbnails, outlines, etc.).

    permissions: string

    Permission flags as string.

    producer?: string

    PDF producer string.

    security: IDocumentSecurity

    Document security settings (encryption, passwords).

    signatures: any[]

    Digital signatures.

    size: number

    File size in bytes.

    subject?: string

    Document subject.

    title?: string

    Document title.

    undoRedoHistory: IDocumentHistory

    Undo/redo history state.

    Methods

    • Parameters

      • data: IAddAttachmentData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IAddBookmarkData

      Returns Promise<IUndoResponse>

    • Returns Promise<IUndoResponse>

    • Parameters

      • data: IAutoOrderAnnotationData

      Returns Promise<IUndoResponse>

    • Parameters

      • pageIndex: number
      • parentIndex: number[]
      • Optionaltitle: string

      Returns Promise<IUndoResponse>

    • Parameters

      • pageIndex: number
      • parentIndex: number[]
      • Optionaltitle: string

      Returns Promise<IUndoResponse>

    • Parameters

      • pageIndex: number
      • parentIndex: number[]
      • Optionaltitle: string

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeTextBlockZOrder

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeTextBlockZOrder

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeTextBlockZOrder

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeTextBlockZOrder

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ICanChangeAnnotZOrderData

      Returns Promise<any>

    • Parameters

      • data: ICanChangeElementZOrderData

      Returns Promise<any>

    • Parameters

      • data: IChangeTextBlockZOrder

      Returns Promise<any>

    • Parameters

      • data: IChangeAcroformValueData

      Returns Promise<IUndoResponse>

    • Parameters

      • annotIndex: number
      • pageIndex: number
      • properties: any
      • type: AnnotsTypes

      Returns Promise<IChangeAnnotationPropertiesResponse>

    • Parameters

      Returns Promise<IChangeAnnotationPropertiesResponse>

    • Parameters

      • data: IChangeAnnotOrderData

      Returns Promise<IUndoResponse>

    • Parameters

      • name: string

      Returns void

    • Parameters

      • data: IChangeDocumentHistoryData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangePropertiesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeElementMatrixData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeElementOrderData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeFontAttributesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeListStyleData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ISetBackgroundData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeMarginData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeParaAttrsData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeTextBlockZOrderData

      Returns Promise<IUndoResponse>

    • Returns Promise<IUndoResponse>

    • Compresses the document by optimizing images and removing unnecessary data. Requires owner password authorization if the document has owner-level restrictions.

      Parameters

      • mode: PDOptSaveImageQuality

        The compression quality mode

      Returns Promise<Uint8Array<ArrayBufferLike>>

      Promise resolving to compressed document as Uint8Array

      If owner password is required but not provided.

    • Converts all pages of the document to PNG images and packages them into a ZIP file. Requires owner password authorization if the document has owner-level restrictions.

      Parameters

      • Optionaldpi: number

        Scaling factor for image resolution (default: 1). - 1 = standard resolution (96 DPI equivalent) - 2 = high resolution (192 DPI equivalent, retina displays) - 3 = very high resolution (288 DPI equivalent) Higher values produce sharper images but larger file sizes.

      Returns Promise<File>

      Promise resolving to a File object containing a ZIP archive with all page images named as {documentName}_Page_{N}.png

      If owner password is required but not provided.

      // Standard resolution (default)
      const zipFile = await document.convertToImages();

      // Explicit standard resolution
      const zipFile = await document.convertToImages(1);

      // High resolution for retina displays
      const zipFileHD = await document.convertToImages(2);

    • Extracts all text content from the document and returns it as a plain text file. Text is extracted from all pages with proper spacing and page separators. Requires owner password authorization if the document has owner-level restrictions.

      Parameters

      • OptionalpageSeparator: string

        Optional separator string between pages (default: '------------------------------')

      Returns Promise<File>

      Promise resolving to a File object containing all extracted text as {documentName}.txt

      If owner password is required but not provided.

      // Extract text with default separator
      const textFile = await document.convertToText();

      // Extract text with custom separator
      const textFile = await document.convertToText('--- Page Break ---');

    • Parameters

      • data: ICopyContentElementData

      Returns Promise<any>

    • Parameters

      • data: ICopyTextBlockData

      Returns Promise<any>

    • Parameters

      • data: ICreateAnnotationUnifiedData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ICreateClipData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ICreateMeasurementCalibrationData

      Returns Promise<any>

    • Parameters

      • data: ICreateTextBlockData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ICreateWidgetAnnotationData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ICropImageData

      Returns Promise<IUndoResponse>

    • Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteAnnotationData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteAttachmentData

      Returns Promise<IUndoResponse>

    • Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteBookmarkData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteClipData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteContentElementData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteHeaderData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeletePageNumberData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeletePagesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteTextBlockData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeleteWatermarkData

      Returns Promise<IUndoResponse>

    • Returns Promise<void>

    • Parameters

      • data: IExportAppearanceStampData

      Returns Promise<any>

    • Parameters

      • action: Observable<any>

      Returns Promise<void>

    • Parameters

      • data: IEditPageTextData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IEditTextParagraphs

      Returns Promise<IUndoResponse>

    • Returns Promise<any>

    • Returns Promise<Uint8Array<ArrayBufferLike>>

    • Parameters

      • attachmentIndex: number

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Returns Promise<any>

    • Parameters

      • params: IExportFileFromWorkerParams

      Returns Promise<IExportFileResponse>

    • Parameters

      • data: IExportFillSignSignAsset

      Returns Promise<any>

    • Extracts a single image from the document. Requires owner password authorization if the document has owner-level restrictions.

      Parameters

      • data: IExtractImageData

        Image extraction parameters

      Returns Promise<any>

      Promise resolving to extracted image data

      If owner password is required but not provided.

    • Extracts multiple images from the document. Requires owner password authorization if the document has owner-level restrictions.

      Parameters

      • data: IExtractImagesData

        Image extraction parameters

      Returns Promise<any>

      Promise resolving to extracted images data

      If owner password is required but not provided.

    • Extracts specific pages from the document as a new PDF. Requires owner password authorization if the document has owner-level restrictions.

      Parameters

      • data: IExtractData

        Page extraction parameters

      Returns Promise<any>

      Promise resolving to extracted pages data

      If owner password is required but not provided.

    • Parameters

      • data: IFillSignCreateData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IFillSignDeleteData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IFillSignPatchData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IForgetContentElementData

      Returns Promise<string>

    • Parameters

      • data: IGetMeasurementViewportsData

      Returns Promise<any>

    • Returns number

    • Parameters

      • index: number

      Returns PageModel

    • Parameters

      • pageIndex: number

      Returns Promise<[number, number, number, number]>

    • Parameters

      • page: any

      Returns number

    • Parameters

      • data: IDrawPageData

      Returns Promise<Readonly<IDrawPageResponse>>

    • Returns PageModel[]

    • Parameters

      • data: Readonly<IGetTextAsTableData>

      Returns Promise<any>

    • Parameters

      • data: File

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertBatesNumberingData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertBlankPagesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertCharData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertDuplicatePagesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertHeaderData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertImageData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertPageNumberData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertPagesFromFileData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IInsertWatermarkData

      Returns Promise<IUndoResponse>

    • Parameters

      • checkDocSecurity: boolean

      Returns boolean

    • Parameters

      • obj: BLPermReqObj
      • op: BLPermReqOp

      Returns boolean

    • Returns Promise<string[]>

    • Parameters

      • page: PageModel

      Returns Promise<void>

    • Parameters

      • data: IMoveBookmarkData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IMovePagesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IOrderAnnotationData

      Returns Promise<IUndoResponse>

    • Parameters

      • password: string

      Returns Promise<IDocumentSecurity>

    • Parameters

      • data: IPasteContentElementData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IPasteTextBlockData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IBookmarkRequestData

      Returns Promise<IUndoResponse>

    • Returns Promise<IUndoResponse>

    • Removes metadata and document information from the PDF. Requires owner password authorization if the document has owner-level restrictions.

      Returns Promise<Uint8Array<ArrayBufferLike>>

      Promise resolving to document without metadata as Uint8Array

      If owner password is required but not provided.

    • Parameters

      • data: IReplaceTextData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IReplaceWithBlankPagesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IReplaceWithDuplicatePagesData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IReplaceWithPagesFromFileData

      Returns Promise<IUndoResponse>

    • Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeSizeData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IReversePages

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IRotatePagesData

      Returns Promise<IUndoResponse>

    • Sanitizes the document by removing hidden content, metadata, attachments, and other sensitive data. Requires owner password authorization if the document has owner-level restrictions.

      Returns Promise<Uint8Array<ArrayBufferLike>>

      Promise resolving to sanitized document as Uint8Array

      If owner password is required but not provided.

    • Parameters

      • data: ISaveAttachmentData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IChangeLayerStateData

      Returns Promise<IUndoResponse>

    • Sets the document to read-only mode, preventing all editing operations.

      Parameters

      • readOnly: boolean

      Returns void

    • Parameters

      • data: ISecuritySaveSettingsData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ITransformClipData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: IDeskewData

      Returns Promise<IUndoResponse>

    • Parameters

      • data: ITransformTextBlockData

      Returns Promise<IUndoResponse>

    • Returns Promise<IUndoResponse>

    • Parameters

      • data: any

      Returns void

    • Parameters

      • data: IDoWhiteoutData

      Returns Promise<IUndoResponse>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    addAttachmentaddBookmarkapplyRedactionsautoOrderAnnotationbookmarkAddAfterbookmarkAddBeforebookmarkAddChildbringBackTextBlocksbringBackwardTextBlocksbringForwardTextBlocksbringFrontTextBlockscanChangeAnnotZOrdercanChangeElementZOrdercanChangeTextBlockZOrderchangeAcroformValuechangeAnnotationPropertieschangeAnnotOrderchangeDocNamechangeDocumentHistorychangeDocumentPropertieschangeElementMatrixchangeElementOrderchangeFontAttributeschangeListStylechangePagesBackgroundchangePagesMarginchangeParaAttrschangeTextBlockZOrderclearDocumentHistorycompressconvertToImagesconvertToTextcopyContentElementcopyTextBlockcreateAnnotationcreateClipcreateMeasurementCalibrationcreateTextBlockcreateWidgetAnnotationcropImagedeleteAllBookmarksdeleteAnnotationsdeleteAttachmentdeleteBatesNumberingdeleteBookmarkdeleteClipdeleteContentElementsdeleteHeaderdeletePageNumberdeletePagesdeleteTextBlocksdeleteWatermarkdisposedocumentExportStampAppearancedoTransactionAsynceditPageTexteditTextParagraphsexportAcroformsFdfDataexportAllAttachmentsexportAttachmentexportCommentsexportDocumentexportFillSignAssetextractImageextractImagesextractPagesfillSignCreatefillSignDeletefillSignUpdateforgetContentElementgetMeasurementViewportsgetNumPagesgetPagegetPageContentBoxgetPageIndexgetPagePreviewgetPagesgetTextAsTableimportAcroformsFdfDatainsertBatesNumberinginsertBlankPagesinsertCharinsertDuplicatePagesinsertHeaderinsertImageContentElementinsertPageNumberinsertPagesFromFileinsertWatermarkisDocPermittedForESignisOperationPermittedlistDocumentClaimsloadPageContentmoveBookmarkmovePagesorderAnnotationownerAuthorizationpasteContentElementpasteTextBlockpatchBookmarkredoremoveMetadatareplaceTextreplaceWithBlankPagesreplaceWithDuplicatePagesreplaceWithPagesFromFileresetAcroformsFdfDataresizePagesreversePagerotatePagessanitizesaveAttachmentsetOCGroupStatesetReadOnlysetSecurityPermissionstransformCliptransformContenttransformTextBlockundoupdateLayerStateswhiteoutPage