Class: MultiPolygon

ol.geom.MultiPolygon

Multi-polygon geometry.

new ol.geom.MultiPolygon(coordinates, opt_layout)

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

Coordinates.

layout ol.geom.GeometryLayout

Layout.

Fires:
  • change - Triggered when the geometry changes.

Extends

Methods

appendPolygon(polygon)

Name Type Description
polygon ol.geom.Polygon

Polygon.

applyTransform(transformFn) inherited

Apply a transform function to the geometry. Modifies the geometry 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.

Make a complete copy of the geometry.

Returns:
Clone.

dispatchChangeEvent() inherited experimental

Dispatches a change event.

Fires:
  • change experimental
Returns:
Area (on projected plane).

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

Name Type Description
point ol.Coordinate

Point.

closestPoint ol.Coordinate

Closest point.

Returns:
Closest point.

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

Returns:
Coordinates.

Get the extent of the geometry.

Name Type Description
extent ol.Extent

Extent.

Returns:
extent Extent.
Returns:
First coordinate.
Returns:
Interior points.
Returns:
Last point.
Returns:
Layout.
Name Type Description
index number

Index.

Returns:
Polygon.
Returns:
Polygons.

getRevision(){number} inherited experimental

Returns:
Revision.

Get the type of this geometry.

Returns:
Geometry type.

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

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

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.

setCoordinates(coordinates, opt_layout)

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

Coordinates.

layout ol.geom.GeometryLayout

Layout.

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

Transform a geometry from one coordinate reference system to another. Modifies the geometry 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
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.

un(type, listener, opt_this) inherited

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.

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.