MarkdownViewerTableOfContentsFactory | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• TableOfContentsFactory<MarkdownDocument>
  • MarkdownViewerTableOfContentsFactory

Index

Constructors

constructor

• new MarkdownViewerTableOfContentsFactory(
  tracker: IWidgetTracker<MarkdownDocument>,
  parser: null | IMarkdownParser,
  sanitizer: IRenderMime.ISanitizer,
  ): MarkdownViewerTableOfContentsFactory

• Parameters

  • tracker: IWidgetTracker<MarkdownDocument>
  • parser: null | IMarkdownParser
  • sanitizer: IRenderMime.ISanitizer

Returns MarkdownViewerTableOfContentsFactory

Properties

Protectedparser

Protectedsanitizer

Protectedtracker

Methods

Protected_createNew

• _createNew(
  widget: MarkdownDocument,
  configuration?: TableOfContents.IConfig,
  ): TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>

• Returns TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>

The table of contents model

createNew

• createNew(
  widget: MarkdownDocument,
  configuration?: TableOfContents.IConfig,
  ): TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>

• Returns TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>

The table of contents model

isApplicable

• isApplicable(widget: Widget): boolean

• Returns boolean

boolean indicating a ToC can be generated