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

Merge pull request #1332 from robhicks/master

Browse Source 
Doc clarification for getting instance of TitledImage
This commit is contained in:
Ian Gilman 2017-10-30 09:13:47 -07:00 committed by GitHub
commit 324ed1f045
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/tiledimage.js
View File

@ -35,8 +35,8 @@
(function( $ ){ (function( $ ){
/** /**
* You shouldn't have to create a TiledImage directly; use {@link OpenSeadragon.Viewer#open} * You shouldn't have to create a TiledImage instance directly; get it asynchronously by
* or {@link OpenSeadragon.Viewer#addTiledImage} instead. * using {@link OpenSeadragon.Viewer#open} or {@link OpenSeadragon.Viewer#addTiledImage} instead.
* @class TiledImage * @class TiledImage
* @memberof OpenSeadragon * @memberof OpenSeadragon
* @extends OpenSeadragon.EventSource * @extends OpenSeadragon.EventSource

5
src/viewer.js
View File

@ -481,6 +481,9 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
/** /**
* Open tiled images into the viewer, closing any others. * 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 * @function
* @param {Array|String|Object|Function} tileSources - This can be a TiledImage * @param {Array|String|Object|Function} tileSources - This can be a TiledImage
* specifier, a TileSource specifier, or an array of either. A TiledImage specifier * specifier, a TileSource specifier, or an array of either. A TiledImage specifier
@ -1263,7 +1266,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
* requests. * requests.
* @param {Function} [options.success] A function that gets called when the image is * @param {Function} [options.success] A function that gets called when the image is
* successfully added. It's passed the event object which contains a single property: * successfully added. It's passed the event object which contains a single property:
* "item", the resulting TiledImage. * "item", which is the resulting instance of TiledImage.
* @param {Function} [options.error] A function that gets called if the image is * @param {Function} [options.error] A function that gets called if the image is
* unable to be added. It's passed the error event object, which contains "message" * unable to be added. It's passed the error event object, which contains "message"
* and "source" properties. * and "source" properties.