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.
This commit is contained in:
Alan Aberdeen 2018-06-14 21:50:45 +01:00
parent 2a67484358
commit a691fbb37e

View File

@ -145,11 +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
* The {@link OpenSeadragon.TileSource} that defines the TiledImage. //part of the API and should not be relied upon.
* @member {OpenSeadragon.TileSource} source
* @memberof OpenSeadragon.Viewer#
*/
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.