Interface: ExtractTextInterface
Interface for text extraction functionality.
Extends
EventHandlerInterface<"start"|"textExtracted",EventMap[ExtractTextEvents]>
Properties
addEventListener()
addEventListener: (
eventName,callback) =>void
Adds an event listener for specified events.
Parameters
• eventName: "start" | "textExtracted"
• callback: () => string | (txt) => void
Returns
void
Inherited from
EventHandlerInterface.addEventListener
emitStart()
emitStart: () =>
void
Triggers an event indicating that text extraction has started.
Returns
void
Example
viewer.document.tools.extractText.emitStart();
emitTextExtracted()
emitTextExtracted: (
txt) =>void
Triggers an event indicating that text has been extracted.
Parameters
• txt: string
The extracted text.
Returns
void
Example
viewer.document.tools.extractText.emitTextExtracted('lorem ipsum');
removeEventListener()
removeEventListener: (
eventName,callback) =>void
Removes an event listener for specified events.
Parameters
• eventName: "start" | "textExtracted"
• callback: () => string | (txt) => void
Returns
void
Inherited from
EventHandlerInterface.removeEventListener