ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update function descriptions for clarity

Browse Source
This commit is contained in:
Otto Pellinen
2019-09-13 14:32:32 +03:00
committed by Olivier Guyot
parent 934ad5b882
commit 175695f877
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/interaction/Draw.js
+8 -3
View File
@@ -903,9 +903,9 @@ class Draw extends PointerInteraction {
} }
/** /**
* Extend the geometry that is being drawn, by appending the linear coordinates * Append the geometry that is currently being drawn with a copy of the
* given as the parameter to the coordinate array of currently drawn feature.. * linear coordinates given as the parameter.
* This can be used when drawing LineStrings or Polygons. Extending supports * This can be used when drawing LineStrings or Polygons. Appending supports
* only linear coordinates, such as the coordinates from a LineString * only linear coordinates, such as the coordinates from a LineString
* or a LinearRing of a Polygon. * or a LinearRing of a Polygon.
* @param {!LineCoordType} coordinateExtension Linear coordinates to be appended into * @param {!LineCoordType} coordinateExtension Linear coordinates to be appended into
@@ -949,6 +949,11 @@ class Draw extends PointerInteraction {
* Extend an existing geometry by adding additional points. This only works * Extend an existing geometry by adding additional points. This only works
* on features with `LineString` geometries, where the interaction will * on features with `LineString` geometries, where the interaction will
* extend lines by adding points to the end of the coordinates array. * extend lines by adding points to the end of the coordinates array.
* This will change the original feature, instead of drawing a copy.
*
* Extend can be used without having triggered the startDrawing_ function.
* The function will dispatch a DRAWSTART event.
*
* @param {!Feature<LineString>} feature Feature to be extended. * @param {!Feature<LineString>} feature Feature to be extended.
* @api * @api
*/ */