Class PDFNet.TextExtractorLine
PDFNet.TextExtractorLine
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.TextExtractorLine(line, uni, num, cur_num, m_direction, mp_bld)
TextExtractor::Line object represents a line of text on a PDF page.
|
| Method Attributes | Method Name and Description |
|---|---|
|
compare(line2)
Comparison function.
|
|
| <static> |
PDFNet.TextExtractorLine.create()
Constructor
|
|
getQuad()
Gets the quadrilateral bounding box for the word (in unrotated page coordinates)
|
|
|
getStyle()
|
|
|
getWord(word_idx)
|
|
|
isValid()
|
Class Detail
PDFNet.TextExtractorLine(line, uni, num, cur_num, m_direction, mp_bld)
TextExtractor::Line object represents a line of text on a PDF page.
Each line consists of a sequence of words, and each words in one or
more styles.
- Parameters:
- line
- uni
- num
- cur_num
- m_direction
- mp_bld
Method Detail
{[ERROR]}
compare(line2)
Comparison function.
Determines if parameter object is equal to current object.
- Parameters:
- line2
- Returns:
- {[ERROR]} True if the two objects are equivalent. False otherwise @param {textextractorline} line2 (generated documentation)
<static>
{textextractorline}
PDFNet.TextExtractorLine.create()
Constructor
- Returns:
- {textextractorline} A promise that resolves to an object of type: "textextractorline" (generated documentation)
{boolean}
endsWithHyphen()
- Returns:
- {boolean} A promise that resolves to true is this line of text ends with a hyphen (i.e. '-'), false otherwise.
{number}
getCurrentNum()
- Returns:
- {number} A promise that resolves to the index of this line of the current page.
{textextractorword}
getFirstWord()
- Returns:
- {textextractorword} A promise that resolves to the first word in the line.
{number}
getFlowID()
- Returns:
- {number} A promise that resolves to the unique identifier for a paragraph or column that this line belongs to. This information can be used to identify which lines/paragraphs belong to which flows.
{textextractorline}
getNextLine()
- Returns:
- {textextractorline} A promise that resolves to the next line on the page.
{number}
getNumWords()
- Returns:
- {number} A promise that resolves to the number of words in this line.
{number}
getParagraphID()
- Returns:
- {number} A promise that resolves to the unique identifier for a paragraph or column that this line belongs to. This information can be used to identify which lines belong to which paragraphs.
getQuad()
Gets the quadrilateral bounding box for the word (in unrotated page coordinates)
{textextractorstyle}
getStyle()
- Returns:
- {textextractorstyle} A promise that resolves to predominant style for this line.
{textextractorword}
getWord(word_idx)
- Parameters:
- {number} word_idx
- A integer representing the index of the word to get.
- Returns:
- {textextractorword} A promise that resolves to the i-th word in this line.
{boolean}
isSimpleLine()
- Returns:
- {boolean} A promise that resolves to true is this line is not rotated (i.e. if the quadrilaterals returned by GetBBox() and GetQuad() coincide).
{boolean}
isValid()
- Returns:
- {boolean} A promise that resolves to true if this is a valid line, false otherwise.