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

Merge pull request #2389 from openseadragon/ms-mousetracker-docs

Browse Source 
MouseTracker options docs fixes
This commit is contained in:
Ian Gilman 2023-08-01 09:33:12 -07:00 committed by GitHub
commit 4a3fc5b325
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.txt
View File

@ -7,6 +7,7 @@ OPENSEADRAGON CHANGELOG
* DEPRECATION: The OpenSeadragon.createCallback function is no longer recommended (#2367 @akansjain) * DEPRECATION: The OpenSeadragon.createCallback function is no longer recommended (#2367 @akansjain)
* Fixed: Sometimes if the viewport was flipped and the user zoomed in far enough, it would flip back (#2364 @SebDelile) * Fixed: Sometimes if the viewport was flipped and the user zoomed in far enough, it would flip back (#2364 @SebDelile)
* Test improvements (#2382 @AndrewADev) * Test improvements (#2382 @AndrewADev)
* MouseTracker options documentation fixes (#2389 @msalsbery)
4.1.0: 4.1.0:

8
src/mousetracker.js
View File

@ -57,16 +57,16 @@
* @param {Boolean} [options.startDisabled=false] * @param {Boolean} [options.startDisabled=false]
* If true, event tracking on the element will not start until * If true, event tracking on the element will not start until
* {@link OpenSeadragon.MouseTracker.setTracking|setTracking} is called. * {@link OpenSeadragon.MouseTracker.setTracking|setTracking} is called.
* @param {Number} options.clickTimeThreshold * @param {Number} [options.clickTimeThreshold=300]
* The number of milliseconds within which a pointer down-up event combination * The number of milliseconds within which a pointer down-up event combination
* will be treated as a click gesture. * will be treated as a click gesture.
* @param {Number} options.clickDistThreshold * @param {Number} [options.clickDistThreshold=5]
* The maximum distance allowed between a pointer down event and a pointer up event * The maximum distance allowed between a pointer down event and a pointer up event
* to be treated as a click gesture. * to be treated as a click gesture.
* @param {Number} options.dblClickTimeThreshold * @param {Number} [options.dblClickTimeThreshold=300]
* The number of milliseconds within which two pointer down-up event combinations * The number of milliseconds within which two pointer down-up event combinations
* will be treated as a double-click gesture. * will be treated as a double-click gesture.
* @param {Number} options.dblClickDistThreshold * @param {Number} [options.dblClickDistThreshold=20]
* The maximum distance allowed between two pointer click events * The maximum distance allowed between two pointer click events
* to be treated as a click gesture. * to be treated as a click gesture.
* @param {Number} [options.stopDelay=50] * @param {Number} [options.stopDelay=50]