LatLngBounds

Represents a rectangular geographical area on a map.

Usage example

var southWest = L.latLng(40.712, -74.227),
northEast = L.latLng(40.774, -74.125),
bounds = L.latLngBounds(southWest, northEast);

All Leaflet methods that accept LatLngBounds objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:

map.fitBounds([
    [40.712, -74.227],
    [40.774, -74.125]
]);

Creation

Factory Description
L.latLngBounds(<LatLng> southWest, <LatLng> northEast) Creates a LatLngBounds object by defining south-west and north-east corners of the rectangle.
L.latLngBounds(<LatLng[]> latlngs) Creates a LatLngBounds object defined by the geographical points it contains. Very useful for zooming the map to fit a particular set of locations with fitBounds.

Methods

Method Returns Description
extend(<LatLng> latlng) this

Extend the bounds to contain the given point

extend(<LatLngBounds> otherBounds) this

Extend the bounds to contain the given bounds

pad(<Number> bufferRatio) LatLngBounds

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

getCenter() LatLng

Returns the center point of the bounds.

getSouthWest() LatLng

Returns the south-west point of the bounds.

getNorthEast() LatLng

Returns the north-east point of the bounds.

getNorthWest() LatLng

Returns the north-west point of the bounds.

getSouthEast() LatLng

Returns the south-east point of the bounds.

getWest() Number

Returns the west longitude of the bounds

getSouth() Number

Returns the south latitude of the bounds

getEast() Number

Returns the east longitude of the bounds

getNorth() Number

Returns the north latitude of the bounds

contains(<LatLngBounds> otherBounds) Boolean

Returns true if the rectangle contains the given one.

contains(<LatLng> latlng) Boolean

Returns true if the rectangle contains the given point.

intersects(<LatLngBounds> otherBounds) Boolean

Returns true if the rectangle intersects the given bounds. Two bounds intersect if they have at least one point in common.

overlaps(<Bounds> otherBounds) Boolean

Returns true if the rectangle overlaps the given bounds. Two bounds overlap if their intersection is an area.

toBBoxString() String

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.

equals(<LatLngBounds> otherBounds) Boolean

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

isValid() Boolean

Returns true if the bounds are properly initialized.

v1.1.0
Props Wrld.Prop
Themes Wrld.themes
Heatmaps Wrld.Heatmap
Events Event objects
Services (Optional) WrldPoiApi