Class: MultiLineString

ol.geom.MultiLineString

Multi-linestring geometry.

new ol.geom.MultiLineString(coordinates, opt_layout) experimental

Name Type Description
coordinates ol.geom.RawMultiLineString

Coordinates.

layout ol.geom.GeometryLayout optional

Layout.

Fires:
  • change experimental - Triggered when the geometry changes.

Extends

Methods

appendLineString(lineString) experimental

Name Type Description
lineString ol.geom.LineString

LineString.

applyTransform(transformFn) inherited experimental

Apply a transform function to the geometry. Modifies the geometry in place.

Name Type Description
transformFn ol.TransformFunction

Transform.

Returns:
Clone.

dispatchChangeEvent() inherited experimental

Dispatches a change event.

Fires:
  • change experimental

getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited experimental

Name Type Description
point ol.Coordinate

Point.

closestPoint ol.Coordinate optional

Closest point.

Returns:
Closest point.

getCoordinateAtM(m, opt_extrapolate, opt_interpolate){ol.Coordinate} experimental

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 optional

Extrapolate.

interpolate boolean optional

Interpolate.

Returns:
Coordinate.
Returns:
Coordinates.

getExtent(opt_extent){ol.Extent} inherited experimental

Get the extent of the geometry.

Name Type Description
extent ol.Extent optional

Extent.

Returns:
extent Extent.

getFirstCoordinate(){ol.Coordinate} inherited experimental

Returns:
First coordinate.

getLastCoordinate(){ol.Coordinate} inherited experimental

Returns:
Last point.
Returns:
Layout.

getLineString(index){ol.geom.LineString} experimental

Name Type Description
index number

Index.

Returns:
LineString.

getLineStrings(){Array.<ol.geom.LineString>} experimental

Returns:
LineStrings.

getSimplifiedGeometry(squaredTolerance){ol.geom.Geometry} inherited experimental

Name Type Description
squaredTolerance number

Squared tolerance.

Returns:
Simplified geometry.
Returns:
Geometry type.

on(type, listener, opt_this){goog.events.Key} inherited experimental

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.

this Object optional

The object to use as this in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited experimental

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.

this Object optional

The object to use as this in listener.

Returns:
Unique key for the listener.

setCoordinates(coordinates, opt_layout) experimental

Name Type Description
coordinates ol.geom.RawMultiLineString

Coordinates.

layout ol.geom.GeometryLayout optional

Layout.

transform(source, destination){ol.geom.Geometry} inherited experimental

Transform a geometry from one coordinate reference system to another. Modifies the geometry in place.

Name Type Description
source ol.proj.ProjectionLike

The current projection. Can be a string identifier or a ol.proj.Projection object.

destination ol.proj.ProjectionLike

The desired projection. Can be a string identifier or a ol.proj.Projection object.

Returns:
This geometry. Note that original geometry is modified in place.

un(type, listener, opt_this) inherited experimental

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.

this Object optional

The object to use as this in listener.

unByKey(key) inherited experimental

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.