Class: LineString

Extends

• ol.geom.SimpleGeometry

Methods

appendCoordinate(coordinate)

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

Append the passed coordinate to the coordinates of the linestring.

Name	Type	Description
coordinate	ol.Coordinate	Coordinate.

applyTransform(transformFn) inherited

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

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 dispatches a 'change' event.

Fires:

• change experimental

clone(){ol.geom.LineString}

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

Make a complete copy of the geometry.

Returns:

Clone.

forEachSegment(callback, opt_this){T|boolean} experimental

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

Iterate over each segment, calling the provided callback. If the callback returns a truthy value the function returns that value immediately. Otherwise the function returns false.

Name	Type	Description
callback	function	Function called for each segment.
this	S	The object to be used as the value of 'this' within callback.

Returns:

Value.

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

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

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

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

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 147

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 163

Return the coordinates of the linestring.

Returns:

Coordinates.

getExtent(opt_extent){ol.Extent} inherited

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

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 112

Return the first coordinate of the geometry.

Returns:

First coordinate.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:

List of property names.

getLastCoordinate(){ol.Coordinate} inherited

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

Return the last coordinate of the geometry.

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited

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

Return the layout of the geometry.

Returns:

Layout.

getLength(){number}

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

Return the length of the linestring on projected plane.

Returns:

Length (on projected plane).

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

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62

Returns:

Revision.

getType(){ol.geom.GeometryType}

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

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean}

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

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.

set(key, value) inherited

src/ol/object.js, line 203

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

setCoordinates(coordinates, opt_layout)

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

Set the coordinates of the linestring.

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

setProperties(values) inherited

src/ol/object.js, line 216

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.

translate(deltaX, deltaY) inherited

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

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

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name	Type	Description
key	string	Key name.