-
Name Type Description coordinates
Array.<(Array.<Array.<module:ol/coordinate~Coordinate>>|module:ol/geom/Polygon~Polygon)> | Array.<number> Coordinates. For internal use, flat coordinates in combination with
layout
andendss
are also accepted.layout
GeometryLayout | undefined Layout.
endss
Array.<Array.<number>> | undefined Array of ends for internal use with flat coordinates.
Fires:
-
change
(BaseEvent) - Generic change event. Triggered when the revision counter is increased. -
error
(BaseEvent) - Generic error event. Triggered when an error occurs. -
propertychange
(ObjectEvent) - Triggered when a property is changed.
-
Extends
Methods
-
Append the passed polygon to this multipolygon.
Name Type Description polygon
Polygon Polygon.
-
Increases the revision counter and dispatches a 'change' event.
-
Make a complete copy of the geometry.
Returns:
Clone.
-
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a
type
property.Name Type Description event
BaseEvent | string Event object.
Returns:
false
if anyone called preventDefault on the event object or if any of the listeners returned false.
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
Return the area of the multipolygon on projected plane.
Returns:
Area (on projected plane).
-
Return the closest point of the geometry to the passed point as
coordinate
.Name Type Description point
Coordinate Point.
closestPoint
Coordinate | undefined Closest point.
Returns:
Closest point.
-
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 | undefined 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.
-
Get the extent of the geometry.
Name Type Description extent
Extent | undefined Extent.
Returns:
extent Extent.
-
Return the first coordinate of the geometry.
Returns:
First coordinate.
-
Return the interior points as
multipoint
.Returns:
Interior points as XYM coordinates, where M is the length of the horizontal intersection that the point belongs to.
-
Get a list of object property names.
Returns:
List of property names.
-
Return the last coordinate of the geometry.
Returns:
Last point.
-
Return the
layout
of the geometry.Returns:
Layout.
-
Return the polygon at the specified index.
Name Type Description index
number Index.
Returns:
Polygon.
-
Return the polygons of this multipolygon.
Returns:
Polygons.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
Get the type of this geometry.
Returns:
Geometry type.
-
Returns true if this geometry includes the specified coordinate. If the coordinate is on the boundary of the geometry, returns false.
Name Type Description coordinate
Coordinate Coordinate.
Returns:
Contains coordinate.
-
Test if the geometry and the passed extent intersect.
Name Type Description extent
Extent Extent.
Returns:
true
if the geometry and the extent intersect.
-
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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean | undefined Update without triggering an event.
-
Set the coordinates of the multipolygon.
Name Type Description coordinates
Array<Array<Array<Coordinate>>> Coordinates.
layout
GeometryLayout | undefined Layout.
-
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.
silent
boolean | undefined Update without triggering an event.
-
Create a simplified version of this geometry. For linestrings, this uses the Douglas Peucker algorithm. For polygons, a quantization-based simplification is used to preserve topology.
Name Type Description tolerance
number The tolerance distance for simplification.
Returns:
A new, simplified version of the original geometry.
-
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
ProjectionLike The current projection. Can be a string identifier or a
Projection
object.destination
ProjectionLike The desired projection. Can be a string identifier or a
Projection
object.Returns:
This geometry. Note that original geometry is modified in place.
-
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.
-
Unsets a property.
Name Type Description key
string Key name.
silent
boolean | undefined Unset without triggering an event.