Options
All
  • Public
  • Public/Protected
  • All
Menu

Passed to format adapter implementation of IReaderDocument.createRenderableDocument() and createRenderableDocumentPageIterator() containing necessary context for those operations.

Hierarchy

  • IReaderDocumentRenderingContext

Index

Methods

addReaderViewPropertyChangedListener

getConstrainedPageDimensions

  • Get the page dimensions that should be used for the renderable in CSS pixels.

    Parameters

    • Optional documentDimensions: IDimensions

      Should be passed if the document is fixed layout.

    Returns IDimensions

    The constrained page dimensions, or null if the renderer has already been detached.

getConstrainedPageScaleFactor

  • getConstrainedPageScaleFactor(documentDimensions: IDimensions): number
  • Get the scale factor between document dimensions and the constrained page dimensions

    Parameters

    Returns number

getPageStream

getReaderView

  • Get rhe ReaderView which will consume the resulting IRenderableDocumentPage

    Returns IReaderView

getReaderViewOptions

getReaderViewProperty

getRenderer

  • Get the renderer connected with this context.

    Returns IRenderer

getRendererRuntime

getRenderingSessionId

  • getRenderingSessionId(): number
  • Get the id of the current rendering session. This id is generated once per call to IRenderer.attach()

    Returns number

isCanceled

  • isCanceled(): boolean
  • If this rendering task has been canceled. The format adapter implementation can safely abort the operation by rejecting the resulting Promise.

    Returns boolean

onSelectionChanged

  • Should be called by the RenderablePage implementation when the text selection changes. This will cause a clearContentSelection ReaderViewProperty event to be emitted to clear selection in other pages.

    Parameters

    Returns void

removeReaderViewPropertyChangedListener

Generated using TypeDoc