floatingRegions property

Class: CheckSettingsPlainPlatform: NightwatchLanguage: JavaScript SDK:

Define multiple floating regions for this target.

Syntax

eyes.check({ floatingRegions: value });

Type:

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

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 |{ELEMENT:string}|{'element-6066-11e4-a52e-4f735466cecf':string}|import('nightwatch').NightwatchTypedCallbackResult.
Selector: Used to identify an HTML element defined as |{locateStrategy:import('nightwatch').LocateStrategy;selector:'string'}|string|{selector:string;type:string}.
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 |{ELEMENT:string}|{'element-6066-11e4-a52e-4f735466cecf':string}|import('nightwatch').NightwatchTypedCallbackResult.
Selector: Used to identify an HTML element defined as |{locateStrategy:import('nightwatch').LocateStrategy;selector:'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.