Skip to main content
Version: Next

multiLineString

Description

Creates a Feature<MultiLineString> based on a coordinate array. Properties can be added optionally.

Parameters

NameTypeDescription
coordinatesArray<Array<Array<number>>>an array of LineStrings
properties?Objectan Object of key-value pairs to add as properties (default {})
options?ObjectOptional Parameters (default {})
options.bbox?Array<number>Bounding Box Array [west, south, east, north] associated with the Feature
options.id?string | numberIdentifier associated with the Feature

Returns

Examples

var multiLine = turf.multiLineString([
[
[0, 0],
[10, 10],
],
]);

//=multiLine

Installation

$ npm install @turf/helpers

import { multiLineString } from "@turf/helpers";
const result = multiLineString(...);
$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.multiLineString(...);