compoundCurve

Creates a CompoundCurve geometry from an array of continuous segments.

Each segment can be either LineString or CircularString, they need to be connected - the first point of a segment is the same as the last point from the previous segment. Empty compound curves without any segments are allowed.

Type Parameters

• P

Parameters

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

CompoundCurve<P>

A new CompoundCurve geometry

Throws

• GEOSError when any of the input geometries is not a LineString, or CircularString
• GEOSError when input segments are not continuous
• GEOSError when input segments includes empty geometry

Examples

const a = compoundCurve([
    lineString([ [ 0, 10 ], [ 0, 0 ], [ 5, 0 ], [5, 5] ]),
    circularString([ [ 5, 5], [ 10, 10 ], [ 10, 0 ] ]),
]);

const a = compoundCurve([ lineString([ [ 0, 10 ], [ 0, 0 ], [ 5, 0 ], [5, 5] ]), circularString([ [ 5, 5], [ 10, 10 ], [ 10, 0 ] ]), ]);