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

Merge pull request #1479 from alanaberdeen/master

Browse Source 
Documentation addition for viewer.world
This commit is contained in:
Ian Gilman 2018-06-15 13:26:04 -07:00 committed by GitHub
commit 0043956e2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/tiledimage.js
View File

@ -85,7 +85,11 @@
*/ */
$.TiledImage = function( options ) { $.TiledImage = function( options ) {
var _this = this; var _this = this;
/**
* The {@link OpenSeadragon.TileSource} that defines this TiledImage.
* @member {OpenSeadragon.TileSource} source
* @memberof OpenSeadragon.TiledImage#
*/
$.console.assert( options.tileCache, "[TiledImage] options.tileCache is required" ); $.console.assert( options.tileCache, "[TiledImage] options.tileCache is required" );
$.console.assert( options.drawer, "[TiledImage] options.drawer is required" ); $.console.assert( options.drawer, "[TiledImage] options.drawer is required" );
$.console.assert( options.viewer, "[TiledImage] options.viewer is required" ); $.console.assert( options.viewer, "[TiledImage] options.viewer is required" );

7
src/viewer.js
View File

@ -145,6 +145,8 @@ $.Viewer = function( options ) {
//These are originally not part options but declared as members //These are originally not part options but declared as members
//in initialize. It's still considered idiomatic to put them here //in initialize. It's still considered idiomatic to put them here
//source is here for backwards compatibility. It is not an official
//part of the API and should not be relied upon.
source: null, source: null,
/** /**
* Handles rendering of tiles in the viewer. Created for each TileSource opened. * Handles rendering of tiles in the viewer. Created for each TileSource opened.
@ -152,6 +154,11 @@ $.Viewer = function( options ) {
* @memberof OpenSeadragon.Viewer# * @memberof OpenSeadragon.Viewer#
*/ */
drawer: null, drawer: null,
/**
* Keeps track of all of the tiled images in the scene.
* @member {OpenSeadragon.Drawer} world
* @memberof OpenSeadragon.Viewer#
*/
world: null, world: null,
/** /**
* Handles coordinate-related functionality - zoom, pan, rotation, etc. Created for each TileSource opened. * Handles coordinate-related functionality - zoom, pan, rotation, etc. Created for each TileSource opened.