Class DMCBounds

Object
   |
   +--DMCBounds

class DMCBounds

DMCBounds is a class that represents a bounds.
Defined in APIJS.js

Field Detail

getMax

DMCPoint getMax

Returns the maximum point in the bounds

getMin

DMCPoint getMin

Returns the minimum point in the bounds

TYPE

string TYPE

Geometry type of the object ("BOUNDS")

xMax

Object xMax

xMin

Object xMin

yMax

Object yMax

yMin

Object yMin

DMCBounds

DMCBounds(<Points[]> points)

Constructs a rectangle containing all the points

Parameters:
points - Array of Points

contains

bool contains( <DMCPoint> point)

Returns true if the point is contained in the bounds and false otherwise

Parameters:
point - A DMCPoint object

Returns:
true if the point is contained in the bounds and false otherwise

containsBounds

bool containsBounds( <DMCBounds> bounds)

Returns true if the bounds is contained in this bounds.

Parameters:
bounds - A DMCBounds

Returns:
true if the bounds is contained in this bounds.

equals

bool equals( <DMCBounds> bounds)

Returns true if the bounds are equal and false otherwise.

Parameters:
bounds - A DMCBounds object

Returns:
true if the bounds are equal and false otherwise

extend

void extend( <DMCPoint> point)

Extends the bounds so that it includes the point passed in

Parameters:
point - Point to extend bounds

getCenter

DMCPoint getCenter()

Returns the center of the bounds

Returns:
the center of the bounds

getNorthEast

DMCPoint getNorthEast()

Returns the NorthEast corner point

Returns:
the NorthEast corner point

getNorthWest

DMCPoint getNorthWest()

Returns the NorthWest corner point

Returns:
the NorthWest corner point

getPoints

DMCPoint[] getPoints()

Returns an Array of DMCPoint which represents the bounds.

Returns:
an Array of DMCPoint which represents the bounds.

getSouthEast

DMCPoint getSouthEast()

Returns the southEast corner point

Returns:
the southEast corner point

getSouthWest

DMCPoint getSouthWest()

Returns the SouthWest corner point

Returns:
the SouthWest corner point

intersection

DMCBounds intersection( <DMCBounds> bounds)

Returns the box by which this box overlaps the other box. If there is no overlap, returns an empty box

Parameters:
bounds - A DMCBounds

Returns:
the box by which this box overlaps the other box. If there is no overlap, returns an empty box

intersects

bool intersects( <DMCBounds> bounds)

Returns true if the bounds intersects this bounds.

Parameters:
bounds - A DMCBounds

Returns:
true if the bounds intersects this bounds.

isEmpty

bool isEmpty()

Returns true if the bounds are valid and not empty and false otherwise

Returns:
true if the bounds are valid and not empty and false otherwise

isValidLat

bool isValidLat()

Returns true if the the bounds contains valid latitude coordinates

Returns:
true if the the bounds contains valid latitude coordinates

isValidLng

bool isValidLng()

Returns true if the the bounds contains valid longitude coordinates

Returns:
true if the the bounds contains valid longitude coordinates

setBounds

void setBounds(<float> xMin, <float> yMin, <float> xMax, <float> yMax)

Sets the bounds

Parameters:
xMin - minimum x value
yMin - minimum y value
xMax - maximum x value
yMax - maximum y value

toSpan

DMCPoint toSpan()

Returns a DMCPoint which represents the size of this rectangle.

Returns:
a DMCPoint which represents the size of this rectangle.

toString

string toString()

Returns the WKT representation of the bounds

Returns:
the WKT representation of the bounds