Skip to content
Lamina PDF

ExtractOptions

Options for Document.extract.

Type Parameters

Section titled “Type Parameters”

F

Section titled “F”

F extends ExtractFormat = ExtractFormat

Properties

Section titled “Properties”

chunk?

Section titled “chunk?”

readonly optional chunk?: ChunkOptions

How chunks are cut ("chunks", and "json" to include them).

dehyphenate?

Section titled “dehyphenate?”

readonly optional dehyphenate?: boolean

Join words hyphenated across lines; on by default.

drop?

Section titled “drop?”

readonly optional drop?: object

keepSpans keeps each dropped run’s text in its dropped entry (JSON), for auditing a file. furniture (on by default) drops running headers, footers, page numbers and artifact-marked text too.

furniture?

Section titled “furniture?”

readonly optional furniture?: boolean

keepSpans?

Section titled “keepSpans?”

readonly optional keepSpans?: boolean

format

Section titled “format”

readonly format: F

What to return: Markdown or plain text as a string, the JSON as an Extraction, or Chunks.

pageMarkers?

Section titled “pageMarkers?”

readonly optional pageMarkers?: boolean

Write <!-- page N --> before each page’s first block (Markdown, chunks and the JSON’s text ranges).

pages?

Section titled “pages?”

readonly optional pages?: readonly number[]

The 0-based page indices to extract, in this order; every page by default.

readingOrder?

Section titled “readingOrder?”

readonly optional readingOrder?: any

Where the reading order comes from; "auto" by default.

tables?

Section titled “tables?”

readonly optional tables?: any

Which table detectors run; "lattice" by default.