Class NotebookToCModel

Table of content model for Notebook files.

Hierarchy (View Summary)

TableOfContentsModel<INotebookHeading, NotebookPanel>
- NotebookToCModel

Constructors

constructor

new NotebookToCModel(
    widget: NotebookPanel,
    parser: null | IMarkdownParser,
    sanitizer: IRenderMime.ISanitizer,
    configuration?: TableOfContents.IConfig,
): NotebookToCModel
Constructor
Parameters
- widget: NotebookPanel
  The widget to search in
- parser: null | IMarkdownParser
  Markdown parser
- sanitizer: IRenderMime.ISanitizer
  Sanitizer
- Optionalconfiguration: TableOfContents.IConfig
  Default model configuration
Returns NotebookToCModel
Overrides TableOfContentsModel.constructor
- Defined in packages/notebook/src/toc.ts:79

Properties

`Protected`configMetadataMap

configMetadataMap: { [k: string | number]: string[] } = ...

Mapping between configuration options and notebook metadata.

If it starts with !, the boolean value of the configuration option is opposite to the one stored in metadata. If it contains /, the metadata data is nested.

`Protected`parser

parser: null | IMarkdownParser

Markdown parser

`Protected`sanitizer

sanitizer: IRenderMime.ISanitizer

Sanitizer

`Readonly`stateChanged

stateChanged: Signal<NotebookToCModel, void>

A signal emitted when any model state changes.

`Protected`widget

widget: NotebookPanel

The widget to search in

Accessors

activeHeading

get activeHeading(): null | H
Current active entry.

Returns null | H
table of contents active entry
Inherited from TableOfContentsModel.activeHeading
- Defined in packages/toc/lib/model.d.ts:22

activeHeadingChanged

get activeHeadingChanged(): ISignal<TableOfContents.IModel<H>, null | H>
Signal emitted when the active heading changes.

Returns ISignal<TableOfContents.IModel<H>, null | H>
Inherited from TableOfContentsModel.activeHeadingChanged
- Defined in packages/toc/lib/model.d.ts:26

collapseChanged

get collapseChanged(): ISignal<TableOfContents.IModel<H>, null | H>
Signal emitted when a table of content section collapse state changes.

Returns ISignal<TableOfContents.IModel<H>, null | H>
Inherited from TableOfContentsModel.collapseChanged
- Defined in packages/toc/lib/model.d.ts:30

configuration

get configuration(): TableOfContents.IConfig
Model configuration

Returns TableOfContents.IConfig
Inherited from TableOfContentsModel.configuration
- Defined in packages/toc/lib/model.d.ts:34

documentType

get documentType(): string
Type of document supported by the model.

Notes
A data-document-type attribute with this value will be set on the tree view .jp-TableOfContents-content[data-document-type="..."]

Returns string
Overrides TableOfContentsModel.documentType
- Defined in packages/notebook/src/toc.ts:116

headings

get headings(): H[]
List of headings.

Returns H[]
table of contents list of headings
Inherited from TableOfContentsModel.headings
- Defined in packages/toc/lib/model.d.ts:48

headingsChanged

get headingsChanged(): ISignal<TableOfContents.IModel<H>, void>
Signal emitted when the headings changes.

Returns ISignal<TableOfContents.IModel<H>, void>
Inherited from TableOfContentsModel.headingsChanged
- Defined in packages/toc/lib/model.d.ts:52

isActive

get isActive(): boolean
Whether the model is active or not.

Notes
An active model means it is displayed in the table of contents. This can be used by subclass to limit updating the headings.

Returns boolean
Inherited from TableOfContentsModel.isActive
- Defined in packages/toc/lib/model.d.ts:60
set isActive(v: boolean): void
Whether the model needs to be kept up to date or not.

Notes
This is set to true if the ToC panel is visible and to false if it is hidden. But some models may require to be always active; e.g. to add numbering in the document.
Parameters
- v: boolean
Returns void
Inherited from TableOfContentsModel.isActive
- Defined in packages/toc/lib/model.d.ts:61

`Protected`isAlwaysActive

get isAlwaysActive(): boolean
Whether the model gets updated even if the table of contents panel is hidden or not.

Returns boolean
Overrides TableOfContentsModel.isAlwaysActive
- Defined in packages/notebook/src/toc.ts:124

isDisposed

get isDisposed(): boolean
Test whether the model is disposed.

Returns boolean
Inherited from TableOfContentsModel.isDisposed
- Defined in packages/ui-components/lib/components/vdom.d.ts:184

supportedOptions

get supportedOptions(): (keyof TableOfContents.IConfig)[]
List of configuration options supported by the model.

Returns (keyof TableOfContents.IConfig)[]
Overrides TableOfContentsModel.supportedOptions
- Defined in packages/notebook/src/toc.ts:131

title

get title(): undefined | string
Document title

Returns undefined | string
Inherited from TableOfContentsModel.title
- Defined in packages/toc/lib/model.d.ts:78
set title(v: undefined | string): void
Document title
Parameters
- v: undefined | string
Returns void
Inherited from TableOfContentsModel.title
- Defined in packages/toc/lib/model.d.ts:79

Methods

dispose

dispose(): void
Dispose the object

Returns void
Overrides TableOfContentsModel.dispose
- Defined in packages/notebook/src/toc.ts:170

getCellHeadings

getCellHeadings(cell: Cell<ICellModel>): INotebookHeading[]
Get the headings of a given cell.
Parameters
- cell: Cell<ICellModel>
  Cell
Returns INotebookHeading[]
The associated headings
- Defined in packages/notebook/src/toc.ts:148

`Protected`getHeadings

getHeadings(): Promise<null | INotebookHeading[]>
Produce the headings for a document.

Returns Promise<null | INotebookHeading[]>
The list of new headings or null if nothing needs to be updated.
Overrides TableOfContentsModel.getHeadings
- Defined in packages/notebook/src/toc.ts:227

`Protected`isHeadingEqual

isHeadingEqual(heading1: INotebookHeading, heading2: INotebookHeading): boolean
Test if two headings are equal or not.
Parameters
- heading1: INotebookHeading
  First heading
- heading2: INotebookHeading
  Second heading
Returns boolean
Whether the headings are equal.
Overrides TableOfContentsModel.isHeadingEqual
- Defined in packages/notebook/src/toc.ts:308

`Protected`loadConfigurationFromMetadata

loadConfigurationFromMetadata(): Partial<TableOfContents.IConfig>
Read table of content configuration from notebook metadata.

Returns Partial<TableOfContents.IConfig>
ToC configuration from metadata
- Defined in packages/notebook/src/toc.ts:323

`Protected`onActiveCellChanged

onActiveCellChanged(notebook: Notebook, cell: Cell<ICellModel>): void
Parameters
- notebook: Notebook
- cell: Cell<ICellModel>
Returns void
- Defined in packages/notebook/src/toc.ts:355

`Protected`onExecuted

onExecuted(
    _: unknown,
    args: {
        cell: Cell<ICellModel>;
        error: null | KernelError;
        notebook: Notebook;
        success: boolean;
    },
): void
Parameters
- _: unknown
- args: {
      cell: Cell<ICellModel>;
      error: null | KernelError;
      notebook: Notebook;
      success: boolean;
  }
Returns void
- Defined in packages/notebook/src/toc.ts:373

`Protected`onExecutionScheduled

onExecutionScheduled(
_: unknown,
args: { cell: Cell<ICellModel>; notebook: Notebook },
): void
Parameters
- _: unknown
- args: { cell: Cell<ICellModel>; notebook: Notebook }
Returns void
- Defined in packages/notebook/src/toc.ts:407

`Protected`onHeadingsChanged

onHeadingsChanged(): void
Returns void
- Defined in packages/notebook/src/toc.ts:364

`Protected`onMetadataChanged

onMetadataChanged(): void
Returns void
- Defined in packages/notebook/src/toc.ts:443

`Protected`onOutputCleared

onOutputCleared(
_: unknown,
args: { cell: Cell<ICellModel>; notebook: Notebook },
): void
Parameters
- _: unknown
- args: { cell: Cell<ICellModel>; notebook: Notebook }
Returns void
- Defined in packages/notebook/src/toc.ts:424

refresh

refresh(): Promise<void>
Refresh the headings list.

Returns Promise<void>
Inherited from TableOfContentsModel.refresh
- Defined in packages/toc/lib/model.d.ts:89

setActiveHeading

setActiveHeading(heading: null | INotebookHeading, emitSignal?: boolean): void
Set a new active heading.
Parameters
- heading: null | INotebookHeading
  The new active heading
- OptionalemitSignal: boolean
  Whether to emit the activeHeadingChanged signal or not.
Returns void
Inherited from TableOfContentsModel.setActiveHeading
- Defined in packages/toc/lib/model.d.ts:96

setConfiguration

setConfiguration(c: Partial<TableOfContents.IConfig>): void
Model configuration setter.
Parameters
- c: Partial<TableOfContents.IConfig>
  New configuration
Returns void
Overrides TableOfContentsModel.setConfiguration
- Defined in packages/notebook/src/toc.ts:202

toggleCollapse

toggleCollapse(
options: { collapsed?: boolean; heading?: INotebookHeading },
): void
Callback on heading collapse.
Parameters
- options: { collapsed?: boolean; heading?: INotebookHeading }
  - Optionalcollapsed?: boolean
    The new collapsed status (toggle existing status if not provided)
  - Optionalheading?: INotebookHeading
    The heading to change state (all headings if not provided)
Returns void
Overrides TableOfContentsModel.toggleCollapse
- Defined in packages/notebook/src/toc.ts:214

`Protected`updateRunningStatus

updateRunningStatus(headings: INotebookHeading[]): void
Parameters
- headings: INotebookHeading[]
Returns void
- Defined in packages/notebook/src/toc.ts:447

Class NotebookToCModel

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebookToCModel

Properties

ProtectedconfigMetadataMap

Protectedparser

Protectedsanitizer

ReadonlystateChanged

Protectedwidget

Accessors

activeHeading

Returns null | H

activeHeadingChanged

Returns ISignal<TableOfContents.IModel<H>, null | H>

collapseChanged

Returns ISignal<TableOfContents.IModel<H>, null | H>

configuration

Returns TableOfContents.IConfig

documentType

Notes

Returns string

headings

Returns H[]

headingsChanged

Returns ISignal<TableOfContents.IModel<H>, void>

isActive

Notes

Returns boolean

Notes

Parameters

Returns void

ProtectedisAlwaysActive

Returns boolean

isDisposed

Returns boolean

supportedOptions

Returns (keyof TableOfContents.IConfig)[]

title

Returns undefined | string

Parameters

Returns void

Methods

dispose

Returns void

getCellHeadings

Parameters

Returns INotebookHeading[]

ProtectedgetHeadings

Returns Promise<null | INotebookHeading[]>

ProtectedisHeadingEqual

Parameters

Returns boolean

ProtectedloadConfigurationFromMetadata

Returns Partial<TableOfContents.IConfig>

ProtectedonActiveCellChanged

Parameters

Returns void

ProtectedonExecuted

Parameters

Returns void

ProtectedonExecutionScheduled

Parameters

Returns void

ProtectedonHeadingsChanged

Returns void

ProtectedonMetadataChanged

Returns void

ProtectedonOutputCleared

Parameters

Returns void

refresh

Returns Promise<void>

`Protected`configMetadataMap

`Protected`parser

`Protected`sanitizer

`Readonly`stateChanged

`Protected`widget

`Protected`isAlwaysActive

`Protected`getHeadings

`Protected`isHeadingEqual

`Protected`loadConfigurationFromMetadata

`Protected`onActiveCellChanged

`Protected`onExecuted

`Protected`onExecutionScheduled

`Protected`onHeadingsChanged

`Protected`onMetadataChanged

`Protected`onOutputCleared

`Optional`collapsed?: boolean

`Optional`heading?: INotebookHeading

`Protected`updateRunningStatus