Type: Spine

Type: Locations

Type: Navigation

Type: PageList

Open a epub or url

book.open("/path/to/book.epub")

Load a resource from the Book

Resolve a path to it's absolute position in the Book

Get a canonical link to a path

Gets a Section of the Book from the Spine Alias for book.spine.get

Sugar to render a book to an element

Set if request should use withCredentials

Set headers request should use

Get the cover url

Find a DOM Range for a given CFI Range

Generates the Book Key using the identifer in the manifest or other string provided

Destroy the Book and all associated objects

Resolves a relative path to a absolute url

Resolve a path relative to the url

Parse the path: https://nodejs.org/api/path.html#path_path_parse_path

Check if path ends with a directory

Resolve a path against the directory of the Path

https://nodejs.org/api/path.html#path_path_resolve_paths

Resolve a path relative to the directory of the Path

https://nodejs.org/api/path.html#path_path_relative_from_to

Return the path string

Unpack items from a opf into spine items

Get an item from the spine

spine.get();

spine.get(1);

spine.get("chap1.html");

spine.get("#id1234");

Loop over the Sections in the Spine

Find the first Section in the Spine

Find the last Section in the Spine

Load the section from its url

Render the contents of a section

Find a string in a section

Reconciles the current chapters layout properies with the global layout properities.

Get a CFI from a Range in the Section

Get a CFI from an Element in the Section

Unload the section document

Load all of sections in the book to generate locations

Get a location from an EpubCFI

Get a percentage position in locations from an EpubCFI

Get a percentage position from a location index

Get an EpubCFI from location index

Get an EpubCFI from location percentage

Load locations from JSON

Save locations to JSON

Get the current location

Set the current location

Locations length

Parse the Container XML

Parse OPF XML

Load JSON Manifest

Parse out the navigation items

Get an item from the navigation

Get a landmark by type List of types: https://idpf.github.io/epub-vocabs/structure/

Load Spine Items

forEach pass through

Create a url to a resource

Create blob urls for all the assets

Resolve all resources URLs relative to an absolute URL

Get a URL for a resource

Substitute urls in content, with replacements, relative to a url if provided

Parse PageList Xml

Get a PageList result from a EpubCFI

Get an EpubCFI from a Page List Item

Get a Page from Book percentage

Returns a value between 0 - 1 corresponding to the location of a page

Returns a value between 0 - 1 corresponding to the location of a cfi

Destroy

Open an archive

Load and Open an archive

Request a url from the archive

Get a Blob from Archive by Url

Get Text from Archive by Url

Get a base64 encoded result from Archive by Url

Create a Url from an unarchived item

Revoke Temp Url for a achive item

Adds Hook methods to the Rendition prototype

Type: object

Type: Themes

Type: Annotations

A Rendered Location Range

Set the manager function

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

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

Start the rendering

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

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.

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

Trigger a resize of the views

Clear all rendered views

Go to the next "page" in the rendition

Go to the previous "page" in the rendition

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

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

Adjust if the rendition uses spreads

Adjust the direction of the rendition

Report the current location

Get the Current Location object

Remove and Clean Up the Rendition

Get a Range from a Visible CFI

Get the Contents object of each rendered view

Get the views member from the manager

Emit that rendering has started

Emit that rendering has attached to an element

Emit that a section has been displayed

Emit that has been an error displaying

Emit that a section has been rendered

Emit that a section has been removed

Emit that the rendition has been resized

Emit that the rendition has been rotated

Emit that a text selection has occured

Emit that a mark was clicked

Adds a function to be run before a hook completes

this.content.register(function(){...});

Triggers a hook to run all functions

this.content.trigger(args).then(function(){...});

Add an item to the queue

Run one item

Run all tasks sequentially, at convince

Flush all, as quickly as possible

Clear all items in wait

Get the number of tasks in the queue

Pause a running queue

End the queue

Switch the flow between paginated and scrolled

Switch between using spreads or not, and set the width at which they switch to single.

Calculate the dimensions of the pagination

Apply Css to a Document

Count number of pages

Add themes to be used by a rendition

themes.register("light", "http://example.com/light.css")

themes.register("light", { "body": { "color": "purple"}})

themes.register({ "light" : {...}, "dark" : {...}})

Add a default theme to be used by a rendition

themes.register("http://example.com/default.css")

themes.register({ "body": { "color": "purple"}})

Register themes object

Register a url

Register rule

Select a theme

Update a theme

Inject all themes into contents

Add Theme to contents

Add override

Add all overrides

Adjust the font size of a rendition

Adjust the font-family of a rendition

Add an annotation to store

Remove an annotation from store

Add a highlight to the store

Add a underline to the store

Add a mark to the store

iterate over annotations in the store

[Not Implemented] Show annotations

[Not Implemented] Hide annotations

Update stored data

Add to a view

Remove from a view

[Not Implemented] Get text of an annotation

Parse a cfi string to a CFI object representation

Convert CFI to a epubcfi(...) string

Compare which of two CFIs is earlier in the text

Create a CFI object from a Range

Create a CFI object from a Node

Creates a DOM range representing a CFI

Check if a string is wrapped with "epubcfi()"

Collapse a CFI Range to a single CFI Position

Get DOM events that are listened for and passed along

Get or Set width

Get or Set height

Get or Set width of the contents

Get or Set height of the contents

Get the width of the text using Range

Get the height of the text using Range

Get documentElement scrollWidth

Get documentElement scrollHeight

Set overflow css style of the contents

Set overflowX css style of the documentElement

Set overflowY css style of the documentElement

Set Css styles on the contents element (typically Body)

Get or Set the viewport element

Get the documentElement

Get the location offset of a EpubCFI or an #id

Append a stylesheet link to the document head

Append stylesheet rules to a generate stylesheet Array: https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet/insertRule Object: https://github.com/desirable-objects/json-to-css

Append a script tag to the document head

Add a class to the contents container

Remove a class from the contents container

Get a Dom Range from EpubCFI

Get an EpubCFI from a Dom Range

Get an EpubCFI from a Dom node

Size the contents to a given width and height

Apply columns to the contents for pagination

Scale contents from center

Fit contents into a fixed width and height

Set the direction of the text

Set the writingMode of the text

Find CFI pairs for entire section at once

Find CFI pairs for a page

Set the axis for mapping

Vendor prefixed requestAnimationFrame

Generates a UUID based on: http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript

Gets the height of a document

Checks if a node is an element

Get a prefixed css property

Apply defaults to an object

Extend properties of an object

Fast quicksort insert for sorted array -- based on: http://stackoverflow.com/questions/1344500/efficient-way-to-insert-a-number-into-a-sorted-array-of-numbers

Finds where something would fit into a sorted array

Finds index of something in a sorted array Returns -1 if not found

Find the bounds of an element taking padding and margin into account

Find the bounds of an element taking padding, margin and borders into account

Find the bounds of any node allows for getting bounds of text nodes by wrapping them in a range

Find the equivelent of getBoundingClientRect of a browser window

Gets the index of a node in its parent

Gets the index of a text node in its parent

Gets the index of an element node in its parent

Check if extension is xml

Create a new blob

Create a new blob url

Remove a blob url

Create a new base64 encoded url

Get type of an object

Parse xml (or html) markup

querySelector polyfill

querySelectorAll polyfill

querySelector by property

Sprint through all text nodes in a document

Create a treeWalker

Convert a blob to a base64 encoded string

Creates a new pending promise and provides methods to resolve or reject it. From: https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules/Promise.jsm/Deferred#backwards_forwards_compatible

querySelector with filter by epub type

Find direct decendents of an element

Find all parents (ancestors) of an element

Find all direct decendents of a specific type

Filter all parents (ancestors) with tag name

Lightweight Polyfill for DOM Range