Class: LineString

ol.geom. LineString

experimental new ol.geom.LineString(coordinates, opt_layout)

Name Type Description
coordinates ol.geom.RawLineString

Coordinates.

layout ol.geom.GeometryLayout | string

Layout.

Fires:
  • change

Extends

Methods

experimental appendCoordinate(coordinate)

Name Type Description
coordinate ol.Coordinate

Coordinate.

experimental inherited dispatchChangeEvent()

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:
  • change

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

Name Type Argument Description
point ol.Coordinate

Point.

closestPoint ol.Coordinate <optional>
optional

Closest point.

Returns:
point.

experimental getCoordinateAtM(m, opt_extrapolate){ol.Coordinate}

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 Argument Description
m number

M.

extrapolate boolean <optional>
optional

Extrapolate.

experimental getCoordinates(){ol.geom.RawLineString}

experimental inherited getExtent(opt_extent){ol.Extent}

Get the extent of the geometry.

Name Type Argument Description
extent ol.Extent <optional>
optional

Extent.

Returns:
Extent.

experimental inherited getFirstCoordinate(){ol.Coordinate}

Returns:
coordinate.

experimental inherited getLastCoordinate(){ol.Coordinate}

Returns:
point.

experimental getLength(){number}

experimental inherited getSimplifiedGeometry(squaredTolerance){ol.geom.Geometry}

Name Type Description
squaredTolerance number

Squared tolerance.

Returns:
geometry.
Returns:
type.

experimental inherited on(type, listener, opt_this){goog.events.Key}

Listen for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>
optional

The object to use as this in listener.

Returns:
key for the listener.

experimental inherited once(type, listener, opt_this){goog.events.Key}

Listen once for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>
optional

The object to use as this in listener.

Returns:
key for the listener.

experimental setCoordinates(coordinates, opt_layout)

Name Type Argument Description
coordinates ol.geom.RawLineString

Coordinates.

layout ol.geom.GeometryLayout <optional>
optional

Layout.

experimental inherited transform(transformFn)

Name Type Description
transformFn ol.TransformFunction

Transform.

experimental inherited un(type, listener, opt_this)

Unlisten for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>
optional

The object to use as this in listener.

experimental inherited unByKey(key)

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.