layout method

Class: SeleniumCheckSettingsPlatform: Selenium 3Language: Python SDK:

If called without parameters, sets the match level for this target to LAYOUT. Otherwise, defines that a match level of LAYOUT should be used for the regions passed as parameters.




Any legal Selenium By request passed as a dictionary, for example [By.TAG_NAME, "p"]

Type definitions

The type BySelector is defined as: List[SeleniumBy,Text].
An element whose position and bounding rectangle defines the region.

Type definitions

The type AnyWebElement is defined as: Union[EyesWebElement,WebElement].
Any legal CSS selector, for example .myClass

Type definitions

The type CssSelector is defined as: Text.
An object that defines a rectangular area in the window.

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.


You can call this method in two ways - with parameters and without parameters. The meaning of the method, and the way it can be used is different in each case. When the method is called without parameters it sets the default match level for this target. When called with one or more regions as parameters it defines the match level for that region. The sections below provide some more details regarding how to use this method in each of these modes.

Called without parameters

If this method is called without parameters then it sets the default match level for this target. This overrides the hard-coded default and the default match level defined by using eyes$setmatchlevel.

For a given target you may call only one of the following methods (without parameters) that set a target default match level:

Called with parameters

When the method is called with one or more parameters that define one or more regions, then these set the match level for those regions, overiding the defaults set for the target (by calling these methods without a parameter), set by eyes$setmatchlevel and the hardcoded default match level.

You may define multiple regions that have an explicit match level by calling this method multiple times in a chain, or by passing the method multiple regions.

The region matchlevel methods checksettings$strict(regions), checksettings$layout(regions)., checksettings$content(regions). checksettings$strictregions(regions), checksettings$layoutregions(regions)., checksettings$contentregions(regions) should not overlap each other or the regions defined using checksettings$ignoreregion(regions). checksettings$ignoreregions(regions). If they overlap each other, or regions that defined using the Test Manager then the results is undefined.

For a full description of the affect of each match levels and the different ways to apply them to tests, checkpoints and regions, How to use Eyes match levels.