multiCurve

Creates a MultiCurve geometry from an array of curves.

Each curve can be either LineString, CircularString or CompoundCurve.

Type Parameters

• P

Parameters

Name	Type	Default	Description
geometries	( LineString | CircularString | CompoundCurve )[]		Array of curve 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

MultiCurve<P>

A new MultiCurve geometry

Throws

• GEOSError when any of the input geometries is not a LineString, CircularString or CompoundCurve

Examples

const parts = [
    // G
    compoundCurve([
        circularString([ [ 20, 20 ], [ 10, 15 ], [ 20, 10 ] ]),
        lineString([ [ 20, 10 ], [ 20, 14 ], [ 16, 14 ] ]),
    ]),
    // E
    lineString([ [ 33, 20 ], [ 23, 20 ], [ 23, 10 ], [ 33, 10 ] ]),
    lineString([ [ 23, 15 ], [ 28, 15 ] ]),
]
const a = multiCurve(parts);
const consumableParts = [
    // O
    circularString([ [ 40, 20 ], [ 35, 15 ], [ 40, 10 ], [ 45, 15 ], [ 40, 20 ] ]),
    // S
    circularString([ [ 53, 20 ], [ 51, 21 ], [ 51, 17 ], [ 51, 9 ], [ 47, 11 ] ]),
]
const b = multiCurve(consumableParts, { consume: true });
// all `consumableParts` are detached

const parts = [ // G compoundCurve([ circularString([ [ 20, 20 ], [ 10, 15 ], [ 20, 10 ] ]), lineString([ [ 20, 10 ], [ 20, 14 ], [ 16, 14 ] ]), ]), // E lineString([ [ 33, 20 ], [ 23, 20 ], [ 23, 10 ], [ 33, 10 ] ]), lineString([ [ 23, 15 ], [ 28, 15 ] ]), ] const a = multiCurve(parts); const consumableParts = [ // O circularString([ [ 40, 20 ], [ 35, 15 ], [ 40, 10 ], [ 45, 15 ], [ 40, 20 ] ]), // S circularString([ [ 53, 20 ], [ 51, 21 ], [ 51, 17 ], [ 51, 9 ], [ 47, 11 ] ]), ] const b = multiCurve(consumableParts, { consume: true }); // all `consumableParts` are detached