Class TableOfContentsModel<H, T>Abstract

constructor

• new TableOfContentsModel<
      H extends TableOfContents.IHeading,
      T extends Widget = Widget,
  >(
      widget: T,
      configuration?: TableOfContents.IConfig,
  ): TableOfContentsModel<H, T>

• Constructor

  Type Parameters

  • H extends TableOfContents.IHeading
  • T extends Widget = Widget

  Parameters

  • widget: T

    The widget to search in
  • Optionalconfiguration: TableOfContents.IConfig

    Default model configuration

  Returns TableOfContentsModel<H, T>

Abstract ReadonlydocumentType

activeHeading

• get activeHeading(): null | H

• Current active entry.

  Returns null | H

  table of contents active entry

activeHeadingChanged

• get activeHeadingChanged(): ISignal<TableOfContents.IModel<H>, null | H>

• Signal emitted when the active heading changes.

  Returns ISignal<TableOfContents.IModel<H>, null | H>

collapseChanged

• get collapseChanged(): ISignal<TableOfContents.IModel<H>, null | H>

• Signal emitted when a table of content section collapse state changes.

  Returns ISignal<TableOfContents.IModel<H>, null | H>

configuration

• get configuration(): TableOfContents.IConfig

• Model configuration

  Returns TableOfContents.IConfig

headings

• get headings(): H[]

• List of headings.

  Returns H[]

  table of contents list of headings

headingsChanged

• get headingsChanged(): ISignal<TableOfContents.IModel<H>, void>

• Signal emitted when the headings changes.

  Returns ISignal<TableOfContents.IModel<H>, void>

isActive

• get isActive(): boolean

• Whether the model is active or not.

  Notes

  An active model means it is displayed in the table of contents. This can be used by subclass to limit updating the headings.

  Returns boolean
• set isActive(v: boolean): void

• Whether the model needs to be kept up to date or not.

  Notes

  This is set to true if the ToC panel is visible and to false if it is hidden. But some models may require to be always active; e.g. to add numbering in the document.

  Parameters

  • v: boolean

  Returns void

supportedOptions

• get supportedOptions(): (keyof TableOfContents.IConfig)[]

• List of configuration options supported by the model.

  Returns (keyof TableOfContents.IConfig)[]

title

• get title(): undefined | string

• Document title

  Returns undefined | string
• set title(v: undefined | string): void

• Document title

  Parameters

  • v: undefined | string

  Returns void

refresh

• refresh(): Promise<void>

• Refresh the headings list.

  Returns Promise<void>

setActiveHeading

• setActiveHeading(heading: null | H, emitSignal?: boolean): void

• Set a new active heading.

  Parameters

  • heading: null | H

    The new active heading
  • emitSignal: boolean = true

    Whether to emit the activeHeadingChanged signal or not.

  Returns void

setConfiguration

• setConfiguration(c: Partial<TableOfContents.IConfig>): void

• Model configuration setter.

  Parameters

  • c: Partial<TableOfContents.IConfig>

    New configuration

  Returns void

toggleCollapse

• toggleCollapse(options: { collapsed?: boolean; heading?: H }): void

• Callback on heading collapse.

  Parameters

  • options: { collapsed?: boolean; heading?: H }

    • Optionalcollapsed?: boolean

      The new collapsed status (toggle existing status if not provided)

    • Optionalheading?: H

      The heading to change state (all headings if not provided)

  Returns void