| Documentation

ePub ▸
- Static members
- .register
Book ▸
- Instance members
- #opened
- #spine
- #locations
- #navigation
- #pageList
- #open
- #load
- #resolve
- #section
- #renderTo
- #setRequestCredentials
- #setRequestHeaders
- #coverUrl
- #range
Locations ▸
- Instance members
- #generate
Container ▸
- Instance members
- #parse
Packaging ▸
- Instance members
- #parse
- #parseSpine
- #findCoverPath
Navigation ▸
- Instance members
- #parse
- #get
Resources ▸
- Instance members
- #replacements
- #relativeTo
- #get
Archive ▸
- Instance members
- #open
- #openUrl
- #request
- #getBlob
- #getText
- #getBase64
- #createUrl
- #revokeUrl
EpubCFI
Url
content
Rendition ▸
- Instance members
- #hooks
- #setManager
- #requireManager
- #requireView
- #start
- #attachTo
- #display
- #moveTo
- #next
- #prev
- #flow
- #layout
- #spread
- #reportLocation
- #destroy
- #range
- #adjustImages
Hook ▸
- Instance members
- #register
- #trigger
Layout ▸
- Instance members
- #flow
- #spread
- #calculate
- #format
- #count

Need help reading this?

ePub

Creates a new Book

ePub(url: (string | ArrayBuffer), options: object): Book

Parameters

url ((string | ArrayBuffer)) URL, Path or ArrayBuffer

options (object) to pass to the book

Returns

Book: a new Book object

Example

ePub("/path/to/book.epub", {})

Static Members

▸ register

Static Members

▸ manager()

manager()

▸ view()

view()

Book

Creates a new Book

new Book(url: string, options: object): Book

Parameters

url (string)

options (object)

Name	Description
options.requestMethod `method`	a request function to use instead of the default
options.requestCredentials `[boolean]` (default `undefined`)	send the xhr request withCredentials
options.requestHeaders `[object]` (default `undefined`)	send the xhr request headers
options.encoding `[string]` (default `binary`)	optional to pass 'binary' or base64' for archived Epubs
options.replacements `[string]` (default `base64`)	use base64, blobs, or none for replacing assets in archived Epubs

Returns

Book:

Example

new Book("/path/to/book.epub", {})

Instance Members

▸ opened

opened

Properties

opened (promise) : returns after the book is loaded

▸ spine

spine

Properties

spine (Spine)

▸ locations

locations

Properties

locations (Locations)

▸ pageList

pageList

Properties

pagelist (PageList)

▸ open(input, [what])

Open a epub or url

open(input: string, what: [string]): Promise

Parameters

input (string) URL, Path or ArrayBuffer

what ([string]) to force opening

Returns

Promise: of when the book has been loaded

Example

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

▸ load(path)

Load a resource from the Book

load(path: string): Promise

Parameters

path (string) path to the resource to load

Returns

Promise: returns a promise with the requested resource

▸ resolve(path, absolute)

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

resolve(path: string, absolute: [boolean]): string

Parameters

path (string)

absolute ([boolean]) force resolving the full URL

Returns

string: the resolved path string

▸ section(target)

Alias for book.spine.get

section(target: string)

Parameters

target (string)

▸ renderTo(element, options)

Sugar to render a book

renderTo(element: element, options: [object]): Rendition

Parameters

element (element) element to add the views to

options ([object])

Returns

Rendition:

▸ setRequestCredentials(credentials)

Set if request should use withCredentials

setRequestCredentials(credentials: boolean)

Parameters

credentials (boolean)

▸ setRequestHeaders(headers)

Set headers request should use

setRequestHeaders(headers: object)

Parameters

headers (object)

▸ coverUrl()

Get the cover url

coverUrl(): string

Returns

string: coverUrl

▸ range(cfiRange)

Find a DOM Range for a given CFI Range

range(cfiRange: EpubCFI): Range

Parameters

cfiRange (EpubCFI) a epub cfi range

Returns

Range:

Locations

Find Locations for a Book

new Locations(spine: Spine, request: request)

Parameters

spine (Spine)

request (request)

Instance Members

▸ generate(chars)

Load all of sections in the book to generate locations

generate(chars: int): object

Parameters

chars (int) how many chars to split on

Returns

object: locations

Container

Handles Parsing and Accessing an Epub Container

new Container(containerDocument: [document])

Parameters

containerDocument ([document]) xml document

Instance Members

▸ parse(containerDocument)

Parse the Container XML

parse(containerDocument: document)

Parameters

containerDocument (document)

Packaging

Open Packaging Format Parser

new Packaging(packageDocument: document)

Parameters

packageDocument (document) OPF XML

Instance Members

▸ parse(packageDocument)

Parse OPF XML

parse(packageDocument: document): object

Parameters

packageDocument (document) OPF XML

Returns

object: parsed package parts

▸ parseSpine(spineXml, manifest)

Parse Spine

parseSpine(spineXml: document, manifest: Packaging.manifest): object

Parameters

spineXml (document)

manifest (Packaging.manifest)

Returns

object: spine

▸ findCoverPath(packageXml)

Find the Cover Path Fallback for Epub 2.0

findCoverPath(packageXml: document): string

Parameters

packageXml (document)

Returns

string: href

Navigation Parser

new Navigation(xml: document)

Parameters

xml (document) navigation html / xhtml / ncx

Instance Members

Resources

Handle Package Resources

new Resources(manifest: Manifest, options: [object])

Parameters

manifest (Manifest)

options ([object])

Name	Description
options.archive `[Archive]`
options.resolver `[method]`

Instance Members

▸ replacements(archive, resolver)

Create blob urls for all the assets

replacements(archive: Archive, resolver: resolver): Promise

Parameters

archive (Archive)

resolver (resolver) Url resolver

Returns

Promise: returns replacement urls

▸ relativeTo(absolute, resolver)

Resolve all resources URLs relative to an absolute URL

relativeTo(absolute: string, resolver: [resolver]): Array<string>

Parameters

absolute (string) to be resolved to

resolver ([resolver])

Returns

Array<string>: array with relative Urls

▸ get(path)

Get a URL for a resource

get(path: string): string

Parameters

path (string)

Returns

string: url

Name	Description
options.base64 `[object]`	use base64 encoding or blob url

EpubCFI

EPUB CFI spec: http://www.idpf.org/epub/linking/cfi/epub-cfi.html

Implements:

Character Offset: epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3)
Simple Ranges : epubcfi(/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4)

Does Not Implement:

Temporal Offset (~)
Spatial Offset (@)
Temporal-Spatial Offset (~ + @)
Text Location Assertion ([)

new EpubCFI(cfiFrom: any, base: any, ignoreClass: any)

Parameters

cfiFrom (any)

base (any)

ignoreClass (any)

Url

creates a uri object

new Url(urlString: string, baseString: [string]): object

Parameters

urlString (string) a url string (relative or absolute)

baseString ([string]) optional base for the url, default to window.location.href

Returns

object: url

content

Properties

hooks.content (method)

Rendition

[Rendition description]

new Rendition(book: Book, options: object)

Parameters

book (Book)

options (object)

Name	Description
options.width `int`
options.height `int`
options.ignoreClass `string`
options.manager `string`
options.view `string`
options.layout `string`
options.spread `string`
options.minSpreadWidth `int`	overridden by spread: none (never) / both (always)

Instance Members

▸ hooks

Adds Hook methods to the Rendition prototype

hooks

Properties

hooks (Hook)

▸ setManager(manager)

Set the manager function

setManager(manager: function)

Parameters

manager (function)

▸ requireManager(manager)

Require the manager from passed string, or as a function

requireManager(manager: (string | function)): method

Parameters

manager ((string | function)) [ description ]

Returns

method:

▸ requireView(view)

Require the view from passed string, or as a function

requireView(view: (string | function)): view

Parameters

view ((string | function))

Returns

view:

▸ start()

Start the rendering

start(): Promise

Returns

Promise: rendering has started

▸ attachTo(element)

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

attachTo(element: element): Promise

Parameters

element (element) to attach to

Returns

Promise:

▸ display(target)

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.

display(target: string): Promise

Parameters

target (string) Url or EpubCFI

Returns

Promise:

▸ moveTo(offset)

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

moveTo(offset: object)

Parameters

offset (object)

▸ next()

Go to the next "page" in the rendition

next(): Promise

Returns

Promise:

▸ prev()

Go to the previous "page" in the rendition

prev(): Promise

Returns

Promise:

▸ flow(flow)

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

flow(flow: string)

Parameters

flow (string)

▸ layout(settings)

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

layout(settings: object)

Parameters

settings (object)

▸ spread(spread, min)

Adjust if the rendition uses spreads

spread(spread: string, min: int)

Parameters

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

min (int) min width to use spreads at

▸ reportLocation()

Report the current location

reportLocation()

▸ destroy()

Remove and Clean Up the Rendition

destroy()

▸ range(cfi, ignoreClass)

Get a Range from a Visible CFI

range(cfi: string, ignoreClass: string): range

Parameters

cfi (string) EpubCfi String

ignoreClass (string)

Returns

range:

▸ adjustImages(view)

Hook to adjust images to fit in columns

adjustImages(view: View)

Parameters

view (View)

Hook

Hooks allow for injecting functions that must all complete in order before finishing They will execute in parallel but all must finish before continuing Functions may return a promise if they are asycn.

new Hook(context: any)

Parameters

context (any) scope of this

Example

this.content = new EPUBJS.Hook(this);

Instance Members

▸ register()

Adds a function to be run before a hook completes

Example

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

▸ trigger()

Triggers a hook to run all functions

trigger()

Example

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

Layout

Figures out the CSS to apply for a layout

new Layout(settings: object)

Parameters

settings (object)

Name	Description
settings.spread `[string]`

Instance Members

▸ flow(flow)

Switch the flow between paginated and scrolled

flow(flow: string)

Parameters

flow (string) paginated | scrolled

▸ spread(spread, min)

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

spread(spread: string, min: boolean)

Parameters

spread (string) true | false

min (boolean) integer in pixels

▸ calculate(_width, _height, _gap)

Calculate the dimensions of the pagination

calculate(_width: number, _height: number, _gap: number)

Parameters

_width (number) [ description ]

_height (number) [ description ]

_gap (number) [ description ]

▸ format(contents)

Apply Css to a Document

format(contents: Contents): [Promise]

Parameters

contents (Contents)

Returns

[Promise]:

▸ count(totalWidth)

Count number of pages

count(totalWidth: number): number

Parameters

totalWidth (number)

Returns

number: spreads

Returns

number: pages