mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2025-01-19 17:21:50 +03:00
Code Issues Projects Releases Wiki Activity

Tweaked how the deprecated API element has handled

Browse Source
This commit is contained in:
houseofyin 2013-06-11 14:35:45 -04:00
parent 9edd6ec131
commit e9587808ec
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/control.js
View File

@ -54,9 +54,7 @@ $.ControlAnchor = {
* element. * element.
* @class * @class
* @param {Element} element - the control element to be anchored in the container. * @param {Element} element - the control element to be anchored in the container.
* @param {Object | OpenSeadragon.ControlAnchor } options - All required and optional settings for configuring a control element. A deprecated * @param {Object } options - All required and optional settings for configuring a control element.
* alternative to passing an object with properties is to just pass an OpenSeadragon.ControlAnchor. The target
* removal date for this deprecated alternative is December 2013.
* @param {OpenSeadragon.ControlAnchor} [options.anchor=OpenSeadragon.ControlAnchor.NONE] - the position of the control * @param {OpenSeadragon.ControlAnchor} [options.anchor=OpenSeadragon.ControlAnchor.NONE] - the position of the control
* relative to the container. * relative to the container.
* @param {Boolean} [options.attachToViewer=true] - Whether the control should be added directly to the viewer, or * @param {Boolean} [options.attachToViewer=true] - Whether the control should be added directly to the viewer, or
@ -76,9 +74,11 @@ $.ControlAnchor = {
*/ */
$.Control = function ( element, options, container ) { $.Control = function ( element, options, container ) {
var parent = element.parentNode; var parent = element.parentNode;
//Deprecated. Target removal date is December 2013
if (typeof options === 'number') if (typeof options === 'number')
{ {
$.console.error("Passing an anchor directly into the OpenSeadragon.Control constructor is deprecated; " +
"please use an options object instead. " +
"Support for this deprecated variant is scheduled for removal in December 2013");
options = {anchor: options}; options = {anchor: options};
} }
options.attachToViewer = (typeof options.attachToViewer === 'undefined') ? true : options.attachToViewer; options.attachToViewer = (typeof options.attachToViewer === 'undefined') ? true : options.attachToViewer;