TableOfContentsRegistry | @jupyterlab (original) (raw)

Class for registering table of contents generators.

Implements

• ITableOfContentsRegistry

Index

Constructors

constructor

• new TableOfContentsRegistry(): TableOfContentsRegistry

• Returns TableOfContentsRegistry

Methods

add

• add(
  generator: TableOfContents.IFactory<Widget, TableOfContents.IHeading>,
  ): IDisposable
• Adds a table of contents generator to the registry.

Parameters

• generator: TableOfContents.IFactory<Widget, TableOfContents.IHeading>
  table of contents generator

Returns IDisposable

getModel

• getModel(
  widget: Widget,
  configuration?: TableOfContents.IConfig,
  ): undefined | TableOfContents.Model

• Parameters

  • widget: Widget
    widget
  • Optionalconfiguration: TableOfContents.IConfig
    Default model configuration

Returns undefined | TableOfContents.Model

Table of contents model