diff --git a/src/viewer.js b/src/viewer.js index 272e5fe3..a5c7365a 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -481,15 +481,16 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, /** * Open tiled images into the viewer, closing any others. + * To get the TiledImage instance created by open, add an event listener for + * {@link OpenSeadragon.Viewer.html#.event:open}, which when fired can be used to get access + * to the instance, i.e., viewer.world.getItemAt(0). * @function * @param {Array|String|Object|Function} tileSources - This can be a TiledImage * specifier, a TileSource specifier, or an array of either. A TiledImage specifier * is the same as the options parameter for {@link OpenSeadragon.Viewer#addTiledImage}, * except for the index property; images are added in sequence. * A TileSource specifier is anything you could pass as the tileSource property - * of the options parameter for {@link OpenSeadragon.Viewer#addTiledImage}. To get the TiledImage - * instance created by open, add an event listener for {@link OpenSeadragon.Viewer.html#.event:open}, which - * when fired can be used to get access to the instance, i.e., viewer.world.getItemAt(0). + * of the options parameter for {@link OpenSeadragon.Viewer#addTiledImage}. * @param {Number} initialPage - If sequenceMode is true, display this page initially * for the given tileSources. If specified, will overwrite the Viewer's existing initialPage property. * @return {OpenSeadragon.Viewer} Chainable.