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 32
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 198

Apply a transform function to the coordinates 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 function. Called with a flat array of geometry coordinates.

changed() inherited

Observable.js, line 36

Increases the revision counter and dispatches a 'change' event.

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

geom/MultiLineString.js, line 99

Make a complete copy of the geometry.

Returns:
Clone.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 96

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event Object | module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 119

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getClosestPoint(point, opt_closestPoint){module:ol/coordinate~Coordinate} inherited

geom/Geometry.js, line 129

Return the closest point of the geometry to the passed point as coordinate.

Name Type Description
point module:ol/coordinate~Coordinate

Point.
closestPoint module:ol/coordinate~Coordinate

Closest point.
Returns:
Closest point.

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>>} inherited

geom/MultiLineString.js, line 160

Return the coordinates of the multilinestring.

Returns:
Coordinates.

getExtent(opt_extent){module:ol/extent~Extent} inherited

geom/Geometry.js, line 162

Get the extent of the geometry.

Name Type Description
extent module:ol/extent~Extent

Extent.
Returns:
extent Extent.

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

geom/SimpleGeometry.js, line 64

Return the first coordinate of the geometry.

Returns:
First coordinate.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:
List of property names.

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

geom/SimpleGeometry.js, line 80

Return the last coordinate of the geometry.

Returns:
Last point.

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

geom/SimpleGeometry.js, line 89

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.

getProperties(){Object.<string, *>} inherited

Object.js, line 141

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

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

geom/MultiLineString.js, line 242

Get the type of this geometry.

Returns:
Geometry type.

intersectsCoordinate(coordinate){boolean} inherited

geom/Geometry.js, line 142

Returns true if this geometry includes the specified coordinate. If the coordinate is on the boundary of the geometry, returns false.

Name Type Description
coordinate module:ol/coordinate~Coordinate

Coordinate.
Returns:
Contains coordinate.

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.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

rotate(angle, anchor) inherited

geom/SimpleGeometry.js, line 212

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 233

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).

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setCoordinates(coordinates, opt_layout) inherited

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.

setProperties(values, opt_silent) inherited

Object.js, line 183

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean

Update without triggering an event.

simplify(tolerance){module:ol/geom/Geometry~Geometry} inherited

geom/Geometry.js, line 206

Create a simplified version of this geometry. For linestrings, this uses the Douglas Peucker algorithm. For polygons, a quantization-based simplification is used to preserve topology.

Name Type Description
tolerance number

The tolerance distance for simplification.
Returns:
A new, simplified version of the original geometry.

transform(source, destination){module:ol/geom/Geometry~Geometry} inherited

geom/Geometry.js, line 281

Transform each coordinate of the geometry from one coordinate reference system to another. The geometry is modified in place. For example, a line will be transformed to a line and a circle to a circle. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

Name Type Description
source module:ol/proj~ProjectionLike

The current projection. Can be a string identifier or a module:ol/proj/Projection~Projection object.
destination module:ol/proj~ProjectionLike

The desired projection. Can be a string identifier or a module:ol/proj/Projection~Projection object.
Returns:
This geometry. Note that original geometry is modified in place.

translate(deltaX, deltaY) inherited

geom/SimpleGeometry.js, line 259

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.

un(type, listener) inherited

Observable.js, line 101

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.