Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentLine

Package version

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

Hierarchy

Index

Properties

Properties

content

content: string

Concatenated content of the contained elements in reading order. Concatenated content of the contained elements in reading order.

Optional polygon

polygon: number[]

Bounding polygon of the line.

spans

spans: DocumentSpan[]

Location of the line in the reading order concatenated content. Location of the line in the reading order concatenated content.

words

words: () => IterableIterator<DocumentWord>

Compute the DocumentWords that are related to this line.

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

Type declaration

    • (): IterableIterator<DocumentWord>
    • Returns IterableIterator<DocumentWord>

Generated using TypeDoc