Options
All
  • Public
  • Public/Protected
  • All
Menu

Options used with the SinglePageSwipeRenderer.

Hierarchy

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 direction

direction?: Axis

The swipe direction to use. Default value is Axis.X

default

X

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 minMarginBetweenPages

minMarginBetweenPages?: number

Minimum margin between pages in pixels.

int
default

24

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

Optional rubberBandElasticity

rubberBandElasticity?: number

A number between 0 and 1 configuring the rubberband effect when trying to swipe before the first page or after the last page. Lower value means less elasticity.

double
default

0.65

Optional showPageBackgroundShadow

showPageBackgroundShadow?: boolean

If a pages should render background shadows.

default

false.

Optional useWindowDimensionsForPageContainers

useWindowDimensionsForPageContainers?: boolean

Use full window dimensions when calculating page container sizes. This option should be true if the ReaderView element allows content to overflow.

default

true

Generated using TypeDoc