JSON Bitmap Parameters

Describes a list of parameters used specifically in the rasterization of a PDF, PS, AFP or PCL file, defining which pages of the source file have to be converted to a bitmap and the properties of the resulting bitmap(s).

Structure

The structure consists of an object with the following optional name/value pairs:

  • type – the image type/format to be used in the creation of the image (value of either jpg, jpeg or png)
    (type of string – default value of jpg)

  • pages – the page range to be output; this counts over all pages even if one of the sections is configured to restart page numbers
    (type of string – default value is determined by the value of the archive parameter. If the archive parameter is specified to false, then the default value will be 1. If the archive parameter is either omitted or specified to a value of true, then the default value will be * (all pages) )

  • archive – whether to return the result as a ZIP file/archive; true means return the result as ZIP file, false as a JPEG or PNG file
    (type of boolean – default value is automatic: false if the output consists of a single file, true if the output consists of multiple files)

  • dpi – the target image resolution in dots per inch (DPI)
    (type of number – default value of 96)

  • scale – the scale of the target image
    (type of float – default value of 1.0)

Specific to parameters with a type parameter specified to a value of jpg, the following optional name/value pair can be specified:

  • quality – the image quality of the preview (value ranging from 0-100)
    (type of number – Default value of 100)

Example

The following is an example of this structure:

{
    "type": "png",
    "dpi": 150,
    "archive": true,
    "pages": "1,3,6-11"
}
{
    "type": "jpg",
    "quality": 90
}