Class Rendition

constructor

• new Rendition(book: Book, options?: RenditionOptions): Rendition

  Parameters

  • book: Book
  • Optionaloptions: RenditionOptions

  Returns Rendition

_layout

annotations

book

displaying

emit

epubcfi

hooks

location

manager

off

on

q

settings

started

starting

themes

View

ViewManager

attachTo

• attachTo(element: string | HTMLElement): Promise<void>

  Call to attach the container to an element in the dom Container must be attached before rendering can begin

  Parameters

  • element: string | HTMLElement

    to attach to

  Returns Promise<void>

clear

• clear(): void

  Clear all rendered views

  Returns void

currentLocation

• currentLocation(): Location | undefined

  Get the Current Location object

  Returns Location | undefined

  location (may be a promise)

destroy

• destroy(): void

  Remove and Clean Up the Rendition

  Returns void

direction

• direction(dir?: string): void

  Adjust the direction of the rendition

  Parameters

  • Optionaldir: string

  Returns void

display

• display(target?: string | number): Promise<Section>

  Display a point in the book The request will be added to the rendering Queue, so it will wait until book is opened, rendering started and all other rendering tasks have finished to be called.

  Parameters

  • Optionaltarget: string | number

    Url or EpubCFI

  Returns Promise<Section>

flow

• flow(flow: string): void

  Adjust the flow of the rendition to paginated or scrolled (scrolled-continuous vs scrolled-doc are handled by different view managers)

  Parameters

  • flow: string

  Returns void

getContents

• getContents(): Contents[]

  Get the Contents object of each rendered view

  Returns Contents[]

getRange

• getRange(cfi: string, ignoreClass?: string): Range | undefined

  Get a Range from a Visible CFI

  Parameters

  • cfi: string

    EpubCfi String

  • OptionalignoreClass: string

  Returns Range | undefined

layout

• layout(settings?: GlobalLayout): Layout | undefined

  Adjust the layout of the rendition to reflowable or pre-paginated

  Parameters

  • Optionalsettings: GlobalLayout

  Returns Layout | undefined

moveTo

• moveTo(offset: { left: number; top: number }): void

  Move the Rendition to a specific offset Usually you would be better off calling display()

  Parameters

  • offset: { left: number; top: number }

  Returns void

next

• next(): Promise<void>

  Go to the next "page" in the rendition

  Returns Promise<void>

prev

• prev(): Promise<void>

  Go to the previous "page" in the rendition

  Returns Promise<void>

reportLocation

• reportLocation(): Promise<void>

  Report the current location. Emits "relocated" and "locationChanged" events.

  Returns Promise<void>

requireManager

• requireManager(
      manager: string | object | ViewManagerConstructor,
  ): ViewManagerConstructor

  Require the manager from passed string, or as a class function

  Parameters

  • manager: string | object | ViewManagerConstructor

    [description]

  Returns ViewManagerConstructor

requireView

• requireView(view: string | object | ViewConstructor): ViewConstructor

  Require the view from passed string, or as a class function

  Parameters

  • view: string | object | ViewConstructor

  Returns ViewConstructor

resize

• resize(width?: number, height?: number, epubcfi?: string): void

  Trigger a resize of the views

  Parameters

  • Optionalwidth: number
  • Optionalheight: number
  • Optionalepubcfi: string

    (optional)

  Returns void

setManager

• setManager(manager: DefaultViewManager): void

  Set the manager function

  Parameters

  • manager: DefaultViewManager

  Returns void

spread

• spread(spread: string, min?: number): void

  Adjust if the rendition uses spreads

  Parameters

  • spread: string

    none | auto (TODO: implement landscape, portrait, both)

  • Optionalmin: number

    min width to use spreads at

  Returns void

start

• start(): void

  Start the rendering

  Returns void

  rendering has started

views

• views(): IframeView[] | Views

  Get the views member from the manager

  Returns IframeView[] | Views