Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SectionTitles

An array containing one object per section or subsection detected in the input document. Sections and subsections are not nested; instead, they are flattened out and can be placed back in order by using the begin and end values of the element and the level value of the section.

Hierarchy

  • SectionTitles

Index

Properties

Optional element_locations

element_locations: ElementLocations[]

An array of location objects that lists the locations of detected section titles.

Optional level

level: number

An integer indicating the level at which the section is located in the input document. For example, 1 represents a top-level section, 2 represents a subsection within the level 1 section, and so forth.

Optional location

location: Location

The numeric location of the identified element in the document, represented with two integers labeled begin and end.

Optional text

text: string

The text of the section title, if identified.

Generated using TypeDoc