NotebookToCModel | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• TableOfContentsModel<INotebookHeading, NotebookPanel>
  • NotebookToCModel

Index

Constructors

constructor

• new NotebookToCModel(
  widget: NotebookPanel,
  parser: null | IMarkdownParser,
  sanitizer: IRenderMime.ISanitizer,
  configuration?: TableOfContents.IConfig,
  ): NotebookToCModel

• Parameters

  • widget: NotebookPanel
  • parser: null | IMarkdownParser
  • sanitizer: IRenderMime.ISanitizer
  • Optionalconfiguration: TableOfContents.IConfig

Returns NotebookToCModel

Properties

ProtectedconfigMetadataMap

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

Protectedparser

Protectedsanitizer

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

getCellHeadings

• getCellHeadings(cell: Cell<ICellModel>): INotebookHeading[]

• Returns INotebookHeading[]

The associated headings

ProtectedgetHeadings

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

• Returns Promise<null | INotebookHeading[]>

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

ProtectedisHeadingEqual

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

• Returns boolean

Whether the headings are equal.

ProtectedloadConfigurationFromMetadata

• loadConfigurationFromMetadata(): Partial<TableOfContents.IConfig>

• Returns Partial<TableOfContents.IConfig>

ToC configuration from metadata

ProtectedonActiveCellChanged

• onActiveCellChanged(notebook: Notebook, cell: Cell<ICellModel>): void

• Returns void

ProtectedonExecuted

• 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

ProtectedonExecutionScheduled

• onExecutionScheduled(
  _: unknown,
  args: { cell: Cell<ICellModel>; notebook: Notebook },
  ): void

• Returns void

ProtectedonHeadingsChanged

• onHeadingsChanged(): void

• Returns void

ProtectedonMetadataChanged

• onMetadataChanged(): void

• Returns void

ProtectedonOutputCleared

• onOutputCleared(
  _: unknown,
  args: { cell: Cell<ICellModel>; notebook: Notebook },
  ): void

• Returns void

refresh

• refresh(): Promise<void>

• Returns Promise<void>

setActiveHeading

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

• Returns void

setConfiguration

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

• Returns void

toggleCollapse

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

• Parameters

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

Returns void

ProtectedupdateRunningStatus

• updateRunningStatus(headings: INotebookHeading[]): void

• Returns void