Rectangle2D

Show usages

Represents a two-dimensional rectangle of size (width x height), located at the point (x, y).

Inheritance Hierarchy

Rectangle2D

Implemented Interfaces

ICloneable

Type Details

yfiles module: algorithms
yfiles-umd modules: All layout modules, view-layout-bridge
Legacy UMD name: yfiles.algorithms.Rectangle2D

Constructors

Rectangle2D

()

Creates a new rectangle of size (0 x 0) at the location (0, 0).

Rectangle2D

(x: number, y: number, width: number, height: number)

Creates a new rectangle of the specified size at the specified location.

Parameters

options - Object
A map of options to pass to the method.

x - number: the x-coordinate of the upper left corner of the created rectangle.
y - number: the y-coordinate of the upper left corner of the created rectangle.
width - number: the width of the created rectangle.
height - number: the height of the created rectangle.

Properties

bounds2D

: Rectangle2D

Gets the bounds of this instance in double precision.

centerX

: number

Gets the x coordinate of the center point of this rectangle.

centerY

: number

Gets the y coordinate of the center point of this rectangle.

empty

: boolean

Gets whether this instance is empty, that is, covers no area.

frame

: Rectangle2D

Gets or sets the outer bounds of this rectangle in double coordinates.

height

: number

Gets the height of this rectangle.

maxX

: number

Gets the largest x coordinate of this rectangle.

maxY

: number

Gets the largest y coordinate of this rectangle.

minX

: number

Gets the smallest x coordinate of this rectangle.

minY

: number

Gets the smallest y coordinate of this rectangle.

rect

: Rectangle2D

Sets the location and size of this rectangle to be similar to the specified rectangle.

width

: number

Gets the width of this rectangle.

x

: number

Gets the x coordinate of the upper left corner.

y

: number

Gets the y coordinate of the upper left corner.

Methods

add

(px: number, py: number)

Adds a point, specified by its coordinates, to this rectangle.

Remarks

The rectangle will be grown if necessary. Note that for points that would lie on the right or bottom border of the rectangle, contains will still return false for the added point.

Parameters

options - Object
A map of options to pass to the method.

px - number: the x coordinate of the point to add
py - number: the y coordinate of the point to add

add

(r: Rectangle2D)

Adds a rectangle to this rectangle.

Remarks

The rectangle will be grown to the union of both rectangles

Parameters

options - Object
A map of options to pass to the method.

r - Rectangle2D: the rectangle to add

clone

() : Object

Creates a new instance of this class that has the same values as this objects.

Returns

↪Object: a new instance of this class that has the same values as this objects.

Implements

ICloneable

contains

(x: number, y: number) : boolean

Checks if the point specified by the given coordinates is contained in this rectangle.

Parameters

options - Object
A map of options to pass to the method.

x - number: the x-coordinate of the point.
y - number: the y-coordinate of the point.

Returns

↪boolean: true if the specified point is contained in this rectangle; false otherwise.

contains

(x: number, y: number, width: number, height: number) : boolean

Checks whether this rectangle completely contains the second specified rectangle.

Parameters

options - Object
A map of options to pass to the method.

x - number: the x coordinate of the second rectangle.
y - number: the y coordinate of the second rectangle.
width - number: the width coordinate of the second rectangle.
height - number: the height coordinate of the second rectangle.

Returns

↪boolean: true if this rectangle contains the second one

contains

(rect: Rectangle2D) : boolean

Checks whether this rectangle completely contains the second specified rectangle.

Parameters

options - Object
A map of options to pass to the method.

rect - Rectangle2D: the rectangle to check for containment

Returns

↪boolean: true if this rectangle contains the second one

createIntersection

(r: Rectangle2D) : Rectangle2D

Calculates the intersection of this rectangle with the given rectangle and returns the result as new rectangle.

Parameters

options - Object
A map of options to pass to the method.

r - Rectangle2D: a rectangle to intersect with this rectangle.

Returns

↪Rectangle2D: a new rectangle that represents the calculated intersection.

createUnion

(r: Rectangle2D) : Rectangle2D

Calculates the union of this rectangle with the given rectangle and returns the result as new rectangle.

Parameters

options - Object
A map of options to pass to the method.

r - Rectangle2D: a rectangle to union with this rectangle.

Returns

↪Rectangle2D: a new rectangle that represents the calculated union.

equals

(obj: Object) : boolean

Returns whether this rectangle and obj are equal.

Remarks

Two rectangles are considered equal if they have the same location and size.

Parameters

options - Object
A map of options to pass to the method.

obj - Object: The object to test for equality.

Returns

↪boolean: true if both objects are equal.

hashCode

() : number

Returns a hash code for this object.

Remarks

The hash code is a numeric value that can be used to treat this object as a key in a hash table or similar data structure.

Two objects that are considered equal must have the same hash code. However, the reverse does not hold and two objects having the same hash code don't have to be equal. Ideally, the hash code should be roughly uniformly-distributed to prevent hash tables from performing poorly. Calculating the hash code is also a potentially frequent operation and should therefore be fast.

Returns

↪number: the hash code for this object

intersects

(x: number, y: number, width: number, height: number) : boolean

Checks whether this rectangle and the second specified rectangle intersect.

Parameters

options - Object
A map of options to pass to the method.

x - number: the x coordinate of the second rectangle.
y - number: the y coordinate of the second rectangle.
width - number: the width coordinate of the second rectangle.
height - number: the height coordinate of the second rectangle.

Returns

↪boolean: true if both rectangles intersect

intersects

(rect: Rectangle2D) : boolean

Checks whether this rectangle and the second specified rectangle intersect.

Parameters

options - Object
A map of options to pass to the method.

rect - Rectangle2D: the rectangle to check for intersection

Returns

↪boolean: true if both rectangles intersect

intersectsLine

(x1: number, y1: number, x2: number, y2: number) : boolean

Checks if the line segment specified by the given coordinates intersects this rectangle.

Parameters

options - Object
A map of options to pass to the method.

x1 - number: the x-coordinate of the first end point of the line.
y1 - number: the y-coordinate of the first end point of the line.
x2 - number: the x-coordinate of the other end point of the line.
y2 - number: the y-coordinate of the other end point of the line.

Returns

↪boolean: true if the specified line intersects this rectangle; false otherwise.

setFrame

(x: number, y: number, width: number, height: number)

Sets the outer bounds of this rectangle based on the specified location and size.

Parameters

options - Object
A map of options to pass to the method.

x - number: the new x-coordinate of the upper left corner.
y - number: the new y-coordinate of the upper left corner.
width - number: the new width.
height - number: the new height.

setFrameFromCenter

(centerX: number, centerY: number, cornerX: number, cornerY: number)

Sets the outer bounds of this rectangle based on the specified new center and corner.

Parameters

options - Object
A map of options to pass to the method.

centerX - number: the x-coordinate of the new center of this rectangle.
centerY - number: the y-coordinate of the new center of this rectangle.
cornerX - number: the x-coordinate of any new corner of this rectangle.
cornerY - number: the y-coordinate of any new corner of this rectangle.

setFrameFromCenter

(center: Point2D, corner: Point2D)

Sets the outer bounds of this rectangle based on the specified new center and corner.

Parameters

options - Object
A map of options to pass to the method.

center - Point2D: the new center of this rectangle.
corner - Point2D: any new corner of this rectangle.

setFrameFromDiagonal

(x1: number, y1: number, x2: number, y2: number)

Sets the outer bounds of this rectangle based on the end points of one of its diagonals.

Parameters

options - Object
A map of options to pass to the method.

x1 - number: the x-coordinate of the first end point of a diagonal.
y1 - number: the y-coordinate of the first end point of a diagonal.
x2 - number: the x-coordinate of the other end point of a diagonal.
y2 - number: the y-coordinate of the other end point of a diagonal.

setFrameFromDiagonal

(p1: Point2D, p2: Point2D)

Sets the outer bounds of this rectangle based on the end points of one of its diagonals.

Parameters

options - Object
A map of options to pass to the method.

p1 - Point2D: the first end point of a diagonal.
p2 - Point2D: the other end point of a diagonal.

setRect

(x: number, y: number, width: number, height: number)

Sets the location and size of this rectangle to the specified values.

Parameters

options - Object
A map of options to pass to the method.

x - number: the new x-coordinate of the upper left corner.
y - number: the new y-coordinate of the upper left corner.
width - number: the new width.
height - number: the new height.

toRect

() : Rect

Creates a Rect from a given Rectangle2D.

Returns

↪Rect: The Rect.

This method is not available unless the module view-layout-bridge is loaded. Either load the module 'view-layout-bridge' explicitly or call Class.ensure(LayoutExecutor) More information.

toString

() : string

Returns a string representation for this object.

Returns

↪string: a string describing this object

Static Methods

intersect

(src1: Rectangle2D, src2: Rectangle2D, dst: Rectangle2D)

Calculates the intersection of the first and second specified rectangle and sets the resulting location and size to the third rectangle.

Parameters

options - Object
A map of options to pass to the method.

src1 - Rectangle2D: the first rectangle to intersect.
src2 - Rectangle2D: the second rectangle to intersect.
dst - Rectangle2D: the rectangle to which the result is set.

union

(src1: Rectangle2D, src2: Rectangle2D, dst: Rectangle2D)

Calculates the union of the first and second specified rectangle and sets the resulting location and size to the third rectangle.

Parameters

options - Object
A map of options to pass to the method.

src1 - Rectangle2D: the first rectangle to union.
src2 - Rectangle2D: the second rectangle to union.
dst - Rectangle2D: the rectangle to which the result is set.