Rasterizer Schema Diagram
The Rasterizer schema contains all the information needed to create a JSON document with parameters to customize how the pdf-image endpoint creates an image from a PDF.Loading ....
Rasterizer Schema JSON
{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Instructions",
"description": "Instructions for Raster endpoint",
"type": "object",
"properties": {
"startPageNumber": {
"description": "Starting page number of the PDF to rasterize.",
"type": "number",
"default": 1
},
"pageCount": {
"description": "Number of the pages to rasterize. Default 0, represents end of PDF.",
"type": "number",
"default": 0
},
"imageFormat": {
"oneOf": [
{
"description": "JPEG Image format.",
"type": "object",
"properties": {
"type": {
"description": "Image format type.",
"type": "string",
"enum": [
"jpeg"
]
},
"quality": {
"description": "Quality of the jpeg image.",
"type": "number",
"default": 60
}
},
"required": [
"type"
]
},
{
"description": "GIF Image format.",
"type": "object",
"properties": {
"type": {
"description": "Image format type.",
"type": "string",
"enum": [
"gif"
]
},
"ditheringPercent": {
"description": "Amount of dithering in percentage.",
"type": "number",
"default": 25
},
"ditheringAlgorithm": {
"description": "Type of dithering algorithm to be used.",
"type": "string",
"enum": [
"FloydSteinberg",
"Bayer",
"None"
],
"default": "floydSteinberg"
}
},
"required": [
"type"
]
},
{
"description": "BMP Image format.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Image format type.",
"enum": [
"bmp"
]
},
"colorFormat": {
"oneOf": [
{
"description": "RGB color format for image.",
"type": "string",
"enum": [
"rgb"
]
},
{
"description": "Monochrome color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format for image.",
"type": "string",
"enum": [
"monochrome"
]
},
"blackThreshold": {
"description": "Grayscale value which defines the limit of black. (0-255)",
"type": "number"
}
},
"required": [
"type",
"blackThreshold"
],
"additionalProperties": false
},
{
"description": "Monochrome color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format for image.",
"type": "string",
"enum": [
"monochrome"
]
},
"ditheringPercent": {
"description": "Amount of dithering in percentage.",
"type": "number",
"default": 25
},
"ditheringAlgorithm": {
"description": "Type of dithering algorithm to be used.",
"type": "string",
"enum": [
"floydSteinberg",
"bayer",
"none"
],
"default": "floydSteinberg"
}
},
"required": [
"type"
],
"additionalProperties": false
}
],
"default": "rgb"
}
},
"required": [
"type"
]
},
{
"description": "PNG Image format.",
"type": "object",
"properties": {
"type": {
"description": "Image format type.",
"type": "string",
"enum": [
"png"
]
},
"colorFormat": {
"oneOf": [
{
"description": "Color format for image which does not need extra processing.",
"type": "string",
"enum": [
"rgb",
"rgba",
"grayscale"
],
"default": "rgb"
},
{
"description": "Monochrome color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format type",
"type": "string",
"enum": [
"monochrome"
]
},
"blackThreshold": {
"description": "Grayscale value which defines the limit of black. (0-255)",
"type": "number"
}
},
"required": [
"type",
"blackThreshold"
],
"additionalProperties": false
},
{
"description": "Monochrome color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format for image.",
"type": "string",
"enum": [
"monochrome"
]
},
"ditheringPercent": {
"description": "Amount of dithering in percentage.",
"type": "number",
"default": 25
},
"ditheringAlgorithm": {
"description": "Type of dithering algorithm to be used.",
"type": "string",
"enum": [
"floydSteinberg",
"bayer",
"none"
],
"default": "floydSteinberg"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"description": "Indexed color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format type",
"type": "string",
"enum": [
"indexed"
]
},
"quantizationAlgorithm": {
"description": "Type of color quantization algorithm to be used.",
"type": "string",
"enum": [
"octree",
"webSafe",
"werner",
"wu"
],
"default": "octree"
},
"ditheringPercent": {
"description": "Amount of dithering in percentage.",
"type": "number",
"default": 25
},
"ditheringAlgorithm": {
"description": "Type of dithering algorithm to be used.",
"type": "string",
"enum": [
"floydSteinberg",
"bayer",
"none"
],
"default": "floydSteinberg"
}
},
"required": [
"type"
]
}
],
"default": "rgb"
}
},
"required": [
"type"
]
},
{
"description": "TIFF Image format.",
"type": "object",
"properties": {
"type": {
"description": "Image format type.",
"type": "string",
"enum": [
"tiff"
]
},
"multiPage": {
"description": "Generate single multipage TIFF file.",
"type": "boolean",
"default": false
},
"colorFormat": {
"oneOf": [
{
"description": "Color format for image which does not need extra processing.",
"type": "string",
"enum": [
"rgb",
"grayscale"
],
"default": "rgb"
},
{
"description": "Monochrome color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format type",
"type": "string",
"enum": [
"monochrome"
]
},
"blackThreshold": {
"description": "Grayscale value which defines the limit of black. (0-255)",
"type": "number"
},
"compressionType": {
"type": "string",
"description": "Compression of type CCIT. Only applies to the monochrome color format.",
"enum": [
"ccitGroup3",
"ccitGroup4"
],
"default": "ccitGroup3"
}
},
"required": [
"type",
"blackThreshold"
],
"additionalProperties": false
},
{
"description": "Monochrome color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format for image.",
"type": "string",
"enum": [
"monochrome"
]
},
"ditheringPercent": {
"description": "Amount of dithering in percentage.",
"type": "number",
"default": 25
},
"ditheringAlgorithm": {
"description": "Type of dithering algorithm to be used.",
"type": "string",
"enum": [
"floydSteinberg",
"bayer",
"none"
],
"default": "floydSteinberg"
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"description": "Indexed color format for image.",
"type": "object",
"properties": {
"type": {
"description": "Color format type",
"type": "string",
"enum": [
"indexed"
]
},
"quantizationAlgorithm": {
"description": "Type of color quantization algorithm to be used.",
"type": "string",
"enum": [
"octree",
"webSafe",
"werner",
"wu"
],
"default": "octree"
},
"ditheringPercent": {
"description": "Amount of dithering in percentage.",
"type": "number",
"default": 25
},
"ditheringAlgorithm": {
"description": "Type of dithering algorithm to be used.",
"type": "string",
"enum": [
"floydSteinberg",
"bayer",
"none"
],
"default": "floydSteinberg"
}
},
"required": [
"type"
]
}
]
}
},
"required": [
"type"
]
}
],
"default": {
"type": "png",
"colorFormat": "rgb"
}
},
"imageSize": {
"oneOf": [
{
"description": "DPI based image size.",
"type": "object",
"properties": {
"type": {
"description": "Image size type.",
"type": "string",
"enum": [
"dpi"
]
},
"horizontalDpi": {
"description": "Horizontal DPI",
"type": "number"
},
"verticalDpi": {
"description": "Vertical DPI",
"type": "number"
}
},
"required": [
"type",
"horizontalDpi",
"verticalDpi"
]
},
{
"description": "Fixed image size.",
"type": "object",
"properties": {
"type": {
"description": "Image size type.",
"type": "string",
"enum": [
"fixed"
]
},
"width": {
"description": "Width of the image in given unit.",
"type": "number"
},
"height": {
"description": "Height of the image in given unit.",
"type": "number"
},
"unit": {
"description": "Unit of width and height provided.",
"type": "string",
"enum": [
"millimeter",
"inch",
"point"
],
"default": "point"
}
},
"required": [
"type",
"width",
"height"
]
},
{
"description": "Image size which fits to given maximum size.",
"type": "object",
"properties": {
"type": {
"description": "Image size type.",
"type": "string",
"enum": [
"max"
]
},
"maxWidth": {
"description": "Maximum width of the image in given unit.",
"type": "number"
},
"maxHeight": {
"description": "Maximum height of the image in given unit.",
"type": "number"
},
"unit": {
"description": "Unit of width and height provided.",
"type": "string",
"enum": [
"millimeter",
"inch",
"point"
],
"default": "point"
}
},
"oneOf": [
{
"required": [
"type",
"maxWidth"
]
},
{
"required": [
"type",
"maxHeight"
]
}
]
},
{
"description": "Percentage based image size.",
"type": "object",
"properties": {
"type": {
"description": "Image size type.",
"type": "string",
"enum": [
"percentage"
]
},
"horizontalPercentage": {
"description": "Horizontal zoom percentage.",
"type": "number",
"default": 100
},
"verticalPercentage": {
"description": "Vertical zoom percentage",
"type": "number",
"default": 100
}
},
"oneOf": [
{
"required": [
"type",
"horizontalPercentage"
]
},
{
"required": [
"type",
"verticalPercentage"
]
}
]
}
],
"default": {
"type": "dpi",
"horizontalDpi": 96,
"verticalDpi": 96
}
}
}
}
Schema Location
https://www.dynamicpdf.com/schemas/raster.instructions.schema.json
