Class NotebookToCFactory

Table of content model factory for Notebook files.

Hierarchy (View Summary)

TableOfContentsFactory<NotebookPanel>
- NotebookToCFactory

Index

Constructors

Properties

commands parser sanitizer tracker

Accessors

Methods

_createNew createNew getToolbarItems isApplicable

Constructors

constructor

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

Properties

`Protected`commands

commands: undefined | CommandRegistry

A registry of commands

`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:593
set scrollToTop(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/notebook/src/toc.ts:596

Methods

`Protected`_createNew

_createNew(
widget: NotebookPanel,
configuration?: TableOfContents.IConfig,
): TableOfContentsModel<TableOfContents.IHeading, NotebookPanel>
Create a new table of contents model for the widget
Parameters
- widget: NotebookPanel
  widget
- Optionalconfiguration: 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:607

createNew

createNew(
widget: NotebookPanel,
configuration?: TableOfContents.IConfig,
): TableOfContentsModel<TableOfContents.IHeading, NotebookPanel>
Create a new table of contents model for the widget
Parameters
- widget: NotebookPanel
  widget
- Optionalconfiguration: 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:39

getToolbarItems

getToolbarItems(widget: NotebookPanel): ToolbarRegistry.IToolbarItem[]
Get the toolbar items for the widget
Parameters
- widget: NotebookPanel
  widget
Returns ToolbarRegistry.IToolbarItem[]
List of toolbar items
Overrides TableOfContentsFactory.getToolbarItems
- Defined in packages/notebook/src/toc.ts:831

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:24