index.md

Epub.js API Reference

global function

• ePub

global classes (dependencies graph)

• Annotation from ./annotation
  • EpubCFI
• Annotations from ./annotations
  • Annotation
  • constants from ./utils/constants
    • EVENTS
• Archive from ./archive
  • Input
  • JSZip
  • mime from ./utils/mime
  • request from ./utils/request
• Book from ./book
  • Archive
  • constants from ./utils/constants
    • EPUBJS_VERSION
    • EVENTS
  • core from ./utils/core
    • extend
  • Container
  • Defer
  • EpubCFI
  • Locations
  • Navigation
  • Packaging
  • Path
  • Rendition
  • Resources
  • request from ./utils/request
  • Sections
  • Storage
  • Url
• Contents from ./contentss
  • constants from ./utils/constants
    • DOM_EVENTS
    • EPUBJS_VERSION
    • EVENTS
  • core from ./utils/core
    • borders
    • defaults
    • isNumber
    • prefixed
  • EpubCFI
  • Mapping
  • replacements from ./utils/replacements
    • replaceLinks
• Input
  • core from ./utils/core
    • isXml
    • parse
  • Defer
  • Path
• EpubCFI from ./epubcfi
  • core from ./utils/core
    • extend
    • findChildren
    • isNumber
    • RangeObject
    • type
• Landmarks from ./navigation/landmarks
  • core from ../utils/core
    • qsa
    • filterChildren
• Layout from ./layout
  • core from ./utils/core
    • extend
  • constants from ./utils/constants
    • EVENTS
• Location from ./location
  • core from ./utils/core
    • extend
• Locations from ./locations
  • constants from ./utils/constants
    • EVENTS
  • core from ./utils/core
    • locationOf
    • sprint
    • qs
  • Defer from ./utils/defer
  • EpubCFI
  • Location
  • Queue
• Manifest from ./packaging/manifest
  • core from ../utils/core
    • qsa
    • qsp
• Mapping from ./mapping
  • core from ./utils/core
    • nodeBounds
  • EpubCFI
• Metadata from ./packaging/metadata
• Navigation from ./navigation
  • core from ./utils/core
    • qs
    • qsa
  • Landmarks
  • PageList
  • Toc
• Packaging from ./packaging
  • core from ./utils/core
    • qs
    • qsp
  • Manifest
  • Metadata
  • Spine
• PageList from ./navigation/pagelist
  • core from ../utils/core
    • indexOfSorted
    • locationOf
    • qs
    • qsa
  • EpubCFI
• Rendition from ./rendition
  • Annotations
  • constants from ./utils/constants
    • EVENTS
    • DOM_EVENTS
  • Contents
  • core from ./utils/core
    • extend
    • isFloat
  • ContinuousViewManager from ./managers/continuous/index
    • constants from ../../utils/constants
      • EVENTS
    • core from ../../utils/core
      • extend
      • requestAnimationFrame
    • DefaultViewManager from ../default/index
    • Defer from ../../utils/defer
    • Snap from ../helpers/snap
  • DefaultViewManager from ./managers/default/index
    • constants from ../../utils/constants
      • EVENTS
    • core from ../../utils/core
      • extend
      • isNumber
      • windowBounds
    • Defer from ../../utils/defer
    • Mapping from ../../mapping
    • scrollType from ../../utils/scrolltype
    • Views from ../helpers/views
  • Defer from ./utils/defer
  • EpubCFI
  • Hook
  • IframeView from ./managers/views/iframe
    • constants from ../../utils/constants
      • EVENTS
    • Contents from ../../contents
    • Marks from ../../marks-pane/marks
      • proxyMouse from ./events
    • Highlight from ../../marks-pane/highlight
      • Mark from ./mark
    • Underline from ../../marks-pane/underline
      • Highlight
    • core from ../../utils/core
      • createBlobUrl
      • borders
      • bounds
      • extend
      • isNumber
      • revokeBlobUrl
      • uuid
    • Defer from ../../utils/defer
    • EpubCFI from ../../epubcfi
  • Layout
  • Themes
  • Queue
• Resources from ./resources
  • core from ./utils/core
    • blob2base64
    • createBase64Url
    • createBlobUrl
  • mime from ./utils/mime
  • Path
  • replacements from ./utils/replacements
    • substitute
  • Url
• Section from ./section
  • core from ./utils/core
    • sprint
  • Defer from ./utils/defer
  • EpubCFI
  • Hook
  • replacements from ./utils/replacements
    • replaceBase
  • request from ./utils/request
• Sections from ./sections
  • EpubCFI
  • Hook
  • replacements from ./utils/replacements
    • replaceBase
    • replaceCanonical
    • replaceMeta
  • Section
• Spine from ./packaging/spine
  • core from ../utils/core
    • indexOfNode
    • qsa
• Storage from ./storage
  • Defer
  • Input
  • localforage
  • mime from ./utils/mime
  • request from ./utils/request
• Themes from ./themes
  • Url
• Toc from ./navigation/toc
  • core from ../utils/core
    • filterChildren
    • qs

utils classes

• Defer from ./utils/defer
• Hook from ./utils/hook
• Path from ./utils/path
• Queue from ./utils/queue
• Url from ./utils/url