@ironsoftware/ironpdf
Version:
IronPDF for Node
25 lines • 1.1 kB
TypeScript
/**
* A single PDF bookmark (outline entry). Mirrors the C# {@code IronPdf.Bookmark}
* shape — flat structure with parent linkage instead of nested children.
*
* <p>Returned by {@link PdfDocument.getBookmarks}. Hierarchy is conveyed via
* {@link parentItemId} (a bookmark's parent has matching {@link itemId}) and
* {@link hierarchy} (a path-like string describing depth in the outline tree).</p>
*/
export interface Bookmark {
/** Human-readable label shown in the PDF reader's bookmark panel. */
text: string;
/** Zero-based page index this bookmark navigates to. */
pageIndex: number;
/**
* Path-like string describing this bookmark's depth in the outline tree.
* Empty string for roots; nested entries have something like "0/1" or
* "Chapter 1/Section 1.1" depending on engine encoding.
*/
hierarchy: string;
/** Stable identifier for this bookmark within the document. */
itemId: string;
/** {@link itemId} of the parent bookmark, or empty string for roots. */
parentItemId: string;
}
//# sourceMappingURL=bookmark.d.ts.map