Options
All
  • Public
  • Public/Protected
  • All
Menu

Options used with the StackRenderer.

Hierarchy

Index

Properties

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

disable3dPerspective?: boolean

Disables 3D perspective when swiping pages. This will also force showPageTurnShadow to false.

default

false

disableAnimations?: boolean

If animations should be used or not by the renderer.

default

false

fixDisappearingCharactersInChromeForAndroid?: boolean

Set to true to enable a bugfix for a specific bug in Chrome on Android. The bug causes content to sometimes disappear when performing pan-zoom gestures.

The negative effect of enabling this bugfix is that zoomed-in content will appear blurry. The bug has not been observed since Chrome 90, but if it should resurface, setting this option to true should fix the problem.

default

false

goToAnimationDurationMs?: number

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

int
default

null

ignoreAspectRatio?: boolean

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

default

false

name?: string

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

Defaults to generated name.

nativeignore
pageBackgroundColor?: string

A CSS color to use as default page background.

default

#ffffff

pageTurnShadowMaxOpacity?: number

A value between 0 and 1 describing maximum amount of opacity that is used for the page turn shadow effects. Larger values will give darker shadows.

double
default

0.5

perspectiveFactor?: number

Sets the perspective factor for the page turn animation. The final CSS value is calculated by multiplying this factor with the width (px) of the renderer. A larger value means the viewer is further away.

double
default

2.0

rendererBackgroundShadowOpacity?: number

A value between 0 and 1, controlling the opacity for the shadow beneath the renderer.

This option has no effect if showRendererBackgroundShadow is set to false.

double
default

0.2

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

showPageTurnShadow?: boolean

Render shadow effects when turning pages.

default

true

showRendererBackgroundShadow?: boolean

Render shadow effects beneath the renderer.

default

true

Generated using TypeDoc