From 1024a2e1d890504a0b33fed003df9f13943cd8a5 Mon Sep 17 00:00:00 2001 From: Alan Aberdeen Date: Wed, 13 Jun 2018 12:32:10 +0100 Subject: [PATCH 1/6] Documentation addition for viewer.world --- src/viewer.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/viewer.js b/src/viewer.js index 6092aedb..30111581 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -152,6 +152,11 @@ $.Viewer = function( options ) { * @memberof OpenSeadragon.Viewer# */ drawer: null, + /** + * Keeps track of all of the tiled images in the scene. + * @member {OpenSeadragon.Drawer} world + * @memberof OpenSeadragon.Viewer# + */ world: null, /** * Handles coordinate-related functionality - zoom, pan, rotation, etc. Created for each TileSource opened. From 002c1fcc6553a16f090d3cabd6d2a9e8a96016ad Mon Sep 17 00:00:00 2001 From: Alan Aberdeen Date: Wed, 13 Jun 2018 20:11:26 +0100 Subject: [PATCH 2/6] Add documentation for .source on TiledImage --- src/tiledimage.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/tiledimage.js b/src/tiledimage.js index cc2c32d3..6fb68413 100644 --- a/src/tiledimage.js +++ b/src/tiledimage.js @@ -85,7 +85,11 @@ */ $.TiledImage = function( options ) { 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.drawer, "[TiledImage] options.drawer is required" ); $.console.assert( options.viewer, "[TiledImage] options.viewer is required" ); From 99b7c3d2e592c667cc3add4993f2ba953f13b5d3 Mon Sep 17 00:00:00 2001 From: Alan Aberdeen Date: Wed, 13 Jun 2018 20:15:51 +0100 Subject: [PATCH 3/6] Add documentation for source on Viewer --- src/viewer.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/viewer.js b/src/viewer.js index 30111581..200a18a5 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -145,6 +145,11 @@ $.Viewer = function( options ) { //These are originally not part options but declared as members //in initialize. It's still considered idiomatic to put them here + /** + * The {@link OpenSeadragon.TileSource} that defines the TiledImage. + * @member {OpenSeadragon.TileSource} source + * @memberof OpenSeadragon.TiledImage# + */ source: null, /** * Handles rendering of tiles in the viewer. Created for each TileSource opened. From 0c4eafb66946296a36d2cac1c9aefdd936d216bb Mon Sep 17 00:00:00 2001 From: Alan Aberdeen Date: Wed, 13 Jun 2018 20:25:00 +0100 Subject: [PATCH 4/6] Revert "Add documentation for source on Viewer" This reverts commit 99b7c3d2e592c667cc3add4993f2ba953f13b5d3. --- src/viewer.js | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/viewer.js b/src/viewer.js index 200a18a5..30111581 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -145,11 +145,6 @@ $.Viewer = function( options ) { //These are originally not part options but declared as members //in initialize. It's still considered idiomatic to put them here - /** - * The {@link OpenSeadragon.TileSource} that defines the TiledImage. - * @member {OpenSeadragon.TileSource} source - * @memberof OpenSeadragon.TiledImage# - */ source: null, /** * Handles rendering of tiles in the viewer. Created for each TileSource opened. From 2a674843589456c63d06efc10aa5510714670ff7 Mon Sep 17 00:00:00 2001 From: Alan Aberdeen Date: Wed, 13 Jun 2018 20:27:57 +0100 Subject: [PATCH 5/6] Add *correct* documentation for source on Viewer --- src/viewer.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/viewer.js b/src/viewer.js index 30111581..6327452d 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -145,6 +145,11 @@ $.Viewer = function( options ) { //These are originally not part options but declared as members //in initialize. It's still considered idiomatic to put them here + /** + * The {@link OpenSeadragon.TileSource} that defines the TiledImage. + * @member {OpenSeadragon.TileSource} source + * @memberof OpenSeadragon.Viewer# + */ source: null, /** * Handles rendering of tiles in the viewer. Created for each TileSource opened. From a691fbb37e89b8ea6b2d61531476cab327462583 Mon Sep 17 00:00:00 2001 From: Alan Aberdeen Date: Thu, 14 Jun 2018 21:50:45 +0100 Subject: [PATCH 6/6] Add note that source in viewer.js is depreciated source is in viewer.js for backwards compatibility. It is not an official part of the API and should not be relied upon. --- src/viewer.js | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/viewer.js b/src/viewer.js index 6327452d..40373863 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -145,11 +145,8 @@ $.Viewer = function( options ) { //These are originally not part options but declared as members //in initialize. It's still considered idiomatic to put them here - /** - * The {@link OpenSeadragon.TileSource} that defines the TiledImage. - * @member {OpenSeadragon.TileSource} source - * @memberof OpenSeadragon.Viewer# - */ + //source is here for backwards compatibility. It is not an official + //part of the API and should not be relied upon. source: null, /** * Handles rendering of tiles in the viewer. Created for each TileSource opened.