Extends

• ol.geom.SimpleGeometry

Methods

appendCoordinate

Stability: experimental

Parameters:

Name	Type	Description
coordinate	ol.Coordinate	Coordinate.

Source:

• linestring.js, line 64

applyTransform

Stability: experimental

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

Parameters:

Name	Type	Description
transformFn	ol.TransformFunction	Transform.

Inherited From:

• ol.geom.SimpleGeometry#applyTransform

Source:

• simplegeometry.js, line 246

clone

Stability: experimental

Source:

• linestring.js, line 79

Returns:

Clone.

Type

ol.geom.Geometry

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 112

Returns:

Closest point.

Type

ol.Coordinate

getCoordinateAtM

Stability: 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.

Parameters:

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

Source:

• linestring.js, line 120

Returns:

Coordinate.

Type

ol.Coordinate

getCoordinates

Stability: experimental

Source:

• linestring.js, line 135

Returns:

Coordinates.

Type

ol.geom.RawLineString

getExtent

Stability: experimental

Get the extent of the geometry.

Parameters:

Name	Type	Argument	Description
extent	ol.Extent	<optional>	Extent.

Inherited From:

• ol.geom.SimpleGeometry#getExtent

Source:

• simplegeometry.js, line 91

Returns:

extent Extent.

Type

ol.Extent

getFirstCoordinate

Stability: experimental

Inherited From:

• ol.geom.SimpleGeometry#getFirstCoordinate

Source:

• simplegeometry.js, line 107

Returns:

First coordinate.

Type

ol.Coordinate

getLastCoordinate

Stability: experimental

Inherited From:

• ol.geom.SimpleGeometry#getLastCoordinate

Source:

• simplegeometry.js, line 124

Returns:

Last point.

Type

ol.Coordinate

getLayout

Stability: experimental

Inherited From:

• ol.geom.SimpleGeometry#getLayout

Source:

• simplegeometry.js, line 133

Returns:

Layout.

Type

ol.geom.GeometryLayout

getLength

Stability: experimental

Source:

• linestring.js, line 145

Returns:

Length.

Type

number

getSimplifiedGeometry

Stability: experimental

Parameters:

Name	Type	Description
squaredTolerance	number	Squared tolerance.

Inherited From:

• ol.geom.SimpleGeometry#getSimplifiedGeometry

Source:

• simplegeometry.js, line 142

Returns:

Simplified geometry.

Type

ol.geom.Geometry

getType

Stability: experimental

Source:

• linestring.js, line 185

Returns:

Geometry type.

Type

ol.geom.GeometryType

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 61

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 74

Returns:

Unique key for the listener.

Type

goog.events.Key

setCoordinates

Stability: experimental

Parameters:

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

Source:

• linestring.js, line 195

transform

Stability: experimental

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

Parameters:

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.

Inherited From:

• ol.geom.Geometry#transform

Source:

• geometry.js, line 183

Returns:

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

Type

ol.geom.Geometry

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 86

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 96