Class Navigation

constructor

• new Navigation(xml?: Document | NavItem[]): Navigation

  Parameters

  • Optionalxml: Document | NavItem[]

  Returns Navigation

landmarks

landmarksByType

length

toc

tocByHref

tocById

forEach

• forEach(fn: (item: NavItem, index: number, array: NavItem[]) => void): void

  forEach pass through

  Parameters

  • fn: (item: NavItem, index: number, array: NavItem[]) => void

    function to run on each item

  Returns void

  forEach loop

get

• get(target?: string): NavItem | NavItem[] | undefined

  Get an item from the navigation

  Parameters

  • Optionaltarget: string

  Returns NavItem | NavItem[] | undefined

  navItem

getByIndex

• getByIndex(
      target: string,
      index: number | undefined,
      navItems: NavItem[],
  ): NavItem | undefined

  Get an item from navigation subitems recursively by index

  Parameters

  • target: string
  • index: number | undefined
  • navItems: NavItem[]

  Returns NavItem | undefined

  navItem

landmark

• landmark(type?: string): LandmarkItem | LandmarkItem[] | undefined

  Get a landmark by type List of types: https://idpf.github.io/epub-vocabs/structure/

  Parameters

  • Optionaltype: string

  Returns LandmarkItem | LandmarkItem[] | undefined

  landmarkItem

load

• load(json: NavItem[]): NavItem[]

  Load Spine Items

  Parameters

  • json: NavItem[]

    the items to be loaded

  Returns NavItem[]

  navItems

parse

• parse(xml: Document | NavItem[]): void

  Parse out the navigation items

  Parameters

  • xml: Document | NavItem[]

    navigation html / xhtml / ncx

  Returns void

parseNavList

• parseNavList(navListHtml: Element, parent?: string): NavItem[]

  Parses lists in the toc

  Parameters

  • navListHtml: Element
  • Optionalparent: string

    id

  Returns NavItem[]

  navigation list