`Abstract`

- Shape
- Bounds

contains2D
contains2DBounds
contains2DCoordinates
contains2DPoint
contains3D
contains3DBounds
contains3DPoint
copy
equals
interacts2D
move2D
move2DToCoordinates
move2DToPoint
move3D
move3DToCoordinates
move3DToPoint
setTo2D
setTo2DIntersection
setTo2DUnion
setTo3D
setTo3DIntersection
setTo3DUnion
setToBounds2D
setToBounds3D
setToIncludePoint2D
setToIncludePoint3D
toString
translate
translate2D
translate3D

`Abstract`

bounds`Abstract`

coordinate- get coordinateType(): CoordinateType
The coordinate type this shape. This property is read only. An Error will be thrown when trying to assign to this property.

#### Returns CoordinateType

`Abstract`

depth- get depth(): number
The depth of the bounding box (the box's extent along the Z-axis). The depth must be larger than or equal to zero.

#### Returns number

- set depth(value): void
#### Parameters

##### value: number

#### Returns void

`Abstract`

focus- get focusPoint(): Point
The focus point of this shape. This property is read only. An error will be thrown when trying to assign to this property. This property contains an object but should be treated with value semantics: changes to the shape will not be reflected in the focusPoint that was retrieved from this Polygon before the modification.

#### Returns Point

`Abstract`

height- get height(): number
The height of the bounding box (the box's extent along the Y-axis). The height must be larger than or equal to zero.

#### Returns number

- set height(value): void
#### Parameters

##### value: number

#### Returns void

- get reference(): null | CoordinateReference
The spatial reference of this shape. This property is read only. An Error will be thrown when trying to assign to this property.

#### Returns null | CoordinateReference

`Abstract`

width- get width(): number
The width of this bounding box (the box's extent along the x-axis). The width must be larger than or equal to zero.

#### Returns number

- set width(value): void
#### Parameters

##### value: number

#### Returns void

`Abstract`

x- get x(): number
The x coordinate or longitude of the location of the bounding box.

#### Returns number

- set x(value): void
#### Parameters

##### value: number

#### Returns void

`Abstract`

y- get y(): number
The y coordinate or latitude of the location of the bounding box.

#### Returns number

- set y(value): void
#### Parameters

##### value: number

#### Returns void

`Abstract`

z- get z(): number
The z coordinate of the location of the bounding box.

#### Returns number

- set z(value): void
#### Parameters

##### value: number

#### Returns void

`Abstract`

contains2D- contains2D(bounds): boolean
Determines whether a given bounds is inside this bounds. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

#### Parameters

##### bounds: Bounds

The bounds for which containment must be checked. If a 3D bounds is passed to this function, it will be treated as a 2D bounds: the z coordinate (height) will be ignored. The reference of the passed bounds must be the same reference as this Bounds

#### Returns boolean

`true`

when the given bounds are contained in this bounds

- contains2DBounds(bounds): boolean
Determines whether a given bounds is inside this bounds. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

#### Parameters

##### bounds: Bounds

The bounds for which containment must be checked. If a 3D bounds is passed to this function, it will be treated as a 2D bounds: the z coordinate (height) will be ignored. The reference of the passed bounds must be the same reference as this Bounds

#### Returns boolean

`true`

when the given bounds are contained in this bounds#### Throws

Bounds with another spatial reference

`Abstract`

contains2DCoordinates- contains2DCoordinates(x, y): boolean
Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

#### Parameters

##### x: number

The x coordinate of the point for which containment must be checked

##### y: number

The y coordinate of the point for which containment must be checked

#### Returns boolean

`true`

when the given point is contained in this shape#### Throws

Point with another spatial reference

- contains2DPoint(point): boolean
Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).

#### Parameters

##### point: Point

The point for which containment must be checked.

#### Returns boolean

`true`

when the given point is contained in this shape#### Throws

Point with another spatial reference

- contains3D(pointOrBounds): boolean
Check whether this Bounds instance contains the bounds in the 3D space.

#### Returns boolean

true when the point or bounds are contained

#### Throws

InvalidReferenceError when the reference of the bounds parameter does not correspond with the reference of this Bounds

#### Deprecated

Please use contains3DBounds instead.

`Abstract`

contains3DBounds- contains3DBounds(bounds): boolean
Check whether this Bounds instance contains the bounds in the 3D space.

#### Parameters

##### bounds: Bounds

The bounds whose containment must be checked

#### Returns boolean

true when the point or bounds are contained

#### Throws

InvalidReferenceError when the reference of the bounds parameter does not correspond with the reference of this Bounds

- contains3DPoint(point): boolean
Determines whether a given point is inside this shape. This method checks containment in three dimensions: on the (x,y,z)-axis or the (lon,lat,height)-axis (depending on the spatial reference of the shape).

#### Parameters

##### point: Point

The point for which containment must be checked. If a 3D point is passed to this function, a z-coordinate (height) value of 0 is assumed. This point must have the same spatial reference as the shape.

#### Returns boolean

#### Throws

Point with another spatial reference.

`Abstract`

copy`Abstract`

equals- equals(otherShape): boolean
Indicates whether this shape is equal to another.

#### Parameters

##### otherShape: Shape

the other shape this shape is compared with.

#### Returns boolean

`true`

if both shapes are equal,`false`

otherwise.

`Abstract`

interacts2D- interacts2D(bounds): boolean
Checks whether this Bounds object interacts with the given Bounds object in the 2D space. Only the first two dimensions of the Bounds objects are considered.

#### Parameters

##### bounds: Bounds

the bounds to compare with.

#### Returns boolean

the boolean result of the interaction test.

- move2D(xOrPoint, y?): void
Moves the location of this Bounds instance to the location specified by x and y.

#### Parameters

##### xOrPoint: number | Point

x coordinate value or the location as a point.

`Optional`

y: numbery coordinate value

#### Returns void

#### Throws

InvalidReferenceError when the reference of the Point parameter does not correspond with the reference of this Bounds.

`Abstract`

move2DTo- move2DTo
Point (point): void Moves the location of this Bounds instance to the location of the point. The z-value of the point is ignored.

#### Returns void

#### Throws

InvalidReferenceError when the reference of the Point parameter does not correspond with the reference of this Bounds.

- move3D(xOrPoint, y?, z?): void
Moves this Bounds instance to the location specified by the x, y and z parameters.

#### Parameters

##### xOrPoint: number | Point

x coordinate value or the point to move the location of this bounds to

`Optional`

y: numbery coordinate value

`Optional`

z: numberz coordinate value

#### Returns void

#### Throws

InvalidReferenceError when the reference of the Point parameter does not correspond with the reference of this Bounds.

`Abstract`

move3DTo- move3DTo
Point (point): void Moves this Bounds instance to the location in 3D space as specified by the point.

#### Parameters

##### point: Point

the point to move the location of this bounds to.

#### Returns void

#### Throws

`Abstract`

set- set
To2D (x, width, y, height): void Configure this Bounds instance in 2 dimensions.

#### Parameters

##### x: number

The x coordinate of Bounds instance's location.

##### width: number

The width of the Bounds instance.

##### y: number

The y coordinate of the Bounds instance's

##### height: number

The height of the Bounds instance's location

#### Returns void

`Abstract`

set- set
To2DIntersection (bounds): void Calculates the 2D intersection of this Bounds instance and a given Bounds instance. Only the first two dimensions of the Bounds objects are considered. This Bounds object is updated with the result. Its third dimension is left unchanged.

#### Parameters

##### bounds: Bounds

the other Bounds operand for the intersection.

#### Returns void

#### Throws

InvalidReferenceError when the reference of the Bounds parameter does not correspond with the reference of this Bounds object

`Abstract`

set- set
To2DUnion (bounds): void Calculates the 2D union of this Bounds instance and a given Bounds instance. The result contains at least all the points that are contained in either of the Bounds objects (and typically more). Only the first two dimensions of the Bounds objects are considered. This Bounds object is updated with the result. Its third dimension is left unchanged.

#### Parameters

##### bounds: Bounds

the other Bounds operand for the union.

#### Returns void

#### Throws

InvalidReferenceError when the reference of the Bounds parameter does not correspond with the reference of this Bounds object

`Abstract`

set- set
To3D (x, width, y, height, z, depth): void Configure this Bounds instance in 3 dimensions.

#### Parameters

##### x: number

The x coordinate of Bounds instance's location.

##### width: number

The width of the Bounds instance.

##### y: number

The y coordinate of the Bounds instance's

##### height: number

The height of the Bounds instance's location

##### z: number

The z coordinate of the Bounds instance's

##### depth: number

The depth of the Bounds instance's location

#### Returns void

`Abstract`

set- set
To3DIntersection (bounds): void Calculates the 3D intersection of this Bounds instance and a given Bounds instance. This Bounds object is updated with the result.

#### Parameters

##### bounds: Bounds

the other Bounds operand for the intersection.

#### Returns void

#### Throws

InvalidReferenceError when the reference of the Bounds parameter does not correspond with the reference of this Bounds object

`Abstract`

set- set
To3DUnion (bounds): void Calculates the 3D union of this Bounds object and a given Bounds object. The result contains at least all the points that are contained in either or both of the Bounds objects (and typically more). This Bounds object is updated with the result.

#### Parameters

##### bounds: Bounds

the other Bounds operand for the union.

#### Returns void

#### Throws

`Abstract`

set- set
To (bounds): voidBounds2D Configure this Bounds instance in 2 dimensions, using the dimensions of another Bounds instance.

#### Parameters

##### bounds: Bounds

the bounds that must be used to configure this bounds. Only the x, width, y and height properties of this bounds instance will be considered.

#### Returns void

#### Throws

InvalidReferenceError if bounds is defined in a different reference

`Abstract`

set- set
To (bounds): voidBounds3D Configure this Bounds instance in 2 dimensions, using the dimensions of another Bounds instance.

#### Parameters

##### bounds: Bounds

the bounds that must be used to configure this bounds.

#### Returns void

#### Throws

InvalidReferenceError if bounds is defined in a different reference

`Abstract`

set- set
To (point): voidInclude Point2D Calculates the 2D extension of this Bounds object that contains a given Point. The result contains at least the given point and all the points that are contained in this Bounds (and typically more). Only the first two dimensions of this Bounds object and the Bounds are considered. This Bounds object is updated with the result. Its third dimension is left unchanged.

#### Parameters

##### point: Point

the point that should be inside (or at the edge) after the extension of the bounds.

#### Returns void

#### Throws

Point's reference does not match the spatial reference of this Bounds.

`Abstract`

set- set
To (point): voidInclude Point3D Calculates the 3D extension of this Bounds that contains a given Point. The result contains at least the given point and all the points that are contained in this Bounds (and typically more). This Bounds object is updated

with the result.#### Parameters

##### point: Point

the point operand for the union.

#### Returns void

#### Throws

Point's reference does not match the spatial reference of this Bounds.

- translate(x, y, z?): void
Translates this bounds from its current position over the given translation vector to another location. This method can be called with an x, y and optionally a z value. If the z coordinate is not specified, the translation will only affect the x and y coordinate.

#### Parameters

##### x: number

x coordinate value

##### y: number

y coordinate value

`Optional`

z: numberz coordinate value, may be omitted.

#### Returns void

`Abstract`

translate2D`Abstract`

translate3D
A Bounds object is a 3D axis-aligned box. It has a location, a width, height, and a depth. The location is represented by the smallest x, y and z coordinate encompassed by the box, i.e. the lower-left corner. The width, height and depth are the box's extents in the positive directions of the x, y and z axis, respectively.

Note that Bounds instances will be normalized when (re)configuring them. width, h In case the Bounds instance is defined in a CoordinateType.GEODETIC coordinate system, the properties will be normalized: