zeropdf v1.5.5

---

zeropdf / PdfOutlineItem

Class: PdfOutlineItem

Defined in: src/document.ts:4340

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;

Defined in: src/document.ts:4346

Creates an outline item handle for an internal outline model.

Parameters

Parameter	Type	Description
outline	InternalOutlineModel	The internal outline model to wrap.

Returns

PdfOutlineItem

Methods

addChild()

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

Defined in: src/document.ts:4357

Adds a nested outline item below this outline entry.

Parameters

Parameter	Type	Description
title	string	The outline title.
target	string | PdfPage	The destination page, outline target, or structure element.
options	OutlineOptions	Options that control the operation.

Returns

PdfOutlineItem

The created child outline item handle.