Class ReplacePagesParams

Parameters for replacing pages of a PDF using ReplacePagesJob.

Implements

Constructors

constructor

Properties

_assetsToReplace _baseAsset

Accessors

assetsToReplace baseAsset

Methods

addPagesForReplace

Constructors

constructor

  • new ReplacePagesParams(baseAsset): ReplacePagesParams

  • Constructs a new ReplacePagesParams instance.

    Parameters

    • baseAsset: Asset

      The base asset to be used for replacing pages. Cannot be undefined.

    Returns ReplacePagesParams

Properties

Private Readonly _assetsToReplace

_assetsToReplace: Map<number, CombinePDFJobInput>

Private Readonly _baseAsset

_baseAsset: Asset

Accessors

assetsToReplace

  • get assetsToReplace(): Map<number, CombinePDFJobInput>
  • Internal

    Used internally by this SDK, not intended to be called by clients.

    Returns Map<number, CombinePDFJobInput>

baseAsset

  • get baseAsset(): Asset

  • Returns the base PDF Asset to which pages will be replaced.

    Returns Asset

    an Asset instance

Methods

addPagesForReplace

  • addPagesForReplace(params): ReplacePagesParams

  • Adds the specified pages of the input PDF file to be replaced at the specified page of the base PDF file

    This method can be invoked multiple times with the same or different input PDF files.

    Parameters

    • params: {
          asset: Asset;
          basePage: number;
          pageRanges?: PageRanges;
      }

      The parameters for adding pages to be replaced.

      • asset: Asset

        The PDF file for insertion. Cannot be undefined.

      • basePage: number

        The page of the base PDF file. Cannot be undefined.

      • Optional pageRanges?: PageRanges

        The page ranges of the input PDF file. If not specified, all pages are included.

    Returns ReplacePagesParams

    this ReplacePagesParams instance.

Settings

Member Visibility

Theme

On This Page

constructor_assetsToReplace_baseAssetassetsToReplacebaseAssetaddPagesForReplace

Generated using TypeDoc