mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-23 05:36:09 +03:00
Code Issues Projects Releases Wiki Activity

Documented "current" param to a number of viewport functions

Browse Source
This commit is contained in:
Ian Gilman 2013-08-19 10:14:04 -07:00
parent 17ef51e309
commit 4b0450d271
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/viewport.js
View File

@ -217,6 +217,7 @@ $.Viewport.prototype = {
/** /**
* @function * @function
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
*/ */
getBounds: function( current ) { getBounds: function( current ) {
var center = this.getCenter( current ), var center = this.getCenter( current ),
@ -233,6 +234,7 @@ $.Viewport.prototype = {
/** /**
* @function * @function
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
*/ */
getCenter: function( current ) { getCenter: function( current ) {
var centerCurrent = new $.Point( var centerCurrent = new $.Point(
@ -283,6 +285,7 @@ $.Viewport.prototype = {
/** /**
* @function * @function
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
*/ */
getZoom: function( current ) { getZoom: function( current ) {
if ( current ) { if ( current ) {
@ -632,6 +635,7 @@ $.Viewport.prototype = {
/** /**
* @function * @function
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
*/ */
deltaPixelsFromPoints: function( deltaPoints, current ) { deltaPixelsFromPoints: function( deltaPoints, current ) {
return deltaPoints.times( return deltaPoints.times(
@ -641,6 +645,7 @@ $.Viewport.prototype = {
/** /**
* @function * @function
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
*/ */
deltaPointsFromPixels: function( deltaPixels, current ) { deltaPointsFromPixels: function( deltaPixels, current ) {
return deltaPixels.divide( return deltaPixels.divide(
@ -650,6 +655,7 @@ $.Viewport.prototype = {
/** /**
* @function * @function
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
*/ */
pixelFromPoint: function( point, current ) { pixelFromPoint: function( point, current ) {
var bounds = this.getBounds( current ); var bounds = this.getBounds( current );
@ -662,6 +668,7 @@ $.Viewport.prototype = {
/** /**
* @function * @function
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
*/ */
pointFromPixel: function( pixel, current ) { pointFromPixel: function( pixel, current ) {
var bounds = this.getBounds( current ); var bounds = this.getBounds( current );