Skip to main content

Region class

Provides an object that describes a rectangular area at a coordinate. An object of this type is required as a parameter in some methods.

Import statement

import com.applitools.eyes.Region;

Region method

Syntax

Region obj = new Region(left, top, width, height);

Region obj = new Region(rectangle);

Region obj = new Region(location, size);

Region obj = new Region(other);

Parameters

left

Type: int

The X coordinate of the left edge of the region in pixels.

top

Type: int

The Y coordinate of the top edge of the region in pixels.

width

Type: int

The width of the region in pixels.

height

Type: int

The height of the region in pixels.

rectangle

Type: Rectangle

The object provided as a parameter specifies both the top-left of the new region and its dimensions.

location

Type: Location

The object passed as a parameter specifies the top-left of the new region.

size

Type: RectangleSize

The object provided as a parameter specifies dimensions of the region.

other

Type: IRegion

Another Region object to clone.

Return value

Type: Region