DocumentLine interface

A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.

Extends

Properties

content

Concatenated content of the contained elements in reading order.

spans

Location of the line in the reading order concatenated content.

words

Compute the DocumentWords that are related to this line.

This function produces a lazy iterator that will yield one word before computing the next.

Inherited Properties

polygon

Bounding polygon of the entity.

Property Details

content

Concatenated content of the contained elements in reading order.

content: string

Property Value

string

spans

Location of the line in the reading order concatenated content.

spans: DocumentSpan[]

Property Value

words

Compute the DocumentWords that are related to this line.

This function produces a lazy iterator that will yield one word before computing the next.

words: () => IterableIterator<DocumentWord>

Property Value

() => IterableIterator<DocumentWord>

Inherited Property Details

polygon

Bounding polygon of the entity.

polygon?: Point2D[]

Property Value

Inherited From HasBoundingPolygon.polygon