IPdfPublicationOptions | Colibrio Reader Framework API

Options used when creating a PdfPublication instance.

Hierarchy

IPdfPublicationOptions

Index

Properties

Optional chunkSize

chunkSize?: number

Sets which chunk size to use when requesting chunks from the IRandomAccessDataSource instance.

If enableDeterministicChunkRequests is false:

This value defines the maximum chunk size that will be used per request.
Smaller chunks may be requested.

If enableDeterministicChunkRequests is true:

All requests will use the specified chunk size, with the exception of the last chunk which might be smaller (but still deterministic).
The startOffset used in the call to IRandomAccessDataSource.fetchChunk() is guaranteed to be a multiple of the chunkSize.

default: 128000
int

Optional disableFontFace

disableFontFace?: boolean

By default fonts are converted to OpenType fonts and loaded via font face rules. If disabled, fonts will be rendered using a built-in font renderer that constructs the glyphs with primitive path commands. The default value is false.

Note: Only set this option to true for platforms and publications that have problems with text-rendering. It may have a major performance impact and may also cause blurrier text.

default: false

Optional enableDeterministicChunkRequests

enableDeterministicChunkRequests?: boolean

Enables deterministic chunk sizes and offsets when streaming the PDF file using an IRandomAccessDataSource instance.

Deterministic chunk requests are useful for caching chunks locally as the same offsets will be used in future requests to RandomAccessDataSource.fetchChunk(). Setting enableDeterministicChunkRequests to true will consume up to 16 MB more of memory in order to prevent multiple requests of the same chunk.

default: false

Optional password

password?: string

Used to decrypt a password-protected publication

default: null