floatingRegions property

Class: CheckSettingsPlainPlatform: Selenium 4Language: JavaScript SDK:

Define multiple floating regions for this target.

Syntax

eyes.check({ floatingRegions: value });

Type:

(
  | {
      region: RegionPlain | WebElement | Selector;
      maxUpOffset?: number;
      maxDownOffset?: number;
      maxLeftOffset?: number;
      maxRightOffset?: number;
    }
  | RegionPlain
  | WebElement
  | Selector
)[];

Type definitions

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

The value returned is the object that called the method. You can use it to call other methods supported by the object class.