Class TableOfContentsModel<H, T>`Abstract`

Abstract table of contents model.

Type Parameters

H extends TableOfContents.IHeading
T extends Widget = Widget

Hierarchy (view full)

VDomModel
- TableOfContentsModel

Implements

TableOfContents.IModel<H>

Constructors

constructor

new TableOfContentsModel<H, T>(widget, configuration?): TableOfContentsModel<H, T>
Constructor
Type Parameters
- H extends TableOfContents.IHeading
- T extends Widget = Widget
Parameters
- widget: T
  The widget to search in
- Optional configuration: TableOfContents.IConfig
  Default model configuration
Returns TableOfContentsModel<H, T>
Overrides VDomModel.constructor
- Defined in packages/toc/src/model.ts:26

Properties

`Private` _activeHeading

_activeHeading: null | H

`Private` _activeHeadingChanged

_activeHeadingChanged: Signal<TableOfContentsModel<H, T>, null | H>

`Private` _collapseChanged

_collapseChanged: Signal<TableOfContentsModel<H, T>, null | H>

`Private` _configuration

_configuration: TableOfContents.IConfig

`Private` _headings

_headings: H[]

`Private` _headingsChanged

_headingsChanged: Signal<TableOfContentsModel<H, T>, void>

`Private` _isActive

_isActive: boolean

`Private` _isRefreshing

_isRefreshing: boolean

`Private` _needsRefreshing

_needsRefreshing: boolean

`Private` `Optional` _title

_title?: string

`Abstract` `Readonly` documentType

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="..."]

`Readonly` stateChanged

stateChanged: Signal<TableOfContentsModel<H, T>, void>

A signal emitted when any model state changes.

`Protected` widget

widget: T

The widget to search in

Accessors

activeHeading

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

Returns null | H
table of contents active entry
Implementation of IModel.activeHeading
- Defined in packages/toc/src/model.ts:50

activeHeadingChanged

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

Returns ISignal<TableOfContents.IModel<H>, null | H>
Implementation of IModel.activeHeadingChanged
- Defined in packages/toc/src/model.ts:57

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>
Implementation of IModel.collapseChanged
- Defined in packages/toc/src/model.ts:64

configuration

get configuration(): TableOfContents.IConfig
Model configuration

Returns TableOfContents.IConfig
Implementation of IModel.configuration
- Defined in packages/toc/src/model.ts:71

headings

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

Returns H[]
table of contents list of headings
Implementation of IModel.headings
- Defined in packages/toc/src/model.ts:89

headingsChanged

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

Returns ISignal<TableOfContents.IModel<H>, void>
Implementation of IModel.headingsChanged
- Defined in packages/toc/src/model.ts:96

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
Implementation of IModel.isActive
- Defined in packages/toc/src/model.ts:107
set isActive(v): 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
Implementation of IModel.isActive
- Defined in packages/toc/src/model.ts:110

`Protected` isAlwaysActive

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

Notes
For example, ToC models use to add title numbering will set this to true.

Returns boolean
- Defined in packages/toc/src/model.ts:129

isDisposed

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

Returns boolean
Implementation of IModel.isDisposed
Inherited from VDomModel.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)[]
Implementation of IModel.supportedOptions
- Defined in packages/toc/src/model.ts:136

title

get title(): undefined | string
Document title

Returns undefined | string
Implementation of IModel.title
- Defined in packages/toc/src/model.ts:143
set title(v): void
Document title
Parameters
- v: undefined | string
Returns void
Implementation of IModel.title
- Defined in packages/toc/src/model.ts:146

Methods

`Private` _areHeadingsEqual

_areHeadingsEqual(headings1, headings2): boolean
Test if two list of headings are equal or not.
Parameters
- headings1: H[]
  First list of headings
- headings2: H[]
  Second list of headings
Returns boolean
Whether the array are equal.
- Defined in packages/toc/src/model.ts:267

dispose

dispose(): void
Dispose the model.

Returns void
Implementation of IModel.dispose
Inherited from VDomModel.dispose
- Defined in packages/ui-components/lib/components/vdom.d.ts:188

`Protected` `Abstract` getHeadings

getHeadings(): Promise<null | H[]>
Abstract function that will produce the headings for a document.

Returns Promise<null | H[]>
The list of new headings or null if nothing needs to be updated.
- Defined in packages/toc/src/model.ts:158

`Protected` isHeadingEqual

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

refresh

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

Returns Promise<void>
- Defined in packages/toc/src/model.ts:163

setActiveHeading

setActiveHeading(heading, emitSignal?): void
Set a new active heading.
Parameters
- heading: null | H
  The new active heading
- emitSignal: boolean = true
  Whether to emit the activeHeadingChanged signal or not.
Returns void
Implementation of IModel.setActiveHeading
- Defined in packages/toc/src/model.ts:196

setConfiguration

setConfiguration(c): void
Model configuration setter.
Parameters
- c: Partial<TableOfContents.IConfig>
  New configuration
Returns void
Implementation of IModel.setConfiguration
- Defined in packages/toc/src/model.ts:213

toggleCollapse

toggleCollapse(options): void
Callback on heading collapse.
Parameters
- options: {
  collapsed?: boolean;
  heading?: H;
  }
  - Optional collapsed?: boolean
    The new collapsed status (toggle existing status if not provided)
  - Optional heading?: H
    The heading to change state (all headings if not provided)
Returns void
Implementation of IModel.toggleCollapse
- Defined in packages/toc/src/model.ts:229

Class TableOfContentsModel<H, T>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TableOfContentsModel<H, T>

Properties

Private _activeHeading

Private _activeHeadingChanged

Private _collapseChanged

Private _configuration

Private _headings

Private _headingsChanged

Private _isActive

Private _isRefreshing

Private _needsRefreshing

Private Optional _title

Abstract Readonly documentType

Notes

Readonly stateChanged

Protected widget

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

headings

Returns H[]

headingsChanged

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

isActive

Notes

Returns boolean

Notes

Parameters

Returns void

Protected isAlwaysActive

Notes

Returns boolean

isDisposed

Returns boolean

supportedOptions

Returns (keyof TableOfContents.IConfig)[]

title

Returns undefined | string

Parameters

Returns void

Methods

Private _areHeadingsEqual

Parameters

Returns boolean

dispose

Returns void

Protected Abstract getHeadings

Returns Promise<null | H[]>

Protected isHeadingEqual

Parameters

Returns boolean

refresh

Returns Promise<void>

setActiveHeading

Parameters

Returns void

setConfiguration

Parameters

Returns void

toggleCollapse

Parameters

Class TableOfContentsModel<H, T>`Abstract`

`Private` _activeHeading

`Private` _activeHeadingChanged

`Private` _collapseChanged

`Private` _configuration

`Private` _headings

`Private` _headingsChanged

`Private` _isActive

`Private` _isRefreshing

`Private` _needsRefreshing

`Private` `Optional` _title

`Abstract` `Readonly` documentType

`Readonly` stateChanged

`Protected` widget

`Protected` isAlwaysActive

`Private` _areHeadingsEqual

`Protected` `Abstract` getHeadings

`Protected` isHeadingEqual

`Optional` collapsed?: boolean

`Optional` heading?: H