region method
Requests that only a region within a selected i-frame should be matched.
Syntax
eyes.Check(Target.window().region(region))
eyes.Check(Target.window().region(css_selector))
eyes.Check(Target.window().region(element))
eyes.Check(Target.window().region(by))Parameters
- region
- Type:Region
- An object that defines the region.
- css_selector
- Type:CssSelector
- Any legal CSS selector, for example .myClass
Type definitions
- CssSelector
- The type CssSelector is defined as: Text.
- element
- Type:AnyWebElement
- An object which defines a region.
Type definitions
- AnyWebElement
- The type AnyWebElement is defined as: Union[EyesWebElement,WebElement].
- by
- Type:BySelector
- Any legal Selenium By request passed as a dictionary, for example [By.TAG_NAME, "p"]
Type definitions
- BySelector
- The type BySelector is defined as: List[SeleniumBy,Text].
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
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.