Class: LineString

Methods

appendCoordinate(coordinate)

geom/LineString.js, line 72

Append the passed coordinate to the coordinates of the linestring.

Name	Type	Description
coordinate	module:ol/coordinate~Coordinate	Coordinate.

clone(){module:ol/geom/LineString~LineString}

geom/LineString.js, line 87

Make a complete copy of the geometry.

Returns:

Clone.

forEachSegment(callback){T|boolean}

geom/LineString.js, line 119

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.

Returns:

Value.

getCoordinateAt(fraction, opt_dest){module:ol/coordinate~Coordinate}

geom/LineString.js, line 168

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	module:ol/coordinate~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){module:ol/coordinate~Coordinate}

geom/LineString.js, line 137

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.<module:ol/coordinate~Coordinate>}

geom/LineString.js, line 153

Return the coordinates of the linestring.

Returns:

Coordinates.

getLength(){number}

geom/LineString.js, line 179

Return the length of the linestring on projected plane.

Returns:

Length (on projected plane).

getType()

geom/LineString.js, line 210

intersectsExtent()

geom/LineString.js, line 218

setCoordinates(coordinates, opt_layout)

geom/LineString.js, line 231

Set the coordinates of the linestring.

Name	Type	Description
coordinates	Array.<module:ol/coordinate~Coordinate>	Coordinates.
layout	module:ol/geom/GeometryLayout	Layout.