Image to Image / Node.js Reference

class ImageToImageClient

All setter methods return ImageToImageClient object unless specified otherwise.

Constructor

function ImageToImageClient(userName, apiKey)

Constructor for the PDFCrowd API client. Initialize a new instance of the conversion client with your PDFCrowd account credentials.

You must provide both your username and API key. This establishes the authenticated connection for all subsequent conversion operations.

Parameters:
  • userName - Your username at PDFCrowd.
  • apiKey - Your API key.

Conversion Input

function convertUrl(url, callbacks)

Convert an image from a URL.

Use this as the primary method for converting web content, online documents, or any publicly accessible URL to the desired output format. Returns the conversion result as a byte array for further processing or direct use.

Parameters:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • callbacks - The object that defines the following functions:
    • data(readStream) - called when the output data can be read from readStream
    • error(message, statusCode) - called when an error occurs
    • end() - called when the conversion finishes
    The client library provides 2 helper functions that can be used here:
    • saveToFile(filePath[, callback]) - saves the output data to a file
      • filePath - the output file path
      • callback(err, filePath) - called when the conversion finishes
    • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
      • response - the response object
      • contentType - the response content type
      • fileName - the desired file name
      • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".

function convertUrlToFile(url, filePath, callback)

Convert an image from a URL and save the conversion result directly to a local file.

Use this for simple file-based workflows, batch processing, or when you need to persist conversion output to disk. The most straightforward method for URL-to-file conversions.

Parameters:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • filePath - The output file path.
  • callback - The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.

function convertFile(file, callbacks)

Convert a local file to the desired output format.

Use this for processing files already on your system, converting uploaded documents, or batch processing local content. Returns the conversion result as a byte array for in-memory processing.

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • callbacks - The object that defines the following functions:
    • data(readStream) - called when the output data can be read from readStream
    • error(message, statusCode) - called when an error occurs
    • end() - called when the conversion finishes
    The client library provides 2 helper functions that can be used here:
    • saveToFile(filePath[, callback]) - saves the output data to a file
      • filePath - the output file path
      • callback(err, filePath) - called when the conversion finishes
    • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
      • response - the response object
      • contentType - the response content type
      • fileName - the desired file name
      • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".

function convertFileToFile(file, filePath, callback)

Convert a local file and save the conversion result to another local file.

Use this for file-based batch processing, document transformation workflows, or when both input and output are file-based. The simplest method for file-to-file conversions.

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • filePath - The output file path.
  • callback - The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.

function convertRawData(data, callbacks)

Convert raw binary data to the desired output format.

Use this for processing binary content, handling file uploads as byte arrays, or when working with data from external APIs. Provides maximum flexibility for binary data conversions.

Parameters:
  • data (byte[]) - The raw content to be converted.
  • callbacks - The object that defines the following functions:
    • data(readStream) - called when the output data can be read from readStream
    • error(message, statusCode) - called when an error occurs
    • end() - called when the conversion finishes
    The client library provides 2 helper functions that can be used here:
    • saveToFile(filePath[, callback]) - saves the output data to a file
      • filePath - the output file path
      • callback(err, filePath) - called when the conversion finishes
    • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
      • response - the response object
      • contentType - the response content type
      • fileName - the desired file name
      • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".

function convertRawDataToFile(data, filePath, callback)

Convert raw binary data and save the conversion result to a local file.

Use this for processing binary uploads and persisting the output, handling data from external sources, or when working with byte array inputs that need file-based storage.

Parameters:
  • data (byte[]) - The raw content to be converted.
  • filePath - The output file path.
  • callback - The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.

function convertStream(inStream, callbacks)

Convert content from an input stream to the desired output format.

Use this when integrating with I/O pipelines, processing data from network streams or file handles, or when the source data is provided as a stream by your application.

Parameters:
  • inStream (InputStream) - The input stream with source data.
  • callbacks - The object that defines the following functions:
    • data(readStream) - called when the output data can be read from readStream
    • error(message, statusCode) - called when an error occurs
    • end() - called when the conversion finishes
    The client library provides 2 helper functions that can be used here:
    • saveToFile(filePath[, callback]) - saves the output data to a file
      • filePath - the output file path
      • callback(err, filePath) - called when the conversion finishes
    • sendImageInHttpResponse(response, contentType, fileName[, disposition]) - sends the generated image in an HTTP response
      • response - the response object
      • contentType - the response content type
      • fileName - the desired file name
      • disposition - the response content disposition, can be "attachment" or "inline", the default is "attachment".

function convertStreamToFile(inStream, filePath, callback)

Convert content from an input stream and save the conversion result to a local file.

Use this when processing streaming uploads that need to be saved, handling network data sources with file-based output, or building services that accept stream input and produce file output.

Parameters:
  • inStream (InputStream) - The input stream with source data.
  • filePath - The output file path.
  • callback - The callback(error, filePath) function is called when the conversion finishes. The error object is present if an error occurred, filePath is the output file path.

Conversion Format

function setOutputFormat(outputFormat)

The output file format.

Parameter:
  • outputFormat
    Allowed Values:
    • png
    • jpg
    • gif
    • tiff
    • bmp
    • ico
    • ppm
    • pgm
    • pbm
    • pnm
    • psb
    • pct
    • ras
    • tga
    • sgi
    • sun
    • webp
    Default:
    png

Image Operations

Settings used for operations with images.

function setResize(resize)

Scale the image to different dimensions. Accepts percentage values for proportional scaling or explicit pixel dimensions for absolute sizing.

Parameter:
  • resize - The resize percentage or new image dimensions.
    Default:
    100%
Examples:
  • Enlarge for high-res display: setResize("200%")
  • Standard XGA screen resolution: setResize("1024x768")

function setRotate(rotate)

Rotate the image by the specified angle in degrees. Positive values rotate clockwise, negative values counterclockwise.

Parameter:
  • rotate - The rotation specified in degrees.

function setCropAreaX(x)

Set the horizontal starting position of the crop area, measured from the left edge of the print area. Positive values offset inward from the left edge, negative values extend beyond the left boundary.

Parameter:
  • x
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
Examples:
  • Crop extends beyond left edge: setCropAreaX("-1in")
  • Skip narrow border area: setCropAreaX("10mm")

function setCropAreaY(y)

Set the vertical starting position of the crop area, measured from the top edge of the print area. Positive values offset inward from the top edge, negative values extend beyond the top boundary.

Parameter:
  • y
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
Examples:
  • Crop extends beyond top edge: setCropAreaY("-1in")
  • Skip narrow border area: setCropAreaY("10mm")

function setCropAreaWidth(width)

Set the horizontal extent of the crop area. Defines the width of the region to be converted. Minimum value is 1 inch.

Parameter:
  • width
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The width of the print area.
Examples:
  • Standard document crop width: setCropAreaWidth("8in")
  • Full A4 page width crop: setCropAreaWidth("210mm")

function setCropAreaHeight(height)

Set the vertical extent of the crop area. Defines the height of the region to be converted. Minimum value is 1 inch.

Parameter:
  • height
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The height of the print area.
Examples:
  • Standard US Letter crop height: setCropAreaHeight("11in")
  • Full A4 page height crop: setCropAreaHeight("297mm")

function setCropArea(x, y, width, height)

Define a rectangular region to convert by setting X/Y position and width/height simultaneously. Coordinates are relative to the print area's top-left corner.

Parameters:
  • x - Set the horizontal starting position of the crop area, measured from the left edge of the print area. Positive values offset inward from the left edge, negative values extend beyond the left boundary.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
  • y - Set the vertical starting position of the crop area, measured from the top edge of the print area. Positive values offset inward from the top edge, negative values extend beyond the top boundary.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
  • width - Set the horizontal extent of the crop area. Defines the width of the region to be converted. Minimum value is 1 inch.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The width of the print area.
  • height - Set the vertical extent of the crop area. Defines the height of the region to be converted. Minimum value is 1 inch.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The height of the print area.

function setRemoveBorders(value)

Detect and remove solid-color borders surrounding the image content. Only removes borders that consist of a single consistent color.

Parameter:
  • value (bool) - Set to true to remove borders.
    Default:
    false

Canvas Setup

function setCanvasSize(size)

Set the output canvas size. Use standard sizes (A4, Letter, A3, etc.) for printable output with consistent dimensions.

Parameter:
  • size
    Allowed Values:
    • A0
    • A1
    • A2
    • A3
    • A4
    • A5
    • A6
    • Letter

function setCanvasWidth(width)

Set the output canvas width.

Parameter:
  • width
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • A4 landscape / banner width: setCanvasWidth("297mm")
  • US Letter standard width: setCanvasWidth("8.5in")

function setCanvasHeight(height)

Set the output canvas height.

Parameter:
  • height
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Large poster canvas height: setCanvasHeight("420mm")
  • US Letter standard height: setCanvasHeight("11in")

function setCanvasDimensions(width, height)

Set the output canvas dimensions. If no canvas size is specified, margins are applied as a border around the image.

Parameters:
  • width - Set the output canvas width.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • height - Set the output canvas height.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • A4 portrait dimensions: setCanvasDimensions("210mm", "297mm")
  • US Letter dimensions: setCanvasDimensions("8.5in", "11in")
  • A3 portrait dimensions: setCanvasDimensions("297mm", "420mm")

function setOrientation(orientation)

Set the output canvas orientation. Use portrait for vertical content, landscape for horizontal or wide content.

Parameter:
  • orientation
    Allowed Values:
    • landscape
    • portrait
    Default:
    portrait

function setPosition(position)

Set the image position on the canvas. Center for balanced composition, or corner/edge positions for specific layouts.

Parameter:
  • position
    Allowed Values:
    • center
    • top
    • bottom
    • left
    • right
    • top-left
    • top-right
    • bottom-left
    • bottom-right
    Default:
    center

function setPrintCanvasMode(mode)

Set the mode to print the image on the canvas.

Parameter:
  • mode
    Allowed Values:
    • default — No image scaling.
    • fit — Fit the image to the canvas with aspect ratio.
    • stretch — Stretch the image to the canvas with no aspect ratio.
    Default:
    default

function setMarginTop(top)

Set the output canvas top margin.

Parameter:
  • top
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginTop("1in")
  • Minimal margin for web images: setMarginTop("10mm")

function setMarginRight(right)

Set the output canvas right margin.

Parameter:
  • right
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginRight("1in")
  • Minimal margin for web images: setMarginRight("10mm")

function setMarginBottom(bottom)

Set the output canvas bottom margin.

Parameter:
  • bottom
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginBottom("1in")
  • Minimal margin for web images: setMarginBottom("10mm")

function setMarginLeft(left)

Set the output canvas left margin.

Parameter:
  • left
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginLeft("1in")
  • Minimal margin for web images: setMarginLeft("10mm")

function setMargins(top, right, bottom, left)

Set the output canvas margins. Create white space around the image for framing, borders, or print bleed.

Parameters:
  • top - Set the output canvas top margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • right - Set the output canvas right margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • bottom - Set the output canvas bottom margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • left - Set the output canvas left margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

function setCanvasBackgroundColor(color)

The canvas background color in RGB or RGBA hexadecimal format. The color fills the entire canvas regardless of margins. If no canvas size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.

Parameter:
  • color
    Constraint:
    • The value must be in RRGGBB or RRGGBBAA hexadecimal format.
Examples:
  • red color: setCanvasBackgroundColor("FF0000")
  • green color: setCanvasBackgroundColor("00ff00")
  • green color with 50% opacity: setCanvasBackgroundColor("00ff0080")

function setDpi(dpi)

Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).

Parameter:
  • dpi (int) - The DPI value.
    Default:
    96
Example:
  • The DPI used for printers. 1 inch contains 300 points: setDpi(300)

Miscellaneous

function setDebugLog(value)

Turn on debug logging to troubleshoot conversion issues. Details about the conversion process, including resource loading, rendering steps, and error messages are stored in the debug log. Use this when conversions fail or produce unexpected results. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

Parameter:
  • value (bool) - Set to true to enable debug logging.
    Default:
    false

function getDebugLogUrl() { return string; }

Get the URL of the debug log for the last conversion.

Returns:
string - The link to the debug log.

function getRemainingCreditCount() { return int; }

Get the number of conversion credits available in your account. Use this to monitor your credit usage and implement alerts before running out of credits.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.

Returns:
int - The number of credits.

function getConsumedCreditCount() { return int; }

Get the number of credits consumed by the last conversion. Use this to track costs per conversion, especially for complex documents or operations that may consume multiple credits.

Returns:
int - The number of credits.

function getJobId() { return string; }

Get the unique job ID for the conversion. Use this to track conversions in your logs, correlate with debug logs, or reference specific conversions when contacting support.

Returns:
string - The unique job identifier.

function getOutputSize() { return int; }

Get the size of the output document in bytes. Use this to check file sizes before delivery, implement size-based quotas, or optimize storage allocation.

Returns:
int - The count of bytes.

function getVersion() { return string; }

Get the version details including API version, converter version, and client library version. Use this for debugging, logging, or ensuring compatibility when reporting issues.

Returns:
string - API version, converter version, and client version.

function setTag(tag)

Tag the conversion with a custom value for tracking and analytics. Use this to categorize conversions by customer ID, document type, or business unit. The tag appears in conversion statistics. A value longer than 32 characters is cut off.

Parameter:
  • tag - A string with the custom tag.
Example:
  • Track job in analytics: setTag("client-1234")

function setHttpProxy(proxy)

A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. This can help circumvent regional restrictions or provide limited access to your intranet.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Corporate proxy server: setHttpProxy("myproxy.com:8080")
  • Direct IP proxy connection: setHttpProxy("113.25.84.10:33333")

function setHttpsProxy(proxy)

A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. This can help circumvent regional restrictions or provide limited access to your intranet.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Secure proxy for HTTPS: setHttpsProxy("myproxy.com:443")
  • Direct secure proxy IP: setHttpsProxy("113.25.84.10:44333")

API Client Options

function setConverterVersion(version)

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

Availability:
API client >= 5.0.0. See versioning.
Parameter:
  • version - The version identifier.
    Allowed Values:
    • 24.04 — Version 24.04.
    • 20.10 — Version 20.10.
    • 18.10 — Version 18.10.
    • latest — Version 20.10 is used.
    Default:
    24.04

function setUseHttp(value)

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.

Parameter:
  • value (bool) - Set to true to use HTTP.
    Default:
    false

function setClientUserAgent(agent)

Specify the User-Agent HTTP header that the client library will use when interacting with the API.

Availability:
API client >= 6.4.0 See versioning.
Parameter:
  • agent - The user agent string.

function setUserAgent(agent)

Deprecated Replaced with: setClientUserAgent

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

Parameter:
  • agent - The user agent string.
    Default:
    pdfcrowd_nodejs_client/6.5.4 (https://pdfcrowd.com)

function setProxy(host, port, userName, password)

Specify an HTTP proxy that the API client library will use to connect to the internet.

Parameters:
  • host - The proxy hostname.
  • port (int) - The proxy port.
  • userName - The username.
  • password - The password.

function setRetryCount(count)

Specify the number of automatic retries when a 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.

Parameter:
  • count (int) - Number of retries.
    Default:
    1
Example:
  • Retry failed requests three times: setRetryCount(3)