HTML to Image / Node.js Reference

class HtmlToImageClient

All setter methods return HtmlToImageClient object unless specified otherwise.

Constructor

function HtmlToImageClient(userName, apiKey)

Constructor for the Pdfcrowd API client.

userName

Your username at Pdfcrowd.

apiKey

Your API key.

Conversion Format

function setOutputFormat(outputFormat)

The format of the output file.

outputFormat

Allowed values:

png
jpg
gif
tiff
bmp
ico
ppm
pgm
pbm
pnm
psb
pct
ras
tga
sgi
sun
webp

Default: png

Conversion Input

function convertUrl(url, callbacks)

Convert a web page.

url

The address of the web page to convert.

The 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 a web page and write the result to a local file.

url

The address of the web page to convert.

The 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.

file

The path to a local file to convert.
The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip).
If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets.

The file must exist and not be empty.

The file name must have a valid extension.

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 write the result to a local file.

file

The file must exist and not be empty.

The file name must have a valid extension.

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 convertString(text, callbacks)

Convert a string.

text

The string content to convert.

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 convertStringToFile(text, filePath, callback)

Convert a string and write the output to a file.

text

The string content to convert.

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 the contents of an input stream.

inStream

The input stream with source data.
The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).
The archive can contain HTML code and its external assets (images, style sheets, javascript).

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 the contents of an input stream and write the result to a local file.

inStream

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 setZipMainFilename(filename)

Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.

filename

The file name.

Image Output

function setScreenshotWidth(width)

Set the output image width in pixels.

width

The value must be in the range 96-65000.

Default: 1024

Example:

Full HD width.

setScreenshotWidth(1920)

function setScreenshotHeight(height)

Set the output image height in pixels. If it is not specified, actual document height is used.

height

Must be a positive integer number.

Example:

Full HD height.

setScreenshotHeight(1080)

function setScaleFactor(factor)

Set the scaling factor (zoom) for the output image.

factor

The percentage value.

Must be a positive integer number.

Default: 100

Example:

setScaleFactor(50)

function setBackgroundColor(color)

The output image background color.

Availability: API client >= 5.0.0, converter >= 20.10. See versioning.

color

The value must be in RRGGBB or RRGGBBAA hexadecimal format.

Examples:

red color

setBackgroundColor("FF0000")
fully transparent background

setBackgroundColor("00000000")
green color with 50% opacity

setBackgroundColor("00ff0080")
green color

setBackgroundColor("00ff00")

General Options

function setUsePrintMedia(value)

Use the print version of the page if available (@media print).

value

Set to true to use the print version of the page.

Default: false

function setNoBackground(value)

Do not print the background graphics.

value

Set to true to disable the background graphics.

Default: false

function setDisableJavascript(value)

Do not execute JavaScript.

value

Set to true to disable JavaScript in web pages.

Default: false

function setDisableImageLoading(value)

Do not load images.

value

Set to true to disable loading of images.

Default: false

function setDisableRemoteFonts(value)

Disable loading fonts from remote sources.

value

Set to true disable loading remote fonts.

Default: false

function setUseMobileUserAgent(value)

Deprecated Replaced with: setConverterUserAgent()

Use a mobile user agent.

Availability: API client >= 5.3.0, converter >= 20.10. See versioning.

value

Set to true to use a mobile user agent.

Default: false

function setLoadIframes(iframes)

Specifies how iframes are handled.

Availability: API client >= 5.0.0, converter >= 20.10. See versioning.

iframes

Allowed values:

all

All iframes are loaded.
same-origin

Only iframes with the same origin as the main page are loaded.
none

Iframe loading is disabled.

Default: all

function setBlockAds(value)

Try to block ads. Enabling this option can produce smaller output and speed up the conversion.

value

Set to true to block ads in web pages.

Default: false

function setDefaultEncoding(encoding)

Set the default HTML content text encoding.

encoding

The text encoding of the HTML content.

Default: auto detect

Examples:

Set to use Latin-2 encoding.

setDefaultEncoding("iso8859-2")
Set to use UTF-8 encoding.

setDefaultEncoding("utf-8")

function setLocale(locale)

Set the locale for the conversion. This may affect the output format of dates, times and numbers.

Availability: API client >= 5.0.0, converter >= 20.10. See versioning.

locale

The locale code according to ISO 639.

Default: en-US

Example:

Set to use Japanese locale.

setLocale("ja-JP")

function setHttpAuth(userName, password)

Set credentials to access HTTP base authentication protected websites.

userName

Set the HTTP authentication user name.

password

Set the HTTP authentication password.

function setCookies(cookies)

Set cookies that are sent in Pdfcrowd HTTP requests.

The cookie string.

Example:

setCookies("session=6d7184b3bf35;token=2710")

function setVerifySslCertificates(value)

Do not allow insecure HTTPS connections.

value

Set to true to enable SSL certificate verification.

Default: false

function setFailOnMainUrlError(failOnError)

Abort the conversion if the main URL HTTP status code is greater than or equal to 400.

failOnError

Set to true to abort the conversion.

Default: false

function setFailOnAnyUrlError(failOnError)

Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.

failOnError

Set to true to abort the conversion.

Default: false

function setNoXpdfcrowdHeader(value)

Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.

value

Set to true to disable sending X-Pdfcrowd HTTP header.

Default: false

function setCustomCss(css)

Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.

Availability: API client >= 5.14.0, converter >= 20.10. See versioning.

css

A string containing valid CSS.

Examples:

Set the page background color to gray.

setCustomCss("body { background-color: gray; }")
Do not show nav HTML elements and the element with ad-block ID in the output PDF.

setCustomCss("nav, #ad-block { display: none !important; }")

function setCustomJavascript(javascript)

Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.

javascript

A string containing a JavaScript code.

Example:

Set the page background color to gray.

setCustomJavascript("document.body.style.setProperty('background-color', 'gray', 'important')")

function setOnLoadJavascript(javascript)

Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.

javascript

A string containing a JavaScript code.

Example:

Set the page background color to gray.

setOnLoadJavascript("document.body.style.setProperty('background-color', 'gray', 'important')")

function setCustomHttpHeader(header)

Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.

header

A string containing the header name and value separated by a colon.

Example:

setCustomHttpHeader("X-My-Client-ID:k2017-12345")

function setJavascriptDelay(delay)

Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.

delay

The number of milliseconds to wait.

Must be a positive integer number or 0.

Default: 200

Example:

Wait for 2 seconds.

setJavascriptDelay(2000)

function setElementToConvert(selectors)

Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.

selectors

One or more CSS selectors separated by commas.

Examples:

The first element with the id main-content is converted.

setElementToConvert("#main-content")
The first element with the class name main-content is converted.

setElementToConvert(".main-content")
The first element with the tag name table is converted.

setElementToConvert("table")
The first element with the tag name table or with the id main-content is converted.

setElementToConvert("table, #main-content")
The first element <p class="article"> within <div class="user-panel main"> is converted.

setElementToConvert("div.user-panel.main p.article")

function setElementToConvertMode(mode)

Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.

mode

Allowed values:

cut-out

The element and its children are cut out of the document.
remove-siblings

All element's siblings are removed.
hide-siblings

All element's siblings are hidden.

Default: cut-out

function setWaitForElement(selectors)

Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter.

selectors

One or more CSS selectors separated by commas.

Examples:

Wait until an element with the id main-content is found.

setWaitForElement("#main-content")
Wait until an element with the class name main-content is found.

setWaitForElement(".main-content")
Wait until an element with the tag name table is found.

setWaitForElement("table")
Wait until an element with the tag name table or with the id main-content is found.

setWaitForElement("table, #main-content")
Wait until <p class="article"> is found within <div class="user-panel main">.

setWaitForElement("div.user-panel.main p.article")

function setAutoDetectElementToConvert(value)

The main HTML element for conversion is detected automatically.

Availability: API client >= 5.5.0, converter >= 20.10. See versioning.

value

Set to true to detect the main element.

Default: false

function setReadabilityEnhancements(enhancements)

The input HTML is automatically enhanced to improve the readability.

Availability: API client >= 5.5.0, converter >= 20.10. See versioning.

enhancements

Allowed values:

none

No enhancements are used.
readability-v1

Version 1 of the enhancements is used.
readability-v2

Version 2 of the enhancements is used.
readability-v3

Version 3 of the enhancements is used.
readability-v4

Version 4 of the enhancements is used.

Default: none

Data

Methods related to HTML template rendering.

function setDataString(dataString)

Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.

dataString

The input data string.

Example:

JSON data.

setDataString("{"recipient": "Anna May", "sender": "John Doe"}")

function setDataFile(dataFile)

Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.

dataFile

The file path to a local file containing the input data.

Example:

setDataFile("/home/user/john/data.json")

function setDataFormat(dataFormat)

Specify the input data format.

dataFormat

The data format.

Allowed values:

auto

the data format is auto detected
json
xml
yaml
csv

Default: auto

function setDataEncoding(encoding)

Set the encoding of the data file set by setDataFile.

encoding

The data file encoding.

Default: utf-8

Example:

Set to use Latin-2 encoding.

setDataEncoding("iso8859-2")

function setDataIgnoreUndefined(value)

Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.

value

Set to true to ignore undefined variables.

Default: false

function setDataAutoEscape(value)

Auto escape HTML symbols in the input data before placing them into the output.

value

Set to true to turn auto escaping on.

Default: false

function setDataTrimBlocks(value)

Auto trim whitespace around each template command block.

value

Set to true to turn auto trimming on.

Default: false

function setDataOptions(options)

Set the advanced data options:

csv_delimiter - The CSV data delimiter, the default is ,.
xml_remove_root - Remove the root XML element from the input data.
data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.

options

Comma separated list of options.

Examples:

Use semicolon to separate CSV data.

setDataOptions("csv_delimiter=;")
Name the root of data rows and use the name in the template loop {% for row in rows %}...{% endfor %}.

setDataOptions("data_root=rows")
Remove XML root so it the HTML template can be more simple.

setDataOptions("xml_remove_root=1")

Miscellaneous

function setDebugLog(value)

Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

value

Set to true to enable the debug logging.

Default: false

function getDebugLogUrl()

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

Returns

string - The link to the debug log.

function getRemainingCreditCount()

Get the number of conversion credits available in your account.
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()

Get the number of credits consumed by the last conversion.

Returns

int - The number of credits.

function getJobId()

Get the job id.

Returns

string - The unique job identifier.

function getOutputSize()

Get the size of the output in bytes.

Returns

int - The count of bytes.

function getVersion()

Get the version details.

Returns

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

function setTag(tag)

Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.

tag

A string with the custom tag.

Example:

setTag("client-1234")

function setHttpProxy(proxy)

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

proxy

The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

Examples:

setHttpProxy("myproxy.com:8080")
setHttpProxy("113.25.84.10:33333")

function setHttpsProxy(proxy)

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

proxy

The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

Examples:

setHttpsProxy("myproxy.com:443")
setHttpsProxy("113.25.84.10:44333")

function setClientCertificate(certificate)

A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.

certificate

The file must be in PKCS12 format.

The file must exist and not be empty.

Example:

setClientCertificate("/home/user/john/pdfcrowd.crt")

function setClientCertificatePassword(password)

A password for PKCS12 file with a client certificate if it is needed.

password

Example:

setClientCertificatePassword("123456")

Tweaks

Expert options for fine-tuning output.

function setMaxLoadingTime(maxTime)

Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.

Availability: API client >= 5.15.0, converter >= 20.10. See versioning.

maxTime

The number of seconds to wait.

The value must be in the range 10-30.

function setConverterUserAgent(agent)

Specifies the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.

Availability: API client >= 6.4.0 See versioning.

agent

The user agent.

Allowed values:

chrome-desktop

The user-agent for desktop chrome corresponding to the converter used.
chrome-mobile

The user-agent for mobile chrome corresponding to the converter used.
latest-chrome-desktop

The user-agent of the recently released Chrome browser on desktops.
latest-chrome-mobile

The user-agent of the recently released Chrome browser on mobile devices.
A custom string for the user agent.

Default: chrome-desktop

Examples:

Mimic the recent chrome on mobiles.

setConverterUserAgent("latest-chrome-mobile")
Mimic Safari 18.0 browser.

setConverterUserAgent("Mozilla/5.0 (Macintosh; Intel Mac OS X 14_7_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.0 Safari/605.1.15")

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.

version

The version identifier.

Allowed values:

24.04

Version 24.04.
20.10

Version 20.10.
18.10

Version 18.10.

Default: 24.04

function setUseHttp(value)

Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.

value

Set to true to use HTTP.

Default: false

Warning

Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

function setClientUserAgent(agent)

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

Availability: API client >= 6.4.0 See versioning.

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.

agent

The user agent string.

Default: pdfcrowd_nodejs_client/6.4.0 (https://pdfcrowd.com)

function setProxy(host, port, userName, password)

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

host

The proxy hostname.

port

The proxy port.

userName

The username.

password

The password.

function setRetryCount(count)

Specifies the number of automatic retries when the 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.

count

Number of retries.

Default: 1

Example:

setRetryCount(3)