IMutableRectangle

Show usages

Interface for mutable rectangles aligned to the axes in 2D coordinate space with double precision coordinates.

Inheritance Hierarchy

IMutableRectangle

MutableRectangle

Implemented Interfaces

Remarks

This interface provides read and write access to the features of the rectangle. This interface does not declare any additional methods. It combines the IMutablePoint interface that describes the upper left corner of the rectangle with the IMutableSize interface that describes the width and height of the rectangle.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.geometry.IMutableRectangle

Properties

bottomLeft

: Point

Gets the coordinates of the bottom left corner of the rectangle as a Point.

Defined in

IRectangle

bottomRight

: Point

Gets the coordinates of the bottom right corner of the rectangle as a Point.

Defined in

IRectangle

center

: Point

Gets the coordinates of the center of the rectangle as a Point.

Defined in

IRectangle

height

: number

Gets or sets the height of this instance.

Remarks

Implementations may adjust the values internally, e.g. to automatically snap the values to grid sizes. So depending on context the value that can be read might not necessarily be the exact same value that has just been written.

Implements

ISize

isEmpty

: boolean

Determines whether the specified rectangle is empty.

Remarks

IRectangle instances are considered empty if their width or height is less than 0.0d.

Defined in

IRectangle

maxX

: number

Gets the maximum X coordinate of the rectangle.

Remarks

This is the x coordinate of the right side of the rectangle, or the left side if the rectangle is isEmpty.

Defined in

IRectangle

maxY

: number

Gets the maximum Y coordinate of the rectangle.

Remarks

This is the y coordinate of the bottom side of the rectangle, or the top side if the rectangle is isEmpty.

Defined in

IRectangle

topLeft

: Point

Gets the coordinates of the top left corner of the rectangle as a Point.

Defined in

IRectangle

topRight

: Point

Gets the coordinates of the top right corner of the rectangle as a Point.

Defined in

IRectangle

width

: number

Gets or sets the width of this instance.

Remarks

Implements

ISize

x

: number

Gets or sets the x coordinate for this point.

Remarks

Implementations may adjust the coordinates internally, e.g. to automatically snap the coordinates to grid points. So depending on context the value that can be read might not necessarily be the exact same value that has just been written.

Implements

IPoint

y

: number

Gets or sets the y coordinate for this point.

Remarks

Implements

IPoint

Methods

add

(rectangle2: IRectangle)

Adds a rectangle to another one.

Remarks

The result is placed into the first rectangle, which is returned. If either of the two rectangles is empty, i.e. its width or height is negative, the result will be the other rectangle. If either of the two rectangles is infinite, i.e. its width or height is positive infinity, the result is an infinite rectangle.

Parameters

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

rectangle2 - IRectangle: The rectangle to be added.

add

(point: IPoint)

Adds a point to a rectangle, possibly enlarging the rectangle.

Remarks

If the rectangle is initially empty, i.e. its width or height is negative, the bounds of the rectangle will be set to (p.x, p.y, 0, 0)

Parameters

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

point - IPoint: The coordinate to include in the bounds.

contains

(point: IPoint) : boolean

Determines whether the given rectangle contains the provided point.

Parameters

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

point - IPoint: The point to test.

Returns

↪boolean: true iff the point lies inside the rectangle.

Defined in

IRectangle

distanceTo

(point2: IPoint) : number

Calculates the Euclidean distance between two points.

Parameters

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

point2 - IPoint: The second point.

Returns

↪number: The distance between the two points.

Overrides

IPoint.distanceTo

relocate

(x: number, y: number)

Sets the coordinates of the point to the given values.

Parameters

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

x - number: The new x coordinate
y - number: The new y coordinate

Defined in

IMutablePoint

relocate

(location: IPoint)

Sets the coordinates of the point to the given values.

Parameters

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

location - IPoint: The new location.

Defined in

IMutablePoint

reshape

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

Applies a new position and size to a given mutable rectangle.

Parameters

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

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

reshape

(newRectangle: IRectangle)

Applies a new position and size to a given mutable rectangle.

Parameters

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

newRectangle - IRectangle: The bounds to set to the rectangle.

reshape

(position: IPoint, size: ISize)

Applies a new position and size to a given mutable rectangle.

Parameters

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

position - IPoint: The new location.
size - ISize: The new size.

resize

(newWidth: number, newHeight: number)

Sets the coordinates of the size to the given values.

Parameters

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

newWidth - number: The new x coordinate
newHeight - number: The new y coordinate

Defined in

IMutableSize

resize

(newSize: ISize)

Sets the coordinates of the size to the given values.

Parameters

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

newSize - ISize: The new location.

Defined in

IMutableSize

setCenter

(center: Point)

Sets the center of the rectangle to the provided value.

Parameters

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

center - Point: The new center coordinates.

setToUnion

(rectangle1: IRectangle, rectangle2: IRectangle)

Creates the union of two rectangles, placing the result in the this parameter.

Remarks

Either of the two parameters rectangles may be the same as the first parameter. The result is placed into the this parameter. This method treats rectangles with negative width or height as empty. If one of the rectangles is an infinite rectangle, an infinite rectangle is returned.

Parameters

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

rectangle1 - IRectangle: The first rectangle to create the union of.
rectangle2 - IRectangle: The second rectangle to create the union of.

toPoint

() : Point

Copies the current values of the coordinates of the point to a Point struct.

Remarks

This method is useful to obtain a copy of the state and for making use of the various utility methods that are provided by Point.

Returns

↪Point: The current values of the coordinates of the point.

Overrides

IPoint.toPoint

toRect

() : Rect

Copies the current values of the rectangle to Rect struct.

Remarks

This method can be used to obtain a copy of the current state of the rectangle and for using the utility methods that are available for the Rect type.

Returns

↪Rect: A Rect that holds the values of the rectangle at the time of the invocation.

Defined in

IRectangle

toSize

() : Size

Converts the ISize to a Size struct.

Returns

↪Size: A Size struct that has been initialized with the current values of size.

Overrides

ISize.toSize

IMutableRectangle

Remarks

Type Details

See Also

Properties

bottomLeft

Defined in

bottomRight

Defined in

center

Defined in

height

Remarks

See Also

Implements

isEmpty

Remarks

Defined in

maxX

Remarks

Defined in

maxY

Remarks

Defined in

topLeft

Defined in

topRight

Defined in

width

Remarks

See Also

Implements

x

Remarks

See Also

Implements

y

Remarks

See Also

Implements

Methods

add

Remarks

Parameters

add

Remarks

Parameters

contains

Parameters

Returns

Defined in

distanceTo

Parameters

Returns

Overrides

relocate

Parameters

Defined in

relocate

Parameters

Defined in

reshape

Parameters

reshape

Parameters

reshape

Parameters

resize

Parameters

Defined in

resize

Parameters

Defined in

setCenter

Parameters

setToUnion

Remarks

Parameters

toPoint

Remarks