From 4b0450d271a47acb89a0fe2f2bb5820fa95b132e Mon Sep 17 00:00:00 2001 From: Ian Gilman Date: Mon, 19 Aug 2013 10:14:04 -0700 Subject: [PATCH] Documented "current" param to a number of viewport functions --- src/viewport.js | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/viewport.js b/src/viewport.js index e4c0ffa0..a0a7bda8 100644 --- a/src/viewport.js +++ b/src/viewport.js @@ -217,6 +217,7 @@ $.Viewport.prototype = { /** * @function + * @param {Boolean} current - Pass true for the current location; defaults to false (target location). */ getBounds: function( current ) { var center = this.getCenter( current ), @@ -233,6 +234,7 @@ $.Viewport.prototype = { /** * @function + * @param {Boolean} current - Pass true for the current location; defaults to false (target location). */ getCenter: function( current ) { var centerCurrent = new $.Point( @@ -283,6 +285,7 @@ $.Viewport.prototype = { /** * @function + * @param {Boolean} current - Pass true for the current location; defaults to false (target location). */ getZoom: function( current ) { if ( current ) { @@ -632,6 +635,7 @@ $.Viewport.prototype = { /** * @function + * @param {Boolean} current - Pass true for the current location; defaults to false (target location). */ deltaPixelsFromPoints: function( deltaPoints, current ) { return deltaPoints.times( @@ -641,6 +645,7 @@ $.Viewport.prototype = { /** * @function + * @param {Boolean} current - Pass true for the current location; defaults to false (target location). */ deltaPointsFromPixels: function( deltaPixels, current ) { return deltaPixels.divide( @@ -650,6 +655,7 @@ $.Viewport.prototype = { /** * @function + * @param {Boolean} current - Pass true for the current location; defaults to false (target location). */ pixelFromPoint: function( point, current ) { var bounds = this.getBounds( current ); @@ -662,6 +668,7 @@ $.Viewport.prototype = { /** * @function + * @param {Boolean} current - Pass true for the current location; defaults to false (target location). */ pointFromPixel: function( pixel, current ) { var bounds = this.getBounds( current );