Child pages
  • Table of Contents Heading Calculator

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
classcomponent-api-page

Anchor
top
top

The Heading Calculator subcomponent is used by the Table of Contents Model Builder to calculate and return the level of heading elements.

Do not use this component directly. The information on this page should be use when customizing Table of Contents.

See Also
Table of Contents Model Builder

Table of Contents API

Div
classsummary-table

Supported Events

none

Methods

none

Options

levels
An array of heading elements presented in the order from the first level to the last level.

Options

Span
classback-to-top
back to top

levels

Div
classapi-table

Description

An array of heading elements presented in the order from the first level to the last level. The level of the heading element "H1" is 1, "H2" is 2, and so on.

Default

["H1", "H2", "H3", "H4", "H5", "H6"]

Example

Code Block
javascript
javascript
{
    levels: []
}