Class MarkdownViewerTableOfContentsFactory

Table of content model factory for Markdown viewer files.

Hierarchy (View Summary)

TableOfContentsFactory<MarkdownDocument>
- MarkdownViewerTableOfContentsFactory

Index

Constructors

Properties

parser sanitizer tracker

Methods

_createNew createNew isApplicable

Constructors

constructor

new MarkdownViewerTableOfContentsFactory(
    tracker: IWidgetTracker<MarkdownDocument>,
    parser: null | IMarkdownParser,
    sanitizer: IRenderMime.ISanitizer,
): MarkdownViewerTableOfContentsFactory
Constructor
Parameters
- tracker: IWidgetTracker<MarkdownDocument>
  Widget tracker
- parser: null | IMarkdownParser
  Markdown parser
- sanitizer: IRenderMime.ISanitizer
Returns MarkdownViewerTableOfContentsFactory
Overrides TableOfContentsFactory.constructor
- Defined in packages/markdownviewer/src/toc.ts:97

Properties

`Protected`parser

parser: null | IMarkdownParser

Markdown parser

`Protected`sanitizer

sanitizer: IRenderMime.ISanitizer

`Protected`tracker

tracker: IWidgetTracker<MarkdownDocument>

Widget tracker

Methods

`Protected`_createNew

_createNew(
widget: MarkdownDocument,
configuration?: TableOfContents.IConfig,
): TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>
Create a new table of contents model for the widget
Parameters
- widget: MarkdownDocument
  widget
- Optionalconfiguration: TableOfContents.IConfig
  Table of contents configuration
Returns TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>
The table of contents model
Overrides TableOfContentsFactory._createNew
- Defined in packages/markdownviewer/src/toc.ts:112

createNew

createNew(
widget: MarkdownDocument,
configuration?: TableOfContents.IConfig,
): TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>
Create a new table of contents model for the widget
Parameters
- widget: MarkdownDocument
  widget
- Optionalconfiguration: TableOfContents.IConfig
  Table of contents configuration
Returns TableOfContentsModel<TableOfContents.IHeading, MarkdownDocument>
The table of contents model
Inherited from TableOfContentsFactory.createNew
- Defined in packages/toc/lib/factory.d.ts:31

isApplicable

isApplicable(widget: Widget): boolean
Whether the factory can handle the widget or not.
Parameters
- widget: Widget
  widget
Returns boolean
boolean indicating a ToC can be generated
Inherited from TableOfContentsFactory.isApplicable
- Defined in packages/toc/lib/factory.d.ts:23