@jupyterlab/notebook/lib/toc.d.ts

JupyterLab - Notebook

import { Cell, ICellModel } from '@jupyterlab/cells';
import { IMarkdownParser, IRenderMime } from '@jupyterlab/rendermime';
import { TableOfContents, TableOfContentsFactory, TableOfContentsModel } from '@jupyterlab/toc';
import { KernelError } from './actions';
import { NotebookPanel } from './panel';
import { INotebookTracker } from './tokens';
import { Notebook } from './widget';
/**
 * Cell running status
 */
export declare enum RunningStatus {
    /**
     * Cell is idle
     */
    Idle = -1,
    /**
     * Cell execution is unsuccessful
     */
    Error = -0.5,
    /**
     * Cell execution is scheduled
     */
    Scheduled = 0,
    /**
     * Cell is running
     */
    Running = 1
}
/**
 * Interface describing a notebook cell heading.
 */
export interface INotebookHeading extends TableOfContents.IHeading {
    /**
     * Reference to a notebook cell.
     */
    cellRef: Cell;
    /**
     * Running status of the cells in the heading
     */
    isRunning: RunningStatus;
    /**
     * Index of the output containing the heading
     */
    outputIndex?: number;
    /**
     * Type of heading
     */
    type: Cell.HeadingType;
}
/**
 * Table of content model for Notebook files.
 */
export declare class NotebookToCModel extends TableOfContentsModel<INotebookHeading, NotebookPanel> {
    protected parser: IMarkdownParser | null;
    protected sanitizer: IRenderMime.ISanitizer;
    /**
     * Constructor
     *
     * @param widget The widget to search in
     * @param parser Markdown parser
     * @param sanitizer Sanitizer
     * @param configuration Default model configuration
     */
    constructor(widget: NotebookPanel, parser: IMarkdownParser | null, sanitizer: IRenderMime.ISanitizer, configuration?: TableOfContents.IConfig);
    /**
     * 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="..."]`
     */
    get documentType(): string;
    /**
     * Whether the model gets updated even if the table of contents panel
     * is hidden or not.
     */
    protected get isAlwaysActive(): boolean;
    /**
     * List of configuration options supported by the model.
     */
    get supportedOptions(): (keyof TableOfContents.IConfig)[];
    /**
     * Get the headings of a given cell.
     *
     * @param cell Cell
     * @returns The associated headings
     */
    getCellHeadings(cell: Cell): INotebookHeading[];
    /**
     * Dispose the object
     */
    dispose(): void;
    /**
     * Model configuration setter.
     *
     * @param c New configuration
     */
    setConfiguration(c: Partial<TableOfContents.IConfig>): void;
    /**
     * Callback on heading collapse.
     *
     * @param options.heading The heading to change state (all headings if not provided)
     * @param options.collapsed The new collapsed status (toggle existing status if not provided)
     */
    toggleCollapse(options: {
        heading?: INotebookHeading;
        collapsed?: boolean;
    }): void;
    /**
     * Produce the headings for a document.
     *
     * @returns The list of new headings or `null` if nothing needs to be updated.
     */
    protected getHeadings(): Promise<INotebookHeading[] | null>;
    /**
     * Test if two headings are equal or not.
     *
     * @param heading1 First heading
     * @param heading2 Second heading
     * @returns Whether the headings are equal.
     */
    protected isHeadingEqual(heading1: INotebookHeading, heading2: INotebookHeading): boolean;
    /**
     * Read table of content configuration from notebook metadata.
     *
     * @returns ToC configuration from metadata
     */
    protected loadConfigurationFromMetadata(): Partial<TableOfContents.IConfig>;
    protected onActiveCellChanged(notebook: Notebook, cell: Cell<ICellModel>): void;
    protected onHeadingsChanged(): void;
    protected onExecuted(_: unknown, args: {
        notebook: Notebook;
        cell: Cell;
        success: boolean;
        error: KernelError | null;
    }): void;
    protected onExecutionScheduled(_: unknown, args: {
        notebook: Notebook;
        cell: Cell;
    }): void;
    protected onOutputCleared(_: unknown, args: {
        notebook: Notebook;
        cell: Cell;
    }): void;
    protected onMetadataChanged(): void;
    protected updateRunningStatus(headings: INotebookHeading[]): void;
    /**
     * 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 configMetadataMap: {
        [k: keyof TableOfContents.IConfig]: string[];
    };
    private _runningCells;
    private _errorCells;
    private _cellToHeadingIndex;
}
/**
 * Table of content model factory for Notebook files.
 */
export declare class NotebookToCFactory extends TableOfContentsFactory<NotebookPanel> {
    protected parser: IMarkdownParser | null;
    protected sanitizer: IRenderMime.ISanitizer;
    /**
     * Constructor
     *
     * @param tracker Widget tracker
     * @param parser Markdown parser
     * @param sanitizer Sanitizer
     */
    constructor(tracker: INotebookTracker, parser: IMarkdownParser | null, sanitizer: IRenderMime.ISanitizer);
    /**
     * Whether to scroll the active heading to the top
     * of the document or not.
     */
    get scrollToTop(): boolean;
    set scrollToTop(v: boolean);
    /**
     * Create a new table of contents model for the widget
     *
     * @param widget - widget
     * @param configuration - Table of contents configuration
     * @returns The table of contents model
     */
    protected _createNew(widget: NotebookPanel, configuration?: TableOfContents.IConfig): TableOfContentsModel<TableOfContents.IHeading, NotebookPanel>;
    private _scrollToTop;
}
/**
 * Get the element id for an heading
 * @param heading Heading
 * @param parser The markdownparser
 * @returns The element id
 */
export declare function getIdForHeading(heading: INotebookHeading, parser: IRenderMime.IMarkdownParser, sanitizer: IRenderMime.ISanitizer): Promise<string | null>;