Class: MultiPolygon

Extends

• ol.geom.SimpleGeometry

Methods

appendPolygon(polygon)

src/ol/geom/multipolygon.js, line 92

Append the passed polygon to this multipolygon.

Name	Type	Description
polygon	ol.geom.Polygon	Polygon.

applyTransform(transformFn) inherited

src/ol/geom/simplegeometry.js, line 260

Apply a transform function to each coordinate of the geometry. The geometry is modified in place. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

Name	Type	Description
transformFn	ol.TransformFunction	Transform.

changed() inherited experimental

src/ol/observable.js, line 51

Increases the revision counter and dispatches a 'change' event.

clone(){ol.geom.MultiPolygon}

src/ol/geom/multipolygon.js, line 120

Make a complete copy of the geometry.

Returns:

Clone.

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getArea(){number}

src/ol/geom/multipolygon.js, line 164

Return the area of the multipolygon on projected plane.

Returns:

Area (on projected plane).

getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited

src/ol/geom/geometry.js, line 124

Return the closest point of the geometry to the passed point as coordinate.

Name	Type	Description
point	ol.Coordinate	Point.
closestPoint	ol.Coordinate	Closest point.

Returns:

Closest point.

getCoordinates(opt_right){Array.<Array.<Array.<ol.Coordinate>>>}

src/ol/geom/multipolygon.js, line 183

Get the coordinate array for this geometry. This array has the structure of a GeoJSON coordinate array for multi-polygons.

Name	Type	Description
right	boolean	Orient coordinates according to the right-hand rule (counter-clockwise for exterior and clockwise for interior rings). If false, coordinates will be oriented according to the left-hand rule (clockwise for exterior and counter-clockwise for interior rings). By default, coordinate orientation will depend on how the geometry was constructed.

Returns:

Coordinates.

getExtent(opt_extent){ol.Extent} inherited

src/ol/geom/geometry.js, line 163

Get the extent of the geometry.

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

extent Extent.

getFirstCoordinate(){ol.Coordinate} inherited

src/ol/geom/simplegeometry.js, line 112

Return the first coordinate of the geometry.

Returns:

First coordinate.

getInteriorPoints(){ol.geom.MultiPoint}

src/ol/geom/multipolygon.js, line 227

Return the interior points as multipoint.

Returns:

Interior points.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:

List of property names.

getLastCoordinate(){ol.Coordinate} inherited

src/ol/geom/simplegeometry.js, line 130

Return the last coordinate of the geometry.

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited

src/ol/geom/simplegeometry.js, line 140

Return the layout of the geometry.

Returns:

Layout.

getPolygon(index){ol.geom.Polygon}

src/ol/geom/multipolygon.js, line 280

Return the polygon at the specified index.

Name	Type	Description
index	number	Index.

Returns:

Polygon.

getPolygons(){Array.<ol.geom.Polygon>}

src/ol/geom/multipolygon.js, line 313

Return the polygons of this multipolygon.

Returns:

Polygons.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 70

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getType(){ol.geom.GeometryType}

src/ol/geom/multipolygon.js, line 342

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean}

src/ol/geom/multipolygon.js, line 351

Test if the geometry and the passed extent intersect.

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

true if the geometry and the extent intersect.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 83

Listen for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 96

Listen once for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener.

set(key, value) inherited

src/ol/object.js, line 203

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

setCoordinates(coordinates, opt_layout)

src/ol/geom/multipolygon.js, line 363

Set the coordinates of the multipolygon.

Name	Type	Description
coordinates	Array.<Array.<Array.<ol.Coordinate>>>	Coordinates.
layout	ol.geom.GeometryLayout	Layout.

setProperties(values) inherited

src/ol/object.js, line 216

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
values	Object.<string, *>	Values.

transform(source, destination){ol.geom.Geometry} inherited

src/ol/geom/geometry.js, line 236

Transform each coordinate of the geometry from one coordinate reference system to another. The geometry is modified in place. For example, a line will be transformed to a line and a circle to a circle. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

Name	Type	Description
source	ol.proj.ProjectionLike	The current projection. Can be a string identifier or a ol.proj.Projection object.
destination	ol.proj.ProjectionLike	The desired projection. Can be a string identifier or a ol.proj.Projection object.

Returns:

This geometry. Note that original geometry is modified in place.

translate(deltaX, deltaY) inherited

src/ol/geom/simplegeometry.js, line 272

Translate the geometry. This modifies the geometry coordinates in place. If instead you want a new geometry, first clone() this geometry.

Name	Type	Description
deltaX	number	Delta X.
deltaY	number	Delta Y.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 109

Unlisten for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 122

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
key	goog.events.Key	The key returned by on() or once().

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name	Type	Description
key	string	Key name.