Interface IPdfEditor

Interface for PDF editing operations

This interface provides methods to interact with PDF documents including:

File operations (open, save, close)
Document manipulation (pages, bookmarks, annotations)
Text and image content editing
Security settings
Metadata manipulation

interface IPdfEditor {
    addAttachment(
        documentId: string,
        data: Readonly<IAddAttachmentData>,
    ): ResponseBase<IAddAttachmentResponse>;
    addBookmark(
        documentId: string,
        data: Readonly<IBookmarkRequestData>,
    ): ResponseBase<IAddBookmarkResponse>;
    addCustomSystemFonts(
        documentId: string,
        data: readonly ICustomSystemFonts[],
    ): Promise<Uint8Array<ArrayBufferLike>>;
    autoOrderAnnotation(
        documentId: string,
        data: Readonly<IAutoOrderAnnotationData>,
    ): ResponseBase<IUndoResponse>;
    beginTransaction(
        body: Readonly<IBeginTransactionData>,
    ): ResponseBase<string>;
    bookmarks(documentId: string): ResponseBase<IBookmarksResponse>;
    cancelTransaction(documentId: string): ResponseBase<IUndoResponse>;
    canChangeAnnotZOrder(
        documentId: string,
        data: Readonly<ICanChangeAnnotZOrderData>,
    ): ResponseBase<ICanChangeAnnotZOrderResponse>;
    canChangeElementZOrder(
        documentId: string,
        data: Readonly<ICanChangeElementZOrderData>,
    ): ResponseBase<ICanChangeElementZOrderResponse>;
    canChangeTextBlockZOrder(
        documentId: string,
        data: Readonly<IChangeTextBlockZOrder>,
    ): ResponseBase<ICanChangeTextBlockZOrderResponse>;
    changeAcroformValue(
        documentId: string,
        data: Readonly<IChangeAcroformValueData>,
    ): ResponseBase<IUndoResponse>;
    changeAnnotationProperties(
        documentId: string,
        data: Readonly<IChangeAnnotationPropertiesData>,
    ): ResponseBase<IChangeAnnotationPropertiesResponse>;
    changeAnnotOrder(
        documentId: string,
        data: Readonly<IChangeAnnotOrderData>,
    ): ResponseBase<IUndoResponse>;
    changeDocumentHistory(
        documentId: string,
        data: Readonly<IChangeDocumentHistoryData>,
    ): ResponseBase<Readonly<IUndoResponse>>;
    changeElementMatrix(
        documentId: string,
        data: Readonly<IChangeElementMatrixData>,
    ): ResponseBase<IChangeElementMatrixResponse>;
    changeElementOrder(
        documentId: string,
        data: Readonly<IChangeElementOrderData>,
    ): ResponseBase<IUndoResponse>;
    changeFontAttributes(
        documentId: string,
        data: Readonly<IChangeFontAttrsWorkerData>,
    ): ResponseBase<Readonly<ITextBlocksResponse>>;
    changeLayerState(
        documentId: string,
        data: Readonly<IChangeLayerStateData>,
    ): ResponseBase<IChangeLayerStateResponse>;
    changeListStyle(
        documentId: string,
        data: Readonly<IChangeListStyleData>,
    ): ResponseBase<Readonly<ITextBlocksResponse>>;
    changeMargin(
        documentId: string,
        body: Readonly<IChangeMarginData>,
    ): ResponseBase<IUndoResponse>;
    changePagesBoxes(
        documentId: string,
        body: Readonly<IChangePagesBoxesData>,
    ): ResponseBase<IUndoResponse>;
    changeParaAttrs(
        documentId: string,
        data: Readonly<IChangeParaAttrsData>,
    ): ResponseBase<Readonly<ITextBlocksResponse>>;
    changeProperties(
        documentId: string,
        body: Readonly<IChangePropertiesData>,
    ): ResponseBase<IUndoResponse>;
    changeTextBlockZOrder(
        documentId: string,
        data: Readonly<IChangeTextBlockZOrderData>,
    ): ResponseBase<ITextBlocksResponse>;
    clearAllSignatures(
        params: Readonly<{ documentId: string }>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    clearDocumentHistory(documentId: string): ResponseBase<string>;
    closeFile(documentId: string): ResponseBase<ICloseFilesResponse>;
    copyContentElement(
        documentId: string,
        data: Readonly<ICopyContentElementData>,
    ): ResponseBase<ICopyContentElementResponse>;
    copyTextBlock(
        documentId: string,
        data: Readonly<ICopyTextBlockData>,
    ): ResponseBase<ICopyTextBlockResponse>;
    createAnnotation(
        documentId: string,
        body: Readonly<ICreateAnnotationUnifiedData>,
    ): ResponseBase<ICreateAnnotationUnifiedResponse>;
    createClip(
        documentId: string,
        body: Readonly<ICreateClipData>,
    ): ResponseBase<ICreateClipResponse>;
    createFillSign(
        documentId: string,
        body: Readonly<IFillSignCreateData>,
    ): ResponseBase<IFillSignCreateResponse>;
    createMeasurementCalibration(
        documentId: string,
        data: Readonly<ICreateMeasurementCalibrationData>,
    ): ResponseBase<IUndoResponse>;
    createTextBlock(
        documentId: string,
        data: Readonly<ICreateTextBlockData>,
    ): ResponseBase<ITextBlocksResponse>;
    cropImage(
        documentId: string,
        body: Readonly<ICropImageData>,
    ): ResponseBase<ICropImageResponse>;
    deleteAnnotations(
        documentId: string,
        body: Readonly<IDeleteAnnotsWorkerData>,
    ): ResponseBase<IUndoResponse>;
    deleteAttachment(
        documentId: string,
        data: Readonly<IDeleteAttachmentData>,
    ): ResponseBase<IUndoResponse>;
    deleteBatesNumbering(documentId: string): ResponseBase<IUndoResponse>;
    deleteBookmark(
        documentId: string,
        data: Readonly<IDeleteBookmarkData>,
    ): ResponseBase<IUndoResponse>;
    deleteBookmarkAll(documentId: string): ResponseBase<IUndoResponse>;
    deleteClip(
        documentId: string,
        body: Readonly<IDeleteClipData>,
    ): ResponseBase<IDeleteClipResponse>;
    deleteContentElements(
        documentId: string,
        data: Readonly<IDeleteContentElementData>,
    ): ResponseBase<IUndoResponse>;
    deleteFillSign(
        documentId: string,
        body: Readonly<IFillSignDeleteData>,
    ): ResponseBase<IPatchFillSignResponse>;
    deleteHeader(
        documentId: string,
        body: Readonly<IDeleteHeaderData>,
    ): ResponseBase<IUndoResponse>;
    deletePageNumber(
        documentId: string,
        body: Readonly<IDeletePageNumberData>,
    ): ResponseBase<IUndoResponse>;
    deleteText(
        documentId: string,
        data: Readonly<IDeleteCharsRangeData>,
    ): ResponseBase<Readonly<ITextBlocksResponse>>;
    deleteTextBlocks(
        documentId: string,
        data: Readonly<IDeleteTextBlockData>,
    ): ResponseBase<IDeleteTextBlockResponse>;
    deleteWatermark(
        documentId: string,
        body: Readonly<IDeleteWatermarkData>,
    ): ResponseBase<IUndoResponse>;
    deskew(
        documentId: string,
        data: Readonly<IDeskewData>,
    ): ResponseBase<IDeskewDataResponse>;
    doWhiteout(
        documentId: string,
        data: Readonly<IDoWhiteoutData>,
    ): ResponseBase<IDoWhiteoutResponse>;
    downloadSignedVersion(
        documentId: string,
        data: Readonly<IDownloadSignedVersionData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    drawPage(
        documentId: string,
        data: Readonly<IDrawPageData>,
    ): ResponseBase<IDrawPageResponse>;
    editPageText(
        documentId: string,
        data: Readonly<IEditPageTextData>,
    ): ResponseBase<ITextBlocksResponse>;
    editTextParagraphs(
        documentId: string,
        data: Readonly<IEditTextParagraphs>,
    ): ResponseBase<ITextBlocksResponse>;
    endTransaction(documentId: string): ResponseBase<IUndoResponse>;
    exportAcroformsFdfData(
        documentId: string,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    exportComments(
        documentId: string,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    exportFile(
        documentId: string,
        data: Readonly<IExportFileFromWorkerParams>,
    ): ResponseBase<IExportFileResponse>;
    exportFillSignSignAsset(
        documentId: string,
        data: Readonly<IExportFillSignSignAsset>,
    ): ResponseBase<Blob>;
    exportStampAppearance(
        documentId: string,
        data: Readonly<IExportAppearanceStampData>,
    ): ResponseBase<string>;
    extractAllAttachments(
        documentId: string,
    ): ResponseBase<{ data: Uint8Array; filename: string }[]>;
    extractAttachment(
        documentId: string,
        data: Readonly<IExtractAttachmentData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    extractImage(
        documentId: string,
        data: Readonly<IExtractImageData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    extractImages(
        documentId: string,
        data: Readonly<IExtractImagesData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    extractPages(
        documentId: string,
        data: Readonly<IExtractData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    findArtifacts(
        body: Readonly<IFindArtifactsData>,
    ): ResponseBase<IFindArtifactsResponse>;
    flattenAnnotation(
        documentId: string,
        data: Readonly<IFlattenAnnotData>,
    ): ResponseBase<IUndoResponse>;
    forgetContentElement(
        documentId: string,
        data: Readonly<IForgetContentElementData>,
    ): ResponseBase<string>;
    getAcroforms(body: Readonly<IGetAcroformsData>): ResponseBase<IFormField[]>;
    getContent(
        data: Readonly<IGetPageContentData>,
    ): ResponseBase<IGetContentResponse>;
    getDocumentAnnotations(
        params: Readonly<IDocumentAnnotationsData>,
    ): Promise<IOpenFileAnnotation[]>;
    getDocumentHistory(documentId: string): ResponseBase<IDocumentHistory>;
    getDocumentInfo(
        params: Readonly<IDocumentInfoData>,
    ): ResponseBase<IDocumentInfoResponse>;
    getDocumentPermissions(
        params: Readonly<{ documentId: string }>,
    ): ResponseBase<{ permissions: string }>;
    getDocumentSecurity(
        params: Readonly<{ documentId: string }>,
    ): ResponseBase<IDocumentSecurity>;
    getMeasurementViewports(
        documentId: string,
        data: Readonly<IGetMeasurementViewportsData>,
    ): ResponseBase<IGetMeasurementViewportsResponse>;
    getPageAnnotations(
        params: Readonly<IGetPageContentData>,
    ): ResponseBase<IGetContentDataAnnotation[]>;
    getPageContent(
        params: Readonly<IGetPageContentData>,
    ): ResponseBase<IListContentResponse>;
    getPageFillSign(
        params: Readonly<IGetPageContentData>,
    ): ResponseBase<IFillSignField[]>;
    getPageText(
        body: Readonly<IGetPageContentData>,
    ): ResponseBase<ITextBlocksDataResponse>;
    getTextAsTable(
        documentId: string,
        data: Readonly<IGetTextAsTableData>,
    ): ResponseBase<ITextAsTableResponse>;
    importAcroformsFdfData(
        documentId: string,
        file: File,
    ): ResponseBase<IUndoResponse>;
    insertBatesNumbering(
        documentId: string,
        data: Readonly<IInsertBatesNumberingData>,
    ): ResponseBase<IUndoResponse>;
    insertChar(
        documentId: string,
        data: Readonly<IInsertCharData>,
    ): ResponseBase<Readonly<ITextBlocksResponse>>;
    insertHeader(
        documentId: string,
        body: Readonly<IInsertHeaderData>,
    ): ResponseBase<IUndoResponse>;
    insertImage(
        documentId: string,
        data: Readonly<IInsertImageData>,
    ): ResponseBase<IInsertImageResponse>;
    insertPageNumber(
        documentId: string,
        body: Readonly<IInsertPageNumberData>,
    ): ResponseBase<IUndoResponse>;
    insertWatermark(
        documentId: string,
        body: Readonly<IInsertWatermarkData>,
    ): ResponseBase<IUndoResponse>;
    listAttachments(
        body: Readonly<IAttachmentData>,
    ): ResponseBase<IAttachment[]>;
    listDocumentClaims(documentId: string): Promise<string[]>;
    listFonts(documentId?: string): Promise<IFontMini[]>;
    loadCustomSystemFont(
        documentId: string,
        data: Uint8Array,
    ): ResponseBase<ILoadCustomSystemFontResponse[]>;
    mergeTextBlocks(
        documentId: string,
        data: Readonly<IMergeTextBlocksData>,
    ): ResponseBase<ITextBlocksResponse>;
    moveBookmark(
        documentId: string,
        data: Readonly<IMoveBookmarkData>,
    ): ResponseBase<IUndoResponse>;
    openBlank(
        body: Readonly<ICreateNewDocumentData>,
    ): ResponseBase<IFileDataResponse>;
    openByFile(data: Readonly<IFileDataFile>): ResponseBase<IFileDataResponse>;
    orderAnnotation(
        documentId: string,
        data: Readonly<IOrderAnnotationData>,
    ): ResponseBase<IUndoResponse>;
    pasteContentElement(
        documentId: string,
        data: Readonly<IPasteContentElementData>,
    ): ResponseBase<IPasteContentElementResponse>;
    pasteTextBlock(
        documentId: string,
        data: Readonly<IPasteTextBlockData>,
    ): ResponseBase<ITextBlocksResponse>;
    patchBookmark(
        documentId: string,
        data: Readonly<IBookmarkRequestData>,
    ): ResponseBase<IAddBookmarkResponse>;
    patchFillSign(
        documentId: string,
        body: Readonly<IFillSignPatchData>,
    ): ResponseBase<IPatchFillSignResponse>;
    previewBatesNumbering(
        body: Readonly<IPreviewBatesNumberingData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    previewHeader(
        body: Readonly<IPreviewHeaderData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    previewWatermark(
        body: Readonly<IPreviewWatermarkData>,
    ): ResponseBase<Uint8Array<ArrayBufferLike>>;
    registerUserFonts(fonts: IUserFontData): void;
    replaceDocument(documentId: string, file: File): Promise<void>;
    replacePagesWorker(
        documentId: string,
        workerData: IReplacePagesWorkerData,
    ): ResponseBase<IUndoResponse>;
    replaceText(
        documentId: string,
        data: Readonly<IReplaceTextData>,
    ): ResponseBase<Readonly<ITextBlocksResponse>>;
    resetAcroformsFdfData(documentId: string): ResponseBase<IUndoResponse>;
    resizePages(
        documentId: string,
        body: Readonly<IChangeSizeData>,
    ): ResponseBase<IUndoResponse>;
    reversePage(
        documentId: string,
        data: Readonly<IReversePages>,
    ): ResponseBase<IUndoResponse>;
    rotatePages(
        documentId: string,
        params: Readonly<IRotatePagesData>,
    ): ResponseBase<IUndoResponse>;
    saveAttachment(
        documentId: string,
        data: Readonly<ISaveAttachmentData>,
    ): ResponseBase<ISaveAttachmentResponse>;
    saveOptimized(
        documentId: string,
        data: Readonly<ISaveOptimizedData>,
    ): Promise<Uint8Array<ArrayBufferLike>>;
    securityApplyRedactions(documentId: string): ResponseBase<IUndoResponse>;
    securityOwnerAuthorization(
        body: Readonly<ISecurityOwnerAuthorizationData>,
    ): ResponseBase<IDocumentPermissionsResponse>;
    securitySaveSettings(
        documentId: string,
        body: Readonly<ISecuritySaveSettingsData>,
    ): ResponseBase<ISecuritySaveSettingsResponse>;
    setBackground(
        documentId: string,
        body: Readonly<ISetBackgroundData>,
    ): ResponseBase<IUndoResponse>;
    transformClip(
        documentId: string,
        body: Readonly<ITransformClipData>,
    ): ResponseBase<ITransformClipResponse>;
    transformTextBlock(
        documentId: string,
        data: Readonly<ITransformTextBlockData>,
    ): ResponseBase<ITextBlocksResponse>;
}

Index

Methods

addAttachment addBookmark addCustomSystemFonts autoOrderAnnotation beginTransaction bookmarks cancelTransaction canChangeAnnotZOrder canChangeElementZOrder canChangeTextBlockZOrder changeAcroformValue changeAnnotationProperties changeAnnotOrder changeDocumentHistory changeElementMatrix changeElementOrder changeFontAttributes changeLayerState changeListStyle changeMargin changePagesBoxes changeParaAttrs changeProperties changeTextBlockZOrder clearAllSignatures clearDocumentHistory closeFile copyContentElement copyTextBlock createAnnotation createClip createFillSign createMeasurementCalibration createTextBlock cropImage deleteAnnotations deleteAttachment deleteBatesNumbering deleteBookmark deleteBookmarkAll deleteClip deleteContentElements deleteFillSign deleteHeader deletePageNumber deleteText deleteTextBlocks deleteWatermark deskew doWhiteout downloadSignedVersion drawPage editPageText editTextParagraphs endTransaction exportAcroformsFdfData exportComments exportFile exportFillSignSignAsset exportStampAppearance extractAllAttachments extractAttachment extractImage extractImages extractPages findArtifacts flattenAnnotation forgetContentElement getAcroforms getContent getDocumentAnnotations getDocumentHistory getDocumentInfo getDocumentPermissions getDocumentSecurity getMeasurementViewports getPageAnnotations getPageContent getPageFillSign getPageText getTextAsTable importAcroformsFdfData insertBatesNumbering insertChar insertHeader insertImage insertPageNumber insertWatermark listAttachments listDocumentClaims listFonts loadCustomSystemFont mergeTextBlocks moveBookmark openBlank openByFile orderAnnotation pasteContentElement pasteTextBlock patchBookmark patchFillSign previewBatesNumbering previewHeader previewWatermark registerUserFonts replaceDocument replacePagesWorker replaceText resetAcroformsFdfData resizePages reversePage rotatePages saveAttachment saveOptimized securityApplyRedactions securityOwnerAuthorization securitySaveSettings setBackground transformClip transformTextBlock

Methods

addAttachment

addAttachment(
documentId: string,
data: Readonly<IAddAttachmentData>,
): ResponseBase<IAddAttachmentResponse>
Adds an attachment to the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IAddAttachmentData>
  Attachment data to add
Returns ResponseBase<IAddAttachmentResponse>
Response with the added attachment information

addBookmark

addBookmark(
documentId: string,
data: Readonly<IBookmarkRequestData>,
): ResponseBase<IAddBookmarkResponse>
Adds a new bookmark to the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IBookmarkRequestData>
  Bookmark configuration data
Returns ResponseBase<IAddBookmarkResponse>
Response with the added bookmark information

addCustomSystemFonts

addCustomSystemFonts(
documentId: string,
data: readonly ICustomSystemFonts[],
): Promise<Uint8Array<ArrayBufferLike>>
Adds multiple custom system fonts
Parameters
- documentId: string
  The document ID
- data: readonly ICustomSystemFonts[]
  Array of custom system font configurations
Returns Promise<Uint8Array<ArrayBufferLike>>
Response indicating the operation result

autoOrderAnnotation

autoOrderAnnotation(
documentId: string,
data: Readonly<IAutoOrderAnnotationData>,
): ResponseBase<IUndoResponse>
Automatically orders annotations based on predefined rules
Parameters
- documentId: string
  The document ID
- data: Readonly<IAutoOrderAnnotationData>
  Configuration for automatic annotation ordering
Returns ResponseBase<IUndoResponse>
Response with the auto-ordering result

beginTransaction

beginTransaction(body: Readonly<IBeginTransactionData>): ResponseBase<string>
Begins a transaction for grouping multiple operations
Parameters
- body: Readonly<IBeginTransactionData>
  Transaction configuration data
Returns ResponseBase<string>
Response with the transaction initialization result

bookmarks

bookmarks(documentId: string): ResponseBase<IBookmarksResponse>
Gets all bookmarks in the document
Parameters
- documentId: string
  The ID of the document to get bookmarks from
Returns ResponseBase<IBookmarksResponse>
Response with the bookmarks data

cancelTransaction

cancelTransaction(documentId: string): ResponseBase<IUndoResponse>
Cancels a transaction, discarding all changes made during it
Parameters
- documentId: string
  The document ID
Returns ResponseBase<IUndoResponse>
Response with the cancellation result

canChangeAnnotZOrder

canChangeAnnotZOrder(
documentId: string,
data: Readonly<ICanChangeAnnotZOrderData>,
): ResponseBase<ICanChangeAnnotZOrderResponse>
Checks if the order of an annotation can be changed
Parameters
- documentId: string
  The document ID
- data: Readonly<ICanChangeAnnotZOrderData>
  Data specifying which annotation to check
Returns ResponseBase<ICanChangeAnnotZOrderResponse>
Response indicating if order can be changed

canChangeElementZOrder

canChangeElementZOrder(
documentId: string,
data: Readonly<ICanChangeElementZOrderData>,
): ResponseBase<ICanChangeElementZOrderResponse>
Checks if the order of an element can be changed
Parameters
- documentId: string
  The document ID
- data: Readonly<ICanChangeElementZOrderData>
  Data specifying which element to check
Returns ResponseBase<ICanChangeElementZOrderResponse>
Response indicating if order can be changed

canChangeTextBlockZOrder

canChangeTextBlockZOrder(
documentId: string,
data: Readonly<IChangeTextBlockZOrder>,
): ResponseBase<ICanChangeTextBlockZOrderResponse>
Checks if the Z-order of text blocks can be changed
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeTextBlockZOrder>
  Data specifying which text blocks to check
Returns ResponseBase<ICanChangeTextBlockZOrderResponse>
Response indicating if order can be changed

changeAcroformValue

changeAcroformValue(
documentId: string,
data: Readonly<IChangeAcroformValueData>,
): ResponseBase<IUndoResponse>
Changes the value of a form field in an AcroForm
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeAcroformValueData>
  Data containing the field value change
Returns ResponseBase<IUndoResponse>
Response with the form field change result

changeAnnotationProperties

changeAnnotationProperties(
documentId: string,
data: Readonly<IChangeAnnotationPropertiesData>,
): ResponseBase<IChangeAnnotationPropertiesResponse>
Modifies properties of an existing annotation
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeAnnotationPropertiesData>
  Data containing the annotation properties to change
Returns ResponseBase<IChangeAnnotationPropertiesResponse>
Response with the result of the property change

changeAnnotOrder

changeAnnotOrder(
documentId: string,
data: Readonly<IChangeAnnotOrderData>,
): ResponseBase<IUndoResponse>
Changes the Z-order of an annotation
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeAnnotOrderData>
  Data specifying the annotation and order change
Returns ResponseBase<IUndoResponse>
Response with the order change result

changeDocumentHistory

changeDocumentHistory(
documentId: string,
data: Readonly<IChangeDocumentHistoryData>,
): ResponseBase<Readonly<IUndoResponse>>
Changes the document history by undoing or redoing actions
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeDocumentHistoryData>
  Data specifying the document ID and history offset
Returns ResponseBase<Readonly<IUndoResponse>>
Response with the result of the change document history operation

changeElementMatrix

changeElementMatrix(
documentId: string,
data: Readonly<IChangeElementMatrixData>,
): ResponseBase<IChangeElementMatrixResponse>
Modifies the transformation matrix of an element
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeElementMatrixData>
  Data containing the element and new matrix
Returns ResponseBase<IChangeElementMatrixResponse>
Response with the matrix change result

changeElementOrder

changeElementOrder(
documentId: string,
data: Readonly<IChangeElementOrderData>,
): ResponseBase<IUndoResponse>
Changes the Z-order of an element
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeElementOrderData>
  Data specifying the element and order change
Returns ResponseBase<IUndoResponse>
Response with the order change result

changeFontAttributes

changeFontAttributes(
documentId: string,
data: Readonly<IChangeFontAttrsWorkerData>,
): ResponseBase<Readonly<ITextBlocksResponse>>
Changes font attributes for text in the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeFontAttrsWorkerData>
  Data specifying the page index and font attributes to change
Returns ResponseBase<Readonly<ITextBlocksResponse>>
Response with the response containing the updated text blocks

changeLayerState

changeLayerState(
documentId: string,
data: Readonly<IChangeLayerStateData>,
): ResponseBase<IChangeLayerStateResponse>
Changes the visibility state of document layers
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeLayerStateData>
  Layer state change data
Returns ResponseBase<IChangeLayerStateResponse>
Response with the updated layer groups

changeListStyle

changeListStyle(
documentId: string,
data: Readonly<IChangeListStyleData>,
): ResponseBase<Readonly<ITextBlocksResponse>>
Changes the list style for text in the document
Parameters
- documentId: string
  Document identifier
- data: Readonly<IChangeListStyleData>
  Data specifying the page index, text block index, and list style to change
Returns ResponseBase<Readonly<ITextBlocksResponse>>
Response with the response containing the updated text blocks

changeMargin

changeMargin(
documentId: string,
body: Readonly<IChangeMarginData>,
): ResponseBase<IUndoResponse>
Changes the margin settings for a document or page
Parameters
- documentId: string
  The document ID
- body: Readonly<IChangeMarginData>
  Margin configuration data
Returns ResponseBase<IUndoResponse>
Response with the margin change result

changePagesBoxes

changePagesBoxes(
documentId: string,
body: Readonly<IChangePagesBoxesData>,
): ResponseBase<IUndoResponse>
Changes the page boxes in a document
Parameters
- documentId: string
  The document ID
- body: Readonly<IChangePagesBoxesData>
  Data specifying the new page boxes
Returns ResponseBase<IUndoResponse>
Response with the page box change result

changeParaAttrs

changeParaAttrs(
documentId: string,
data: Readonly<IChangeParaAttrsData>,
): ResponseBase<Readonly<ITextBlocksResponse>>
Changes paragraph attributes for text in the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeParaAttrsData>
  Data specifying the page index and paragraph attributes to change
Returns ResponseBase<Readonly<ITextBlocksResponse>>
Response with the response containing the updated text blocks

changeProperties

changeProperties(
documentId: string,
body: Readonly<IChangePropertiesData>,
): ResponseBase<IUndoResponse>
Changes document properties (metadata)
Parameters
- documentId: string
  The document ID
- body: Readonly<IChangePropertiesData>
  Updated properties data
Returns ResponseBase<IUndoResponse>
Response with the property change result

changeTextBlockZOrder

changeTextBlockZOrder(
documentId: string,
data: Readonly<IChangeTextBlockZOrderData>,
): ResponseBase<ITextBlocksResponse>
Changes the Z-order of text blocks
Parameters
- documentId: string
  The document ID
- data: Readonly<IChangeTextBlockZOrderData>
  Data specifying which text blocks to move and how
Returns ResponseBase<ITextBlocksResponse>
Response with the Z-order change result

clearAllSignatures

clearAllSignatures(
params: Readonly<{ documentId: string }>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Removes all signatures from the specified document
Parameters
- params: Readonly<{ documentId: string }>
  Object containing the document ID to clear signatures from
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with information about the cleared signatures

clearDocumentHistory

clearDocumentHistory(documentId: string): ResponseBase<string>
Clears the document history (undo/redo stack)
Parameters
- documentId: string
  The document ID
Returns ResponseBase<string>
Response with "OK" status

closeFile

closeFile(documentId: string): ResponseBase<ICloseFilesResponse>
Closes open PDF document
Parameters
- documentId: string
  The document ID
Returns ResponseBase<ICloseFilesResponse>
Response indicating the result of the close operation

copyContentElement

copyContentElement(
documentId: string,
data: Readonly<ICopyContentElementData>,
): ResponseBase<ICopyContentElementResponse>
Copies a content element for later pasting
Parameters
- documentId: string
  The document ID
- data: Readonly<ICopyContentElementData>
  Data specifying which content element to copy
Returns ResponseBase<ICopyContentElementResponse>
Response with the copy operation result

copyTextBlock

copyTextBlock(
documentId: string,
data: Readonly<ICopyTextBlockData>,
): ResponseBase<ICopyTextBlockResponse>
Copies a text block for later pasting
Parameters
- documentId: string
  The document ID
- data: Readonly<ICopyTextBlockData>
  Data specifying which text block to copy
Returns ResponseBase<ICopyTextBlockResponse>
Response with the copy operation result

createAnnotation

createAnnotation(
documentId: string,
body: Readonly<ICreateAnnotationUnifiedData>,
): ResponseBase<ICreateAnnotationUnifiedResponse>
Creates a new annotation in the document
Parameters
- documentId: string
  The document ID
- body: Readonly<ICreateAnnotationUnifiedData>
  Configuration data for the annotation to create
Returns ResponseBase<ICreateAnnotationUnifiedResponse>
Response with the created annotation information

createClip

createClip(
documentId: string,
body: Readonly<ICreateClipData>,
): ResponseBase<ICreateClipResponse>
Creates a clip (masked area) in the document
Parameters
- documentId: string
  The document ID
- body: Readonly<ICreateClipData>
  Clip configuration data
Returns ResponseBase<ICreateClipResponse>
Response with the created clip information

createFillSign

createFillSign(
documentId: string,
body: Readonly<IFillSignCreateData>,
): ResponseBase<IFillSignCreateResponse>
Creates a fill and sign field in the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IFillSignCreateData>
  Fill and sign field configuration
Returns ResponseBase<IFillSignCreateResponse>
Response with the created field information

createMeasurementCalibration

createMeasurementCalibration(
documentId: string,
data: Readonly<ICreateMeasurementCalibrationData>,
): ResponseBase<IUndoResponse>
Creates a measurement calibration for the document
Parameters
- documentId: string
  The document ID
- data: Readonly<ICreateMeasurementCalibrationData>
Returns ResponseBase<IUndoResponse>
Response with the calibration creation result

createTextBlock

createTextBlock(
documentId: string,
data: Readonly<ICreateTextBlockData>,
): ResponseBase<ITextBlocksResponse>
Creates a new text block in the PDF document
Parameters
- documentId: string
- data: Readonly<ICreateTextBlockData>
Returns ResponseBase<ITextBlocksResponse>
Response with the created text block information

cropImage

cropImage(
documentId: string,
body: Readonly<ICropImageData>,
): ResponseBase<ICropImageResponse>
Crops an image in the document
Parameters
- documentId: string
  The document ID
- body: Readonly<ICropImageData>
  Crop configuration data
Returns ResponseBase<ICropImageResponse>
Response with the crop operation result

deleteAnnotations

deleteAnnotations(
documentId: string,
body: Readonly<IDeleteAnnotsWorkerData>,
): ResponseBase<IUndoResponse>
Deletes annotations from the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IDeleteAnnotsWorkerData>
  Data specifying which annotations to delete
Returns ResponseBase<IUndoResponse>
Response with the result of the delete operation

deleteAttachment

deleteAttachment(
documentId: string,
data: Readonly<IDeleteAttachmentData>,
): ResponseBase<IUndoResponse>
Deletes an attachment from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IDeleteAttachmentData>
  Data specifying which attachment to delete
Returns ResponseBase<IUndoResponse>
Response with the deletion result

deleteBatesNumbering

deleteBatesNumbering(documentId: string): ResponseBase<IUndoResponse>
Removes Bates numbering from the document
Parameters
- documentId: string
  The document ID
Returns ResponseBase<IUndoResponse>
Response with the removal result

deleteBookmark

deleteBookmark(
documentId: string,
data: Readonly<IDeleteBookmarkData>,
): ResponseBase<IUndoResponse>
Deletes a bookmark from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IDeleteBookmarkData>
  Data specifying which bookmark to delete
Returns ResponseBase<IUndoResponse>
Response with the deletion result

deleteBookmarkAll

deleteBookmarkAll(documentId: string): ResponseBase<IUndoResponse>
Deletes all bookmarks from the document
Parameters
- documentId: string
  The document ID
Returns ResponseBase<IUndoResponse>
Response with the deletion result

deleteClip

deleteClip(
documentId: string,
body: Readonly<IDeleteClipData>,
): ResponseBase<IDeleteClipResponse>
Deletes a clip from the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IDeleteClipData>
  Data specifying which clip to delete
Returns ResponseBase<IDeleteClipResponse>
Response with the deletion result

deleteContentElements

deleteContentElements(
documentId: string,
data: Readonly<IDeleteContentElementData>,
): ResponseBase<IUndoResponse>
Deletes content elements from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IDeleteContentElementData>
  Data specifying which content elements to delete
Returns ResponseBase<IUndoResponse>
Response with the deletion operation result

deleteFillSign

deleteFillSign(
documentId: string,
body: Readonly<IFillSignDeleteData>,
): ResponseBase<IPatchFillSignResponse>
Deletes a fill and sign field
Parameters
- documentId: string
  The document ID
- body: Readonly<IFillSignDeleteData>
  Data specifying which field to delete
Returns ResponseBase<IPatchFillSignResponse>
Response with the deletion result

deleteHeader

deleteHeader(
documentId: string,
body: Readonly<IDeleteHeaderData>,
): ResponseBase<IUndoResponse>
Removes a header from the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IDeleteHeaderData>
  Data specifying which header to delete
Returns ResponseBase<IUndoResponse>
Response with the header deletion result

deletePageNumber

deletePageNumber(
documentId: string,
body: Readonly<IDeletePageNumberData>,
): ResponseBase<IUndoResponse>
Removes page numbers from the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IDeletePageNumberData>
  Data specifying which page numbers to delete
Returns ResponseBase<IUndoResponse>
Response with the page number deletion result

deleteText

deleteText(
documentId: string,
data: Readonly<IDeleteCharsRangeData>,
): ResponseBase<Readonly<ITextBlocksResponse>>
Deletes a range of characters from the text content
Parameters
- documentId: string
  Document identifier
- data: Readonly<IDeleteCharsRangeData>
  Data specifying the page index, text block index, and character range to delete
Returns ResponseBase<Readonly<ITextBlocksResponse>>
Response with the response containing the updated text blocks

deleteTextBlocks

deleteTextBlocks(
documentId: string,
data: Readonly<IDeleteTextBlockData>,
): ResponseBase<IDeleteTextBlockResponse>
Deletes text blocks from the document
Parameters
- documentId: string
  The ID of the document to delete text blocks from
- data: Readonly<IDeleteTextBlockData>
  Data specifying which text blocks to delete
Returns ResponseBase<IDeleteTextBlockResponse>
Response with the result of the delete operation

deleteWatermark

deleteWatermark(
documentId: string,
body: Readonly<IDeleteWatermarkData>,
): ResponseBase<IUndoResponse>
Removes a watermark from the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IDeleteWatermarkData>
  Data specifying which watermark to delete
Returns ResponseBase<IUndoResponse>
Response with the watermark deletion result

deskew

deskew(
documentId: string,
data: Readonly<IDeskewData>,
): ResponseBase<IDeskewDataResponse>
Automatically corrects skewed (angled) pages in the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IDeskewData>
  Deskew configuration data
Returns ResponseBase<IDeskewDataResponse>
Response with the deskew operation result

doWhiteout

doWhiteout(
documentId: string,
data: Readonly<IDoWhiteoutData>,
): ResponseBase<IDoWhiteoutResponse>
Applies a whiteout effect to an area of the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IDoWhiteoutData>
  Whiteout configuration data
Returns ResponseBase<IDoWhiteoutResponse>
Response with the whiteout operation result

downloadSignedVersion

downloadSignedVersion(
documentId: string,
data: Readonly<IDownloadSignedVersionData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Parameters
- documentId: string
- data: Readonly<IDownloadSignedVersionData>
Returns ResponseBase<Uint8Array<ArrayBufferLike>>

drawPage

drawPage(
documentId: string,
data: Readonly<IDrawPageData>,
): ResponseBase<IDrawPageResponse>
Renders a specific page from the PDF document
Parameters
- documentId: string
  Document identifier
- data: Readonly<IDrawPageData>
  Object containing rendering parameters including document ID and page index
Returns ResponseBase<IDrawPageResponse>
Response with the rendered page data

editPageText

editPageText(
documentId: string,
data: Readonly<IEditPageTextData>,
): ResponseBase<ITextBlocksResponse>
Edits existing text content in the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IEditPageTextData>
  Data containing the text changes to apply
Returns ResponseBase<ITextBlocksResponse>
Response with the result of the text edit operation

editTextParagraphs

editTextParagraphs(
documentId: string,
data: Readonly<IEditTextParagraphs>,
): ResponseBase<ITextBlocksResponse>
Edits text paragraphs in the document
Parameters
- documentId: string
  Document identifier
- data: Readonly<IEditTextParagraphs>
  Configuration for paragraph text editing
Returns ResponseBase<ITextBlocksResponse>
Response with the result of the paragraph edit operation

endTransaction

endTransaction(documentId: string): ResponseBase<IUndoResponse>
Ends a previously started transaction
Parameters
- documentId: string
  The document ID
Returns ResponseBase<IUndoResponse>
Response with the transaction completion result

exportAcroformsFdfData

exportAcroformsFdfData(
documentId: string,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Exports AcroForms data in FDF format
Parameters
- documentId: string
  The document ID
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with the exported FDF data

exportComments

exportComments(documentId: string): ResponseBase<Uint8Array<ArrayBufferLike>>
Exports comments from the document
Parameters
- documentId: string
  The document ID
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with the exported comments

exportFile

exportFile(
documentId: string,
data: Readonly<IExportFileFromWorkerParams>,
): ResponseBase<IExportFileResponse>
Exports a file from the worker
Parameters
- documentId: string
  The document ID
- data: Readonly<IExportFileFromWorkerParams>
  Data including name, file type, and export type
Returns ResponseBase<IExportFileResponse>
Response with the exported file, blob, uint8array, or arraybuffer

exportFillSignSignAsset

exportFillSignSignAsset(
documentId: string,
data: Readonly<IExportFillSignSignAsset>,
): ResponseBase<Blob>
Exports a signature asset for fill and sign
Parameters
- documentId: string
  The document ID
- data: Readonly<IExportFillSignSignAsset>
  Data specifying which signature to export
Returns ResponseBase<Blob>
Response with the exported signature as a Blob

exportStampAppearance

exportStampAppearance(
documentId: string,
data: Readonly<IExportAppearanceStampData>,
): ResponseBase<string>
Exports the appearance of a stamp annotation
Parameters
- documentId: string
  The document ID
- data: Readonly<IExportAppearanceStampData>
Returns ResponseBase<string>
Response with the exported stamp appearance as a string

extractAllAttachments

extractAllAttachments(
documentId: string,
): ResponseBase<{ data: Uint8Array; filename: string }[]>
Extracts all attachments from the document
Parameters
- documentId: string
  The document ID
Returns ResponseBase<{ data: Uint8Array; filename: string }[]>
Response with all extracted attachment data

extractAttachment

extractAttachment(
documentId: string,
data: Readonly<IExtractAttachmentData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Extracts an attachment from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IExtractAttachmentData>
  Data specifying which attachment to extract
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with the extracted attachment data

extractImage

extractImage(
documentId: string,
data: Readonly<IExtractImageData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Extracts a single image from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IExtractImageData>
  Data specifying which image to extract
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response indicating the extraction result

extractImages

extractImages(
documentId: string,
data: Readonly<IExtractImagesData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Extracts multiple images from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IExtractImagesData>
  Data specifying which images to extract
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response indicating the extraction result

extractPages

extractPages(
documentId: string,
data: Readonly<IExtractData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Extracts pages from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IExtractData>
  Data specifying which pages to extract
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with the extracted pages data

findArtifacts

findArtifacts(
body: Readonly<IFindArtifactsData>,
): ResponseBase<IFindArtifactsResponse>
Searches for artifacts (unwanted elements) in the document
Parameters
- body: Readonly<IFindArtifactsData>
  Search configuration data
Returns ResponseBase<IFindArtifactsResponse>
Response with the found artifacts

flattenAnnotation

flattenAnnotation(
documentId: string,
data: Readonly<IFlattenAnnotData>,
): ResponseBase<IUndoResponse>
Flattens an annotation, converting it into page content
Parameters
- documentId: string
  The document ID
- data: Readonly<IFlattenAnnotData>
  Data specifying which annotation to flatten
Returns ResponseBase<IUndoResponse>
Response with the result of the flatten operation

forgetContentElement

forgetContentElement(
documentId: string,
data: Readonly<IForgetContentElementData>,
): ResponseBase<string>
Removes content element data from memory (clipboard)
Parameters
- documentId: string
  The document ID
- data: Readonly<IForgetContentElementData>
  Data specifying which content element to forget
Returns ResponseBase<string>
Response with the operation result

getAcroforms

getAcroforms(body: Readonly<IGetAcroformsData>): ResponseBase<IFormField[]>
Gets all form fields (AcroForms) in the document
Parameters
- body: Readonly<IGetAcroformsData>
  Data specifying which document to get form fields from
Returns ResponseBase<IFormField[]>
Response with the form fields information

getContent

getContent(
data: Readonly<IGetPageContentData>,
): ResponseBase<IGetContentResponse>
Gets content data from specified pages in the document
Parameters
- data: Readonly<IGetPageContentData>
  Object specifying document ID, page range, and content options
Returns ResponseBase<IGetContentResponse>
Response containing the requested content data

getDocumentAnnotations

getDocumentAnnotations(
params: Readonly<IDocumentAnnotationsData>,
): Promise<IOpenFileAnnotation[]>
Retrieves annotations from a PDF document in short format
Parameters
- params: Readonly<IDocumentAnnotationsData>
  Data specifying which document to get information for
Returns Promise<IOpenFileAnnotation[]>
Response containing the document annotations

getDocumentHistory

getDocumentHistory(documentId: string): ResponseBase<IDocumentHistory>
Gets the current document history (undo/redo state)
Parameters
- documentId: string
  The document ID
Returns ResponseBase<IDocumentHistory>
Response with the document history

getDocumentInfo

getDocumentInfo(
params: Readonly<IDocumentInfoData>,
): ResponseBase<IDocumentInfoResponse>
Retrieves metadata and information about a PDF document
Parameters
- params: Readonly<IDocumentInfoData>
  Data specifying which document to get information for
Returns ResponseBase<IDocumentInfoResponse>
Response containing the document information

getDocumentPermissions

getDocumentPermissions(
params: Readonly<{ documentId: string }>,
): ResponseBase<{ permissions: string }>
Get the permissions for a document
Parameters
- params: Readonly<{ documentId: string }>
  Data specifying which document to get permissions for
Returns ResponseBase<{ permissions: string }>
Response with the permissions

getDocumentSecurity

getDocumentSecurity(
params: Readonly<{ documentId: string }>,
): ResponseBase<IDocumentSecurity>
Retrieves the security settings of a document
Parameters
- params: Readonly<{ documentId: string }>
  Data specifying which document to get security settings for
Returns ResponseBase<IDocumentSecurity>
Response with the document security settings

getMeasurementViewports

getMeasurementViewports(
documentId: string,
data: Readonly<IGetMeasurementViewportsData>,
): ResponseBase<IGetMeasurementViewportsResponse>
Gets measurement viewports from the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IGetMeasurementViewportsData>
  Data specifying which measurement viewports to retrieve
Returns ResponseBase<IGetMeasurementViewportsResponse>
Response with the measurement viewports data

getPageAnnotations

getPageAnnotations(
params: Readonly<IGetPageContentData>,
): ResponseBase<IGetContentDataAnnotation[]>
Retrieves annotations from a specific page in the document
Parameters
- params: Readonly<IGetPageContentData>
  Parameters specifying the page and document to get annotations from
Returns ResponseBase<IGetContentDataAnnotation[]>
Response containing an array of page annotations

getPageContent

getPageContent(
params: Readonly<IGetPageContentData>,
): ResponseBase<IListContentResponse>
Retrieves the content elements from a specific page in the document
Parameters
- params: Readonly<IGetPageContentData>
  Parameters specifying the page and document to get content from
Returns ResponseBase<IListContentResponse>
Response containing the page content elements

getPageFillSign

getPageFillSign(
params: Readonly<IGetPageContentData>,
): ResponseBase<IFillSignField[]>
Retrieves fill and sign fields from a specific page in the document
Parameters
- params: Readonly<IGetPageContentData>
  Parameters specifying the page and document to get fill and sign fields from
Returns ResponseBase<IFillSignField[]>
Response containing an array of fill and sign fields

getPageText

getPageText(
body: Readonly<IGetPageContentData>,
): ResponseBase<ITextBlocksDataResponse>
Gets all text content from a specific page
Parameters
- body: Readonly<IGetPageContentData>
  Data specifying which page to get text from
Returns ResponseBase<ITextBlocksDataResponse>
Response with the page text content

getTextAsTable

getTextAsTable(
documentId: string,
data: Readonly<IGetTextAsTableData>,
): ResponseBase<ITextAsTableResponse>
Gets text content structured as a table
Parameters
- documentId: string
  The document ID
- data: Readonly<IGetTextAsTableData>
  Data specifying which text to retrieve as a table
Returns ResponseBase<ITextAsTableResponse>
Response with the text formatted as a table

importAcroformsFdfData

importAcroformsFdfData(
documentId: string,
file: File,
): ResponseBase<IUndoResponse>
Imports AcroForms data from FDF format

documentId: string;
Parameters
- documentId: string
- file: File
  The FDF file to import
Returns ResponseBase<IUndoResponse>
Response with the import operation result

insertBatesNumbering

insertBatesNumbering(
documentId: string,
data: Readonly<IInsertBatesNumberingData>,
): ResponseBase<IUndoResponse>
Inserts Bates numbering into the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IInsertBatesNumberingData>
  Bates numbering configuration
Returns ResponseBase<IUndoResponse>
Response with the insertion result

insertChar

insertChar(
documentId: string,
data: Readonly<IInsertCharData>,
): ResponseBase<Readonly<ITextBlocksResponse>>
Inserts a character at a specific index in the text content
Parameters
- documentId: string
  The document ID
- data: Readonly<IInsertCharData>
  Data specifying the page index, and character index to insert
Returns ResponseBase<Readonly<ITextBlocksResponse>>
Response with the result of the insert operation

insertHeader

insertHeader(
documentId: string,
body: Readonly<IInsertHeaderData>,
): ResponseBase<IUndoResponse>
Inserts a header into the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IInsertHeaderData>
  Header configuration data
Returns ResponseBase<IUndoResponse>
Response with the header insertion result

insertImage

insertImage(
documentId: string,
data: Readonly<IInsertImageData>,
): ResponseBase<IInsertImageResponse>
Inserts an image into the document
Parameters
- documentId: string
- data: Readonly<IInsertImageData>
Returns ResponseBase<IInsertImageResponse>
Response with the image insertion result

insertPageNumber

insertPageNumber(
documentId: string,
body: Readonly<IInsertPageNumberData>,
): ResponseBase<IUndoResponse>
Inserts page numbers into the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IInsertPageNumberData>
  Page number configuration data
Returns ResponseBase<IUndoResponse>
Response with the page number insertion result

insertWatermark

insertWatermark(
documentId: string,
body: Readonly<IInsertWatermarkData>,
): ResponseBase<IUndoResponse>
Inserts a watermark into the document
Parameters
- documentId: string
  The document ID
- body: Readonly<IInsertWatermarkData>
  Watermark configuration data
Returns ResponseBase<IUndoResponse>
Response with the watermark insertion result

listAttachments

listAttachments(body: Readonly<IAttachmentData>): ResponseBase<IAttachment[]>
Lists all attachments in the document
Parameters
- body: Readonly<IAttachmentData>
  Data specifying which document to list attachments for
Returns ResponseBase<IAttachment[]>
Response with the attachments list

listDocumentClaims

listDocumentClaims(documentId: string): Promise<string[]>
Lists all claims used in the current editing session
Parameters
- documentId: string
  The document ID
Returns Promise<string[]>
Response with an array of claim strings

listFonts

listFonts(documentId?: string): Promise<IFontMini[]>
Gets all system fonts available
Parameters
- OptionaldocumentId: string
  The ID of the document to get system fonts for
Returns Promise<IFontMini[]>
Response with the system fonts data

loadCustomSystemFont

loadCustomSystemFont(
documentId: string,
data: Uint8Array,
): ResponseBase<ILoadCustomSystemFontResponse[]>
Loads all fonts from the provided binary data and adds them to the system fonts
Parameters
- documentId: string
  The document ID
- data: Uint8Array
  Font binary data (Uint8Array)
Returns ResponseBase<ILoadCustomSystemFontResponse[]>
Response with array of loaded font faces information

mergeTextBlocks

mergeTextBlocks(
documentId: string,
data: Readonly<IMergeTextBlocksData>,
): ResponseBase<ITextBlocksResponse>
Merges multiple text blocks into a single text block
Parameters
- documentId: string
  The document ID
- data: Readonly<IMergeTextBlocksData>
  Data specifying which text blocks to merge
Returns ResponseBase<ITextBlocksResponse>
Response with the merged text block result

moveBookmark

moveBookmark(
documentId: string,
data: Readonly<IMoveBookmarkData>,
): ResponseBase<IUndoResponse>
Changes a bookmark's position in the bookmark hierarchy
Parameters
- documentId: string
  The document ID
- data: Readonly<IMoveBookmarkData>
  Data specifying the bookmark move operation
Returns ResponseBase<IUndoResponse>
Response with the move operation result

openBlank

openBlank(
body: Readonly<ICreateNewDocumentData>,
): ResponseBase<IFileDataResponse>
Creates and opens a new blank PDF document
Parameters
- body: Readonly<ICreateNewDocumentData>
  Configuration data for the new document
Returns ResponseBase<IFileDataResponse>
Response with the created document data

openByFile

openByFile(data: Readonly<IFileDataFile>): ResponseBase<IFileDataResponse>
Opens a PDF document using a file object
Parameters
- data: Readonly<IFileDataFile>
  Object containing the file data to open
Returns ResponseBase<IFileDataResponse>
Response with the opened file data

orderAnnotation

orderAnnotation(
documentId: string,
data: Readonly<IOrderAnnotationData>,
): ResponseBase<IUndoResponse>
Changes the order of annotations in the document
Parameters
- documentId: string
  The document ID
- data: Readonly<IOrderAnnotationData>
  Data specifying the annotation ordering
Returns ResponseBase<IUndoResponse>
Response with the ordering result

pasteContentElement

pasteContentElement(
documentId: string,
data: Readonly<IPasteContentElementData>,
): ResponseBase<IPasteContentElementResponse>
Pastes a previously copied content element
Parameters
- documentId: string
  The document ID
- data: Readonly<IPasteContentElementData>
  Data specifying where to paste the content element
Returns ResponseBase<IPasteContentElementResponse>
Response with the paste operation result

pasteTextBlock

pasteTextBlock(
documentId: string,
data: Readonly<IPasteTextBlockData>,
): ResponseBase<ITextBlocksResponse>
Pastes a previously copied text block
Parameters
- documentId: string
  The document ID
- data: Readonly<IPasteTextBlockData>
  Data specifying where to paste the text block
Returns ResponseBase<ITextBlocksResponse>
Response with the paste operation result

patchBookmark

patchBookmark(
documentId: string,
data: Readonly<IBookmarkRequestData>,
): ResponseBase<IAddBookmarkResponse>
Updates an existing bookmark's properties
Parameters
- documentId: string
  The document ID
- data: Readonly<IBookmarkRequestData>
  Updated bookmark data
Returns ResponseBase<IAddBookmarkResponse>
Response with the updated bookmark information

patchFillSign

patchFillSign(
documentId: string,
body: Readonly<IFillSignPatchData>,
): ResponseBase<IPatchFillSignResponse>
Updates a fill and sign field
Parameters
- documentId: string
  The document ID
- body: Readonly<IFillSignPatchData>
  Updated fill and sign field data
Returns ResponseBase<IPatchFillSignResponse>
Response with the update result

previewBatesNumbering

previewBatesNumbering(
body: Readonly<IPreviewBatesNumberingData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Generates a preview of Bates numbering
Parameters
- body: Readonly<IPreviewBatesNumberingData>
  Bates numbering configuration
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with the preview data

previewHeader

previewHeader(
body: Readonly<IPreviewHeaderData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Generates a preview of a header
Parameters
- body: Readonly<IPreviewHeaderData>
  Header configuration for the preview
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with the header preview data

previewWatermark

previewWatermark(
body: Readonly<IPreviewWatermarkData>,
): ResponseBase<Uint8Array<ArrayBufferLike>>
Generates a preview of a watermark
Parameters
- body: Readonly<IPreviewWatermarkData>
  Watermark configuration for the preview
Returns ResponseBase<Uint8Array<ArrayBufferLike>>
Response with the watermark preview data

registerUserFonts

registerUserFonts(fonts: IUserFontData): void
Registers user-defined fonts for use in text editing
Parameters
- fonts: IUserFontData
  Array of user font configurations to register
Returns void

replaceDocument

replaceDocument(documentId: string, file: File): Promise<void>
Replaces the current document with new PDF data by closing the old worker and creating a new one. This method performs an in-place document replacement without creating new tabs or views.
Parameters
- documentId: string
  The document ID
- file: File
  The new PDF binary data as File
Returns Promise<void>
Promise that resolves when the document has been replaced

replacePagesWorker

replacePagesWorker(
documentId: string,
workerData: IReplacePagesWorkerData,
): ResponseBase<IUndoResponse>
Unified worker method for all page operations (insert, replace, move, delete)
Parameters
- documentId: string
  The document ID
- workerData: IReplacePagesWorkerData
  Prepared worker data for the operation
Returns ResponseBase<IUndoResponse>
Response with the operation result

replaceText

replaceText(
documentId: string,
data: Readonly<IReplaceTextData>,
): ResponseBase<Readonly<ITextBlocksResponse>>
Replaces text in the document with new content
Parameters
- documentId: string
  The document ID
- data: Readonly<IReplaceTextData>
  Data specifying the page index and text replacement details
Returns ResponseBase<Readonly<ITextBlocksResponse>>
Response with the response containing the updated text blocks

resetAcroformsFdfData

resetAcroformsFdfData(documentId: string): ResponseBase<IUndoResponse>
Resets form fields to their default values
Parameters
- documentId: string
  The document ID
Returns ResponseBase<IUndoResponse>
Response with the reset operation result

resizePages

resizePages(
documentId: string,
body: Readonly<IChangeSizeData>,
): ResponseBase<IUndoResponse>
Resizes pages in a document
Parameters
- documentId: string
  The document ID
- body: Readonly<IChangeSizeData>
  Size configuration data
Returns ResponseBase<IUndoResponse>
Response with the size change result

reversePage

reversePage(
documentId: string,
data: Readonly<IReversePages>,
): ResponseBase<IUndoResponse>
Reverses the order of pages in a range
Parameters
- documentId: string
  The document ID
- data: Readonly<IReversePages>
  Data specifying the page range to reverse
Returns ResponseBase<IUndoResponse>
Response with the page reversal result

rotatePages

rotatePages(
documentId: string,
params: Readonly<IRotatePagesData>,
): ResponseBase<IUndoResponse>
Rotates pages in the document
Parameters
- documentId: string
  The document ID
- params: Readonly<IRotatePagesData>
  Data specifying which pages to rotate and rotation angle
Returns ResponseBase<IUndoResponse>
Response with the rotation result

saveAttachment

saveAttachment(
documentId: string,
data: Readonly<ISaveAttachmentData>,
): ResponseBase<ISaveAttachmentResponse>
Saves changes to an attachment
Parameters
- documentId: string
  The document ID
- data: Readonly<ISaveAttachmentData>
  Updated attachment data
Returns ResponseBase<ISaveAttachmentResponse>
Response with the save operation result

saveOptimized

saveOptimized(
documentId: string,
data: Readonly<ISaveOptimizedData>,
): Promise<Uint8Array<ArrayBufferLike>>
Saves optimized data to a file
Parameters
- documentId: string
  The document ID
- data: Readonly<ISaveOptimizedData>
  Data containing the document ID and optimization settings
Returns Promise<Uint8Array<ArrayBufferLike>>
Promise resolving to the optimized file as a Uint8Array

securityApplyRedactions

securityApplyRedactions(documentId: string): ResponseBase<IUndoResponse>
Applies redaction annotations to permanently remove content
Parameters
- documentId: string
  The document ID
Returns ResponseBase<IUndoResponse>
Response with the redaction result

securityOwnerAuthorization

securityOwnerAuthorization(
body: Readonly<ISecurityOwnerAuthorizationData>,
): ResponseBase<IDocumentPermissionsResponse>
Authorizes owner access to a secured document
Parameters
- body: Readonly<ISecurityOwnerAuthorizationData>
  Owner authorization data (typically password)
Returns ResponseBase<IDocumentPermissionsResponse>
Response with the authorization result

securitySaveSettings

securitySaveSettings(
documentId: string,
body: Readonly<ISecuritySaveSettingsData>,
): ResponseBase<ISecuritySaveSettingsResponse>
Saves security settings for the document
Parameters
- documentId: string
  The document ID
- body: Readonly<ISecuritySaveSettingsData>
  Security settings configuration
Returns ResponseBase<ISecuritySaveSettingsResponse>
Response with the security settings result

setBackground

setBackground(
documentId: string,
body: Readonly<ISetBackgroundData>,
): ResponseBase<IUndoResponse>
Sets the background of a document or page
Parameters
- documentId: string
  The document ID
- body: Readonly<ISetBackgroundData>
  Background configuration data
Returns ResponseBase<IUndoResponse>
Response with the background setting result

transformClip

transformClip(
documentId: string,
body: Readonly<ITransformClipData>,
): ResponseBase<ITransformClipResponse>
Transforms (moves, scales, rotates) a clip
Parameters
- documentId: string
  The document ID
- body: Readonly<ITransformClipData>
  Transformation data for the clip
Returns ResponseBase<ITransformClipResponse>
Response with the transformation result

transformTextBlock

transformTextBlock(
documentId: string,
data: Readonly<ITransformTextBlockData>,
): ResponseBase<ITextBlocksResponse>
Transforms (rotates, scales, or repositions) a text block
Parameters
- documentId: string
  Document identifier
- data: Readonly<ITransformTextBlockData>
  Transformation data for the text block
Returns ResponseBase<ITextBlocksResponse>
Response with the result of the transformation

PDF Web SDK Documentation

Interface IPdfEditor

Index

Methods

Methods

addAttachment

Parameters

Returns ResponseBase<IAddAttachmentResponse>

addBookmark

Parameters

Returns ResponseBase<IAddBookmarkResponse>

addCustomSystemFonts

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

autoOrderAnnotation

Parameters

Returns ResponseBase<IUndoResponse>

beginTransaction

Parameters

Returns ResponseBase<string>

bookmarks

Parameters

Returns ResponseBase<IBookmarksResponse>

cancelTransaction

Parameters

Returns ResponseBase<IUndoResponse>

canChangeAnnotZOrder

Parameters

Returns ResponseBase<ICanChangeAnnotZOrderResponse>

canChangeElementZOrder

Parameters

Returns ResponseBase<ICanChangeElementZOrderResponse>

canChangeTextBlockZOrder

Parameters

Returns ResponseBase<ICanChangeTextBlockZOrderResponse>

changeAcroformValue

Parameters

Returns ResponseBase<IUndoResponse>

changeAnnotationProperties

Parameters

Returns ResponseBase<IChangeAnnotationPropertiesResponse>

changeAnnotOrder

Parameters

Returns ResponseBase<IUndoResponse>

changeDocumentHistory

Parameters

Returns ResponseBase<Readonly<IUndoResponse>>

changeElementMatrix

Parameters

Returns ResponseBase<IChangeElementMatrixResponse>

changeElementOrder

Parameters

Returns ResponseBase<IUndoResponse>

changeFontAttributes

Parameters

Returns ResponseBase<Readonly<ITextBlocksResponse>>

changeLayerState

Parameters

Returns ResponseBase<IChangeLayerStateResponse>

changeListStyle

Parameters

Returns ResponseBase<Readonly<ITextBlocksResponse>>

changeMargin

Parameters

Returns ResponseBase<IUndoResponse>

changePagesBoxes

Parameters

Returns ResponseBase<IUndoResponse>

changeParaAttrs

Parameters

Returns ResponseBase<Readonly<ITextBlocksResponse>>

changeProperties

Parameters

Returns ResponseBase<IUndoResponse>

changeTextBlockZOrder

Parameters

Returns ResponseBase<ITextBlocksResponse>

clearAllSignatures

Parameters

Returns ResponseBase<Uint8Array<ArrayBufferLike>>