ignore method

Class: SeleniumCheckSettingsPlatform: Selenium 3Language: Java SDK:

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

Syntax

eyes.check(Target.window().ignore(regionSelector, regionSelectors))
eyes.check(Target.window().ignore(regionSelectors))
eyes.check(Target.window().ignore(selector, leftPadding, topPadding, rightPadding, bottomPadding))
eyes.check(Target.window().ignore(element, leftPadding, topPadding, rightPadding, bottomPadding))
eyes.check(Target.window().ignore(region, regions))
eyes.check(Target.window().ignore(regions))

Parameters

region
Type:Region
An object that defines a rectangular area in the window.
regions
Type:Region...
An array of Region objects that defines rectangular areas in the checked image.
regions
Type:Region[]
An array of Region objects that defines rectangular areas in the checked image.
regionSelector
Type:By
An object that defines a selector for the region.
regionSelectors
Type:By...
An array of selector objects that define regions.
element
Type:WebElement
An element whose position and bounding rectangle defines the region.
regionSelectors
Type:By[]
An array of selector objects that define regions.
selector
Type:By
An object that defines a selector for the region.
leftPadding
Type:int
Increase (>0) or decrease (<0) the region to the left.
topPadding
Type:int
Increase (>0) or decrease the (<0) region upwards.
rightPadding
Type:int
Increase (>0) or decrease (<0) the region to the right.
bottomPadding
Type:int
Increase (>0) or decrease the (<0) region downwards.

Return value

Type: SeleniumCheckSettings
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 such as floating or match level regions.

The padding parameters increase (> 0) or decrease (< 0) the region dimensions relative to the size of the element or selector used to define the region.