TableOfContentsFactory | @jupyterlab (original) (raw)

• @jupyterlab
• toc
• TableOfContentsFactory

Class TableOfContentsFactory<W, H>Abstract

Type Parameters

• W extends IDocumentWidget
• H extends TableOfContents.IHeading = TableOfContents.IHeading

Hierarchy (View Summary)

• TableOfContentsFactory
  • EditorTableOfContentsFactory
  • MarkdownViewerTableOfContentsFactory
  • NotebookToCFactory

Implements

• TableOfContents.IFactory<W, H>

Index

Constructors

constructor

• new TableOfContentsFactory<
  W extends IDocumentWidget<Widget, DocumentRegistry.IModel>,
  H extends TableOfContents.IHeading = TableOfContents.IHeading,
  >(
  tracker: IWidgetTracker<W>,
  ): TableOfContentsFactory<W, H>

• Type Parameters

  • W extends IDocumentWidget<Widget, DocumentRegistry.IModel>
  • H extends TableOfContents.IHeading = TableOfContents.IHeading

Returns TableOfContentsFactory<W, H>

Properties

Protectedtracker

Methods

Protected Abstract_createNew

• _createNew(
  widget: W,
  configuration?: TableOfContents.IConfig,
  ): TableOfContentsModel<H, W>

• Returns TableOfContentsModel<H, W>

createNew

• createNew(
  widget: W,
  configuration?: TableOfContents.IConfig,
  ): TableOfContentsModel<H, W>

• Returns TableOfContentsModel<H, W>

The table of contents model

isApplicable

• isApplicable(widget: Widget): boolean

• Returns boolean

boolean indicating a ToC can be generated