layoutRegions method

Class: CheckSettingsPlatform: ProtractorLanguage: JavaScript SDK:

Defines that a match level of Layout should be used for the region(s) passed as parameter(s).

Syntax

eyes.check(Target.window().layoutRegions(layoutRegions));

Parameters

layoutRegions
Type:
(RegionPlain|Element|Selector)[]
One or more region descriptors or selectors in one of the defined types.

Type definitions

RegionPlain
Used to describe a position and rectangular region in an image. RegionPlain is defined as: LocationPlain&RectangleSizePlain
Element
Used to identify an HTML element defined as import('selenium-webdriver').WebElement|import('protractor').ElementFinder.
Selector
Used to identify an HTML element defined as |import('protractor').Locator|{using:string;value:string}|string|{selector:string;type:string}.

Return value

Type: CheckSettings
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 define multiple regions that have an explicit match level by calling this method multiple times, 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.