# ocrGetElementPositionByText

Get the position of a text on the screen. The command will search for the provided text and try to find a match based on Fuzzy Logic from [Fuse.js](https://fusejs.io/). This means that if you might provide a selector with a typo, or the found text might not be a 100% match it will still try to give you back an element. See the [logs](#logs) below.

## Usage[​](#usage "Direct link to Usage")

```
const result = await browser.ocrGetElementPositionByText("Username");



console.log("result = ", JSON.stringify(result, null, 2));
```

## Output[​](#output "Direct link to Output")

### Result[​](#result "Direct link to Result")

```
result = {

  "dprPosition": {

    "left": 373,

    "top": 606,

    "right": 439,

    "bottom": 620

  },

  "filePath": ".tmp/ocr/desktop-1716658199410.png",

  "matchedString": "Started",

  "originalPosition": {

    "left": 373,

    "top": 606,

    "right": 439,

    "bottom": 620

  },

  "score": 85.71,

  "searchValue": "Start3d"

}
```

### Logs[​](#logs "Direct link to Logs")

```
# Still finding a match even though we searched for "Start3d" and the found text was "Started"

[0-0] 2024-05-25T17:29:59.179Z INFO webdriver: COMMAND ocrGetElementPositionByText(<object>)

......................

[0-0] 2024-05-25T17:29:59.993Z INFO @wdio/ocr-service:ocrGetElementPositionByText: Multiple matches were found based on the word "Start3d". The match "Started" with score "85.71%" will be used.
```

## Options[​](#options "Direct link to Options")

### `text`[​](#text "Direct link to text")

* Type

  `string`

* Required

  `yes`

The text you want to search for to click on.

#### Example[​](#example "Direct link to Example")

```
await browser.ocrGetElementPositionByText({ text: "WebdriverIO" });
```

### `contrast`[​](#contrast "Direct link to contrast")

* Type

  `number`

* Default

  `0.25`

* Required

  `no`

The higher the contrast, the darker the image and vice versa. This can help to find text in an image. It accepts values between `-1` and `1`.

#### Example[​](#example-1 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    contrast: 0.5,

});
```

### `haystack`[​](#haystack "Direct link to haystack")

* Type

  `number`

* Required

  `WebdriverIO.Element | ChainablePromiseElement | Rectangle`

This is the search area in the screen where the OCR needs to look for text. This can be an element or a rectangle containing `x`, `y`, `width` and `height`

#### Example[​](#example-2 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    haystack: $("elementSelector"),

});



// OR

await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    haystack: await $("elementSelector"),

});



// OR

await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    haystack: {

        x: 10,

        y: 50,

        width: 300,

        height: 75,

    },

});
```

### `language`[​](#language "Direct link to language")

* Type

  `string`

* Default

  `eng`

* Required

  `No`

The language that Tesseract will recognize. More info can be found [here](https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions) and the supported languages can be found [here](https://github.com/webdriverio/visual-testing/blob/main/packages/ocr-service/src/utils/constants.ts).

#### Example[​](#example-3 "Direct link to Example")

```
import { SUPPORTED_OCR_LANGUAGES } from "@wdio/ocr-service";

await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    // Use Dutch as a language

    language: SUPPORTED_OCR_LANGUAGES.DUTCH,

});
```

### `fuzzyFindOptions`[​](#fuzzyfindoptions "Direct link to fuzzyfindoptions")

You can alter the fuzzy logic to find text with the following options. This might help find a better match

#### `fuzzyFindOptions.distance`[​](#fuzzyfindoptionsdistance "Direct link to fuzzyfindoptionsdistance")

* Type

  `number`

* Default

  `100`

* Required

  `no`

Determines how close the match must be to the fuzzy location (specified by location). An exact letter match which is distance characters away from the fuzzy location would score as a complete mismatch. A distance of 0 requires the match to be at the exact location specified. A distance of 1000 would require a perfect match to be within 800 characters of the location to be found using a threshold of 0.8.

##### Example[​](#example-4 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    fuzzyFindOptions: {

        distance: 20,

    },

});
```

#### `fuzzyFindOptions.location`[​](#fuzzyfindoptionslocation "Direct link to fuzzyfindoptionslocation")

* Type

  `number`

* Default

  `0`

* Required

  `no`

Determines approximately where in the text is the pattern expected to be found.

##### Example[​](#example-5 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    fuzzyFindOptions: {

        location: 20,

    },

});
```

#### `fuzzyFindOptions.threshold`[​](#fuzzyfindoptionsthreshold "Direct link to fuzzyfindoptionsthreshold")

* Type

  `number`

* Default

  `0.6`

* Required

  `no`

At what point does the matching algorithm give up. A threshold of 0 requires a perfect match (of both letters and location), a threshold of 1.0 would match anything.

##### Example[​](#example-6 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    fuzzyFindOptions: {

        threshold: 0.8,

    },

});
```

#### `fuzzyFindOptions.isCaseSensitive`[​](#fuzzyfindoptionsiscasesensitive "Direct link to fuzzyfindoptionsiscasesensitive")

* Type

  `boolean`

* Default

  `false`

* Required

  `no`

Whether the search should be case sensitive.

##### Example[​](#example-7 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    fuzzyFindOptions: {

        isCaseSensitive: true,

    },

});
```

#### `fuzzyFindOptions.minMatchCharLength`[​](#fuzzyfindoptionsminmatchcharlength "Direct link to fuzzyfindoptionsminmatchcharlength")

* Type

  `number`

* Default

  `2`

* Required

  `no`

Only the matches whose length exceeds this value will be returned. (For instance, if you want to ignore single character matches in the result, set it to 2)

##### Example[​](#example-8 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    fuzzyFindOptions: {

        minMatchCharLength: 5,

    },

});
```

#### `fuzzyFindOptions.findAllMatches`[​](#fuzzyfindoptionsfindallmatches "Direct link to fuzzyfindoptionsfindallmatches")

* Type

  `number`

* Default

  `false`

* Required

  `no`

When `true`, the matching function will continue to the end of a search pattern even if a perfect match has already been located in the string.

##### Example[​](#example-9 "Direct link to Example")

```
await browser.ocrGetElementPositionByText({

    text: "WebdriverIO",

    fuzzyFindOptions: {

        findAllMatches: 100,

    },

});
```
