Please enable JavaScript to view this site.

Version:

Navigation: Activities > Activity Reference

Add Image To PDF Activity

Prev Top Next More

Description

Adds an image to a PDF document.

Usage

Given a PDF document and an image, a workflow can add the image to the PDF at the specified location in the document. The activity produces a new PDF document. The Write File Bytes activity could write the new PDF to disk, or the Create Download activity could generate a URL to the new PDF so that an end user could download it.

Inputs

Source

Required

Type: String | Number[]

The source PDF document to modify. Either a file path or byte content are accepted.

Bytes are the raw binary values that represent content. A byte array is represented by a list of numbers between 0 and 255. Invalid byte content will cause an error.

One way byte content can be retrieved is by using the Read File Bytes activity.

Image

Required

Type: Number[]

The image to add.

Bytes are the raw binary values that represent content. A byte array is represented by a list of numbers between 0 and 255. Invalid byte content will cause an error.

One way byte content can be retrieved is by using the Read File Bytes activity.

X

Required

Type: Number

The X coordinate (in points) at which to add the image. The coordinate [0, 0] represents the bottom left corner of the page.

Y

Required

Type: Number

The Y coordinate (in points) at which to add the image. The coordinate [0, 0] represents the bottom left corner of the page.

Height

Optional

Type: Number

The height of the image (in points).

Width

Optional

Type: Number

The width of the image (in points).

Border Width

Optional

Type: Number

The width (in points) of the image border. The default is 0 (no border).

Border Color

Optional

Type: String

The RGBA hex color of the image border. The default is 000000FF (black). The alpha value is optional.

Page Index

Optional

Type: Number

The zero-based index of the page to add the image. The default is 0.

Outputs

result

Type: Number[]

The modified PDF document.

Properties

For information about the ID, Display Name, and Description properties, see Properties Common to all Activities.

Connectivity Requirements

This activity does not work when the device has intermittent connectivity to the network.

© 2024 VertiGIS North America Ltd. All Rights Reserved. | Privacy Center | Imprint
Documentation Version 5.42 (58a5caf5)