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

added documentation to getConstrainedBounds

Browse Source
This commit is contained in:
Tom 2022-12-02 18:46:57 -05:00
parent ac18d5629d
commit aede32c335
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/viewport.js
View File

@ -616,7 +616,7 @@ $.Viewport.prototype = {
* @function
* @param {Boolean} [immediately=false]
* @returns {OpenSeadragon.Viewport} Chainable.
* @fires OpenSeadragon.Viewer.event:constrain
* @fires OpenSeadragon.Viewer.event:constrain if the
*/
applyConstraints: function(immediately) {
var actualZoom = this.getZoom();
@ -627,10 +627,10 @@ $.Viewport.prototype = {
}
var constrainedBounds = this.getConstrainedBounds(false);
this._raiseConstraintsEvent(immediately);
if(constrainedBounds.constraintApplied){
this.fitBounds(constrainedBounds, immediately);
this._raiseConstraintsEvent(immediately);
}
return this;
@ -794,7 +794,9 @@ $.Viewport.prototype = {
* Returns bounds taking constraints into account
* Added to improve constrained panning
* @param {Boolean} current - Pass true for the current location; defaults to false (target location).
* @returns {OpenSeadragon.Viewport} Chainable.
* @returns {OpenSeadragon.Rect} The bounds after applying constraints. The returned $.Rect contains additonal
* properties xConstrained, yConstrained, constraintsApplied indicating the status
* of the constraining operation; x and y are in the viewer element coordinate system.
*/
getConstrainedBounds: function(current) {
var bounds,