frame method

Class: TargetPlatform: Selenium 3Language: Python SDK:

Configure check to match an iframe in a window or another iframe.

Chain several calls to this method to navigate a hierarchical iframe tree. You can also chain a region method to define that only a region in the frame should be matched and not the entire iframe.

Syntax

eyes.check(Target.frame(frame_name_or_id))
eyes.check(Target.frame(frame_element))
eyes.check(Target.frame(frame_index))
eyes.check(Target.frame(frame_by_selector))

Note: This method is a static method.

Parameters

frame_name_or_id
Type:FrameNameOrId
The name or id of the frame element.

Type definitions

FrameNameOrId
The type FrameNameOrId is defined as: Text.
frame_element
Type:AnyWebElement
The element object of the frame.

Type definitions

AnyWebElement
The type AnyWebElement is defined as: Union[EyesWebElement,WebElement].
frame_index
Type:FrameIndex
A Selenium frame index.

Type definitions

FrameIndex
The type FrameIndex is defined as: int.
frame_by_selector
Type:BySelector
Any legal Selenium By request that refers to an iframe, 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