Options
All
  • Public
  • Public/Protected
  • All
Menu

Used internally by Renderer to fetch RenderableDocumentPages from ReaderDocuments associated with a ReaderView. Also contains methods used to report the Renderer state back to the ReaderView.

Passed by the ReaderView when it calls the IRenderer.attach() method.

Hierarchy

  • IRendererContext

Index

Methods

fetchEstimatedHeightPerReaderDocument

  • fetchEstimatedHeightPerReaderDocument(): Promise<number[]>
  • Fetch the estimated clientHeight for each reader document.

    Returns Promise<number[]>

getContentOnLoading

getPageProgressionDirection

getPreferredPageAspectRatio

  • getPreferredPageAspectRatio(): number
  • The preferred page aspect ratio that should be used when rendering reflowable content documents. This may be ignored by the renderer.

    Returns number

getReaderDocuments

  • Get the reader documents attached to the ReaderView.

    Returns IReaderDocument[]

getReaderPublications

getReaderViewDimensions

  • The dimensions of the view in CSS pixels.

    Returns IDimensions

getReaderViewElement

  • getReaderViewElement(): HTMLElement
  • The element that the renderer should render into, set by ReaderView.renderTo().

    Returns HTMLElement

isFirstPage

isLastPage

isLastPageOfReaderDocument

isRendererRuntimeVisible

  • isRendererRuntimeVisible(): boolean
  • If the renderer runtime associated with this context is currently visible on-screen.

    Returns boolean

isSwipeNavigationGestureAllowed

  • isSwipeNavigationGestureAllowed(): boolean
  • Returns boolean

loadFirstPage

loadNextPage

loadPageByContentLocation

loadPageByReaderDocumentPageIndex

loadPreviousPage

notifyPageLoadingComplete

  • notifyPageLoadingComplete(): void
  • Called by the renderer after all the renderTo() methods have been called on the loaded pages.

    Returns void

notifyPossibleNavigationActions

  • Called by the renderer to indicate what navigation actions it can currently accept. Note that GOTO navigations must always be accepted and will always override any existing navigation.

    Parameters

    Returns void

notifyScrollEnded

  • Called by the renderer after it has finished scrolling.

    Parameters

    Returns void

notifyScrollHeightChanged

  • notifyScrollHeightChanged(): void
  • Called by the renderer when the scrollHeight of the currently visible document has changed.

    Returns void

notifyScrollStarted

  • notifyScrollStarted(): void
  • Called by the renderer when it has started scrolling for any reason (can be a user scrolling, or due to a navigation).

    Returns void

notifyTransitionFinished

  • notifyTransitionFinished(): void
  • Called by the renderer when it has finished its transitioning animations.

    Returns void

notifyTransitionStarted

  • notifyTransitionStarted(): void
  • Called by the renderer when it is performing transitioning animations.

    Returns void

notifyVisibilityIntentionForLoadingPage

  • notifyVisibilityIntentionForLoadingPage(pagePromise: Promise<IRenderableDocumentPage>, visibilityIntent: boolean): void
  • Called by the renderer if it wishes to update the visibility intention for a page that has not yet finished loading. Does nothing if the page has already loaded, or if the visibilityIntent was already set to the specified value.

    Parameters

    Returns void

notifyVisiblePagesUpdated

  • notifyVisiblePagesUpdated(): void
  • Called by the renderer AFTER page.setVisible(true/false) have been called for all relevant pages.

    The renderer does not have to wait for pages to be rendered before calling this method.

    Returns void

setPanZoomAllowed

  • setPanZoomAllowed(allowed: boolean): void
  • Sets whether the renderer runtime accept transformations such as scaling and panning.

    Parameters

    • allowed: boolean

    Returns void

setSwipeNavigationGestureAllowed

  • setSwipeNavigationGestureAllowed(allowed: boolean): void
  • Sets whether the renderer runtime accept calls to handlePointerEngineEvent()

    Parameters

    • allowed: boolean

    Returns void

unloadPage

Generated using TypeDoc