Interface INotebookHeading

Interface describing a notebook cell heading.

interface INotebookHeading {
    cellRef: Cell<ICellModel>;
    collapsed?: boolean;
    dataset?: Record<string, string>;
    isRunning: RunningStatus;
    level: number;
    outputIndex?: number;
    prefix?: null | string;
    skip?: boolean;
    text: string;
    type: HeadingType;
}

Hierarchy (view full)

Properties

cellRef collapsed? dataset? isRunning level outputIndex? prefix? skip? text type

Properties

cellRef

cellRef: Cell<ICellModel>

Reference to a notebook cell.

Optional collapsed

collapsed?: boolean

Whether the heading is collapsed or not

Optional dataset

dataset?: Record<string, string>

Dataset to add to the item node

isRunning

isRunning: RunningStatus

Running status of the cells in the heading

level

level: number

HTML heading level.

Optional outputIndex

outputIndex?: number

Index of the output containing the heading

Optional prefix

prefix?: null | string

Heading prefix.

Optional skip

skip?: boolean

Whether the heading is marked to skip or not

text

text: string

Heading text.

type

type: HeadingType

Type of heading

Settings

Member Visibility

Theme

On This Page

cellRefcollapseddatasetisRunningleveloutputIndexprefixskiptexttype