Namespace: extent

Methods

ol.extent.applyTransform(extent, transformFn, opt_extent){ol.Extent}

src/ol/extent.js, line 799

Apply a transform function to the extent.

Name	Type	Description
extent	ol.Extent	Extent.
transformFn	ol.TransformFunction	Transform function. Called with [minX, minY, maxX, maxY] extent coordinates.
extent	ol.Extent	Destination extent.

Returns:

Extent.

ol.extent.boundingExtent(coordinates){ol.Extent}

src/ol/extent.js, line 54

Builds an extent that includes all given coordinates.

Name	Type	Description
coordinates	Array.<ol.Coordinate>	Coordinates.

Returns:

Bounding extent.

ol.extent.buffer(extent, value, opt_extent){ol.Extent}

src/ol/extent.js, line 89

Return extent increased by the provided value.

Name	Type	Description
extent	ol.Extent	Extent.
value	number	The amount by which the extent should be buffered.
extent	ol.Extent	Extent.

Returns:

Extent.

ol.extent.containsCoordinate(extent, coordinate){boolean}

src/ol/extent.js, line 161

Checks if the passed coordinate is contained or on the edge of the extent.

Name	Type	Description
extent	ol.Extent	Extent.
coordinate	ol.Coordinate	Coordinate.

Returns:

Contains.

ol.extent.containsExtent(extent1, extent2){boolean}

src/ol/extent.js, line 175

Checks if extent2 is contained by or on the edge of extent1.

Name	Type	Description
extent1	ol.Extent	Extent 1.
extent2	ol.Extent	Extent 2.

Returns:

Contains.

ol.extent.createEmpty(){ol.Extent}

src/ol/extent.js, line 217

Returns:

Empty extent.

ol.extent.equals(extent1, extent2){boolean}

src/ol/extent.js, line 321

Name	Type	Description
extent1	ol.Extent	Extent 1.
extent2	ol.Extent	Extent 2.

Returns:

Equals.

ol.extent.extend(extent1, extent2){ol.Extent}

src/ol/extent.js, line 333

Name	Type	Description
extent1	ol.Extent	Extent 1.
extent2	ol.Extent	Extent 2.

Returns:

Extent.

ol.extent.getBottomLeft(extent){ol.Coordinate}

src/ol/extent.js, line 447

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Bottom left coordinate.

ol.extent.getBottomRight(extent){ol.Coordinate}

src/ol/extent.js, line 457

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Bottom right coordinate.

ol.extent.getCenter(extent){ol.Coordinate}

src/ol/extent.js, line 467

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Center.

ol.extent.getHeight(extent){number}

src/ol/extent.js, line 544

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Height.

ol.extent.getSize(extent){ol.Size}

src/ol/extent.js, line 610

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Size.

ol.extent.getTopLeft(extent){ol.Coordinate}

src/ol/extent.js, line 620

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Top left coordinate.

ol.extent.getTopRight(extent){ol.Coordinate}

src/ol/extent.js, line 630

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Top right coordinate.

ol.extent.getWidth(extent){number}

src/ol/extent.js, line 640

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Width.

ol.extent.intersects(extent1, extent2){boolean}

src/ol/extent.js, line 651

Name	Type	Description
extent1	ol.Extent	Extent 1.
extent2	ol.Extent	Extent.

Returns:

Intersects.

ol.extent.isEmpty(extent){boolean}

src/ol/extent.js, line 664

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

Is empty.