IPaginatedRendererOptions | Colibrio Reader Framework API

Common options for paginated renderers.

Hierarchy

IRendererOptions
- IPaginatedRendererOptions

Index

Properties

Optional animationDurationMs

animationDurationMs?: number

How long the animations to next/previous will be. Default is null which will use specific values dependent on the presentation mode and platform types: 'mobile', 'tablet' or 'desktop'.

double
default: null

Optional disableAnimations

disableAnimations?: boolean

If animations should be used or not by the renderer.

default: false

Optional goToAnimationDurationMs

goToAnimationDurationMs?: number

The goTo animation duration when fading in. The default value null will use platform specific duration.

int
default: null

Optional ignoreAspectRatio

ignoreAspectRatio?: boolean

Ignore the calculated aspectRatio to take up as much of the available view space as possible.

default: false

Optional name

name?: string

The name of the Renderer. This can be used to retrieve the Renderer from the ReaderView etc.

Defaults to generated name.

nativeignore

Optional pageBackgroundColor

pageBackgroundColor?: string

A CSS color to use as default page background.

default: #ffffff