Extends

• ol.geom.SimpleGeometry

Members

getType

Stability: experimental

Inherited From:

• ol.geom.Geometry#getType

Source:

• geometry.js, line 148

Methods

appendLineString

Stability: not documented

Parameters:

Name	Type	Description
lineString	ol.geom.LineString	LineString.

Source:

• multilinestring.js, line 57

dispatchChangeEvent

Stability: experimental

Dispatches a change event. Register a listener for this event to get notified of changes.

Inherited From:

• ol.Observable#dispatchChangeEvent

Source:

• observable.js, line 39

Fires:

• event:change

getClosestPoint

Stability: experimental

Parameters:

Name	Type	Argument	Description
point	ol.Coordinate		Point.
closestPoint	ol.Coordinate	<optional>	Closest point.

Inherited From:

• ol.geom.Geometry#getClosestPoint

Source:

• geometry.js, line 103

Returns:

Closest point.

Type

ol.Coordinate

getCoordinateAtM

Stability: not documented

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.

Parameters:

Name	Type	Argument	Description
m	number		M.
extrapolate	boolean	<optional>	Extrapolate.
interpolate	boolean	<optional>	Interpolate.

Source:

• multilinestring.js, line 122

Returns:

Coordinate.

Type

ol.Coordinate

getCoordinates

Stability: experimental

Source:

• multilinestring.js, line 140

Returns:

Coordinates.

Type

ol.geom.RawMultiLineString

getFirstCoordinate

Stability: not documented

Inherited From:

• ol.geom.SimpleGeometry#getFirstCoordinate

Source:

• simplegeometry.js, line 105

Returns:

First coordinate.

Type

ol.Coordinate

getLastCoordinate

Stability: not documented

Inherited From:

• ol.geom.SimpleGeometry#getLastCoordinate

Source:

• simplegeometry.js, line 121

Returns:

Last point.

Type

ol.Coordinate

getLayout

Stability: experimental

Inherited From:

• ol.geom.SimpleGeometry#getLayout

Source:

• simplegeometry.js, line 130

Returns:

Layout.

Type

ol.geom.GeometryLayout

getLineString

Stability: not documented

Parameters:

Name	Type	Description
index	number	Index.

Source:

• multilinestring.js, line 158

Returns:

LineString.

Type

ol.geom.LineString

getLineStrings

Stability: experimental

Source:

• multilinestring.js, line 174

Returns:

LineStrings.

Type

Array.<ol.geom.LineString>

on

Stability: experimental

Listen for a certain type of event.

Parameters:

Name	Type	Argument	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.

Inherited From:

• ol.Observable#on

Source:

• observable.js, line 62

Returns:

Unique key for the listener.

Type

goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

Parameters:

Name	Type	Argument	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.

Inherited From:

• ol.Observable#once

Source:

• observable.js, line 75

Returns:

Unique key for the listener.

Type

goog.events.Key

setCoordinates

Stability: experimental

Parameters:

Name	Type	Argument	Description
coordinates	ol.geom.RawMultiLineString		Coordinates.
layout	ol.geom.GeometryLayout	<optional>	Layout.

Source:

• multilinestring.js, line 244

un

Stability: experimental

Unlisten for a certain type of event.

Parameters:

Name	Type	Argument	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.

Inherited From:

• ol.Observable#un

Source:

• observable.js, line 87

unByKey

Stability: experimental

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

Parameters:

Name	Type	Description
key	goog.events.Key	Key.

Inherited From:

• ol.Observable#unByKey

Source:

• observable.js, line 97