diff --git a/src/button.js b/src/button.js index 1cc819ef..546958f1 100644 --- a/src/button.js +++ b/src/button.js @@ -187,7 +187,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "enter", { originalEvent: event.originalEvent } ); } else if ( !event.buttonDownAny ) { @@ -203,7 +203,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "focus", { originalEvent: event.originalEvent } ); }, @@ -217,7 +217,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "exit", { originalEvent: event.originalEvent } ); } @@ -231,7 +231,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "blur", { originalEvent: event.originalEvent } ); }, @@ -244,7 +244,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "press", { originalEvent: event.originalEvent } ); }, @@ -258,7 +258,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "release", { originalEvent: event.originalEvent } ); } else if ( event.insideElementPressed ) { @@ -276,7 +276,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent("click", { originalEvent: event.originalEvent }); } @@ -291,7 +291,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "click", { originalEvent: event.originalEvent } ); /*** @@ -300,7 +300,7 @@ $.Button = function( options ) { * @type {object} * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( "release", { originalEvent: event.originalEvent } ); return false; diff --git a/src/drawer.js b/src/drawer.js index 85ae741b..5999d18e 100644 --- a/src/drawer.js +++ b/src/drawer.js @@ -208,7 +208,7 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{ * @property {Element} element * @property {OpenSeadragon.Point|OpenSeadragon.Rect} location * @property {OpenSeadragon.OverlayPlacement} placement - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'add-overlay', { element: element, @@ -249,7 +249,7 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{ * @property {Element} element * @property {OpenSeadragon.Point|OpenSeadragon.Rect} location * @property {OpenSeadragon.OverlayPlacement} placement - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'update-overlay', { element: element, @@ -286,7 +286,7 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{ * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Element} element - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'remove-overlay', { element: element @@ -312,7 +312,7 @@ $.Drawer.prototype = /** @lends OpenSeadragon.Drawer.prototype */{ * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'clear-overlay', {} ); } @@ -512,7 +512,7 @@ function updateViewport( drawer ) { * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ drawer.viewer.raiseEvent( 'update-viewport', {} ); } @@ -701,7 +701,7 @@ function updateLevel( drawer, haveDrawn, drawLevel, level, levelOpacity, levelVi * @property {Object} bottomright * @property {Object} currenttime * @property {Object} best - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ drawer.viewer.raiseEvent( 'update-level', { havedrawn: haveDrawn, @@ -772,7 +772,7 @@ function updateTile( drawer, drawLevel, haveDrawn, x, y, level, levelOpacity, le * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Object} tile - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ drawer.viewer.raiseEvent( 'update-tile', { tile: tile @@ -1294,7 +1294,7 @@ function drawTiles( drawer, lastDrawn ){ * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Object} tile - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ drawer.viewer.raiseEvent( 'tile-drawn', { tile: tile diff --git a/src/mousetracker.js b/src/mousetracker.js index 95012f85..596ad166 100644 --- a/src/mousetracker.js +++ b/src/mousetracker.js @@ -244,8 +244,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -269,8 +269,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -289,8 +289,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -314,8 +314,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -334,8 +334,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -358,8 +358,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -382,8 +382,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -406,8 +406,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -426,8 +426,8 @@ * True if the original event is a touch event, otherwise false. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -446,8 +446,8 @@ * True if the shift key was pressed during this event. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -462,8 +462,8 @@ * A reference to the tracker instance. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ @@ -478,8 +478,8 @@ * A reference to the tracker instance. * @param {Object} event.originalEvent * The original event object. - * @param {Boolean} [event.preventDefaultAction=false] - * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). + * @param {Boolean} event.preventDefaultAction + * Set to true to prevent the tracker subscriber from performing its default action (subscriber implementation dependent). Default: false. * @param {Object} event.userData * Arbitrary user-defined object. */ diff --git a/src/tilesource.js b/src/tilesource.js index 58d13718..adadf97f 100644 --- a/src/tilesource.js +++ b/src/tilesource.js @@ -305,7 +305,7 @@ $.TileSource.prototype = /** @lends OpenSeadragon.TileSource.prototype */{ * @property {OpenSeadragon.TileSource} eventSource - A reference to the TileSource which raised the event. * @property {String} message * @property {String} source - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'open-failed', { message: "Unable to load TileSource", source: url } ); return; @@ -320,7 +320,7 @@ $.TileSource.prototype = /** @lends OpenSeadragon.TileSource.prototype */{ * @type {object} * @property {OpenSeadragon.TileSource} eventSource - A reference to the TileSource which raised the event. * @property {Object} tileSource - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'ready', { tileSource: readySource } ); }; @@ -369,7 +369,7 @@ $.TileSource.prototype = /** @lends OpenSeadragon.TileSource.prototype */{ * @property {OpenSeadragon.TileSource} eventSource - A reference to the TileSource which raised the event. * @property {String} message * @property {String} source - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'open-failed', { message: msg, diff --git a/src/viewer.js b/src/viewer.js index 577b112a..d7965559 100644 --- a/src/viewer.js +++ b/src/viewer.js @@ -476,7 +476,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {String} message * @property {String} source - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'open-failed', event ); }); @@ -498,7 +498,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {String} message * @property {String} source - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'open-failed', { message: "Unable to load TileSource", @@ -556,7 +556,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'close' ); @@ -628,7 +628,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Boolean} enabled - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'mouse-enabled', { enabled: enabled } ); return this; @@ -670,7 +670,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Boolean} enabled - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'controls-enabled', { enabled: enabled } ); return this; @@ -720,8 +720,8 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Boolean} fullPage - True if entering full-page mode, false if exiting full-page mode. - * @property {Boolean} preventDefaultAction - Set to true to prevent full-page mode change. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {Boolean} preventDefaultAction - Set to true to prevent full-page mode change. Default: false. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'pre-full-page', fullPageEventArgs ); if ( fullPageEventArgs.preventDefaultAction ) { @@ -874,7 +874,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Boolean} fullPage - True if changed to full-page mode, false if exited full-page mode. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'full-page', { fullPage: fullPage } ); @@ -910,8 +910,8 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Boolean} fullScreen - True if entering full-screen mode, false if exiting full-screen mode. - * @property {Boolean} preventDefaultAction - Set to true to prevent full-screen mode change. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {Boolean} preventDefaultAction - Set to true to prevent full-screen mode change. Default: false. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'pre-full-screen', fullScreeEventArgs ); if ( fullScreeEventArgs.preventDefaultAction ) { @@ -950,7 +950,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Boolean} fullScreen - True if changed to full-screen mode, false if exited full-screen mode. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'full-screen', { fullScreen: isFullScreen } ); }; @@ -989,7 +989,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Boolean} visible - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'visible', { visible: visible } ); return this; @@ -1228,7 +1228,7 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {Object} page - The page changed to (1-based). - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'page', { page: page } ); @@ -1505,7 +1505,7 @@ function openTileSource( viewer, source ) { * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. * @property {OpenSeadragon.TileSource} source - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ _this.raiseEvent( 'open', { source: source } ); @@ -1622,7 +1622,7 @@ function onCanvasClick( event ) { * @property {Boolean} quick - True only if the clickDistThreshold and clickDeltaThreshold are both passed. Useful for differentiating between clicks and drags. * @property {Boolean} shift - True if the shift key was pressed during this event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'canvas-click', { tracker: event.eventSource, @@ -1660,7 +1660,7 @@ function onCanvasDrag( event ) { * @property {OpenSeadragon.Point} delta - The x,y components of the difference between start drag and end drag. * @property {Boolean} shift - True if the shift key was pressed during this event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'canvas-drag', { tracker: event.eventSource, @@ -1685,7 +1685,7 @@ function onCanvasRelease( event ) { * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. * @property {Boolean} insideElementReleased - True if the cursor still inside the tracked element when the button was released. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'canvas-release', { tracker: event.eventSource, @@ -1716,7 +1716,7 @@ function onCanvasScroll( event ) { * @property {Number} scroll - The scroll delta for the event. * @property {Boolean} shift - True if the shift key was pressed during this event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'canvas-scroll', { tracker: event.eventSource, @@ -1746,7 +1746,7 @@ function onContainerExit( event ) { * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. * @property {Boolean} buttonDownAny - Was the button down anywhere in the screen during the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'container-exit', { tracker: event.eventSource, @@ -1774,7 +1774,7 @@ function onContainerRelease( event ) { * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. * @property {Boolean} insideElementReleased - True if the cursor still inside the tracked element when the button was released. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'container-release', { tracker: event.eventSource, @@ -1798,7 +1798,7 @@ function onContainerEnter( event ) { * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. * @property {Boolean} buttonDownAny - Was the button down anywhere in the screen during the event. * @property {Object} originalEvent - The original DOM event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.raiseEvent( 'container-enter', { tracker: event.eventSource, @@ -1861,7 +1861,7 @@ function updateOnce( viewer ) { * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ viewer.raiseEvent( "animation-start" ); abortControlsAutoHide( viewer ); @@ -1877,7 +1877,7 @@ function updateOnce( viewer ) { * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ viewer.raiseEvent( "animation" ); } else if ( THIS[ viewer.hash ].forceRedraw || viewer.drawer.needsUpdate() ) { @@ -1894,7 +1894,7 @@ function updateOnce( viewer ) { * @memberof OpenSeadragon.Viewer * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ viewer.raiseEvent( "animation-finish" ); diff --git a/src/viewport.js b/src/viewport.js index 788aef13..3c48e1c5 100644 --- a/src/viewport.js +++ b/src/viewport.js @@ -128,7 +128,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{ * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. * @property {OpenSeadragon.Point} contentSize - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'reset-size', { contentSize: contentSize @@ -182,7 +182,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{ * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. * @property {Boolean} immediately - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'home', { immediately: immediately @@ -390,7 +390,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{ * @type {object} * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. * @property {Boolean} immediately - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'constrain', { immediately: immediately @@ -550,7 +550,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{ * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. * @property {OpenSeadragon.Point} center * @property {Boolean} immediately - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'pan', { center: center, @@ -602,7 +602,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{ * @property {Number} zoom * @property {OpenSeadragon.Point} refPoint * @property {Boolean} immediately - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'zoom', { zoom: zoom, @@ -673,7 +673,7 @@ $.Viewport.prototype = /** @lends OpenSeadragon.Viewport.prototype */{ * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. * @property {OpenSeadragon.Point} newContainerSize * @property {Boolean} maintain - * @property {Object} [userData=null] - Arbitrary subscriber-defined object. + * @property {?Object} userData - Arbitrary subscriber-defined object. */ this.viewer.raiseEvent( 'resize', { newContainerSize: newContainerSize,