The information in this topic may be out of date. The current SDK reference guide has moved here.
region property
Requests that only a region within a selected i-frame should be matched.
Syntax
eyes.check(Target.frame(frameSelector).region);
Type:RegionPlain|WebElement|Selector
Type definitions
- RegionPlain
- Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
An object that defines a rectangular area in the window.
An object that defines the region.
Remarks
The parameter to the method specifies the region to be matched.
The enclosing frame(s) are selected by the previous calls in the chain to Target.frame.
You may only use this method in the chain if the first method in the chain is Target.frame.
You may not call it if the first method in the chain is Target.window or Target.region.
To match a region within a window, use the method Target.region as the first method in the Target chain.
You may only call this method once in a given chain.