Class PageList

constructor

• new PageList(xml?: Document): PageList

  Parameters

  • Optionalxml: Document

  Returns PageList

epubcfi

firstPage

lastPage

locations

ncx

pageList

pages

toc

totalPages

cfiFromPage

• cfiFromPage(pg: string | number): string | number

  Get an EpubCFI from a Page List Item

  Parameters

  • pg: string | number

  Returns string | number

  cfi

destroy

• destroy(): void

  Destroy

  Returns void

ncxItem

• ncxItem(item: Element): PageListItem

  Parameters

  • item: Element

  Returns PageListItem

pageFromCfi

• pageFromCfi(cfi: string): number

  Get a PageList result from a EpubCFI

  Parameters

  • cfi: string

    EpubCFI String

  Returns number

  page

pageFromPercentage

• pageFromPercentage(percent: number): number

  Get a Page from Book percentage

  Parameters

  • percent: number

  Returns number

  page

parse

• parse(xml: Document): PageListItem[]

  Parse PageList Xml

  Parameters

  • xml: Document

  Returns PageListItem[]

parseNcx

• parseNcx(navXml: Document): PageListItem[]

  Parameters

  • navXml: Document

  Returns PageListItem[]

percentageFromCfi

• percentageFromCfi(cfi: string): number

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

  Parameters

  • cfi: string

    EpubCFI String

  Returns number

  percentage

percentageFromPage

• percentageFromPage(pg: number): number

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

  Parameters

  • pg: number

    the page

  Returns number

  percentage