ignoreRegions method

Class: CheckSettingsPlatform: NightwatchLanguage: JavaScript SDK:

Add one or more ignore regions to this target (i.e. areas whose content matches anything).

Syntax

eyes.check(Target.window().ignoreRegions(ignoreRegions));

Parameters

ignoreRegions
Type:
(RegionPlain|Element|Selector)[]
A region defined by one of the possible types.

Type definitions

RegionPlain
Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
Element
Used to identify an HTML element defined as |{ELEMENT:string}|{'element-6066-11e4-a52e-4f735466cecf':string}|import('nightwatch').NightwatchTypedCallbackResult.
Selector
Used to identify an HTML element defined as |{locateStrategy:import('nightwatch').LocateStrategy;selector:'string'}|string|{selector:string;type:string}.

Return value

Type: CheckSettings
The value returned is the object that called the method. You can use it to call other methods supported by the object class.

Remarks

You may call this method multiple times in a given chain. Ignore regions should not overlap each other or other types of regions (i.e. floating or match level regions).