Class PDFNet.TextExtractorWord
PDFNet.TextExtractorWord
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.TextExtractorWord(line, word, end, uni, num, cur_num, mp_bld)
TextExtractor::Word object represents a word on a PDF page.
|
| Method Attributes | Method Name and Description |
|---|---|
|
compare(word)
Comparison function.
|
|
| <static> |
PDFNet.TextExtractorWord.create()
Constructor
|
|
getCharStyle(char_idx)
|
|
|
getStyle()
|
|
|
isValid()
|
Class Detail
PDFNet.TextExtractorWord(line, word, end, uni, num, cur_num, mp_bld)
TextExtractor::Word object represents a word on a PDF page.
Each word contains a sequence of characters in one or more styles
(see TextExtractor::Style).
- Parameters:
- line
- word
- end
- uni
- num
- cur_num
- mp_bld
Method Detail
{[ERROR]}
compare(word)
Comparison function.
Determines if parameter object is equal to current object.
- Parameters:
- word
- Returns:
- {[ERROR]} True if the two objects are equivalent. False otherwise @param {textextractorword} word (generated documentation)
<static>
{textextractorword}
PDFNet.TextExtractorWord.create()
Constructor
- Returns:
- {textextractorword} A promise that resolves to an object of type: "textextractorword" (generated documentation)
{textextractorstyle}
getCharStyle(char_idx)
- Parameters:
- {number} char_idx
- The index of a character in this word.
- Returns:
- {textextractorstyle} A promise that resolves to the style associated with a given character.
{number}
getCurrentNum()
- Returns:
- {number} A promise that resolves to the index of this word of the current line. A word that starts the line will return 0, whereas the last word in the line will return (line.GetNumWords()-1).
{textextractorword}
getNextWord()
- Returns:
- {textextractorword} A promise that resolves to the next word on the current line.
{number}
getNumGlyphs()
- Returns:
- {number} A promise that resolves to the number of glyphs in this word.
{number}
getStringLen()
- Returns:
- {number} A promise that resolves to the number of characters in this word.
{textextractorstyle}
getStyle()
- Returns:
- {textextractorstyle} A promise that resolves to predominant style for this word.
{boolean}
isValid()
- Returns:
- {boolean} A promise that resolves to true if this is a valid word, false otherwise.