multiLineString

Creates a MultiLineString geometry from an array of line strings coordinates or an array of LineStrings.

Each line string must contain at least 2 positions. Empty line strings with 0 positions are allowed.

Type Parameters

• P

Parameters

Name	Type	Default	Description
data	Position[][] | LineString[]		MultiLineString coordinates or an array of LineStrings
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.layout?	'XY' | 'XYZ' | 'XYZM' | 'XYM'	'XYZM'	Coordinate layout for interpreting GeoJSON coordinates. Defines how to interpret the coordinates of input geometries. This does not force the dimension of the resulting geometries - the actual geometry dimension will be determined from the parsed data. Use this to: Trim unwanted Z or M ordinates from the input. Treat the third ordinate as M instead of Z.
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

MultiLineString<P>

A new MultiLineString geometry

Throws

• InvalidGeoJSONError on line with 1 position
• GEOSError when any of the input geometries is not a LineString

Examples

// from coordinates
const a = multiLineString([
    [ [ -10, 3 ], [ 5, 4 ] ],
    [ [ -10, 7 ], [ 5, 6 ] ],
]);
const b = multiLineString([
    [ [ 0, 0 ], [ 10, 5 ], [ 0, 10 ] ],
    [ [ 1, 0 ], [ 12, 5 ], [ 1, 10 ] ],
], { properties: { name: 'B' } });

// from line string geometries
const parts = [
    lineString([ [ -14, 10 ], [ -14, -4 ], [ 16, -4 ] ]),
    lineString([ [ 16, 0 ], [ 16, 14 ], [ -14, 14 ] ]),
];
const c = multiLineString(parts, { id: 'C' });
const consumableParts = [
    lineString([ [ -15, 11 ], [ -15, -5 ], [ 17, -5 ] ]),
    lineString([ [ 17, -1 ], [ 17, 15 ], [ -15, 15 ] ]),
];
const d = multiLineString(consumableParts, { consume: true });
// all `consumableParts` are detached

// from coordinates const a = multiLineString([ [ [ -10, 3 ], [ 5, 4 ] ], [ [ -10, 7 ], [ 5, 6 ] ], ]); const b = multiLineString([ [ [ 0, 0 ], [ 10, 5 ], [ 0, 10 ] ], [ [ 1, 0 ], [ 12, 5 ], [ 1, 10 ] ], ], { properties: { name: 'B' } }); // from line string geometries const parts = [ lineString([ [ -14, 10 ], [ -14, -4 ], [ 16, -4 ] ]), lineString([ [ 16, 0 ], [ 16, 14 ], [ -14, 14 ] ]), ]; const c = multiLineString(parts, { id: 'C' }); const consumableParts = [ lineString([ [ -15, 11 ], [ -15, -5 ], [ 17, -5 ] ]), lineString([ [ 17, -1 ], [ 17, 15 ], [ -15, 15 ] ]), ]; const d = multiLineString(consumableParts, { consume: true }); // all `consumableParts` are detached