MarkdownTableOfContentsModel | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• TableOfContentsModel<
  IEditorHeading,
  IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
  >
  • MarkdownTableOfContentsModel

Index

Constructors

constructor

• new MarkdownTableOfContentsModel(
  widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>,
  configuration?: TableOfContents.IConfig,
  ): MarkdownTableOfContentsModel

• Parameters

  • widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>
  • Optionalconfiguration: TableOfContents.IConfig

Returns MarkdownTableOfContentsModel

Properties

ReadonlystateChanged

Protectedwidget

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

documentType

• get documentType(): string

• Returns string

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

ProtectedgetHeadings

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

• Returns Promise<null | IEditorHeading[]>

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

ProtectedisHeadingEqual

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

• Returns boolean

Whether the headings are equal.

refresh

• refresh(): Promise<void>

• Returns Promise<void>

setActiveHeading

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

• Returns void

setConfiguration

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

• Returns void

toggleCollapse

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

• Parameters

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

Returns void