Class: OutlineElement

PSPDFKit.OutlineElement

new PSPDFKit.OutlineElement()

Element in the document outline tree.

This record is used to represent document outline elements. These allow the user to navigate interactively from one part of the document to another.

Outline elements can be nested in a tree-like stucture where elements are collapsible/expandable to hide/reveal their subtrees.

Extends

  • Immutable.Record

Members




Members

The action that will be triggered when the outline element is either clicked or tapped.

Please refer to PSPDFKit.Actions for an in-depth look at PDF actions.

Type:

The action that will be triggered when the outline element is either clicked or tapped.

Please refer to PSPDFKit.Actions for an in-depth look at PDF actions.

Type:

Each outline element can have nested outline elements. The visibility of which is controlled by PSPDFKit.OutlineElement.isExpanded.

Type:

(nullable) color: PSPDFKit.Color

The text color of the outline element title. When this value is null the color is the default PSPDFKit for Web UI which can be configured via PSPDFKit's public CSS API.

Type:
Default Value:
  • null

isBold: boolean

Whether the outline element title is bold.

Type:
  • boolean
Default Value:
  • false

isExpanded: boolean

Whether the outline element is expanded and shows its child elements.

Type:
  • boolean
Default Value:
  • false

isItalic: boolean

Whether the outline element title is italic.

Type:
  • boolean
Default Value:
  • false

title: string

The outline element title, must be human readable.

Type:
  • string