Class Locations

constructor

• new Locations(spine: Spine, request: RequestFunction, pause?: number): Locations

  Parameters

  • spine: Spine
  • request: RequestFunction
  • Optionalpause: number

  Returns Locations

_current

_currentCfi

_locations

_locationsWords

_wordCounter

break

emit

epubcfi

off

on

pause

processingTimeout

q

request

spine

total

currentLocation

• get currentLocation(): number | undefined

  Get the current location

  Returns number | undefined

• set currentLocation(curr: string | number | undefined): void

  Set the current location

  Parameters

  • curr: string | number | undefined

  Returns void

cfiFromLocation

• cfiFromLocation(loc: string | number): string | number

  Get an EpubCFI from location index

  Parameters

  • loc: string | number

  Returns string | number

  cfi

cfiFromPercentage

• cfiFromPercentage(percentage: number): string | number

  Get an EpubCFI from location percentage

  Parameters

  • percentage: number

  Returns string | number

  cfi

countWords

• countWords(s: string): number

  Parameters

  • s: string

  Returns number

createRange

• createRange(): {
      endContainer: Node
      | undefined;
      endOffset: number | undefined;
      startContainer: Node | undefined;
      startOffset: number | undefined;
  }

  Returns {
      endContainer: Node | undefined;
      endOffset: number | undefined;
      startContainer: Node | undefined;
      startOffset: number | undefined;
  }

destroy

• destroy(): void

  Returns void

generate

• generate(chars?: number): Promise<string[]>

  Load all of sections in the book to generate locations

  Parameters

  • Optionalchars: number

    how many chars to split on

  Returns Promise<string[]>

  locations

generateFromWords

• generateFromWords(
      startCfi?: string,
      wordCount?: number,
      count?: number,
  ): Promise<{ cfi: string; wordCount: number }[]>

  Load all of sections in the book to generate locations

  Parameters

  • OptionalstartCfi: string

    start position

  • OptionalwordCount: number

    how many words to split on

  • Optionalcount: number

    result count

  Returns Promise<{ cfi: string; wordCount: number }[]>

  locations

getCurrent

• getCurrent(): number

  Returns number

length

• length(): number

  Locations length

  Returns number

load

• load(locations: string | string[]): string[]

  Load locations from JSON

  Parameters

  • locations: string | string[]

  Returns string[]

locationFromCfi

• locationFromCfi(cfi: string | EpubCFI): number

  Get a location from an EpubCFI

  Parameters

  • cfi: string | EpubCFI

  Returns number

parse

• parse(contents: Element, cfiBase: string, chars?: number): string[]

  Parameters

  • contents: Element
  • cfiBase: string
  • Optionalchars: number

  Returns string[]

parseWords

• parseWords(
      contents: Element,
      section: Section,
      wordCount: number,
      startCfi?: EpubCFI,
  ): { cfi: string; wordCount: number }[]

  Parameters

  • contents: Element
  • section: Section
  • wordCount: number
  • OptionalstartCfi: EpubCFI

  Returns { cfi: string; wordCount: number }[]

percentageFromCfi

• percentageFromCfi(cfi: string | EpubCFI): number | null

  Get a percentage position in locations from an EpubCFI

  Parameters

  • cfi: string | EpubCFI

  Returns number | null

percentageFromLocation

• percentageFromLocation(loc: number): number

  Get a percentage position from a location index

  Parameters

  • loc: number

    location index

  Returns number

  percentage

process

• process(section: Section): Promise<string[]>

  Parameters

  • section: Section

  Returns Promise<string[]>

processWords

• processWords(
      section: Section,
      wordCount: number,
      startCfi?: EpubCFI,
      count?: number,
  ): Promise<{ cfi: string; wordCount: number }[]>

  Parameters

  • section: Section
  • wordCount: number
  • OptionalstartCfi: EpubCFI
  • Optionalcount: number

  Returns Promise<{ cfi: string; wordCount: number }[]>

save

• save(): string

  Save locations to JSON

  Returns string

setCurrent

• setCurrent(curr: string | number | undefined): void

  Parameters

  • curr: string | number | undefined

  Returns void