GitHubJupyter
  • Preparing search index...
  • The search index is not available
@jupyterlab
  • @jupyterlab
  • toc
  • TableOfContentsUtils
  • filterHeadings

Function filterHeadings

  • filterHeadings<T extends TableOfContents.IHeading = TableOfContents.IHeading>(
        headings: T[],
        options?: Partial<TableOfContents.IConfig>,
        initialLevels?: number[],
    ): T[]
  • Filter headings for table of contents and compute associated prefix

    Type Parameters

    • T extends TableOfContents.IHeading = TableOfContents.IHeading

    Parameters

    • headings: T[]

      Headings to process

    • Optionaloptions: Partial<TableOfContents.IConfig>

      Options

    • initialLevels: number[] = []

      Initial levels for prefix computation

    Returns T[]

    Extracted headings

    • Defined in packages/toc/src/utils/common.ts:29

Settings

Member Visibility
GitHubJupyter
@jupyterlab
  • Loading...

Generated using TypeDoc