Floating method

Class: CheckSettingsPlatform: ApppiumLanguage: C# SDK:

Add one more floating region to this target.

When you define a floating region, you define an inner region and offsets outwards from the inner region in all directions to form an outer region. All the pixels of the outer region will be considered as matched if the pixels of the checkpoint inner region match at least one area in the baseline outer region.

Syntax


eyes.Check(Target.Window().Floating(maxOffset, regions))
eyes.Check(Target.Window().Floating(region, maxUpOffset, maxDownOffset, maxLeftOffset, maxRightOffset))

Parameters

maxOffset
Type:int
The maximum amount that the region can shift in any direction and still be considered matching.
regions
Type:<b>params</b> Rectangle[]
region
Type:Rectangle
An object that defines a rectangular area in the window.
maxUpOffset
Type:int
The maximum amount that the region can shift upwards and still be considered matching.
maxDownOffset
Type:int
The maximum amount that the region can shift downwards and still be considered matching.
maxLeftOffset
Type:int
The maximum amount that the region can shift to the left and still be considered matching.
maxRightOffset
Type:int
The maximum amount that the region can shift to the right and still be considered matching.

Return value

Type: ICheckSettings
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 call this method multiple times in a given chain; each call defines a different floating region. Floating regions may not overlap each other or other types of regions, such as ignore or match level regions.