PythonTableOfContentsFactory | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• EditorTableOfContentsFactory
  • PythonTableOfContentsFactory

Index

Constructors

constructor

• new PythonTableOfContentsFactory(
  tracker: IWidgetTracker<
  IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
  >,
  ): PythonTableOfContentsFactory

• Returns PythonTableOfContentsFactory

Properties

Protectedtracker

Methods

Protected_createNew

• _createNew(
  widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
  configuration?: TableOfContents.IConfig,
  ): PythonTableOfContentsModel

• Parameters

  • widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>
  • Optionalconfiguration: TableOfContents.IConfig

Returns PythonTableOfContentsModel

The table of contents model

createNew

• createNew(
  widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
  configuration?: TableOfContents.IConfig,
  ): TableOfContentsModel<
  IEditorHeading,
  IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
  >

• Parameters

  • widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>
  • Optionalconfiguration: TableOfContents.IConfig

Returns TableOfContentsModel<

IEditorHeading,
IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
>
The table of contents model

isApplicable

• isApplicable(widget: Widget): boolean

• Returns boolean

boolean indicating a ToC can be generated