Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INotebookHeading

Interface describing a notebook cell heading.

Hierarchy

Index

Properties

Properties

cellRef

cellRef: Cell<ICellModel>

Reference to a notebook cell.

Optional hasChild

hasChild: boolean

Boolean indicating whether a heading has a child node.

Optional html

html: string

Special HTML markup.

Notes
  • The HTML string should be properly sanitized!
  • The HTML string can be used to render Markdown headings which have already been rendered as HTML.

index

index: number

index of reference cell in the notebook

isRunning

isRunning: RunningStatus

Running status of the cells in the heading

level

level: number

HTML heading level.

Optional numbering

numbering: string

Heading numbering.

onClick

onClick: () => void

Type declaration

    • (): void

    • Callback invoked upon clicking a ToC item.

      Notes
      • This will typically be used to scroll the parent widget to this item.

      Returns void

Optional prompt

prompt: string

Heading prompt.

text

text: string

Heading text.

type

type: "markdown" | "code" | "header"

Heading type.

Generated using TypeDoc