Class: LineString

Extends

• module:ol/geom/SimpleGeometry~SimpleGeometry

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.

applyTransform(transformFn) inherited

geom/SimpleGeometry.js, line 200

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	module:ol/proj~TransformFunction	Transform.

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.

getFirstCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 65

Return the first coordinate of the geometry.

Returns:

First coordinate.

getLastCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 81

Return the last coordinate of the geometry.

Returns:

Last point.

getLayout(){module:ol/geom/Geometry~GeometryLayout} inherited

geom/SimpleGeometry.js, line 90

Return the layout of the geometry.

Returns:

Layout.

getLength(){number}

geom/LineString.js, line 179

Return the length of the linestring on projected plane.

Returns:

Length (on projected plane).

getType(){module:ol/geom/GeometryType}

geom/LineString.js, line 210

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean}

geom/LineString.js, line 218

Test if the geometry and the passed extent intersect.

Name	Type	Description
extent	module:ol/extent~Extent	Extent.

Returns:

true if the geometry and the extent intersect.

rotate(angle, anchor) inherited

geom/SimpleGeometry.js, line 211

Rotate the geometry around a given coordinate. This modifies the geometry coordinates in place.

Name	Type	Description
angle	number	Rotation angle in radians.
anchor	module:ol/coordinate~Coordinate	The rotation center.

scale(sx, opt_sy, opt_anchor) inherited

geom/SimpleGeometry.js, line 226

Scale the geometry (with an optional origin). This modifies the geometry coordinates in place.

Name	Type	Description
sx	number	The scaling factor in the x-direction.
sy	number	The scaling factor in the y-direction (defaults to sx).
anchor	module:ol/coordinate~Coordinate	The scale origin (defaults to the center of the geometry extent).

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.

translate(deltaX, deltaY) inherited

geom/SimpleGeometry.js, line 249

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.