ADF node: heading

Node

Description

Represents a topic heading, as for the <h1> through <h6> tags used in HTML.

Example

Java

1
2
h4("Heading 4");

ADF

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "type": "heading",
  "attrs": {
    "level": 1
  },
  "content": [
    {
      "type": "text",
      "text": "Heading 4"
    }
  ]
}

Result

Heading 4

Compatibility

Products

Usage

• DocContent
• LayoutColumnContent – no marks1
• NestedExpandContent – no marks2
• NonNestableBlockContent – no marks3
• PanelContent – no marks4
• TableCellContent

Marks

• alignment
• indentation

Structure

• type - heading
• content? - array(InlineContent..,)
• attrs
  • level - int – from 1 to 6
  • localId? - string (should not be empty, and likely to be a UUID, but neither is enforced)
• marks? - array(PositionMark?)

---

1. Although heading nodes are usually permitted to have a mark, such as alignment or indentation, these are not permitted in most of the cases where the heading is within another block element.↩︎
2. Although heading nodes are usually permitted to have a mark, such as alignment or indentation, these are not permitted in most of the cases where the heading is within another block element.↩︎
3. Although heading nodes are usually permitted to have a mark, such as alignment or indentation, these are not permitted in most of the cases where the heading is within another block element.↩︎
4. Although heading nodes are usually permitted to have a mark, such as alignment or indentation, these are not permitted in most of the cases where the heading is within another block element.↩︎