Class InsertPagesParams

Parameters for inserting pages into a PDF using InsertPagesJob.

Implements

Constructors

constructor

Properties

_assetsToInsert _baseAsset

Accessors

assetsToInsert baseAsset

Methods

addPagesToInsertAt updateFilesToInsert

Constructors

constructor

  • new InsertPagesParams(baseAsset): InsertPagesParams

  • Constructs a new InsertPagesParams instance.

    Parameters

    • baseAsset: Asset

      the base asset to insert pages into.

    Returns InsertPagesParams

Properties

Private Readonly _assetsToInsert

_assetsToInsert: Map<number, CombinePDFJobInput[]>

Private Readonly _baseAsset

_baseAsset: Asset

Accessors

assetsToInsert

  • get assetsToInsert(): 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 asset to insert pages into.

    Returns Asset

    the base asset to insert pages into.

Methods

addPagesToInsertAt

  • addPagesToInsertAt(params): InsertPagesParams

  • Adds the specified pages of the input PDF file to be inserted 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: {
          basePage: number;
          inputAsset: Asset;
          pageRanges?: PageRanges;
      }

      The parameters for adding pages to insert at.

      • basePage: number

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

      • inputAsset: Asset

        The PDF file for insertion. Cannot be undefined.

      • Optional pageRanges?: PageRanges

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

    Returns InsertPagesParams

    this InsertPagesParams instance.

Private updateFilesToInsert

  • updateFilesToInsert(index, combinePDFJobInput): void

  • Parameters

    • index: number
    • combinePDFJobInput: CombinePDFJobInput

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor_assetsToInsert_baseAssetassetsToInsertbaseAssetaddPagesToInsertAtupdateFilesToInsert

Generated using TypeDoc