UNPKG

@lillallol/outline-pdf-data-structure

Version:

Create a pdf outline data structure from a high level string representation of pdf outline. This data structure can be used to create a real pdf outline.

github.com/lillallol/outline-pdf-data-structure

lillallol/outline-pdf-data-structure

27 lines (26 loc) • 1.1 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import type { IOutline } from "../publicApi"; /** * @description Converts the outline string representation to its programmatic representation. * It throws if the outline string representation is not valid. * ```ts * //input * printedToOutline(` * 1||Document * 2|-|Section 1 * -3|-|Section 2 * 4|--|Subsection 1 * 5|-|Section 3 * 6||Summary * `,6) * //output * [ * { pageNumber: 1, depth: 0, title: "Document" , collapse : false , line : "1||Document"}, * { pageNumber: 2, depth: 1, title: "Section 1" , collapse : false , line : "2|-|Section 1"}, * { pageNumber: 3, depth: 1, title: "Section 2" , collapse : true , line : "-3|-|Section 2"}, * { pageNumber: 4, depth: 2, title: "Subsection 1" , collapse : false , line : "4|--|Subsection 1"}, * { pageNumber: 5, depth: 1, title: "Section 3" , collapse : false , line : "5|-|Section 3"}, * { pageNumber: 6, depth: 0, title: "Summary" , collapse : false , line : "6||Summary"}, * ] * ``` */ export declare function printedToOutline(inputOutline: string, totalNumberOfPages: number): IOutline;