IReaderViewGotoOptions | Colibrio Reader Framework API

Options object used with ReaderView.goTo()

Hierarchy

IReaderViewGotoOptions

Index

Properties

setReadingPositionToVisibleRangeStart

Properties

Optional setReadingPositionToVisibleRangeStart

setReadingPositionToVisibleRangeStart?: boolean

If this option is false, the ReaderView will use the location specified to ReaderView.goTo() as the reading position if the navigation is successful. This is the default behaviour.

If this option is true, the ReaderView will use the start of the new visible range as the reading position if the navigation is successful.

As the readingPosition is used when synchronizing positions with an attached SyncMediaPlayer, this options is useful in order to control where the SyncMediaPlayer will start to play after a navigation.

Example 1: The user clicks an item in the Table of Contents:

Leave the option to false to let the SyncMediaPlayer start reading from the location specified in the Table of Contents item.

Example 2: The user clicks a position in a reading progress bar:

Set this option to true to let the SyncMediaPlayer start reading from the start of visible range.

default: false