Rectangle

Constructors

Rectangle(point, size)

Rectangle(object)

Creates a Rectangle object.

Parameters:

object: Object — an object containing properties to be set on the rectangle

Returns:

Rectangle

Example — Create a rectangle between {x: 20, y: 20} and {x: 80, y:80}

var rectangle = new Rectangle({
    point: [20, 20],
    size: [60, 60]
});

Example — Create a rectangle between {x: 20, y: 20} and {x: 80, y:80}

var rectangle = new Rectangle({
    from: [20, 20],
    to: [80, 80]
});

Rectangle(x, y, width, height)

Rectangle(from, to)

Creates a rectangle object from the passed points. These do not necessarily need to be the top left and bottom right corners, the constructor figures out how to fit a rectangle between them.

Parameters:

from: Point — The first point defining the rectangle
to: Point — The second point defining the rectangle

Returns:

Rectangle

Rectangle(rt)

Properties

x

y

width

height

point

size

Side Positions

left

top

right

bottom

Corner and Center Point Positions

center

topLeft

topRight

bottomLeft

bottomRight

leftCenter

topCenter

rightCenter

bottomCenter

area

Item Bounds

selected

Methods

clone()

equals(rect)

toString()

isEmpty()

Geometric Tests

contains(point)

Tests if the specified point is inside the boundary of the rectangle.

Parameters:

point: Point — the specified point

Returns:

Boolean — true if the point is inside the rectangle's boundary, false otherwise

Example — Checking whether the mouse position falls within the bounding rectangle of an item:

Run

contains(rect)

Tests if the interior of the rectangle entirely contains the specified rectangle.

Parameters:

rect: Rectangle — The specified rectangle

Returns:

Boolean — true if the rectangle entirely contains the specified rectangle, false otherwise

Example — Checking whether the bounding box of one item is contained within that of another item:

Run

intersects(rect)

Tests if the interior of this rectangle intersects the interior of another rectangle. Rectangles just touching each other are considered as non-intersecting.

Parameters:

rect: Rectangle — the specified rectangle

Returns:

Boolean — true if the rectangle and the specified rectangle intersect each other, false otherwise

Example — Checking whether the bounding box of one item intersects with that of another item:

Run

Boolean Operations

intersect(rect)

Returns a new rectangle representing the intersection of this rectangle with the specified rectangle.

Parameters:

rect: Rectangle — The rectangle to be intersected with this rectangle

Returns:

Rectangle — the largest rectangle contained in both the specified rectangle and in this rectangle

Example — Intersecting two rectangles and visualizing the result using rectangle shaped paths:

Run

unite(rect)

Returns a new rectangle representing the union of this rectangle with the specified rectangle.

Parameters:

rect: Rectangle — the rectangle to be combined with this rectangle

Returns:

Rectangle — the smallest rectangle containing both the specified rectangle and this rectangle

include(point)

Adds a point to this rectangle. The resulting rectangle is the smallest rectangle that contains both the original rectangle and the specified point.

After adding a point, a call to contains(point) with the added point as an argument does not necessarily return true.

The rectangle.contains(point) method does not return true for points on the right or bottom edges of a rectangle. Therefore, if the added point falls on the left or bottom edge of the enlarged rectangle, rectangle.contains(point) returns false for that point.

Parameters:

point: Point

expand(amount)

expand(hor, ver)

scale(amount)

scale(hor, ver)