The information in this topic may be out of date. The current SDK reference guide has moved here.

setHideCaret method

Class: EyesPlatform: Selenium 4Language: JavaScript SDK:

Use this method to set whether Eyes should hide the cursor before the screenshot is captured.

Syntax

eyes.setHideCaret(hideCaret);

Parameters

hideCaret
Type:boolean
If this paramter has a value of true, then the cursor will be hidden before the image is captured.

Return value

Type: void

Remarks

We recommend using this method instead of Eyes.setIgnoreCaret, Configuration.setIgnoreCaret or CheckSettings.ignoreCaret, since this method/property eliminates cursor related artifacts instead of detecting and ignoring them.