Update clipsegment documentation

Per the tests here (https://github.com/Leaflet/Leaflet/blob/master/spec/suites/geometry/LineUtilSpec.js), and the implementation, clipSegement no longer modifies the points in place.
This commit is contained in:
Peter Wilczynski 2016-02-24 09:26:48 -08:00
parent 2bc8a8b762
commit 0c99f08c8b

View File

@ -5517,9 +5517,9 @@ MyClass.FOO; // 'bar'</code></pre>
<nobr>&lt;<a href="#bounds">Bounds</a>&gt; <i>bounds</i> )</nobr> <nobr>&lt;<a href="#bounds">Bounds</a>&gt; <i>bounds</i> )</nobr>
</code></td> </code></td>
<td><code>-</code></td> <td><code><a href="#point">Point</a>[]</code></td>
<td>Clips the segment <code>a</code> to <code>b</code> by rectangular bounds (modifying the segment points directly!). Used by Leaflet to only show polyline points that are on the screen or near, increasing performance.</td> <td>Clips the segment <code>a</code> to <code>b</code> by rectangular bounds. Returns either false or an array of clipped points. Used by Leaflet to only show polyline points that are on the screen or near, increasing performance.</td>
</tr> </tr>
</table> </table>