Class TableOfContentsRegistry

Class for registering table of contents generators.

Hierarchy

TableOfContentsRegistry

Implements

ITableOfContentsRegistry

Index

Constructors

Properties

_generators _idCounter

Methods

Constructors

constructor

new TableOfContentsRegistry(): TableOfContentsRegistry
Returns TableOfContentsRegistry

Properties

`Private` _generators

_generators: any

`Private` _idCounter

_idCounter: any

Methods

add

add(generator): IDisposable
Adds a table of contents generator to the registry.
Parameters
- generator: TableOfContents.IFactory<Widget, TableOfContents.IHeading>
  
  table of contents generator
Returns IDisposable
Implementation of ITableOfContentsRegistry.add
- Defined in packages/toc/lib/registry.d.ts:25

getModel

getModel(widget, configuration?): TableOfContents.Model
Finds a table of contents model for a widget.

Notes
- If unable to find a table of contents model, the method return undefined.
Parameters
- widget: Widget
  
  widget
- Optional configuration: TableOfContents.IConfig
  
  Default model configuration
Returns TableOfContents.Model
Table of contents model
Implementation of ITableOfContentsRegistry.getModel
- Defined in packages/toc/lib/registry.d.ts:19

Generated using TypeDoc