Class ParsedPage

Namespace

LMKit.Document.Parsing

Assembly

LM-Kit.NET.dll

One parsed page: its geometry and its elements in reading order.

public sealed class ParsedPage

Inheritance

object

ParsedPage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Every position on the page (Bounds, Bounds, Bounds) is expressed in the page's coordinate frame, in Unit, with the origin at the top-left corner of the page.

Properties

Blocks

The layout blocks that group the page's elements (ParsedBlock), in the reading order of the member each ends on; every member is one of Elements, which the blocks never replace. May be empty, depending on the page and the effort level.

Body

Everything that is neither a running head nor a running foot.

Elements

Every element of the page, in reading order.

FigureTexts

The text the page's figures print (ParsedFigureText), each a child of its figure, figure by figure in the order of Elements; never an element of the page. May be empty, depending on the page and the effort level.

Footers

Running feet at the bottom of the page, in reading order.

Headers

Running heads at the top of the page, in reading order.

Height

Page height, in Unit.

OcrPerformed

Whether an OCR engine read words of this page that its text layer does not carry (a scanned page, or pictures holding print) and they are part of the result.

PageIndex

Zero-based page index in the source document.

PageNumber

One-based page number.

Regions

The page's grounding regions (ParsedRegion): the partition of Elements into the units a reader points at, in the reading order of each region's first member, each with the box it occupies on the page. A region holds one element unless the page sets several as one unit, such as a label and its value on one row; a page parsed without regions holds one region per element, boxed by its bounds.

Unit

Unit of Width, Height and every position on the page: points for a document page, pixels for an image.

Width

Page width, in Unit.

Methods

ToDocLang()

Renders the page as a DocLang document, as ToDocLang() renders each page.

ToHtml()

Renders the page as a standalone, semantic HTML page, as ToHtml() renders each page.

ToJson()

Serializes the page as JSON, in the same schema as one entry of the pages array of ToJson().

ToMarkdown()

Renders the page as Markdown: its elements in reading order, as ToMarkdown() renders them.

ToMarkdown(ChartMarkdownStyle)

Renders the page as Markdown as ToMarkdown() does, each chart written as charts says: its data table, the words it prints, or both.