Android Scanbot SDK API reference/io.scanbot.pdf.model/PdfConfiguration

PdfConfiguration

data class PdfConfiguration(var attributes: PdfAttributes = PdfAttributes( ), var pageSize: PageSize = PageSize.A4, var pageDirection: PageDirection = PageDirection.PORTRAIT, var pageFit: PageFit = PageFit.FIT_IN, var dpi: Int = 72, var jpegQuality: Int = 80, var resamplingMethod: ResamplingMethod = ResamplingMethod.NONE) : Parcelable

The parameters pageSize, pageFit, dpi and resamplingMethod interact in a complex way when adding bitmap images (JPEG, PNG, or raw) to the PDF. There are three cases to consider:

pageSize is CUSTOM: in this case dpi is used as the conversion ratio to calculate both the physical page and image sizes in inches from the bitmap dimensions. resamplingMethod is ignored.
pageSize is not CUSTOM AND pageFit is NONE: in this case dpi is used as the conversion ratio to calculate only the physical image size in inches from the bitmap dimensions. The image is centered onto the page. resamplingMethod is ignored.
pageSize is not CUSTOM AND pageFit is not NONE: in this case the page has a pre-determined physical size and we want to stretch the image to fit the page in one of the ways described by pageFit. The image DPI is automatically calculated for each image from the given physical page size, page fit setting and image dimensions. There are two sub-cases to consider: a. resamplingMethod is NONE OR the calculated DPI is less than or equal to dpi: in this case the image is added to the PDF without resampling, which means that the image rectangle is simply rescaled to fit into the page as specified by pageFit and pageSize. b. resamplingMethod is not NONE AND the calculated DPI is greater than dpi: in this case the bitmap of the image is resampled to match dpi using the selected method before adding it to the PDF. This will result in a bitmap that is smaller than the original image and hence, the resulting PDF will be smaller in size.

Constructors

PdfConfiguration

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(attributes: PdfAttributes = PdfAttributes( ), pageSize: PageSize = PageSize.A4, pageDirection: PageDirection = PageDirection.PORTRAIT, pageFit: PageFit = PageFit.FIT_IN, dpi: Int = 72, jpegQuality: Int = 80, resamplingMethod: ResamplingMethod = ResamplingMethod.NONE)

Types

Companion

object Companion

Properties

attributes

var attributes: PdfAttributes

Attributes.

dpi

var dpi: Int

The dpi parameter has two different meanings depending on the value of pageSize and pageFit. If pageSize is CUSTOM or pageFit is NONE, then dpi is the conversion ratio used to convert from units of pixels to physical inches when adding bitmap images (JPEG, PNG, or raw) to the PDF. Otherwise, if resamplingMethod is not NONE, then the image is downscaled if necessary (if the image after being fit to the page has a higher calculated DPI than dpi) to match dpi before adding it to the PDF. Otherwise, the setting is ignored and the calculated image DPI is used instead.

jpegQuality

var jpegQuality: Int

JPEG quality for images. Applies if an image is added as a cv::Mat and therefore needs to be encoded. Also applies if resamplingMethod not NONE and the image being added needs to be downscaled. Otherwise, when adding JPEG files to the PDF, the files are copied directly into the PDF and not re-encoded, which is many times faster and also preserves the quality of the original.

pageDirection

var pageDirection: PageDirection

Page direction.

pageFit

var pageFit: PageFit

How to fit the image into the page. Only used if pageSize is not CUSTOM. The image can either be stretched to fill the page, in one of three ways, or centered on the page without stretching.

pageSize

var pageSize: PageSize

Physical size of the page. If CUSTOM, the page size will be set as the image size at given dpi.

resamplingMethod

var resamplingMethod: ResamplingMethod

Resampling method.

Functions

clone

fun clone(): PdfConfiguration

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject