multiSurface

Creates a MultiSurface geometry from an array of surfaces.

Each surface can be either Polygon, or CurvePolygon.

Type Parameters

• P

Parameters

Name	Type	Default	Description
geometries	( Polygon | CurvePolygon )[]		Array of surface geometry objects to be included in the collection
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.
options.consume?	boolean	false	Whether to consume the input geometries - consumed geometries become detached, are no longer valid and should not be used. When true the ownership of input geometries is passed to created collection geometry, no extra copies are made, but the input geometries can no longer be used on their own. When false the clones of input geometries are used to create a collection geometry.

Returns

MultiSurface<P>

A new MultiSurface geometry

Throws

• GEOSError when any of the input geometries is not a Polygon or CurvePolygon

Examples

const kier = curvePolygon([
    circularString([
        [ 10, 0 ], [ 5, 13 ], [ 2, 17 ], [ 5, 25 ], [ 10, 21 ],
        [ 15, 25 ], [ 18, 17 ], [ 15, 13 ], [ 10, 0 ],
    ]),
]);
const trefl = curvePolygon([
    circularString([
        [ 24, 0 ], [ 27, 4 ], [ 29, 13 ], [ 21, 13 ], [ 27, 18 ],
        [ 30, 25 ], [ 33, 18 ], [ 39, 13 ], [ 31, 13 ], [ 33, 4 ],
        [ 36, 0 ], [ 30, 1 ], [ 24, 0 ],
    ]),
]);
const karo = curvePolygon([
    circularString([
        [ 43, 13 ], [ 47, 19 ], [ 50, 25 ], [ 53, 19 ], [ 57, 13 ],
        [ 53, 7 ], [ 50, 1 ], [ 47, 7 ], [ 43, 13 ],
    ]),
]);
const suits = multiSurface([ kier, trefl, karo ]);

const kier = curvePolygon([ circularString([ [ 10, 0 ], [ 5, 13 ], [ 2, 17 ], [ 5, 25 ], [ 10, 21 ], [ 15, 25 ], [ 18, 17 ], [ 15, 13 ], [ 10, 0 ], ]), ]); const trefl = curvePolygon([ circularString([ [ 24, 0 ], [ 27, 4 ], [ 29, 13 ], [ 21, 13 ], [ 27, 18 ], [ 30, 25 ], [ 33, 18 ], [ 39, 13 ], [ 31, 13 ], [ 33, 4 ], [ 36, 0 ], [ 30, 1 ], [ 24, 0 ], ]), ]); const karo = curvePolygon([ circularString([ [ 43, 13 ], [ 47, 19 ], [ 50, 25 ], [ 53, 19 ], [ 57, 13 ], [ 53, 7 ], [ 50, 1 ], [ 47, 7 ], [ 43, 13 ], ]), ]); const suits = multiSurface([ kier, trefl, karo ]);