Class: LineString

Extends

• ol.geom.SimpleGeometry

Methods

appendCoordinate(coordinate)

src/ol/geom/linestring.js, line 67

Name	Type	Description
coordinate	ol.Coordinate	Coordinate.

applyTransform(transformFn) inherited

src/ol/geom/simplegeometry.js, line 244

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	ol.TransformFunction	Transform.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:

• change experimental

clone(){ol.geom.LineString}

src/ol/geom/linestring.js, line 83

Make a complete copy of the geometry.

Returns:

Clone.

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

src/ol/geom/geometry.js, line 120

Name	Type	Description
point	ol.Coordinate	Point.
closestPoint	ol.Coordinate	Closest point.

Returns:

Closest point.

getCoordinateAtM(m, opt_extrapolate){ol.Coordinate}

src/ol/geom/linestring.js, line 124

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.

Name	Type	Description
m	number	M.
extrapolate	boolean	Extrapolate. Default is false.

Returns:

Coordinate.

getCoordinates(){Array.<ol.Coordinate>}

src/ol/geom/linestring.js, line 139

Returns:

Coordinates.

getExtent(opt_extent){ol.Extent} inherited

src/ol/geom/geometry.js, line 159

Get the extent of the geometry.

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

extent Extent.

getFirstCoordinate(){ol.Coordinate} inherited

src/ol/geom/simplegeometry.js, line 105

Returns:

First coordinate.

getLastCoordinate(){ol.Coordinate} inherited

src/ol/geom/simplegeometry.js, line 122

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited

src/ol/geom/simplegeometry.js, line 131

Returns:

Layout.

getLength(){number}

src/ol/geom/linestring.js, line 149

Returns:

Length (on projected plane).

getRevision(){number} inherited experimental

src/ol/observable.js, line 62

Returns:

Revision.

getType(){ol.geom.GeometryType}

src/ol/geom/linestring.js, line 189

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean} experimental

src/ol/geom/linestring.js, line 198

Test if the geometry and the passed extent intersect.

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

true if the geometry and the extent intersect.

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

src/ol/observable.js, line 75

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	The object to use as this in listener.

Returns:

Unique key for the listener.

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

src/ol/observable.js, line 88

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	The object to use as this in listener.

Returns:

Unique key for the listener.

setCoordinates(coordinates, opt_layout)

src/ol/geom/linestring.js, line 210

Name	Type	Description
coordinates	Array.<ol.Coordinate>	Coordinates.
layout	ol.geom.GeometryLayout	Layout.

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

src/ol/geom/geometry.js, line 235

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

translate(deltaX, deltaY) inherited experimental

src/ol/geom/simplegeometry.js, line 258

Translate the geometry.

Name	Type	Description
deltaX	number	Delta X.
deltaY	number	Delta Y.

un(type, listener, opt_this) inherited

src/ol/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.
this	Object	The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
key	goog.events.Key	The key returned by on() or once().