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

Docs for sequence mode

Browse Source
This commit is contained in:
Ian Gilman 2014-11-17 11:50:20 -08:00
parent 1279c6766c
commit f018059b60
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.txt
View File

@ -4,6 +4,7 @@ OPENSEADRAGON CHANGELOG
2.0.0: (in progress) 2.0.0: (in progress)
* True multi-image mode (#450) * 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: Navigator no longer sends an open event when its viewer opens
* BREAKING CHANGE: Viewer.drawers and Viewer.drawersContainer no longer exist * 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. * 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.

21
src/openseadragon.js
View File

@ -446,8 +446,8 @@
* this setting when set to false. * this setting when set to false.
* *
* @property {Boolean} [showSequenceControl=true] * @property {Boolean} [showSequenceControl=true]
* If the viewer has been configured with a sequence of tile sources, then * If sequenceMode is true, then provide buttons for navigating forward and
* provide buttons for navigating forward and backward through the images. * backward through the images.
* *
* @property {OpenSeadragon.ControlAnchor} [sequenceControlAnchor=TOP_LEFT] * @property {OpenSeadragon.ControlAnchor} [sequenceControlAnchor=TOP_LEFT]
* Placement of the default sequence controls. * Placement of the default sequence controls.
@ -505,18 +505,21 @@
* To only change the button images, consider using * To only change the button images, consider using
* {@link OpenSeadragon.Options.navImages} * {@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] * @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] * @property {Boolean} [preserveViewport=false]
* If the viewer has been configured with a sequence of tile sources, then * If sequenceMode is true, then normally navigating to through each image resets the
* normally navigating to through each image resets the viewport to 'home' * viewport to 'home' position. If preserveViewport is set to true, then the viewport
* position. If preserveViewport is set to true, then the viewport position * position is preserved when navigating between images in the sequence.
* is preserved when navigating between images in the sequence.
* *
* @property {Boolean} [showReferenceStrip=false] * @property {Boolean} [showReferenceStrip=false]
* If the viewer has been configured with a sequence of tile sources, then * If sequenceMode is true, then display a scrolling strip of image thumbnails for
* display a scrolling strip of image thumbnails for navigating through the images. * navigating through the images.
* *
* @property {String} [referenceStripScroll='horizontal'] * @property {String} [referenceStripScroll='horizontal']
* *