Class: LineString

Extends

• ol.geom.SimpleGeometry

Methods

appendCoordinate(coordinate)

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

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 255

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 50

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

clone(){ol.geom.LineString}

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

Make a complete copy of the geometry.

Returns:

Clone.

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 72

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	goog.events.EventLike	Event object.

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

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

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 147

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 125

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.

getCoordinateAt(fraction, opt_dest){ol.Coordinate} experimental

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

Return the coordinate at the provided fraction along the linestring. The fraction is a number between 0 and 1, where 0 is the start of the linestring and 1 is the end.

Name	Type	Description
fraction	number	Fraction.
dest	ol.Coordinate	Optional coordinate whose values will be modified. If not provided, a new coordinate will be returned.

Returns:

Coordinate of the interpolated point.

getCoordinateAtM(m, opt_extrapolate){ol.Coordinate}

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

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 161

Return the coordinates of the linestring.

Returns:

Coordinates.

getExtent(opt_extent){ol.Extent} inherited

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

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 111

Return the first coordinate of the geometry.

Returns:

First coordinate.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 161

Get a list of object property names.

Returns:

List of property names.

getLastCoordinate(){ol.Coordinate} inherited

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

Return the last coordinate of the geometry.

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited

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

Return the layout of the geometry.

Returns:

Layout.

getLength(){number}

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

Return the length of the linestring on projected plane.

Returns:

Length (on projected plane).

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

src/ol/object.js, line 171

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 81

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getType(){ol.geom.GeometryType}

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

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean}

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

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 94

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 107

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, opt_silent) inherited

src/ol/object.js, line 201

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setCoordinates(coordinates, opt_layout)

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

Set the coordinates of the linestring.

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

setProperties(values, opt_silent) inherited

src/ol/object.js, line 221

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.
silent	boolean	Update without triggering an event.

simplify(tolerance){ol.geom.Geometry} inherited experimental

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

Create a simplified version of this geometry. For linestrings, this uses the the Douglas Peucker algorithm. For polygons, a quantization-based simplification is used to preserve topology.

Name	Type	Description
tolerance	number	The tolerance distance for simplification.

Returns:

A new, simplified version of the original geometry.

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

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

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

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

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 120

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 133

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, opt_silent) inherited

src/ol/object.js, line 235

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.