Class NotebookToCFactory

Table of content model factory for Notebook files.

Hierarchy (view full)

TableOfContentsFactory<NotebookPanel>
- NotebookToCFactory

Index

Constructors

Properties

_scrollToTop parser sanitizer tracker

Accessors

Methods

_createNew createNew isApplicable

Constructors

constructor

new NotebookToCFactory(tracker, parser, sanitizer): NotebookToCFactory
Constructor
Parameters
- tracker: INotebookTracker
  Widget tracker
- parser: null | IMarkdownParser
  Markdown parser
- sanitizer: IRenderMime.ISanitizer
  Sanitizer
Returns NotebookToCFactory
Overrides TableOfContentsFactory.constructor
- Defined in packages/notebook/src/toc.ts:558

Properties

`Private` _scrollToTop

_scrollToTop: boolean = true

`Protected` parser

parser: null | IMarkdownParser

Markdown parser

`Protected` sanitizer

sanitizer: IRenderMime.ISanitizer

Sanitizer

`Protected` tracker

tracker: IWidgetTracker<NotebookPanel>

Widget tracker

Accessors

scrollToTop

get scrollToTop(): boolean
Whether to scroll the active heading to the top of the document or not.

Returns boolean
- Defined in packages/notebook/src/toc.ts:570
set scrollToTop(v): void
Parameters
- v: boolean
Returns void
- Defined in packages/notebook/src/toc.ts:573

Methods

`Protected` _createNew

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

createNew

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

isApplicable

isApplicable(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