Module: playerapi/path/PathElementMetadata

Methods

<inner> getLevel() → {Number}

Gets the intention level of the section.

Returns:

The level of outline.

Type
Number

<inner> getPageMetadata() → {module:playerapi/page/PageMetadata}

Gets access to the page that is attached to this element.
If the element is of type "section", the next page in order is returned.

See:
Returns:

pageMetadata or null if the section contains no pages

Type
module:playerapi/page/PageMetadata

<inner> getTitle() → {string}

Gets the title of the section.

Returns:

The title of the section.

Type
string

<inner> getType() → {string}

Gets the type of the element.
Use this function to distinguish elements in the outlineView.

Returns:

"section" or "page"

Type
string