Options
All
  • Public
  • Public/Protected
  • All
Menu

Options used for configuring the panZoom gesture on a ReaderView. Part of IReaderViewOptions.gestureOptions

Hierarchy

  • IReaderViewPanZoomGestureOptions

Index

Properties

Optional allowSinglePointerPan

allowSinglePointerPan?: boolean

Allow panning with single pointer.

default

true

Optional maxPanOffsetHorizontal

maxPanOffsetHorizontal?: string

The maximum horizontal pan offset relative to the dimensions of the ReaderView, defined as a CSS string in pixels or percentage.

Example: Setting it to "0%" will not allow the left side of the publication to be panned further right than the left side of the ReaderView. (and the opposite for the right side)

Example: Setting it to "50%" will allow the left side of the publication to be panned to the midpoint of the ReaderView. (and the same for the right side)

Example: Setting it to "100%" will allow the publication to be panned all the way outside the ReaderView.

NOTE: This options has no effect if IReaderViewOptions.transformManagerOptions.maxPanOffsetVertical has been set.

default

50%

deprecated

Please use IReaderViewOptions.transformManagerOptions.maxPanOffsetHorizontal instead.

Optional maxPanOffsetVertical

maxPanOffsetVertical?: string

The maximum vertical pan offset relative to the dimensions of the ReaderView, defined as a CSS string in pixels or percentage.

Example: Setting it to "0%" will not allow the top of the publication to be panned further down than the top of the ReaderView. (and the opposite for the bottom)

Example: Setting it to "50%" will allow the top of the publication to be panned to the midpoint of the ReaderView. (and the same for the bottom)

Example: Setting it to "100%" will allow the publication to be panned all the way outside the ReaderView.

NOTE: This options has no effect if IReaderViewOptions.transformManagerOptions.maxPanOffsetVertical has been set.

default

50%

deprecated

Please use IReaderViewOptions.transformManagerOptions.maxPanOffsetVertical instead.

Optional maxScaleFactor

maxScaleFactor?: number

The maximum allowed scale factor.

NOTE: This options has no effect if IReaderViewOptions.transformManagerOptions.maxScaleFactor has been set.

double
default

5.0

deprecated

Please use IReaderViewOptions.transformManagerOptions.maxScaleFactor instead.

Optional pinchZoomThresholdPx

pinchZoomThresholdPx?: number

How much the distance between pointers has to change before applying zoom/scale.

int
default

32

Optional pointerTypes

pointerTypes?: IPointerTypeOptions

Sets which pointer-types that should trigger pan-zoom gestures.

default

IPointerTypeOptions

Optional removeTransformOnZoomOutGesture

removeTransformOnZoomOutGesture?: boolean

Allow pan-zoom gestures to exit the transform when zoomed out to a scale factor close to 1.

default

true

Generated using TypeDoc