Class TOCView

constructor

• new TOCView(
      store: OPSDocStore,
      url: string,
      lang: string,
      clientLayout: Vtree.ClientLayout,
      fontMapper: Mapper,
      pref: Preferences,
      rendererFactory: CustomRendererFactory,
      fallbackMap: { [key: string]: string },
      documentURLTransformer: DocumentURLTransformer,
      counterStore: CounterStore,
  ): TOCView

  Parameters

  • store: OPSDocStore
  • url: string
  • lang: string
  • clientLayout: Vtree.ClientLayout
  • fontMapper: Mapper
  • pref: Preferences
  • rendererFactory: CustomRendererFactory
  • fallbackMap: { [key: string]: string }
  • documentURLTransformer: DocumentURLTransformer
  • counterStore: CounterStore

  Returns TOCView

ReadonlyclientLayout

ReadonlycounterStore

ReadonlydocumentURLTransformer

ReadonlyfallbackMap

ReadonlyfontMapper

instance

Readonlylang

page

pref

ReadonlyrendererFactory

Readonlystore

Readonlyurl

getTOC

• getTOC(): TOCItem[]

  Returns TOCItem[]

hideTOC

• hideTOC(): void

  Returns void

isTOCVisible

• isTOCVisible(): boolean

  Returns boolean

makeCustomRenderer

• makeCustomRenderer(xmldoc: XMLDocHolder): CustomRenderer

  Parameters

  • xmldoc: XMLDocHolder

  Returns CustomRenderer

setAutoHeight

• setAutoHeight(elem: Element, depth: number): void

  Parameters

  • elem: Element
  • depth: number

  Returns void

showTOC

• showTOC(
      elem: HTMLElement,
      viewport: Viewport,
      width: number,
      height: number,
      fontSize: number,
  ): Result<Page>

  Parameters

  • elem: HTMLElement
  • viewport: Viewport
  • width: number
  • height: number
  • fontSize: number

  Returns Result<Page>