mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-28 08:06:08 +03:00
Code Issues Projects Releases Wiki Activity

fix typo in docs. change to options object for requestDrawer API

Browse Source
This commit is contained in:
Tom 2024-02-22 13:30:05 -05:00
parent c6e3e06194
commit b6501a3786
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/viewer.js
View File

@ -456,7 +456,7 @@ $.Viewer = function( options ) {
this.drawer = null; this.drawer = null;
for (const drawerCandidate of drawerCandidates){ for (const drawerCandidate of drawerCandidates){
let success = this.requestDrawer(drawerCandidate, true, false); let success = this.requestDrawer(drawerCandidate, {mainDrawer: true, redrawImmediately: false});
if(success){ if(success){
break; break;
} }
@ -931,13 +931,24 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
/** /**
* Request a drawer for this viewer, as a supported string or drawer constructor. * Request a drawer for this viewer, as a supported string or drawer constructor.
* @param {String | OpenSeadragon.DrawerBase} drawerCandidate The type of drawer to try to construct. * @param {String | OpenSeadragon.DrawerBase} drawerCandidate The type of drawer to try to construct.
* @param { Boolean } [mainDrawer] Whether to use this as the viewer's main drawer. Default = true. * @param { Object } options
* @param { Boolean } [redrawImmediately] Whether to immediately draw a new frame. Only used if mainDrawer = true. Default = true. * @param { Boolean } [options.mainDrawer] Whether to use this as the viewer's main drawer. Default = true.
* @param { Object } [drawerOptions] Options for this drawer. If falsey, defaults to viewer.drawerOptions * @param { Boolean } [options.redrawImmediately] Whether to immediately draw a new frame. Only used if options.mainDrawer = true. Default = true.
* @param { Object } [options.drawerOptions] Options for this drawer. Defaults to viewer.drawerOptions.
* for this viewer type. See {@link OpenSeadragon.Options}. * for this viewer type. See {@link OpenSeadragon.Options}.
* @returns {Object | Boolean} The drawer that was created, or false if the requestd drawer is not supported * @returns {Object | Boolean} The drawer that was created, or false if the requested drawer is not supported
*/ */
requestDrawer(drawerCandidate, mainDrawer = true, redrawImmediately = true, drawerOptions = null){ requestDrawer(drawerCandidate, options){
const defaultOpts = {
mainDrawer: true,
redrawImmediately: true,
drawerOptions: null
};
options = $.extend(true, defaultOpts, options);
const mainDrawer = options.mainDrawer;
const redrawImmediately = options.redrawImmediately;
const drawerOptions = options.drawerOptions;
const oldDrawer = this.drawer; const oldDrawer = this.drawer;
let Drawer = null; let Drawer = null;

2
src/webgldrawer.js
View File

@ -231,7 +231,7 @@
*/ */
_getBackupCanvasDrawer(){ _getBackupCanvasDrawer(){
if(!this._backupCanvasDrawer){ if(!this._backupCanvasDrawer){
this._backupCanvasDrawer = this.viewer.requestDrawer('canvas', false); this._backupCanvasDrawer = this.viewer.requestDrawer('canvas', {mainDrawer: false});
this._backupCanvasDrawer.canvas.style.setProperty('visibility', 'hidden'); this._backupCanvasDrawer.canvas.style.setProperty('visibility', 'hidden');
} }