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

add clarifications to api docs for TiledImage

Browse Source
This commit is contained in:
Rob Hicks 2017-10-25 14:51:17 -06:00
parent 557ff005a2
commit 12e1869f99
2 changed files with 6 additions and 4 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. * use {@link OpenSeadragon.Viewer#open} or {@link OpenSeadragon.Viewer#addTiledImage} instead.
* @class TiledImage * @class TiledImage
* @memberof OpenSeadragon * @memberof OpenSeadragon
* @extends OpenSeadragon.EventSource * @extends OpenSeadragon.EventSource

6
src/viewer.js
View File

@ -487,7 +487,9 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
* is the same as the options parameter for {@link OpenSeadragon.Viewer#addTiledImage}, * is the same as the options parameter for {@link OpenSeadragon.Viewer#addTiledImage},
* except for the index property; images are added in sequence. * except for the index property; images are added in sequence.
* A TileSource specifier is anything you could pass as the tileSource property * A TileSource specifier is anything you could pass as the tileSource property
* of the options parameter for {@link OpenSeadragon.Viewer#addTiledImage}. * 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, i.e., viewer.world.getItemAt(0).
* @param {Number} initialPage - If sequenceMode is true, display this page initially * @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. * for the given tileSources. If specified, will overwrite the Viewer's existing initialPage property.
* @return {OpenSeadragon.Viewer} Chainable. * @return {OpenSeadragon.Viewer} Chainable.
@ -1263,7 +1265,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.