com.gwidgets.api.leaflet

Class LatLngBounds

java.lang.Object

com.gwidgets.api.leaflet.LatLngBounds

@JsType(isNative=true)
public class LatLngBounds
extends Object

Represents a rectangular geographical area on a map.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
Boolean	contains(LatLng latlng) Returns true if the rectangle contains the given point.
Boolean	contains(LatLngBounds otherBounds) Returns true if the rectangle contains the given one.
Boolean	equals(LatLngBounds otherBounds) Returns true if the rectangle is equivalent (within a small margin of error) to the given bounds.
L	extend(LatLng latlng) Extends the bounds to contain the given point.
L	extend(LatLngBounds latlng) Extends the bounds to contain the given bounds.
LatLng	getCenter() Returns the center point of the bounds.
double	getEast() Returns the east longitude of the bounds.
double	getNorth() Returns the north latitude of the bounds.
LatLng	getNorthEast() Returns the north-east point of the bounds.
LatLng	getNorthWest() Returns the north-west point of the bounds.
double	getSouth() Returns the south latitude of the bounds.
LatLng	getSouthEast() Returns the south-east point of the bounds.
LatLng	getSouthWest() Returns the south-west point of the bounds.
double	getWest() Returns the west longitude of the bounds.
Boolean	intersects(LatLngBounds otherBounds) Returns true if the rectangle intersects the given bounds.
Boolean	isValid() Returns true if the bounds are properly initialized.
LatLngBounds	pad(double bufferRatio) Returns bigger bounds created by extending the current bounds by a given percentage in each direction.
String	toBBoxString() Returns a string with bounding box coordinates in a 'southwest_lng,southwest_lat,northeast_lng,northeast_lat' format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

extend

@JsMethod
public L extend(LatLng latlng)

Extends the bounds to contain the given point.

Parameters:

latlng - the latlng

Returns:

the L class

extend

@JsMethod
public L extend(LatLngBounds latlng)

Extends the bounds to contain the given bounds.

Parameters:

latlng - the latlng

Returns:

the L class

getSouthWest

@JsMethod
public LatLng getSouthWest()

Returns the south-west point of the bounds.

Returns:

the south west

getNorthEast

@JsMethod
public LatLng getNorthEast()

Returns the north-east point of the bounds.

Returns:

the north east

getNorthWest

@JsMethod
public LatLng getNorthWest()

Returns the north-west point of the bounds.

Returns:

the north west

getSouthEast

@JsMethod
public LatLng getSouthEast()

Returns the south-east point of the bounds.

Returns:

the south east

getWest

@JsMethod
public double getWest()

Returns the west longitude of the bounds.

Returns:

the west

getSouth

@JsMethod
public double getSouth()

Returns the south latitude of the bounds.

Returns:

the south

getEast

@JsMethod
public double getEast()

Returns the east longitude of the bounds.

Returns:

the east

getNorth

@JsMethod
public double getNorth()

Returns the north latitude of the bounds.

Returns:

the north

getCenter

@JsMethod
public LatLng getCenter()

Returns the center point of the bounds.

Returns:

the center

contains

@JsMethod
public Boolean contains(LatLngBounds otherBounds)

Returns true if the rectangle contains the given one.

Parameters:

otherBounds - the other bounds

Returns:

true/false

contains

@JsMethod
public Boolean contains(LatLng latlng)

Returns true if the rectangle contains the given point.

Parameters:

latlng - the latlng

Returns:

true/false

intersects

@JsMethod
public Boolean intersects(LatLngBounds otherBounds)

Returns true if the rectangle intersects the given bounds.

Parameters:

otherBounds - the other bounds

Returns:

true/false

equals

@JsMethod
public Boolean equals(LatLngBounds otherBounds)

Returns true if the rectangle is equivalent (within a small margin of error) to the given bounds.

Parameters:

otherBounds - the other bounds

Returns:

true/flase

toBBoxString

@JsMethod
public String toBBoxString()

Returns a string with bounding box coordinates in a 'southwest_lng,southwest_lat,northeast_lng,northeast_lat' format. Useful for sending requests to web services that return geo data

Returns:

the string

pad

@JsMethod
public LatLngBounds pad(double bufferRatio)

Returns bigger bounds created by extending the current bounds by a given percentage in each direction.

Parameters:

bufferRatio - the buffer ratio

Returns:

the lat lng bounds

isValid

@JsMethod
public Boolean isValid()

Returns true if the bounds are properly initialized.

Returns:

true/false