OCRRegion class

Platform: Selenium

Language: Javascript

Selenium JavaPuppeteer JavascriptImages JavaImages PythonSelenium JavascriptAppium Java

An object of this type is used to define where OCR text extraction should be done.

Note

This feature is experimental. Please note that the functionality and/or API may change.

You can extract text from an application window using OCR by passing one or more OCRRegion objects to the method Eyes.extractText. Each such object defines a region in the application window.

In addition, you can use the hint method to specify literal text or a regular expression-like pattern that should match the text found. The pattern passed as a hint helps overcome ambiguities that arise when using OCR. It can be used, for example, to distinguish between the digit 0 (zero) and the letter O.

For more information see Eyes OCR support.

Example

JavaScript

const element = await driver.findElement(Webdriver.By.css('#btn_click_txt'))
const textsFound  = await eyes.extractText([
  { target: element },
  { 
    target: {left: 5, top: 8, width: 76, height: 30},
  },
  {
      target: "#btn_click_txt", 
      hint:"click me"
  },
  { target: 'h2'},
  { target: '#allpage'}
]);

for (let i=0; i< textsFound.length; i++ ) {
  console.log(`${i}) found '${textsFound[i]}'`);
}