region method

Class: ImagesCheckSettingsPlatform: ImagesLanguage: JavaScript SDK:

Requests that only a region within a selected i-frame should be matched.

Syntax


eyes.check(Target.window().region(region))

Parameters

region
Type:Region|RegionObject
An object that defines a rectangular area in the window.
RegionObject
The type RegionObject is defined as: {left:number,top:number,width:number,height:number,coordinatesType:CoordinatesType|undefined} The field coordinatesType is for internal use only and should not be set by users.

Return value

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

Remarks

The parameter to the method specifies the region to be matched. You may only call this method once in a given chain.