From f018059b600b686804a1cb4c2f41e68f4a446e5b Mon Sep 17 00:00:00 2001 From: Ian Gilman Date: Mon, 17 Nov 2014 11:50:20 -0800 Subject: [PATCH] Docs for sequence mode --- changelog.txt | 1 + src/openseadragon.js | 21 ++++++++++++--------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/changelog.txt b/changelog.txt index 8b7a991c..4b4eb7d2 100644 --- a/changelog.txt +++ b/changelog.txt @@ -4,6 +4,7 @@ OPENSEADRAGON CHANGELOG 2.0.0: (in progress) * True multi-image mode (#450) + * BREAKING CHANGE: Passing an array for the tileSources option is no longer enough to trigger sequence mode; you have to set the sequenceMode option to true as well * BREAKING CHANGE: Navigator no longer sends an open event when its viewer opens * BREAKING CHANGE: Viewer.drawers and Viewer.drawersContainer no longer exist * BREAKING CHANGE: A Viewer's Drawer and Viewport are now made once per Viewer and reused for every image that Viewer opens (rather than being recreated for every open); this means if you change Viewer options between opens, the behavior is different now. diff --git a/src/openseadragon.js b/src/openseadragon.js index 70aeca84..5a40c560 100644 --- a/src/openseadragon.js +++ b/src/openseadragon.js @@ -446,8 +446,8 @@ * this setting when set to false. * * @property {Boolean} [showSequenceControl=true] - * If the viewer has been configured with a sequence of tile sources, then - * provide buttons for navigating forward and backward through the images. + * If sequenceMode is true, then provide buttons for navigating forward and + * backward through the images. * * @property {OpenSeadragon.ControlAnchor} [sequenceControlAnchor=TOP_LEFT] * Placement of the default sequence controls. @@ -505,18 +505,21 @@ * To only change the button images, consider using * {@link OpenSeadragon.Options.navImages} * + * @property {Boolean} [sequenceMode=false] + * Set to true to have the viewer treat your tilesources as a sequence of images to + * be opened one at a time rather than all at once. + * * @property {Number} [initialPage=0] - * If the viewer has been configured with a sequence of tile sources, display this page initially. + * If sequenceMode is true, display this page initially. * * @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' - * position. If preserveViewport is set to true, then the viewport position - * is preserved when navigating between images in the sequence. + * If sequenceMode is true, then normally navigating to 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} [showReferenceStrip=false] - * If the viewer has been configured with a sequence of tile sources, then - * display a scrolling strip of image thumbnails for navigating through the images. + * If sequenceMode is true, then display a scrolling strip of image thumbnails for + * navigating through the images. * * @property {String} [referenceStripScroll='horizontal'] *