Plugin API » Files » Generation and transforms » std:pdf:overlay

std:pdf:overlay transform step

This transform step overlaps two PDF files, and can be used to add letterheads to generated documents or apply watermarks.

NOTE: This transform is implemented by an optional platform component, and may not be available in your installation.

Transform specification

property input

Name of the input file. Optional, defaults to "input".

property output

Name of the output file. Optional, defaults to "output".

property overlay

Name of the PDF file which will be overlaid on the input file. Required.

If you’re not sure your overlay file will be a PDF, you can use a std:convert step to make sure it’s a PDF. If the file is already a PDF, it won’t do anything.

pipeline.transform("std:convert",
  {input:"overlay", output:"overlay", mimeType:"application/pdf"});

property background

If true, the overlay file will be in the background of the input file. Optional, defaults to true.

property firstPage

The first page of the input file to modify. Optional, defaults to 1.

property lastPage

The last page of the input file to modify. Optional, defaults to the length of the input document.