From 85f08d1092217fcfbf85c5831dfb6cc180de3c4d Mon Sep 17 00:00:00 2001 From: Tom Payne Date: Sun, 2 Mar 2014 11:38:17 +0100 Subject: [PATCH] Add documentation to ol.geom.LineString#getCoordinateAtM --- src/ol/geom/linestring.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/ol/geom/linestring.js b/src/ol/geom/linestring.js index 35988047bb..989c9c88bb 100644 --- a/src/ol/geom/linestring.js +++ b/src/ol/geom/linestring.js @@ -81,6 +81,14 @@ ol.geom.LineString.prototype.closestPointXY = /** + * 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. + * * @param {number} m M. * @param {boolean=} opt_extrapolate Extrapolate. * @return {ol.Coordinate} Coordinate.