multiPolygon

Creates a MultiPolygon geometry from an array of polygon coordinates.

Each polygon must consist of an array of linear rings coordinates. The first ring represents the exterior ring (shell), subsequent rings represent interior rings (holes). Each ring must be a closed line string with first and last positions identical and contain at least 3 positions. Empty polygons without any rings are allowed.

Type Parameters

• P

Parameters

Name	Type	Description
pppts	Position[][][]	MultiPolygon coordinates
options?	object	Optional geometry options
options.id?	number | string	Optional identifier to be assigned to the geometry instance.
options.properties?	P	Optional data to be assigned to the geometry instance.

Returns

MultiPolygon<P>

A new Geometry object

Throws

• InvalidGeoJSONError if any ring is invalid (not closed or with 1 or 2 positions)

Examples

const a = multiPolygon([
    [ [ [ 1, 0 ], [ 0, 1 ], [ 1, 1 ], [ 1, 0 ] ] ],
    [ [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 1, 1 ] ] ],
]);
const b = multiPolygon([
    [ [ [ 0, 1 ], [ 1, 2 ], [ 1, 1 ], [ 0, 1 ] ] ],
    [ [ [ 1, 0 ], [ 1, 1 ], [ 2, 1 ], [ 1, 0 ] ] ],
], { properties: { name: 'B' } });
const wkt = toWKT(a); // 'MULTIPOLYGON (((1 0, 0 1, 1 1, 1 0)), ((1 1, 1 2, 2 1, 1 1)))'

const a = multiPolygon([ [ [ [ 1, 0 ], [ 0, 1 ], [ 1, 1 ], [ 1, 0 ] ] ], [ [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 1, 1 ] ] ], ]); const b = multiPolygon([ [ [ [ 0, 1 ], [ 1, 2 ], [ 1, 1 ], [ 0, 1 ] ] ], [ [ [ 1, 0 ], [ 1, 1 ], [ 2, 1 ], [ 1, 0 ] ] ], ], { properties: { name: 'B' } }); const wkt = toWKT(a); // 'MULTIPOLYGON (((1 0, 0 1, 1 1, 1 0)), ((1 1, 1 2, 2 1, 1 1)))'