# Rendition Displays an Epub as a series of Views for each Section. Requires Manager and View class to handle specifics of rendering the section content. **Kind**: global class * [Rendition](#Rendition) * [new Rendition(book, [options])](#new_Rendition_new) * _instance_ * [.setManager(manager)](#Rendition+setManager) * [.requireManager(manager)](#Rendition+requireManager) ⇒ any * [.start()](#Rendition+start) * [.attachTo(element)](#Rendition+attachTo) ⇒ Promise.<any> * [.display([target])](#Rendition+display) ⇒ Promise.<Section> * [.moveTo(offset)](#Rendition+moveTo) * [.resize([width], [height])](#Rendition+resize) ⇒ Object * [.clear()](#Rendition+clear) * [.next()](#Rendition+next) ⇒ Promise.<any> * [.prev()](#Rendition+prev) ⇒ Promise.<any> * [.updateLayout(options)](#Rendition+updateLayout) * [.currentLocation()](#Rendition+currentLocation) ⇒ displayedLocation \| Promise * [.destroy()](#Rendition+destroy) * [.getRange(epubcfi, ignoreClass)](#Rendition+getRange) ⇒ Range * [.getContents()](#Rendition+getContents) ⇒ Array.<Contents> * [.views()](#Rendition+views) ⇒ Views * _static_ * [.settings](#Rendition.settings) : object * [.hooks](#Rendition.hooks) : object * [.annotations](#Rendition.annotations) : Annotations * [.themes](#Rendition.themes) : Themes * [.started](#Rendition.started) : Promise.<any> * [.layout](#Rendition.layout) : Layout * [.viewport](#Rendition.viewport) : Viewport * ["layout" (props, changed)](#Rendition.event_layout) * ["resized" (rect)](#Rendition.event_resized) * ["orientationchange" (target)](#Rendition.event_orientationchange) * ["started"](#Rendition.event_started) * ["attached"](#Rendition.event_attached) * ["displayed" (section)](#Rendition.event_displayed) * ["displayError" (err)](#Rendition.event_displayError) * ["rendered" (view)](#Rendition.event_rendered) * ["removed" (view)](#Rendition.event_removed) * ["relocated" (location)](#Rendition.event_relocated) * ["selected" (cfirange, contents)](#Rendition.event_selected) * ["markClicked" (cfiRange, data, contents)](#Rendition.event_markClicked) * [.location](#Rendition.location) : object ## new Rendition(book, [options]) | Param | Type | Default | Description | | --- | --- | --- | --- | | book | Book | | | | [options] | object | | | | [options.axis] | string | | viewport axis | | [options.width] | string \| number | | viewport width | | [options.height] | string \| number | | viewport height | | [options.ignoreClass] | string | | class for the cfi parser to ignore | | [options.manager] | string \| class | "'default'" | string values: default / continuous | | [options.view] | string \| class | "'iframe'" | | | [options.method] | string | "'write'" | values: `"write"` OR `"srcdoc"` | | [options.layout] | string | | layout to force | | [options.spread] | string | | force spread value | | [options.direction] | string | | direction `"ltr"` OR `"rtl"` | | [options.pageWidth] | number | | page width | | [options.pageHeight] | number | | page height | | [options.minSpreadWidth] | number | | overridden by spread: none (never) / both (always) | | [options.stylesheet] | string | | url of stylesheet to be injected | | [options.script] | string | | url of script to be injected | | [options.snap] | object | | use snap scrolling | | [options.sandbox] | Array.<string> | [] | iframe sandbox policy list | ## rendition.setManager(manager) Set the manager function **Kind**: instance method of [Rendition](#Rendition) | Param | Type | | --- | --- | | manager | function | ## rendition.requireManager(manager) ⇒ any Require the manager from passed string, or as a class function **Kind**: instance method of [Rendition](#Rendition) | Param | Type | Description | | --- | --- | --- | | manager | string \| object | [description] | ## rendition.start() Start the rendering **Kind**: instance method of [Rendition](#Rendition) ## rendition.attachTo(element) ⇒ Promise.<any> Call to attach the container to an element in the dom Container must be attached before rendering can begin **Kind**: instance method of [Rendition](#Rendition) | Param | Type | Description | | --- | --- | --- | | element | Element \| string | viewport element | ## rendition.display([target]) ⇒ 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. **Kind**: instance method of [Rendition](#Rendition) | Param | Type | Description | | --- | --- | --- | | [target] | string \| number | `Section.index` OR `Section.idref` OR `Section.href` OR EpubCFI | **Example** ```js rendition.display() ``` **Example** ```js rendition.display(3) ``` **Example** ```js rendition.display("#chapter_001") ``` **Example** ```js rendition.display("chapter_001.xhtml") ``` **Example** ```js rendition.display("epubcfi(/6/8!/4/2/16/1:0)") ``` ## rendition.moveTo(offset) Move the Rendition to a specific offset Usually you would be better off calling display() **Kind**: instance method of [Rendition](#Rendition) | Param | Type | | --- | --- | | offset | object | ## rendition.resize([width], [height]) ⇒ Object Resize viewport container **Kind**: instance method of [Rendition](#Rendition) | Param | Type | | --- | --- | | [width] | number \| string | | [height] | number \| string | **Example** ```js rendition.resize(800, 600) ``` **Example** ```js rendition.resize("90%", 600) ``` ## rendition.clear() Clear all rendered views **Kind**: instance method of [Rendition](#Rendition) ## rendition.next() ⇒ Promise.<any> Go to the next "page" in the rendition **Kind**: instance method of [Rendition](#Rendition) ## rendition.prev() ⇒ Promise.<any> Go to the previous "page" in the rendition **Kind**: instance method of [Rendition](#Rendition) ## rendition.updateLayout(options) Layout configuration **Kind**: instance method of [Rendition](#Rendition) | Param | Type | | --- | --- | | options | object | ## rendition.currentLocation() ⇒ displayedLocation \| Promise Get the Current Location object **Kind**: instance method of [Rendition](#Rendition) **Returns**: displayedLocation \| Promise - location (may be a promise) ## rendition.destroy() Remove and Clean Up the Rendition **Kind**: instance method of [Rendition](#Rendition) ## rendition.getRange(epubcfi, ignoreClass) ⇒ Range Get a Range from a Visible CFI **Kind**: instance method of [Rendition](#Rendition) | Param | Type | Description | | --- | --- | --- | | epubcfi | string | EpubCfi string | | ignoreClass | string | | ## rendition.getContents() ⇒ Array.<Contents> Get the Contents object of each rendered view **Kind**: instance method of [Rendition](#Rendition) ## rendition.views() ⇒ Views Get the views member from the manager **Kind**: instance method of [Rendition](#Rendition) ## Rendition.settings : object **Kind**: static property of [Rendition](#Rendition) **Read only**: true ## Rendition.hooks : object Adds Hook methods to the Rendition prototype **Kind**: static property of [Rendition](#Rendition) **Properties** | Name | Type | | --- | --- | | hooks.content | Hook | | hooks.display | Hook | | hooks.layout | Hook | | hooks.render | Hook | | hooks.show | Hook | | hooks.unloaded | Hook | ## Rendition.annotations : Annotations **Kind**: static property of [Rendition](#Rendition) **Read only**: true ## Rendition.themes : Themes **Kind**: static property of [Rendition](#Rendition) **Read only**: true ## Rendition.started : Promise.<any> returns after the rendition has started **Kind**: static property of [Rendition](#Rendition) ## Rendition.layout : Layout **Kind**: static property of [Rendition](#Rendition) **Read only**: true ## Rendition.viewport : Viewport **Kind**: static property of [Rendition](#Rendition) **Read only**: true ## "layout" (props, changed) Emit of updated the Layout state **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | props | Layout | | changed | object | ## "resized" (rect) Emit that the rendition has been resized **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | rect | object | ## "orientationchange" (target) **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | target | object | ## "started" Emit that rendering has started **Kind**: event emitted by [Rendition](#Rendition) ## "attached" Emit that rendering has attached to an element **Kind**: event emitted by [Rendition](#Rendition) ## "displayed" (section) Emit that a section has been displayed **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | section | Section | ## "displayError" (err) Emit that has been an error displaying **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | err | Error | ## "rendered" (view) Emit that a section has been rendered **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | view | View | ## "removed" (view) Emit that a section has been removed **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | view | View | ## "relocated" (location) **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | location | object | ## "selected" (cfirange, contents) Emit that a text selection has occurred **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | cfirange | string | | contents | Contents | ## "markClicked" (cfiRange, data, contents) Emit that a mark was clicked **Kind**: event emitted by [Rendition](#Rendition) | Param | Type | | --- | --- | | cfiRange | EpubCFI | | data | object | | contents | Contents | ## Rendition.location : object A Rendered Location Range **Kind**: static typedef of [Rendition](#Rendition) **Properties** | Name | Type | Description | | --- | --- | --- | | start | object | | | start.index | string | | | start.href | string | | | start.displayed | object | | | start.displayed.page | number | | | start.displayed.total | number | | | start.cfi | string | EpubCFI string format | | start.location | number | | | start.percentage | number | | | end | object | | | end.index | string | | | end.href | string | | | end.displayed | object | | | end.displayed.page | number | | | end.displayed.total | number | | | end.cfi | string | EpubCFI string format | | end.location | number | | | end.percentage | number | | | atStart | boolean | Location at start position | | atEnd | boolean | Location at end position |