From 83b7d7597ac7c74422d23f16c94ad2dc287db15c Mon Sep 17 00:00:00 2001 From: Ian Gilman Date: Mon, 12 Jan 2015 14:22:10 -0800 Subject: [PATCH] Added a note about preserveOverlays --- src/openseadragon.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/openseadragon.js b/src/openseadragon.js index e1a37e2f..27d3262c 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -515,15 +515,17 @@ * * @property {Boolean} [preserveViewport=false] * 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 * is preserved when navigating between images in the sequence. * * @property {Boolean} [preserveOverlays=false] * 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 * are preserved when navigating between images in the sequence. + * Note: setting preserveOverlays overrides any overlays specified in the + * "overlays" property. * * @property {Boolean} [showReferenceStrip=false] * If the viewer has been configured with a sequence of tile sources, then