sempdf — TypeScript PDF generation and editing

sempdf / PdfOutlineItem

Defined in: src/document.ts:5937

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

new PdfOutlineItem(outline): PdfOutlineItem;

Defined in: src/document.ts:5943

Creates an outline item handle for an internal outline model.

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

PdfOutlineItem

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

Defined in: src/document.ts:5954

Adds a nested outline item below this outline entry.

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.

PdfOutlineItem

The created child outline item handle.