set_hide_caret method

Class: ConfigurationPlatform: Selenium 3Language: Python SDK:

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

If your UI includes a blinking cursor, then sometimes the cursor will be captured in the screenshot, and sometimes it won't be captured. This can lead to differences between the checkpoint and the basline and, therefore, to false mismatch reports. If you enable hiding the curser, Eyes will turn the cursor off before capturing the image, eliminating the possibility that this will happen.

Syntax


configval = config.set_hide_caret(hide_caret)

Parameters

hide_caret
Type:bool
If this paramter has a value of True, then the cursor will be hidden before the image is captured.

Return value

Type: <a class ='link' href='/Content/api/eyes-sdk/index-gen/class-configuration-selenium-python_sdk4.htm'>Configuration</a>
The value returned is the object that called the method. This allows you to use a fluent style to call the setXXXX methods of this class.

Remarks

We recommend using this method instead of Eyes.ignore_caret, Configuration.set_ignore_caret or SeleniumCheckSettings.ignore_caret, since this method/property eliminates cursor related artifacts instead of detecting and ignoring them.