Merge pull request #2563 from openseadragon/ms-pixelDensityRatio-docs

JSDoc comments for OpenSeadragon.getCurrentPixelDensityRatio
This commit is contained in:
Ian Gilman 2024-08-05 09:26:18 -07:00 committed by GitHub
commit d4c9b601c8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1069,8 +1069,9 @@ function OpenSeadragon( options ){
/** /**
* A ratio comparing the device screen's pixel density to the canvas's backing store pixel density, * A ratio comparing the device screen's pixel density to the canvas's backing store pixel density,
* clamped to a minimum of 1. Defaults to 1 if canvas isn't supported by the browser. * clamped to a minimum of 1. Defaults to 1 if canvas isn't supported by the browser.
* @member {Number} pixelDensityRatio * @function getCurrentPixelDensityRatio
* @memberof OpenSeadragon * @memberof OpenSeadragon
* @returns {Number}
*/ */
$.getCurrentPixelDensityRatio = function() { $.getCurrentPixelDensityRatio = function() {
if ( $.supportsCanvas ) { if ( $.supportsCanvas ) {
@ -1088,6 +1089,8 @@ function OpenSeadragon( options ){
}; };
/** /**
* A ratio comparing the device screen's pixel density to the canvas's backing store pixel density,
* clamped to a minimum of 1. Defaults to 1 if canvas isn't supported by the browser.
* @member {Number} pixelDensityRatio * @member {Number} pixelDensityRatio
* @memberof OpenSeadragon * @memberof OpenSeadragon
*/ */