mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-21 20:56:09 +03:00
Code Issues Projects Releases Wiki Activity

1540 Update documentation for setCroppingPolygons

Browse Source
This commit is contained in:
zero41120 2020-02-10 16:19:09 -08:00
parent 9d0c7bd9c9
commit ff70878bb9
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/tiledimage.js
View File

@ -677,14 +677,12 @@ $.extend($.TiledImage.prototype, $.EventSource.prototype, /** @lends OpenSeadrag
/**
* Sets an array of polygons to crop the TiledImage during draw tiles.
* The render function will use the default non-zero winding rule.
* @param Polygons represented in an array of pair array or point object in pixels.
* @param Polygons represented in an array of point object in pixels.
* Example format: [
* [[197,172],[226,172],[226,198],[197,198]], // First polygon
* [[328,200],[330,199],[332,201],[329,202]] // Second polygon
* [{x: 197, y:172}, {x: 226, y:172}, {x: 226, y:198}, {x: 197, y:198}], // First polygon
* [{x: 328, y:200}, {x: 330, y:199}, {x: 332, y:201}, {x: 329, y:202}] // Second polygon
* [{x: 321, y:201}, {x: 356, y:205}, {x: 341, y:250}] // Third polygon
* ]
* Argument may mix array and point objects.
* Point objects will be convert to array.
*/
setCroppingPolygons: function( polygons ) {