epubjs
Version:
Parse and Render Epubs
1,475 lines (1,099 loc) • 451 kB
HTML
<!doctype html>
<html>
<head>
<meta charset='utf-8' />
<title>epubjs 0.3.73 | Documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
<link href='assets/style.css' type='text/css' rel='stylesheet' />
<link href='assets/github.css' type='text/css' rel='stylesheet' />
<link href='assets/split.css' type='text/css' rel='stylesheet' />
</head>
<body class='documentation m0'>
<div class='flex'>
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>epubjs</h3>
<div class='mb1'><code>0.3.73</code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#epub'
class="">
ePub
</a>
</li>
<li><a
href='#book'
class=" toggle-sibling">
Book
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#bookopened'
class='regular pre-open'>
.opened
</a></li>
<li><a
href='#bookspine'
class='regular pre-open'>
.spine
</a></li>
<li><a
href='#booklocations'
class='regular pre-open'>
.locations
</a></li>
<li><a
href='#booknavigation'
class='regular pre-open'>
.navigation
</a></li>
<li><a
href='#bookpagelist'
class='regular pre-open'>
.pagelist
</a></li>
</ul>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#bookopen'
class='regular pre-open'>
#open
</a></li>
<li><a
href='#bookload'
class='regular pre-open'>
#load
</a></li>
<li><a
href='#bookresolve'
class='regular pre-open'>
#resolve
</a></li>
<li><a
href='#bookcanonical'
class='regular pre-open'>
#canonical
</a></li>
<li><a
href='#booksection'
class='regular pre-open'>
#section
</a></li>
<li><a
href='#bookrenderto'
class='regular pre-open'>
#renderTo
</a></li>
<li><a
href='#booksetrequestcredentials'
class='regular pre-open'>
#setRequestCredentials
</a></li>
<li><a
href='#booksetrequestheaders'
class='regular pre-open'>
#setRequestHeaders
</a></li>
<li><a
href='#bookcoverurl'
class='regular pre-open'>
#coverUrl
</a></li>
<li><a
href='#bookgetrange'
class='regular pre-open'>
#getRange
</a></li>
<li><a
href='#bookkey'
class='regular pre-open'>
#key
</a></li>
<li><a
href='#bookdestroy'
class='regular pre-open'>
#destroy
</a></li>
</ul>
</div>
</li>
<li><a
href='#url'
class=" toggle-sibling">
Url
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#urlpath'
class='regular pre-open'>
#path
</a></li>
<li><a
href='#urlresolve'
class='regular pre-open'>
#resolve
</a></li>
<li><a
href='#urlrelative'
class='regular pre-open'>
#relative
</a></li>
<li><a
href='#urltostring'
class='regular pre-open'>
#toString
</a></li>
</ul>
</div>
</li>
<li><a
href='#path'
class=" toggle-sibling">
Path
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#pathparse'
class='regular pre-open'>
#parse
</a></li>
<li><a
href='#pathisabsolute'
class='regular pre-open'>
#isAbsolute
</a></li>
<li><a
href='#pathisdirectory'
class='regular pre-open'>
#isDirectory
</a></li>
<li><a
href='#pathresolve'
class='regular pre-open'>
#resolve
</a></li>
<li><a
href='#pathrelative'
class='regular pre-open'>
#relative
</a></li>
<li><a
href='#pathtostring'
class='regular pre-open'>
#toString
</a></li>
</ul>
</div>
</li>
<li><a
href='#spine'
class=" toggle-sibling">
Spine
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#spineunpack'
class='regular pre-open'>
#unpack
</a></li>
<li><a
href='#spineget'
class='regular pre-open'>
#get
</a></li>
<li><a
href='#spineeach'
class='regular pre-open'>
#each
</a></li>
<li><a
href='#spinefirst'
class='regular pre-open'>
#first
</a></li>
<li><a
href='#spinelast'
class='regular pre-open'>
#last
</a></li>
</ul>
</div>
</li>
<li><a
href='#section'
class=" toggle-sibling">
Section
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#sectionload'
class='regular pre-open'>
#load
</a></li>
<li><a
href='#sectionrender'
class='regular pre-open'>
#render
</a></li>
<li><a
href='#sectionfind'
class='regular pre-open'>
#find
</a></li>
<li><a
href='#sectionreconcilelayoutsettings'
class='regular pre-open'>
#reconcileLayoutSettings
</a></li>
<li><a
href='#sectioncfifromrange'
class='regular pre-open'>
#cfiFromRange
</a></li>
<li><a
href='#sectioncfifromelement'
class='regular pre-open'>
#cfiFromElement
</a></li>
<li><a
href='#sectionunload'
class='regular pre-open'>
#unload
</a></li>
</ul>
</div>
</li>
<li><a
href='#locations'
class=" toggle-sibling">
Locations
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#locationsgenerate'
class='regular pre-open'>
#generate
</a></li>
<li><a
href='#locationslocationfromcfi'
class='regular pre-open'>
#locationFromCfi
</a></li>
<li><a
href='#locationspercentagefromcfi'
class='regular pre-open'>
#percentageFromCfi
</a></li>
<li><a
href='#locationspercentagefromlocation'
class='regular pre-open'>
#percentageFromLocation
</a></li>
<li><a
href='#locationscfifromlocation'
class='regular pre-open'>
#cfiFromLocation
</a></li>
<li><a
href='#locationscfifrompercentage'
class='regular pre-open'>
#cfiFromPercentage
</a></li>
<li><a
href='#locationsload'
class='regular pre-open'>
#load
</a></li>
<li><a
href='#locationssave'
class='regular pre-open'>
#save
</a></li>
<li><a
href='#locationscurrentlocation'
class='regular pre-open'>
#currentLocation
</a></li>
<li><a
href='#locationscurrentlocation'
class='regular pre-open'>
#currentLocation
</a></li>
<li><a
href='#locationslength'
class='regular pre-open'>
#length
</a></li>
</ul>
</div>
</li>
<li><a
href='#container'
class=" toggle-sibling">
Container
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#containerparse'
class='regular pre-open'>
#parse
</a></li>
</ul>
</div>
</li>
<li><a
href='#packaging'
class=" toggle-sibling">
Packaging
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#packagingparse'
class='regular pre-open'>
#parse
</a></li>
<li><a
href='#packagingload'
class='regular pre-open'>
#load
</a></li>
</ul>
</div>
</li>
<li><a
href='#navigation'
class=" toggle-sibling">
Navigation
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#navigationparse'
class='regular pre-open'>
#parse
</a></li>
<li><a
href='#navigationget'
class='regular pre-open'>
#get
</a></li>
<li><a
href='#navigationlandmark'
class='regular pre-open'>
#landmark
</a></li>
<li><a
href='#navigationload'
class='regular pre-open'>
#load
</a></li>
<li><a
href='#navigationforeach'
class='regular pre-open'>
#forEach
</a></li>
</ul>
</div>
</li>
<li><a
href='#resources'
class=" toggle-sibling">
Resources
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#resourcescreateurl'
class='regular pre-open'>
#createUrl
</a></li>
<li><a
href='#resourcesreplacements'
class='regular pre-open'>
#replacements
</a></li>
<li><a
href='#resourcesrelativeto'
class='regular pre-open'>
#relativeTo
</a></li>
<li><a
href='#resourcesget'
class='regular pre-open'>
#get
</a></li>
<li><a
href='#resourcessubstitute'
class='regular pre-open'>
#substitute
</a></li>
</ul>
</div>
</li>
<li><a
href='#pagelist'
class=" toggle-sibling">
PageList
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#pagelistparse'
class='regular pre-open'>
#parse
</a></li>
<li><a
href='#pagelistpagefromcfi'
class='regular pre-open'>
#pageFromCfi
</a></li>
<li><a
href='#pagelistcfifrompage'
class='regular pre-open'>
#cfiFromPage
</a></li>
<li><a
href='#pagelistpagefrompercentage'
class='regular pre-open'>
#pageFromPercentage
</a></li>
<li><a
href='#pagelistpercentagefrompage'
class='regular pre-open'>
#percentageFromPage
</a></li>
<li><a
href='#pagelistpercentagefromcfi'
class='regular pre-open'>
#percentageFromCfi
</a></li>
<li><a
href='#pagelistdestroy'
class='regular pre-open'>
#destroy
</a></li>
</ul>
</div>
</li>
<li><a
href='#archive'
class=" toggle-sibling">
Archive
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#archiveopen'
class='regular pre-open'>
#open
</a></li>
<li><a
href='#archiveopenurl'
class='regular pre-open'>
#openUrl
</a></li>
<li><a
href='#archiverequest'
class='regular pre-open'>
#request
</a></li>
<li><a
href='#archivegetblob'
class='regular pre-open'>
#getBlob
</a></li>
<li><a
href='#archivegettext'
class='regular pre-open'>
#getText
</a></li>
<li><a
href='#archivegetbase64'
class='regular pre-open'>
#getBase64
</a></li>
<li><a
href='#archivecreateurl'
class='regular pre-open'>
#createUrl
</a></li>
<li><a
href='#archiverevokeurl'
class='regular pre-open'>
#revokeUrl
</a></li>
</ul>
</div>
</li>
<li><a
href='#rendition'
class=" toggle-sibling">
Rendition
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#renditionhooks'
class='regular pre-open'>
.hooks
</a></li>
<li><a
href='#renditionthemes'
class='regular pre-open'>
.themes
</a></li>
<li><a
href='#renditionannotations'
class='regular pre-open'>
.annotations
</a></li>
<li><a
href='#renditionlocation'
class='regular pre-open'>
.location
</a></li>
<li><a
href='#renditionstarted'
class='regular pre-open'>
.started
</a></li>
</ul>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#renditionsetmanager'
class='regular pre-open'>
#setManager
</a></li>
<li><a
href='#renditionrequiremanager'
class='regular pre-open'>
#requireManager
</a></li>
<li><a
href='#renditionrequireview'
class='regular pre-open'>
#requireView
</a></li>
<li><a
href='#renditionstart'
class='regular pre-open'>
#start
</a></li>
<li><a
href='#renditionattachto'
class='regular pre-open'>
#attachTo
</a></li>
<li><a
href='#renditiondisplay'
class='regular pre-open'>
#display
</a></li>
<li><a
href='#renditionmoveto'
class='regular pre-open'>
#moveTo
</a></li>
<li><a
href='#renditionresize'
class='regular pre-open'>
#resize
</a></li>
<li><a
href='#renditionclear'
class='regular pre-open'>
#clear
</a></li>
<li><a
href='#renditionnext'
class='regular pre-open'>
#next
</a></li>
<li><a
href='#renditionprev'
class='regular pre-open'>
#prev
</a></li>
<li><a
href='#renditionflow'
class='regular pre-open'>
#flow
</a></li>
<li><a
href='#renditionlayout'
class='regular pre-open'>
#layout
</a></li>
<li><a
href='#renditionspread'
class='regular pre-open'>
#spread
</a></li>
<li><a
href='#renditiondirection'
class='regular pre-open'>
#direction
</a></li>
<li><a
href='#renditionreportlocation'
class='regular pre-open'>
#reportLocation
</a></li>
<li><a
href='#renditioncurrentlocation'
class='regular pre-open'>
#currentLocation
</a></li>
<li><a
href='#renditiondestroy'
class='regular pre-open'>
#destroy
</a></li>
<li><a
href='#renditiongetrange'
class='regular pre-open'>
#getRange
</a></li>
<li><a
href='#renditiongetcontents'
class='regular pre-open'>
#getContents
</a></li>
<li><a
href='#renditionviews'
class='regular pre-open'>
#views
</a></li>
</ul>
<ul class='list-reset py1-ul pl1'>
<li class='h5'>Events</li>
<li><a
href='#renditioneventstarted'
class='regular pre-open'>
ⓔ started
</a></li>
<li><a
href='#renditioneventattached'
class='regular pre-open'>
ⓔ attached
</a></li>
<li><a
href='#renditioneventdisplayed'
class='regular pre-open'>
ⓔ displayed
</a></li>
<li><a
href='#renditioneventdisplayerror'
class='regular pre-open'>
ⓔ displayError
</a></li>
<li><a
href='#renditioneventrendered'
class='regular pre-open'>
ⓔ rendered
</a></li>
<li><a
href='#renditioneventremoved'
class='regular pre-open'>
ⓔ removed
</a></li>
<li><a
href='#renditioneventresized'
class='regular pre-open'>
ⓔ resized
</a></li>
<li><a
href='#renditioneventorientationchange'
class='regular pre-open'>
ⓔ orientationchange
</a></li>
<li><a
href='#renditioneventlocationchanged'
class='regular pre-open'>
ⓔ locationChanged
</a></li>
<li><a
href='#renditioneventrelocated'
class='regular pre-open'>
ⓔ relocated
</a></li>
<li><a
href='#renditioneventselected'
class='regular pre-open'>
ⓔ selected
</a></li>
<li><a
href='#renditioneventmarkclicked'
class='regular pre-open'>
ⓔ markClicked
</a></li>
</ul>
</div>
</li>
<li><a
href='#hook'
class=" toggle-sibling">
Hook
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#hookregister'
class='regular pre-open'>
#register
</a></li>
<li><a
href='#hooktrigger'
class='regular pre-open'>
#trigger
</a></li>
</ul>
</div>
</li>
<li><a
href='#queue'
class=" toggle-sibling">
Queue
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#queueenqueue'
class='regular pre-open'>
#enqueue
</a></li>
<li><a
href='#queuedequeue'
class='regular pre-open'>
#dequeue
</a></li>
<li><a
href='#queuerun'
class='regular pre-open'>
#run
</a></li>
<li><a
href='#queueflush'
class='regular pre-open'>
#flush
</a></li>
<li><a
href='#queueclear'
class='regular pre-open'>
#clear
</a></li>
<li><a
href='#queuelength'
class='regular pre-open'>
#length
</a></li>
<li><a
href='#queuepause'
class='regular pre-open'>
#pause
</a></li>
<li><a
href='#queuestop'
class='regular pre-open'>
#stop
</a></li>
</ul>
</div>
</li>
<li><a
href='#layout'
class=" toggle-sibling">
Layout
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#layoutflow'
class='regular pre-open'>
#flow
</a></li>
<li><a
href='#layoutspread'
class='regular pre-open'>
#spread
</a></li>
<li><a
href='#layoutcalculate'
class='regular pre-open'>
#calculate
</a></li>
<li><a
href='#layoutformat'
class='regular pre-open'>
#format
</a></li>
<li><a
href='#layoutcount'
class='regular pre-open'>
#count
</a></li>
</ul>
</div>
</li>
<li><a
href='#themes'
class=" toggle-sibling">
Themes
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#themesregister'
class='regular pre-open'>
#register
</a></li>
<li><a
href='#themesdefault'
class='regular pre-open'>
#default
</a></li>
<li><a
href='#themesregisterthemes'
class='regular pre-open'>
#registerThemes
</a></li>
<li><a
href='#themesregisterurl'
class='regular pre-open'>
#registerUrl
</a></li>
<li><a
href='#themesregisterrules'
class='regular pre-open'>
#registerRules
</a></li>
<li><a
href='#themesselect'
class='regular pre-open'>
#select
</a></li>
<li><a
href='#themesupdate'
class='regular pre-open'>
#update
</a></li>
<li><a
href='#themesinject'
class='regular pre-open'>
#inject
</a></li>
<li><a
href='#themesadd'
class='regular pre-open'>
#add
</a></li>
<li><a
href='#themesoverride'
class='regular pre-open'>
#override
</a></li>
<li><a
href='#themesoverrides'
class='regular pre-open'>
#overrides
</a></li>
<li><a
href='#themesfontsize'
class='regular pre-open'>
#fontSize
</a></li>
<li><a
href='#themesfont'
class='regular pre-open'>
#font
</a></li>
</ul>
</div>
</li>
<li><a
href='#annotations'
class=" toggle-sibling">
Annotations
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#annotationsadd'
class='regular pre-open'>
#add
</a></li>
<li><a
href='#annotationsremove'
class='regular pre-open'>
#remove
</a></li>
<li><a
href='#annotationshighlight'
class='regular pre-open'>
#highlight
</a></li>
<li><a
href='#annotationsunderline'
class='regular pre-open'>
#underline
</a></li>
<li><a
href='#annotationsmark'
class='regular pre-open'>
#mark
</a></li>
<li><a
href='#annotationseach'
class='regular pre-open'>
#each
</a></li>
<li><a
href='#annotationsshow'
class='regular pre-open'>
#show
</a></li>
<li><a
href='#annotationshide'
class='regular pre-open'>
#hide
</a></li>
</ul>
</div>
</li>
<li><a
href='#annotation'
class=" toggle-sibling">
Annotation
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#annotationupdate'
class='regular pre-open'>
#update
</a></li>
<li><a
href='#annotationattach'
class='regular pre-open'>
#attach
</a></li>
<li><a
href='#annotationdetach'
class='regular pre-open'>
#detach
</a></li>
<li><a
href='#annotationtext'
class='regular pre-open'>
#text
</a></li>
</ul>
</div>
</li>
<li><a
href='#epubcfi'
class=" toggle-sibling">
EpubCFI
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#epubcfiparse'
class='regular pre-open'>
#parse
</a></li>
<li><a
href='#epubcfitostring'
class='regular pre-open'>
#toString
</a></li>
<li><a
href='#epubcficompare'
class='regular pre-open'>
#compare
</a></li>
<li><a
href='#epubcfifromrange'
class='regular pre-open'>
#fromRange
</a></li>
<li><a
href='#epubcfifromnode'
class='regular pre-open'>
#fromNode
</a></li>
<li><a
href='#epubcfitorange'
class='regular pre-open'>
#toRange
</a></li>
<li><a
href='#epubcfiiscfistring'
class='regular pre-open'>
#isCfiString
</a></li>
<li><a
href='#epubcficollapse'
class='regular pre-open'>
#collapse
</a></li>
</ul>
</div>
</li>