Options
All
  • Public
  • Public/Protected
  • All
Menu

An object used by RendererRuntime implementations to notify the ReaderView about content range changes.

A new instance is passed to RendererRuntime each time navigate() or navigateTo() is called. The RendererRuntime must then call notifyContentRangesChanged and notifyVisibleRangeChanged whenever new ranges have been calculated.

Hierarchy

  • IReaderViewContentRangeChangeCallbacks

Index

Methods

notifyContentRangesChanged

  • Called by the RendererRuntime to notify the reading system that the content ranges have changed.

    This method will internally call notifyVisibleRangeChanged.

    Parameters

    • contentRanges: IReaderViewContentRanges

      The new IReaderViewContentRanges.

    • visiblePages: IRenderableDocumentPage[]
    • Optional suggestedReadingPosition: IContentLocation

      The reading position that the renderer deems suitable for the new visible range. This position may be used by the ReaderView if its current readingPosition is outside the new visible range. If omitted, the start of the visible range will be used.

    Returns void

notifyVisibleRangeChanged

  • Called by the RendererRuntime to notify the reading system that the visible range has changed.

    Parameters

    • range: IContentLocation

      The visible range.

    • visiblePages: IRenderableDocumentPage[]
    • Optional suggestedReadingPosition: IContentLocation

      The reading position that the renderer deems suitable for the new visible range. This position may be used by the ReaderView if its current readingPosition is outside the new visible range. If omitted, the start of the visible range will be used.

    Returns void

Generated using TypeDoc