OpenLayers

Class: MultiPolygon

ol/geom/MultiPolygon~MultiPolygon 


import MultiPolygon from 'ol/geom/MultiPolygon';

Multi-polygon geometry.

new MultiPolygon(coordinates, opt_layout, opt_endss)

geom/MultiPolygon.js, line 28
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 opt_layout and opt_endss are also accepted.
layout module:ol/geom/GeometryLayout

Layout.
endss Array.<Array.<number>>

Array of ends for internal use with flat coordinates.
Fires:

Extends

Methods

appendPolygon(polygon)

geom/MultiPolygon.js, line 119

Append the passed polygon to this multipolygon.

Name Type Description
polygon module:ol/geom/Polygon~Polygon

Polygon.

applyTransform(transformFn) inherited

geom/SimpleGeometry.js, line 200

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 module:ol/proj~TransformFunction

Transform.

clone(){module:ol/geom/MultiPolygon~MultiPolygon}

geom/MultiPolygon.js, line 144

Make a complete copy of the geometry.

Returns:
Clone.

getArea(){number}

geom/MultiPolygon.js, line 184

Return the area of the multipolygon on projected plane.

Returns:
Area (on projected plane).

getCoordinates(opt_right){Array.<Array.<Array.<module:ol/coordinate~Coordinate>>>}

geom/MultiPolygon.js, line 202

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.

getFirstCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 65

Return the first coordinate of the geometry.

Returns:
First coordinate.

getInteriorPoints(){module:ol/geom/MultiPoint~MultiPoint}

geom/MultiPolygon.js, line 244

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.

getLastCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 81

Return the last coordinate of the geometry.

Returns:
Last point.

getLayout(){module:ol/geom/Geometry~GeometryLayout} inherited

geom/SimpleGeometry.js, line 90

Return the layout of the geometry.

Returns:
Layout.

getPolygon(index){module:ol/geom/Polygon~Polygon}

geom/MultiPolygon.js, line 287

Return the polygon at the specified index.

Name Type Description
index number

Index.
Returns:
Polygon.

getPolygons(){Array.<module:ol/geom/Polygon~Polygon>}

geom/MultiPolygon.js, line 313

Return the polygons of this multipolygon.

Returns:
Polygons.

getType(){module:ol/geom/GeometryType}

geom/MultiPolygon.js, line 338

Get the type of this geometry.

Returns:
Geometry type.

intersectsExtent(extent){boolean}

geom/MultiPolygon.js, line 346

Test if the geometry and the passed extent intersect.

Name Type Description
extent module:ol/extent~Extent

Extent.
Returns:
true if the geometry and the extent intersect.

rotate(angle, anchor) inherited

geom/SimpleGeometry.js, line 211

Rotate the geometry around a given coordinate. This modifies the geometry coordinates in place.

Name Type Description
angle number

Rotation angle in radians.
anchor module:ol/coordinate~Coordinate

The rotation center.

scale(sx, opt_sy, opt_anchor) inherited

geom/SimpleGeometry.js, line 226

Scale the geometry (with an optional origin). This modifies the geometry coordinates in place.

Name Type Description
sx number

The scaling factor in the x-direction.
sy number

The scaling factor in the y-direction (defaults to sx).
anchor module:ol/coordinate~Coordinate

The scale origin (defaults to the center of the geometry extent).

setCoordinates(coordinates, opt_layout)

geom/MultiPolygon.js, line 358

Set the coordinates of the multipolygon.

Name Type Description
coordinates Array.<Array.<Array.<module:ol/coordinate~Coordinate>>>

Coordinates.
layout module:ol/geom/GeometryLayout

Layout.

translate(deltaX, deltaY) inherited

geom/SimpleGeometry.js, line 249

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.