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

Added a note about preserveOverlays

Browse Source
This commit is contained in:
Ian Gilman 2015-01-12 14:22:10 -08:00
parent 00edbe565a
commit 83b7d7597a
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/openseadragon.js
View File

@ -515,15 +515,17 @@
* *
* @property {Boolean} [preserveViewport=false] * @property {Boolean} [preserveViewport=false]
* If the viewer has been configured with a sequence of tile sources, then * If the viewer has been configured with a sequence of tile sources, then
* normally navigating to through each image resets the viewport to 'home' * normally navigating through each image resets the viewport to 'home'
* position. If preserveViewport is set to true, then the viewport position * position. If preserveViewport is set to true, then the viewport position
* is preserved when navigating between images in the sequence. * is preserved when navigating between images in the sequence.
* *
* @property {Boolean} [preserveOverlays=false] * @property {Boolean} [preserveOverlays=false]
* If the viewer has been configured with a sequence of tile sources, then * If the viewer has been configured with a sequence of tile sources, then
* normally navigating to through each image resets the overlays. * normally navigating through each image resets the overlays.
* If preserveOverlays is set to true, then the overlays * If preserveOverlays is set to true, then the overlays
* are preserved when navigating between images in the sequence. * are preserved when navigating between images in the sequence.
* Note: setting preserveOverlays overrides any overlays specified in the
* "overlays" property.
* *
* @property {Boolean} [showReferenceStrip=false] * @property {Boolean} [showReferenceStrip=false]
* If the viewer has been configured with a sequence of tile sources, then * If the viewer has been configured with a sequence of tile sources, then