OpenLayers

Class: MultiLineString

ol/geom/MultiLineString~MultiLineString 


import MultiLineString from 'ol/geom/MultiLineString';

Multi-linestring geometry.

new MultiLineString(coordinates, opt_layout, opt_ends)

geom/MultiLineString.js, line 23
Name Type Description
coordinates Array.<(Array.<module:ol/coordinate~Coordinate>|module:ol/geom/LineString~LineString)> | Array.<number>

Coordinates or LineString geometries. (For internal use, flat coordinates in combination with opt_layout and opt_ends are also accepted.)
layout module:ol/geom/GeometryLayout

Layout.
ends Array.<number>

Flat coordinate ends for internal use.
Fires:

Extends

Methods

appendLineString(lineString)

geom/MultiLineString.js, line 83

Append the passed linestring to the multilinestring.

Name Type Description
lineString module:ol/geom/LineString~LineString

LineString.

applyTransform(transformFn) inherited

geom/SimpleGeometry.js, line 200

Apply a transform function to each coordinate of the geometry. The geometry is modified in place. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

Name Type Description
transformFn module:ol/proj~TransformFunction

Transform.

clone(){module:ol/geom/MultiLineString~MultiLineString}

geom/MultiLineString.js, line 99

Make a complete copy of the geometry.

Returns:
Clone.

getCoordinateAtM(m, opt_extrapolate, opt_interpolate){module:ol/coordinate~Coordinate}

geom/MultiLineString.js, line 142

Returns the coordinate at m using linear interpolation, or null if no such coordinate exists.

opt_extrapolate controls extrapolation beyond the range of Ms in the MultiLineString. If opt_extrapolate is true then Ms less than the first M will return the first coordinate and Ms greater than the last M will return the last coordinate.

opt_interpolate controls interpolation between consecutive LineStrings within the MultiLineString. If opt_interpolate is true the coordinates will be linearly interpolated between the last coordinate of one LineString and the first coordinate of the next LineString. If opt_interpolate is false then the function will return null for Ms falling between LineStrings.

Name Type Description
m number

M.
extrapolate boolean

Extrapolate. Default is false.
interpolate boolean

Interpolate. Default is false.
Returns:
Coordinate.

getCoordinates(){Array.<Array.<module:ol/coordinate~Coordinate>>}

geom/MultiLineString.js, line 160

Return the coordinates of the multilinestring.

Returns:
Coordinates.

getFirstCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 65

Return the first coordinate of the geometry.

Returns:
First coordinate.

getLastCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 81

Return the last coordinate of the geometry.

Returns:
Last point.

getLayout(){module:ol/geom/Geometry~GeometryLayout} inherited

geom/SimpleGeometry.js, line 90

Return the layout of the geometry.

Returns:
Layout.

getLineString(index){module:ol/geom/LineString~LineString}

geom/MultiLineString.js, line 178

Return the linestring at the specified index.

Name Type Description
index number

Index.
Returns:
LineString.

getLineStrings(){Array.<module:ol/geom/LineString~LineString>}

geom/MultiLineString.js, line 191

Return the linestrings of this multilinestring.

Returns:
LineStrings.

getType(){module:ol/geom/GeometryType}

geom/MultiLineString.js, line 242

Get the type of this geometry.

Returns:
Geometry type.

intersectsExtent(extent){boolean}

geom/MultiLineString.js, line 250

Test if the geometry and the passed extent intersect.

Name Type Description
extent module:ol/extent~Extent

Extent.
Returns:
true if the geometry and the extent intersect.

rotate(angle, anchor) inherited

geom/SimpleGeometry.js, line 211

Rotate the geometry around a given coordinate. This modifies the geometry coordinates in place.

Name Type Description
angle number

Rotation angle in radians.
anchor module:ol/coordinate~Coordinate

The rotation center.

scale(sx, opt_sy, opt_anchor) inherited

geom/SimpleGeometry.js, line 226

Scale the geometry (with an optional origin). This modifies the geometry coordinates in place.

Name Type Description
sx number

The scaling factor in the x-direction.
sy number

The scaling factor in the y-direction (defaults to sx).
anchor module:ol/coordinate~Coordinate

The scale origin (defaults to the center of the geometry extent).

setCoordinates(coordinates, opt_layout)

geom/MultiLineString.js, line 262

Set the coordinates of the multilinestring.

Name Type Description
coordinates Array.<Array.<module:ol/coordinate~Coordinate>>

Coordinates.
layout module:ol/geom/GeometryLayout

Layout.

translate(deltaX, deltaY) inherited

geom/SimpleGeometry.js, line 249

Translate the geometry. This modifies the geometry coordinates in place. If instead you want a new geometry, first clone() this geometry.

Name Type Description
deltaX number

Delta X.
deltaY number

Delta Y.