Class: LineString

Extends

• SimpleGeometry

Methods

appendCoordinate(coordinate)

geom/LineString.js, line 75

Append the passed coordinate to the coordinates of the linestring.

Name	Type	Description
coordinate	Coordinate	Coordinate.

applyTransform(transformFn) inherited

geom/SimpleGeometry.js, line 208

Apply a transform function to the coordinates 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	TransformFunction	Transform function. Called with a flat array of geometry coordinates.

changed() inherited

Observable.js, line 68

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

clone(){LineString}

geom/LineString.js, line 86

Make a complete copy of the geometry.

Returns:

Clone.

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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	BaseEvent | string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

forEachSegment(callback){T | boolean}

geom/LineString.js, line 144

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. The function will receive two arguments, the start and end coordinates of the segment.

Returns:

Value.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getClosestPoint(point, closestPoint){Coordinate} inherited

geom/Geometry.js, line 152

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

Name	Type	Description
point	Coordinate	Point.
closestPoint	Coordinate | undefined	Closest point.

Returns:

Closest point.

getCoordinateAt(fraction, dest){Coordinate}

geom/LineString.js, line 208

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	Coordinate | undefined	Optional coordinate whose values will be modified. If not provided, a new coordinate will be returned.

Returns:

Coordinate of the interpolated point.

getCoordinateAtM(m, extrapolate){Coordinate | null}

geom/LineString.js, line 168

Returns the coordinate at m using linear interpolation, or null if no such coordinate exists.

extrapolate controls extrapolation beyond the range of Ms in the MultiLineString. If 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 | undefined	Extrapolate. Default is false.

Returns:

Coordinate.

getCoordinates(){Array<Coordinate>}

geom/LineString.js, line 189

Return the coordinates of the linestring.

Returns:

Coordinates.

getExtent(extent){Extent} inherited

geom/Geometry.js, line 185

Get the extent of the geometry.

Name	Type	Description
extent	Extent | undefined	Extent.

Returns:

extent Extent.

getFirstCoordinate(){Coordinate} inherited

geom/SimpleGeometry.js, line 69

Return the first coordinate of the geometry.

Returns:

First coordinate.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:

List of property names.

getLastCoordinate(){Coordinate} inherited

geom/SimpleGeometry.js, line 85

Return the last coordinate of the geometry.

Returns:

Last point.

getLayout(){GeometryLayout} inherited

geom/SimpleGeometry.js, line 96

Return the layout of the geometry.

Returns:

Layout.

getLength(){number}

geom/LineString.js, line 225

Return the length of the linestring on projected plane.

Returns:

Length (on projected plane).

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

Object.js, line 157

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited

Observable.js, line 79

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

Returns:

Revision.

getType(){Type}

geom/LineString.js, line 275

Get the type of this geometry.

Returns:

Geometry type.

intersectsCoordinate(coordinate){boolean} inherited

geom/Geometry.js, line 165

Returns true if this geometry includes the specified coordinate. If the coordinate is on the boundary of the geometry, returns false.

Name	Type	Description
coordinate	Coordinate	Coordinate.

Returns:

Contains coordinate.

intersectsExtent(extent){boolean}

geom/LineString.js, line 286

Test if the geometry and the passed extent intersect.

Name	Type	Description
extent	Extent	Extent.

Returns:

true if the geometry and the extent intersect.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

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.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

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.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

rotate(angle, anchor) inherited

geom/SimpleGeometry.js, line 228

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

Name	Type	Description
angle	number	Rotation angle in counter-clockwise radians.
anchor	Coordinate	The rotation center.

scale(sx, sy, anchor) inherited

geom/SimpleGeometry.js, line 255

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 | undefined	The scaling factor in the y-direction (defaults to sx).
anchor	Coordinate | undefined	The scale origin (defaults to the center of the geometry extent).

set(key, value, silent) inherited

Object.js, line 215

Sets a value.

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

setCoordinates(coordinates, layout)

geom/LineString.js, line 303

Set the coordinates of the linestring.

Name	Type	Description
coordinates	Array<Coordinate>	Coordinates.
layout	GeometryLayout | undefined	Layout.

setProperties(values, silent) inherited

Object.js, line 235

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

simplify(tolerance){Geometry} inherited

geom/Geometry.js, line 231

Create a simplified version of this geometry. For linestrings, this uses 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){this} inherited

geom/Geometry.js, line 306

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	ProjectionLike	The current projection. Can be a string identifier or a Projection object.
destination	ProjectionLike	The desired projection. Can be a string identifier or a Projection object.

Returns:

This geometry. Note that original geometry is modified in place.

translate(deltaX, deltaY) inherited

geom/SimpleGeometry.js, line 287

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

Observable.js, line 173

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.

unset(key, silent) inherited

Object.js, line 259

Unsets a property.

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