TableOfContentsModel | @jupyterlab (original) (raw)

• @jupyterlab
• toc
• TableOfContentsModel

Class TableOfContentsModel<H, T>Abstract

Type Parameters

• H extends TableOfContents.IHeading
• T extends Widget = Widget

Hierarchy (View Summary)

• VDomModel
  • TableOfContentsModel
    * LaTeXTableOfContentsModel
    * MarkdownTableOfContentsModel
    * PythonTableOfContentsModel
    * MarkdownViewerTableOfContentsModel
    * NotebookToCModel

Implements

• TableOfContents.IModel<H>

Index

Constructors

constructor

• new TableOfContentsModel<
  H extends TableOfContents.IHeading,
  T extends Widget = Widget,
  >(
  widget: T,
  configuration?: TableOfContents.IConfig,
  ): TableOfContentsModel<H, T>

• Type Parameters

  • H extends TableOfContents.IHeading
  • T extends Widget = Widget

Returns TableOfContentsModel<H, T>

Properties

Abstract ReadonlydocumentType

documentType: string

ReadonlystateChanged

Protectedwidget

widget: T

Accessors

activeHeading

• get activeHeading(): null | H

• Returns null | H

table of contents active entry

activeHeadingChanged

• get activeHeadingChanged(): ISignal<TableOfContents.IModel<H>, null | H>

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

collapseChanged

• get collapseChanged(): ISignal<TableOfContents.IModel<H>, null | H>

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

configuration

• get configuration(): TableOfContents.IConfig

• Returns TableOfContents.IConfig

headings

• get headings(): H[]

• Returns H[]

table of contents list of headings

headingsChanged

• get headingsChanged(): ISignal<TableOfContents.IModel<H>, void>

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

isActive

• get isActive(): boolean

• Returns boolean

• set isActive(v: boolean): void

• Returns void

ProtectedisAlwaysActive

• get isAlwaysActive(): boolean

• Returns boolean

isDisposed

• get isDisposed(): boolean

• Returns boolean

supportedOptions

• get supportedOptions(): (keyof TableOfContents.IConfig)[]

• Returns (keyof TableOfContents.IConfig)[]

title

• get title(): undefined | string

• Returns undefined | string

• set title(v: undefined | string): void

• Parameters

  • v: undefined | string

Returns void

Methods

dispose

• dispose(): void

• Returns void

Protected AbstractgetHeadings

• getHeadings(): Promise<null | H[]>

• Returns Promise<null | H[]>

The list of new headings or null if nothing needs to be updated.

ProtectedisHeadingEqual

• isHeadingEqual(heading1: H, heading2: H): boolean

• Parameters

  • heading1: H
  • heading2: H

Returns boolean

Whether the headings are equal.

refresh

• refresh(): Promise<void>

• Returns Promise<void>

setActiveHeading

• setActiveHeading(heading: null | H, emitSignal?: boolean): void

• Parameters

  • heading: null | H
  • emitSignal: boolean = true

Returns void

setConfiguration

• setConfiguration(c: Partial<TableOfContents.IConfig>): void

• Returns void

toggleCollapse

• toggleCollapse(options: { collapsed?: boolean; heading?: H }): void

• Parameters

  • options: { collapsed?: boolean; heading?: H }
    * ##### Optionalcollapsed?: boolean
    * ##### Optionalheading?: H

Returns void