Table of Contents configuration

Notes

A document model may ignore some of those options.

interface IConfig {
    baseNumbering: number;
    includeOutput: boolean;
    maximalDepth: number;
    numberHeaders: boolean;
    numberingH1: boolean;
    syncCollapseState: boolean;
}

Hierarchy

Properties

baseNumbering: number

Base level for the highest headings

includeOutput: boolean

Whether to include cell outputs in headings or not.

maximalDepth: number

Maximal depth of headings to display

numberHeaders: boolean

Whether to number headings in document or not.

numberingH1: boolean

Whether to number first-level headings or not.

syncCollapseState: boolean

Whether to synchronize heading collapse state between the ToC and the document or not.