Options
All
  • Public
  • Public/Protected
  • All
Menu

Options related to processing and presentation of PDF publications.

Hierarchy

Index

Properties

Optional additionalLocatorUrls

additionalLocatorUrls?: string[]

Additional locator URLs that should resolve to the ReaderPublication when calling methods with locator parameters, such as ReaderView.goTo(), ReaderViewAnnotationLayer.createAnnotation()

This can be useful when loading Locator data such as web annotation data from third party services or other applications.

default

[]

Optional clipboardOptions

Options controlling clipboard actions.

default

IReaderPublicationClipboardOptions

Optional defaultLocatorUrl

defaultLocatorUrl?: string

The base URL that should be used by the ReaderPublication when it creates new Locators.

NOTE: This option can only be set when calling ReadingSystemEngine.loadPublication(). It is NOT possible to change defaultLocatorUrl using ReaderPublication.setOptions().

If not specified, it will be generated based on the Publication's hash signature. (See IPublication.getHashSignature()) See the publication format implementation (EpubReaderPublication, PdfReaderPublication, etc) for details on how the defaultLocatorUrl is generated.

nodefault

Optional highResScaleThreshold

highResScaleThreshold?: number

The minimum amount of scaling before re-rendering the visible pages at a higher resolution.

default

1.1

double

Optional includeContentLocationInPointerMoveEvents

includeContentLocationInPointerMoveEvents?: boolean

If "pointermove" PointerEngineEvents should include the contentLocation property.

Defaults to false.

default

false

Optional maxCanvasPixels

maxCanvasPixels?: number

Determines the maximum number of pixels of the canvas we render the pdf to.

Defaults to 8M pixels for android/ios devices and 16M pixels for everything else.

default

8388608

int

Optional preventDefaultContextMenu

preventDefaultContextMenu?: boolean

If set to true, the reading system will prevent the default "right-click" and "long-press" context menus to be shown for publication content.

In order to prevent the default "right-click" and "long-press" context menus for your app content, you need to listen on the browser contextmenu event and call event.preventDefault();

IMPORTANT: Please note that this option does not work on iOS and iPadOS. There is no Web API available to prevent the context menu from being shown on those platforms. A workaround is to disable user content selection with ReaderView.setContentSelectionEnabled(false).

If you are using the Colibrio Reader Framework for iOS, then please use ColibrioView.setAllowedCalloutActions() instead.

default

false

Optional preventDragAndDropActions

preventDragAndDropActions?: boolean

Sets if users should be able to "drag-and-drop" content from the publication.

default

true

Generated using TypeDoc