BoundingRectangle

new BoundingRectangle(x, y, width, height)

A bounding rectangle given by a corner, width and height.
Name Type Default Description
x Number 0.0 optional The x coordinate of the rectangle.
y Number 0.0 optional The y coordinate of the rectangle.
width Number 0.0 optional The width of the rectangle.
height Number 0.0 optional The height of the rectangle.
See:
Source: Core/BoundingRectangle.js, line 34

Members

height :Number

The height of the rectangle.
Default Value: 0.0
Source: Core/BoundingRectangle.js, line 61

width :Number

The width of the rectangle.
Default Value: 0.0
Source: Core/BoundingRectangle.js, line 54

x :Number

The x coordinate of the rectangle.
Default Value: 0.0
Source: Core/BoundingRectangle.js, line 40

y :Number

The y coordinate of the rectangle.
Default Value: 0.0
Source: Core/BoundingRectangle.js, line 47

Methods

staticBoundingRectangle.clone(rectangle, result) → BoundingRectangle

Duplicates a BoundingRectangle instance.
Name Type Description
rectangle BoundingRectangle The bounding rectangle to duplicate.
result BoundingRectangle optional The object onto which to store the result.
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided. (Returns undefined if rectangle is undefined)
Source: Core/BoundingRectangle.js, line 159

staticBoundingRectangle.equals(left, right) → Boolean

Compares the provided BoundingRectangles componentwise and returns true if they are equal, false otherwise.
Name Type Description
left BoundingRectangle optional The first BoundingRectangle.
right BoundingRectangle optional The second BoundingRectangle.
Returns:
true if left and right are equal, false otherwise.
Source: Core/BoundingRectangle.js, line 292

staticBoundingRectangle.expand(rectangle, point, result) → BoundingRectangle

Computes a bounding rectangle by enlarging the provided rectangle until it contains the provided point.
Name Type Description
rectangle BoundingRectangle A rectangle to expand.
point Cartesian2 A point to enclose in a bounding rectangle.
result BoundingRectangle optional The object onto which to store the result.
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
Source: Core/BoundingRectangle.js, line 219

staticBoundingRectangle.fromPoints(positions, result) → BoundingRectangle

Computes a bounding rectangle enclosing the list of 2D points. The rectangle is oriented with the corner at the bottom left.
Name Type Description
positions Cartesian2[] List of points that the bounding rectangle will enclose. Each point must have x and y properties.
result BoundingRectangle optional The object onto which to store the result.
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
Source: Core/BoundingRectangle.js, line 73

staticBoundingRectangle.fromRectangle(rectangle, projection, result) → BoundingRectangle

Computes a bounding rectangle from an rectangle.
Name Type Default Description
rectangle Rectangle The valid rectangle used to create a bounding rectangle.
projection Object GeographicProjection optional The projection used to project the rectangle into 2D.
result BoundingRectangle optional The object onto which to store the result.
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
Source: Core/BoundingRectangle.js, line 124

staticBoundingRectangle.intersect(left, right) → Intersect

Determines if two rectangles intersect.
Name Type Description
left BoundingRectangle A rectangle to check for intersection.
right BoundingRectangle The other rectangle to check for intersection.
Returns:
Intersect.INTESECTING if the rectangles intersect, Intersect.OUTSIDE otherwise.
Source: Core/BoundingRectangle.js, line 259

staticBoundingRectangle.union(left, right, result) → BoundingRectangle

Computes a bounding rectangle that is the union of the left and right bounding rectangles.
Name Type Description
left BoundingRectangle A rectangle to enclose in bounding rectangle.
right BoundingRectangle A rectangle to enclose in a bounding rectangle.
result BoundingRectangle optional The object onto which to store the result.
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
Source: Core/BoundingRectangle.js, line 184

clone(result) → BoundingRectangle

Duplicates this BoundingRectangle instance.
Name Type Description
result BoundingRectangle optional The object onto which to store the result.
Returns:
The modified result parameter or a new BoundingRectangle instance if one was not provided.
Source: Core/BoundingRectangle.js, line 309

equals(right) → Boolean

Compares this BoundingRectangle against the provided BoundingRectangle componentwise and returns true if they are equal, false otherwise.
Name Type Description
right BoundingRectangle optional The right hand side BoundingRectangle.
Returns:
true if they are equal, false otherwise.
Source: Core/BoundingRectangle.js, line 332

intersect(right) → Intersect

Determines if this rectangle intersects with another.
Name Type Description
right BoundingRectangle A rectangle to check for intersection.
Returns:
Intersect.INTESECTING if the rectangles intersect, Intersect.OUTSIDE otherwise.
Source: Core/BoundingRectangle.js, line 320