Options
All
  • Public
  • Public/Protected
  • All
Menu

The ReaderView state as a JSON serializable object.

Hierarchy

  • IReaderViewStateData

Index

Properties

activeGestureType

activeGestureType: ReaderViewGestureType

The current active user gesture if any.

activeNavigationAction

activeNavigationAction: NavigationAction

The current navigation action being performed if any.

activeRendererName

activeRendererName: string

The name of the current active renderer.

nativeignore

activeTransform

activeTransform: ITransformData

The current active transform applied to the ReaderView, if any.

allowedGestureTypes

allowedGestureTypes: ReaderViewGestureType[]

The types of gestures that are allowed to be performed on this ReaderView.

atEnd

atEnd: boolean

Check if this ReaderView is currently showing the last content in the last reader document added to the ReaderView.

atStart

atStart: boolean

If this ReaderView is currently showing the first content in the first reader document added to the ReaderView.

canPerformGoTo

canPerformGoTo: boolean

If the goTo() or goToStart() action can be performed right now.

canPerformNext

canPerformNext: boolean

If the next() action can be performed right now.

canPerformPrevious

canPerformPrevious: boolean

If the previous() action can be performed right now.

canTransform

canTransform: boolean

If the ReaderViewTransformManager can be used to apply transforms right now.

contentSelectionEnabled

contentSelectionEnabled: boolean

If the user is able to select content in content documents.

destroyed

destroyed: boolean

If this ReaderView has been destroyed.

name

name: string

Get the name of the ReaderView

nativeignore

offscreenContentRendering

offscreenContentRendering: boolean

If offscreen content is currently rendering.

pageProgressionDirection

pageProgressionDirection: ReaderViewPageProgressionDirection

The page progression direction used by the ReaderView.

readingPosition

readingPosition: ISimpleLocatorData

The current reading position.

responsiveRendererSelectionEnabled

responsiveRendererSelectionEnabled: boolean

If the ReaderView will choose the activeRenderer based on the ResponsiveViewRules associated with each added renderer. See ReaderView.addRenderer() for more details.

scriptedContentDocumentEventHandlersEnabled

scriptedContentDocumentEventHandlersEnabled: boolean

If the scripted content document event handlers are allowed to receive events. Note that regardless if it is true or false, you will still receive EngineEvents.

scrollState

Information about a renderer's current scroll state. Note that the scrollTop value is not up-to-date while scrolling is true.

visibleContentRendering

visibleContentRendering: boolean

If visible content is currently rendering.

visiblePages

visiblePages: IVisiblePageData[]

Information about the current visible pages.

visibleRange

visibleRange: ISimpleLocatorData

The locator describing the range of the visible content

Generated using TypeDoc