Skip to main content

Class: PdfOutlineItem

A handle for an outline entry in a PDF document. It can receive nested child outline items that point to pages or named destinations.

Constructors​

Constructor​

new PdfOutlineItem(outline): PdfOutlineItem;

Creates an outline item handle for an internal outline model.

Parameters​

ParameterTypeDescription
outlineInternalOutlineModelThe internal outline model to wrap.

Returns​

PdfOutlineItem

Methods​

addChild()​

addChild(
title,
target,
options?): PdfOutlineItem;

Adds a nested outline item below this outline entry.

Parameters​

ParameterTypeDescription
titlestringThe outline title.
targetstring | PdfPageThe destination page, outline target, or structure element.
optionsOutlineOptionsOptions that control the operation.

Returns​

PdfOutlineItem

The created child outline item handle.