Last active
May 8, 2025 03:20
-
-
Save PolCPP/fc4763eb21f8e93ce380e5f01e9db692 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!DOCTYPE html> | |
| <html> | |
| <head> | |
| <title>Iframe example embed</title> | |
| <script type="text/javascript" src='../build/openseadragon/openseadragon.js'></script> | |
| <meta name="viewport" content="initial-scale=1.0"> | |
| <meta charset="utf-8"> | |
| <style> | |
| html, body { height: 100%; margin: 0; padding: 0; background-color: white;} | |
| </style> | |
| </head> | |
| <body> | |
| <div id="contentDiv" allowfullscreen style="height: 100%"> </div> | |
| <script type="text/javascript"> | |
| var _viewer = OpenSeadragon({ | |
| element: document.getElementById("contentDiv"), | |
| tileSources: [{ | |
| type: "szi", | |
| tilesUrl: "http://localhost:8000/demo/CMU-1.szi" | |
| }], | |
| homeFillsViewer: true, | |
| showZoomControl: false, | |
| constrainDuringPan: true, | |
| visibilityRatio: 1, | |
| loadTilesWithAjax: true, | |
| prefixUrl: "../build/openseadragon/images/", | |
| minZoomImageRatio: 1 | |
| }); | |
| </script> | |
| </body> | |
| </html> |
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| //! openseadragon 5.0.1 | |
| //! Built on 2025-05-07 | |
| //! Git commit: v5.0.1-184-01b61e1a-dirty | |
| //! http://openseadragon.github.io | |
| //! License: http://openseadragon.github.io/license/ | |
| /* | |
| * OpenSeadragon | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| /* | |
| * Portions of this source file taken from jQuery: | |
| * | |
| * Copyright 2011 John Resig | |
| * | |
| * Permission is hereby granted, free of charge, to any person obtaining | |
| * a copy of this software and associated documentation files (the | |
| * "Software"), to deal in the Software without restriction, including | |
| * without limitation the rights to use, copy, modify, merge, publish, | |
| * distribute, sublicense, and/or sell copies of the Software, and to | |
| * permit persons to whom the Software is furnished to do so, subject to | |
| * the following conditions: | |
| * | |
| * The above copyright notice and this permission notice shall be | |
| * included in all copies or substantial portions of the Software. | |
| * | |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |
| * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | |
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | |
| * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | |
| * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | |
| * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | |
| * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
| */ | |
| /* | |
| * Portions of this source file taken from mattsnider.com: | |
| * | |
| * Copyright (c) 2006-2013 Matt Snider | |
| * | |
| * Permission is hereby granted, free of charge, to any person obtaining a | |
| * copy of this software and associated documentation files (the "Software"), | |
| * to deal in the Software without restriction, including without limitation | |
| * the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
| * and/or sell copies of the Software, and to permit persons to whom the | |
| * Software is furnished to do so, subject to the following conditions: | |
| * | |
| * The above copyright notice and this permission notice shall be included | |
| * in all copies or substantial portions of the Software. | |
| * | |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | |
| * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | |
| * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | |
| * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY | |
| * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT | |
| * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR | |
| * THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
| */ | |
| /** | |
| * @namespace OpenSeadragon | |
| * @version openseadragon 5.0.1 | |
| * @classdesc The root namespace for OpenSeadragon. All utility methods | |
| * and classes are defined on or below this namespace. | |
| * | |
| */ | |
| // Typedefs | |
| /** | |
| * All required and optional settings for instantiating a new instance of an OpenSeadragon image viewer. | |
| * | |
| * @typedef {Object} Options | |
| * @memberof OpenSeadragon | |
| * | |
| * @property {String} id | |
| * Id of the element to append the viewer's container element to. If not provided, the 'element' property must be provided. | |
| * If both the element and id properties are specified, the viewer is appended to the element provided in the element property. | |
| * | |
| * @property {Element} element | |
| * The element to append the viewer's container element to. If not provided, the 'id' property must be provided. | |
| * If both the element and id properties are specified, the viewer is appended to the element provided in the element property. | |
| * | |
| * @property {Array|String|Function|Object} [tileSources=null] | |
| * Tile source(s) to open initially. This is a complex parameter; see | |
| * {@link OpenSeadragon.Viewer#open} for details. | |
| * | |
| * @property {Number} [tabIndex=0] | |
| * Tabbing order index to assign to the viewer element. Positive values are selected in increasing order. When tabIndex is 0 | |
| * source order is used. A negative value omits the viewer from the tabbing order. | |
| * | |
| * @property {Array} overlays Array of objects defining permanent overlays of | |
| * the viewer. The overlays added via this option and later removed with | |
| * {@link OpenSeadragon.Viewer#removeOverlay} will be added back when a new | |
| * image is opened. | |
| * To add overlays which can be definitively removed, one must use | |
| * {@link OpenSeadragon.Viewer#addOverlay} | |
| * If displaying a sequence of images, the overlays can be associated | |
| * with a specific page by passing the overlays array to the page's | |
| * tile source configuration. | |
| * Expected properties: | |
| * * x, y, (or px, py for pixel coordinates) to define the location. | |
| * * width, height in point if using x,y or in pixels if using px,py. If width | |
| * and height are specified, the overlay size is adjusted when zooming, | |
| * otherwise the size stays the size of the content (or the size defined by CSS). | |
| * * className to associate a class to the overlay | |
| * * id to set the overlay element. If an element with this id already exists, | |
| * it is reused, otherwise it is created. If not specified, a new element is | |
| * created. | |
| * * placement a string to define the relative position to the viewport. | |
| * Only used if no width and height are specified. Default: 'TOP_LEFT'. | |
| * See {@link OpenSeadragon.Placement} for possible values. | |
| * | |
| * @property {String} [xmlPath=null] | |
| * <strong>DEPRECATED</strong>. A relative path to load a DZI file from the server. | |
| * Prefer the newer Options.tileSources. | |
| * | |
| * @property {String} [prefixUrl='/images/'] | |
| * Prepends the prefixUrl to navImages paths, which is very useful | |
| * since the default paths are rarely useful for production | |
| * environments. | |
| * | |
| * @property {OpenSeadragon.NavImages} [navImages] | |
| * An object with a property for each button or other built-in navigation | |
| * control, eg the current 'zoomIn', 'zoomOut', 'home', and 'fullpage'. | |
| * Each of those in turn provides an image path for each state of the button | |
| * or navigation control, eg 'REST', 'GROUP', 'HOVER', 'PRESS'. Finally the | |
| * image paths, by default assume there is a folder on the servers root path | |
| * called '/images', eg '/images/zoomin_rest.png'. If you need to adjust | |
| * these paths, prefer setting the option.prefixUrl rather than overriding | |
| * every image path directly through this setting. | |
| * | |
| * @property {Boolean} [debugMode=false] | |
| * TODO: provide an in-screen panel providing event detail feedback. | |
| * | |
| * @property {String} [debugGridColor=['#437AB2', '#1B9E77', '#D95F02', '#7570B3', '#E7298A', '#66A61E', '#E6AB02', '#A6761D', '#666666']] | |
| * The colors of grids in debug mode. Each tiled image's grid uses a consecutive color. | |
| * If there are more tiled images than provided colors, the color vector is recycled. | |
| * | |
| * @property {Boolean} [silenceMultiImageWarnings=false] | |
| * Silences warnings when calling viewport coordinate functions with multi-image. | |
| * Useful when you're overlaying multiple images on top of one another. | |
| * | |
| * @property {Number} [blendTime=0] | |
| * Specifies the duration of animation as higher or lower level tiles are | |
| * replacing the existing tile. | |
| * | |
| * @property {Boolean} [alwaysBlend=false] | |
| * Forces the tile to always blend. By default the tiles skip blending | |
| * when the blendTime is surpassed and the current animation frame would | |
| * not complete the blend. | |
| * | |
| * @property {Boolean} [autoHideControls=true] | |
| * If the user stops interacting with the viewport, fade the navigation | |
| * controls. Useful for presentation since the controls are by default | |
| * floated on top of the image the user is viewing. | |
| * | |
| * @property {Boolean} [immediateRender=false] | |
| * Render the best closest level first, ignoring the lowering levels which | |
| * provide the effect of very blurry to sharp. It is recommended to change | |
| * setting to true for mobile devices. | |
| * | |
| * @property {Number} [defaultZoomLevel=0] | |
| * Zoom level to use when image is first opened or the home button is clicked. | |
| * If 0, adjusts to fit viewer. | |
| * | |
| * @property {String|DrawerImplementation|Array} [drawer = ['webgl', 'canvas', 'html']] | |
| * Which drawer to use. Valid strings are 'webgl', 'canvas', and 'html'. Valid drawer | |
| * implementations are constructors of classes that extend OpenSeadragon.DrawerBase. | |
| * An array of strings and/or constructors can be used to indicate the priority | |
| * of different implementations, which will be tried in order based on browser support. | |
| * | |
| * @property {Object} drawerOptions | |
| * Options to pass to the selected drawer implementation. For details | |
| * please see {@link OpenSeadragon.DrawerOptions}. | |
| * | |
| * @property {Number} [opacity=1] | |
| * Default proportional opacity of the tiled images (1=opaque, 0=hidden) | |
| * Hidden images do not draw and only load when preloading is allowed. | |
| * | |
| * @property {Boolean} [preload=false] | |
| * Default switch for loading hidden images (true loads, false blocks) | |
| * | |
| * @property {String} [compositeOperation=null] | |
| * Valid values are 'source-over', 'source-atop', 'source-in', 'source-out', | |
| * 'destination-over', 'destination-atop', 'destination-in', 'destination-out', | |
| * 'lighter', 'difference', 'copy', 'xor', etc. | |
| * For complete list of modes, please @see {@link https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation/ globalCompositeOperation} | |
| * | |
| * @property {Boolean} [imageSmoothingEnabled=true] | |
| * Image smoothing for rendering (only if the canvas or webgl drawer is used). Note: Ignored | |
| * by some (especially older) browsers which do not support this canvas property. | |
| * This property can be changed in {@link Viewer.DrawerBase.setImageSmoothingEnabled}. | |
| * | |
| * @property {String|CanvasGradient|CanvasPattern|Function} [placeholderFillStyle=null] | |
| * Draws a colored rectangle behind the tile if it is not loaded yet. | |
| * You can pass a CSS color value like "#FF8800". | |
| * When passing a function the tiledImage and canvas context are available as argument which is useful when you draw a gradient or pattern. | |
| * | |
| * @property {Object} [subPixelRoundingForTransparency=null] | |
| * Determines when subpixel rounding should be applied for tiles when rendering images that support transparency. | |
| * This property is a subpixel rounding enum values dictionary [{@link BROWSERS}] --> {@link SUBPIXEL_ROUNDING_OCCURRENCES}. | |
| * The key is a {@link BROWSERS} value, and the value is one of {@link SUBPIXEL_ROUNDING_OCCURRENCES}, | |
| * indicating, for a given browser, when to apply subpixel rounding. | |
| * Key '*' is the fallback value for any browser not specified in the dictionary. | |
| * This property has a simple mode, and one can set it directly to | |
| * {@link SUBPIXEL_ROUNDING_OCCURRENCES.NEVER}, {@link SUBPIXEL_ROUNDING_OCCURRENCES.ONLY_AT_REST} or {@link SUBPIXEL_ROUNDING_OCCURRENCES.ALWAYS} | |
| * in order to apply this rule for all browser. The values {@link SUBPIXEL_ROUNDING_OCCURRENCES.ALWAYS} would be equivalent to { '*', SUBPIXEL_ROUNDING_OCCURRENCES.ALWAYS }. | |
| * The default is {@link SUBPIXEL_ROUNDING_OCCURRENCES.NEVER} for all browsers, for backward compatibility reason. | |
| * | |
| * @property {Number} [degrees=0] | |
| * Initial rotation. | |
| * | |
| * @property {Boolean} [flipped=false] | |
| * Initial flip state. | |
| * | |
| * @property {Boolean} [overlayPreserveContentDirection=true] | |
| * When the viewport is flipped (by pressing 'f'), the overlay is flipped using ScaleX. | |
| * Normally, this setting (default true) keeps the overlay's content readable by flipping it back. | |
| * To make the content flip with the overlay, set overlayPreserveContentDirection to false. | |
| * | |
| * @property {Number} [minZoomLevel=null] | |
| * | |
| * @property {Number} [maxZoomLevel=null] | |
| * | |
| * @property {Boolean} [homeFillsViewer=false] | |
| * Make the 'home' button fill the viewer and clip the image, instead | |
| * of fitting the image to the viewer and letterboxing. | |
| * | |
| * @property {Boolean} [panHorizontal=true] | |
| * Allow horizontal pan. | |
| * | |
| * @property {Boolean} [panVertical=true] | |
| * Allow vertical pan. | |
| * | |
| * @property {Boolean} [constrainDuringPan=false] | |
| * | |
| * @property {Boolean} [wrapHorizontal=false] | |
| * Set to true to force the image to wrap horizontally within the viewport. | |
| * Useful for maps or images representing the surface of a sphere or cylinder. | |
| * | |
| * @property {Boolean} [wrapVertical=false] | |
| * Set to true to force the image to wrap vertically within the viewport. | |
| * Useful for maps or images representing the surface of a sphere or cylinder. | |
| * | |
| * @property {Number} [minZoomImageRatio=0.9] | |
| * The minimum percentage ( expressed as a number between 0 and 1 ) of | |
| * the viewport height or width at which the zoom out will be constrained. | |
| * Setting it to 0, for example will allow you to zoom out infinity. | |
| * | |
| * @property {Number} [maxZoomPixelRatio=1.1] | |
| * The maximum ratio to allow a zoom-in to affect the highest level pixel | |
| * ratio. This can be set to Infinity to allow 'infinite' zooming into the | |
| * image though it is less effective visually if the HTML5 Canvas is not | |
| * available on the viewing device. | |
| * | |
| * @property {Number} [smoothTileEdgesMinZoom=1.1] | |
| * A zoom percentage ( where 1 is 100% ) of the highest resolution level. | |
| * When zoomed in beyond this value alternative compositing will be used to | |
| * smooth out the edges between tiles. This will have a performance impact. | |
| * Can be set to Infinity to turn it off. | |
| * Note: This setting is ignored on iOS devices due to a known bug (See {@link https://github.com/openseadragon/openseadragon/issues/952}) | |
| * | |
| * @property {Boolean} [iOSDevice=?] | |
| * True if running on an iOS device, false otherwise. | |
| * Used to disable certain features that behave differently on iOS devices. | |
| * | |
| * @property {Boolean} [autoResize=true] | |
| * Set to false to prevent polling for viewer size changes. Useful for providing custom resize behavior. | |
| * | |
| * @property {Boolean} [preserveImageSizeOnResize=false] | |
| * Set to true to have the image size preserved when the viewer is resized. This requires autoResize=true (default). | |
| * | |
| * @property {Number} [minScrollDeltaTime=50] | |
| * Number of milliseconds between canvas-scroll events. This value helps normalize the rate of canvas-scroll | |
| * events between different devices, causing the faster devices to slow down enough to make the zoom control | |
| * more manageable. | |
| * | |
| * @property {Number} [rotationIncrement=90] | |
| * The number of degrees to rotate right or left when the rotate buttons or keyboard shortcuts are activated. | |
| * | |
| * @property {Number} [maxTilesPerFrame=1] | |
| * The number of tiles loaded per frame. As the frame rate of the client's machine is usually high (e.g., 50 fps), | |
| * one tile per frame should be a good choice. However, for large screens or lower frame rates, the number of | |
| * loaded tiles per frame can be adjusted here. Reasonable values might be 2 or 3 tiles per frame. | |
| * (Note that the actual frame rate is given by the client's browser and machine). | |
| * | |
| * @property {Number} [pixelsPerWheelLine=40] | |
| * For pixel-resolution scrolling devices, the number of pixels equal to one scroll line. | |
| * | |
| * @property {Number} [pixelsPerArrowPress=40] | |
| * The number of pixels viewport moves when an arrow key is pressed. | |
| * | |
| * @property {Number} [visibilityRatio=0.5] | |
| * The percentage ( as a number from 0 to 1 ) of the source image which | |
| * must be kept within the viewport. If the image is dragged beyond that | |
| * limit, it will 'bounce' back until the minimum visibility ratio is | |
| * achieved. Setting this to 0 and wrapHorizontal ( or wrapVertical ) to | |
| * true will provide the effect of an infinitely scrolling viewport. | |
| * | |
| * @property {Object} [viewportMargins={}] | |
| * Pushes the "home" region in from the sides by the specified amounts. | |
| * Possible subproperties (Numbers, in screen coordinates): left, top, right, bottom. | |
| * | |
| * @property {Number} [imageLoaderLimit=0] | |
| * The maximum number of image requests to make concurrently. By default | |
| * it is set to 0 allowing the browser to make the maximum number of | |
| * image requests in parallel as allowed by the browsers policy. | |
| * | |
| * @property {Number} [clickTimeThreshold=300] | |
| * The number of milliseconds within which a pointer down-up event combination | |
| * will be treated as a click gesture. | |
| * | |
| * @property {Number} [clickDistThreshold=5] | |
| * The maximum distance allowed between a pointer down event and a pointer up event | |
| * to be treated as a click gesture. | |
| * | |
| * @property {Number} [dblClickTimeThreshold=300] | |
| * The number of milliseconds within which two pointer down-up event combinations | |
| * will be treated as a double-click gesture. | |
| * | |
| * @property {Number} [dblClickDistThreshold=20] | |
| * The maximum distance allowed between two pointer click events | |
| * to be treated as a double-click gesture. | |
| * | |
| * @property {Number} [springStiffness=6.5] | |
| * | |
| * @property {Number} [animationTime=1.2] | |
| * Specifies the animation duration per each {@link OpenSeadragon.Spring} | |
| * which occur when the image is dragged, zoomed or rotated. | |
| * | |
| * @property {Boolean} [loadDestinationTilesOnAnimation=true] | |
| * If true, tiles are loaded only at the destination of an animation. | |
| * If false, tiles are loaded along the animation path during the animation. | |
| * @property {OpenSeadragon.GestureSettings} [gestureSettingsMouse] | |
| * Settings for gestures generated by a mouse pointer device. (See {@link OpenSeadragon.GestureSettings}) | |
| * @property {Boolean} [gestureSettingsMouse.dragToPan=true] - Pan on drag gesture | |
| * @property {Boolean} [gestureSettingsMouse.scrollToZoom=true] - Zoom on scroll gesture | |
| * @property {Boolean} [gestureSettingsMouse.clickToZoom=true] - Zoom on click gesture | |
| * @property {Boolean} [gestureSettingsMouse.dblClickToZoom=false] - Zoom on double-click gesture. Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * @property {Boolean} [gestureSettingsMouse.dblClickDragToZoom=false] - Zoom on dragging through | |
| * double-click gesture ( single click and next click to drag). Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * @property {Boolean} [gestureSettingsMouse.pinchToZoom=false] - Zoom on pinch gesture | |
| * @property {Boolean} [gestureSettingsMouse.zoomToRefPoint=true] - If zoomToRefPoint is true, the zoom is centered at the pointer position. Otherwise, | |
| * the zoom is centered at the canvas center. | |
| * @property {Boolean} [gestureSettingsMouse.flickEnabled=false] - Enable flick gesture | |
| * @property {Number} [gestureSettingsMouse.flickMinSpeed=120] - If flickEnabled is true, the minimum speed to initiate a flick gesture (pixels-per-second) | |
| * @property {Number} [gestureSettingsMouse.flickMomentum=0.25] - If flickEnabled is true, the momentum factor for the flick gesture | |
| * @property {Boolean} [gestureSettingsMouse.pinchRotate=false] - If pinchRotate is true, the user will have the ability to rotate the image using their fingers. | |
| * | |
| * @property {OpenSeadragon.GestureSettings} [gestureSettingsTouch] | |
| * Settings for gestures generated by a touch pointer device. (See {@link OpenSeadragon.GestureSettings}) | |
| * @property {Boolean} [gestureSettingsTouch.dragToPan=true] - Pan on drag gesture | |
| * @property {Boolean} [gestureSettingsTouch.scrollToZoom=false] - Zoom on scroll gesture | |
| * @property {Boolean} [gestureSettingsTouch.clickToZoom=false] - Zoom on click gesture | |
| * @property {Boolean} [gestureSettingsTouch.dblClickToZoom=true] - Zoom on double-click gesture. Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * @property {Boolean} [gestureSettingsTouch.dblClickDragToZoom=true] - Zoom on dragging through | |
| * double-click gesture ( single click and next click to drag). Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * @property {Boolean} [gestureSettingsTouch.pinchToZoom=true] - Zoom on pinch gesture | |
| * @property {Boolean} [gestureSettingsTouch.zoomToRefPoint=true] - If zoomToRefPoint is true, the zoom is centered at the pointer position. Otherwise, | |
| * the zoom is centered at the canvas center. | |
| * @property {Boolean} [gestureSettingsTouch.flickEnabled=true] - Enable flick gesture | |
| * @property {Number} [gestureSettingsTouch.flickMinSpeed=120] - If flickEnabled is true, the minimum speed to initiate a flick gesture (pixels-per-second) | |
| * @property {Number} [gestureSettingsTouch.flickMomentum=0.25] - If flickEnabled is true, the momentum factor for the flick gesture | |
| * @property {Boolean} [gestureSettingsTouch.pinchRotate=false] - If pinchRotate is true, the user will have the ability to rotate the image using their fingers. | |
| * | |
| * @property {OpenSeadragon.GestureSettings} [gestureSettingsPen] | |
| * Settings for gestures generated by a pen pointer device. (See {@link OpenSeadragon.GestureSettings}) | |
| * @property {Boolean} [gestureSettingsPen.dragToPan=true] - Pan on drag gesture | |
| * @property {Boolean} [gestureSettingsPen.scrollToZoom=false] - Zoom on scroll gesture | |
| * @property {Boolean} [gestureSettingsPen.clickToZoom=true] - Zoom on click gesture | |
| * @property {Boolean} [gestureSettingsPen.dblClickToZoom=false] - Zoom on double-click gesture. Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * @property {Boolean} [gestureSettingsPen.pinchToZoom=false] - Zoom on pinch gesture | |
| * @property {Boolean} [gestureSettingsPen.zoomToRefPoint=true] - If zoomToRefPoint is true, the zoom is centered at the pointer position. Otherwise, | |
| * the zoom is centered at the canvas center. | |
| * @property {Boolean} [gestureSettingsPen.flickEnabled=false] - Enable flick gesture | |
| * @property {Number} [gestureSettingsPen.flickMinSpeed=120] - If flickEnabled is true, the minimum speed to initiate a flick gesture (pixels-per-second) | |
| * @property {Number} [gestureSettingsPen.flickMomentum=0.25] - If flickEnabled is true, the momentum factor for the flick gesture | |
| * @property {Boolean} [gestureSettingsPen.pinchRotate=false] - If pinchRotate is true, the user will have the ability to rotate the image using their fingers. | |
| * | |
| * @property {OpenSeadragon.GestureSettings} [gestureSettingsUnknown] | |
| * Settings for gestures generated by unknown pointer devices. (See {@link OpenSeadragon.GestureSettings}) | |
| * @property {Boolean} [gestureSettingsUnknown.dragToPan=true] - Pan on drag gesture | |
| * @property {Boolean} [gestureSettingsUnknown.scrollToZoom=true] - Zoom on scroll gesture | |
| * @property {Boolean} [gestureSettingsUnknown.clickToZoom=false] - Zoom on click gesture | |
| * @property {Boolean} [gestureSettingsUnknown.dblClickToZoom=true] - Zoom on double-click gesture. Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * @property {Boolean} [gestureSettingsUnknown.dblClickDragToZoom=false] - Zoom on dragging through | |
| * double-click gesture ( single click and next click to drag). Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * @property {Boolean} [gestureSettingsUnknown.pinchToZoom=true] - Zoom on pinch gesture | |
| * @property {Boolean} [gestureSettingsUnknown.zoomToRefPoint=true] - If zoomToRefPoint is true, the zoom is centered at the pointer position. Otherwise, | |
| * the zoom is centered at the canvas center. | |
| * @property {Boolean} [gestureSettingsUnknown.flickEnabled=true] - Enable flick gesture | |
| * @property {Number} [gestureSettingsUnknown.flickMinSpeed=120] - If flickEnabled is true, the minimum speed to initiate a flick gesture (pixels-per-second) | |
| * @property {Number} [gestureSettingsUnknown.flickMomentum=0.25] - If flickEnabled is true, the momentum factor for the flick gesture | |
| * @property {Boolean} [gestureSettingsUnknown.pinchRotate=false] - If pinchRotate is true, the user will have the ability to rotate the image using their fingers. | |
| * | |
| * @property {Number} [zoomPerClick=2.0] | |
| * The "zoom distance" per mouse click or touch tap. <em><strong>Note:</strong> Setting this to 1.0 effectively disables the click-to-zoom feature (also see gestureSettings[Mouse|Touch|Pen].clickToZoom/dblClickToZoom).</em> | |
| * | |
| * @property {Number} [zoomPerScroll=1.2] | |
| * The "zoom distance" per mouse scroll or touch pinch. <em><strong>Note:</strong> Setting this to 1.0 effectively disables the mouse-wheel zoom feature (also see gestureSettings[Mouse|Touch|Pen].scrollToZoom}).</em> | |
| * | |
| * @property {Number} [zoomPerDblClickDrag=1.2] | |
| * The "zoom distance" per double-click mouse drag. <em><strong>Note:</strong> Setting this to 1.0 effectively disables the double-click-drag-to-Zoom feature (also see gestureSettings[Mouse|Touch|Pen].dblClickDragToZoom).</em> | |
| * | |
| * @property {Number} [zoomPerSecond=1.0] | |
| * Sets the zoom amount per second when zoomIn/zoomOut buttons are pressed and held. | |
| * The value is a factor of the current zoom, so 1.0 (the default) disables zooming when the zoomIn/zoomOut buttons | |
| * are held. Higher values will increase the rate of zoom when the zoomIn/zoomOut buttons are held. Note that values | |
| * < 1.0 will reverse the operation of the zoomIn/zoomOut buttons (zoomIn button will decrease the zoom, zoomOut will | |
| * increase the zoom). | |
| * | |
| * @property {Boolean} [showNavigator=false] | |
| * Set to true to make the navigator minimap appear. | |
| * | |
| * @property {Element} [navigatorElement=null] | |
| * The element to hold the navigator minimap. | |
| * If an element is specified, the Id option (see navigatorId) is ignored. | |
| * If no element nor ID is specified, a div element will be generated accordingly. | |
| * | |
| * @property {String} [navigatorId=navigator-GENERATED DATE] | |
| * The ID of a div to hold the navigator minimap. | |
| * If an ID is specified, the navigatorPosition, navigatorSizeRatio, navigatorMaintainSizeRatio, navigator[Top|Left|Height|Width] and navigatorAutoFade options will be ignored. | |
| * If an ID is not specified, a div element will be generated and placed on top of the main image. | |
| * | |
| * @property {String} [navigatorPosition='TOP_RIGHT'] | |
| * Valid values are 'TOP_LEFT', 'TOP_RIGHT', 'BOTTOM_LEFT', 'BOTTOM_RIGHT', or 'ABSOLUTE'.<br> | |
| * If 'ABSOLUTE' is specified, then navigator[Top|Left|Height|Width] determines the size and position of the navigator minimap in the viewer, and navigatorSizeRatio and navigatorMaintainSizeRatio are ignored.<br> | |
| * For 'TOP_LEFT', 'TOP_RIGHT', 'BOTTOM_LEFT', and 'BOTTOM_RIGHT', the navigatorSizeRatio or navigator[Height|Width] values determine the size of the navigator minimap. | |
| * | |
| * @property {Number} [navigatorSizeRatio=0.2] | |
| * Ratio of navigator size to viewer size. Ignored if navigator[Height|Width] are specified. | |
| * | |
| * @property {Boolean} [navigatorMaintainSizeRatio=false] | |
| * If true, the navigator minimap is resized (using navigatorSizeRatio) when the viewer size changes. | |
| * | |
| * @property {Number|String} [navigatorTop=null] | |
| * Specifies the location of the navigator minimap (see navigatorPosition). | |
| * | |
| * @property {Number|String} [navigatorLeft=null] | |
| * Specifies the location of the navigator minimap (see navigatorPosition). | |
| * | |
| * @property {Number|String} [navigatorHeight=null] | |
| * Specifies the size of the navigator minimap (see navigatorPosition). | |
| * If specified, navigatorSizeRatio and navigatorMaintainSizeRatio are ignored. | |
| * | |
| * @property {Number|String} [navigatorWidth=null] | |
| * Specifies the size of the navigator minimap (see navigatorPosition). | |
| * If specified, navigatorSizeRatio and navigatorMaintainSizeRatio are ignored. | |
| * | |
| * @property {Boolean} [navigatorAutoResize=true] | |
| * Set to false to prevent polling for navigator size changes. Useful for providing custom resize behavior. | |
| * Setting to false can also improve performance when the navigator is configured to a fixed size. | |
| * | |
| * @property {Boolean} [navigatorAutoFade=true] | |
| * If the user stops interacting with the viewport, fade the navigator minimap. | |
| * Setting to false will make the navigator minimap always visible. | |
| * | |
| * @property {Boolean} [navigatorRotate=true] | |
| * If true, the navigator will be rotated together with the viewer. | |
| * | |
| * @property {String} [navigatorBackground='#000'] | |
| * Specifies the background color of the navigator minimap | |
| * | |
| * @property {Number} [navigatorOpacity=0.8] | |
| * Specifies the opacity of the navigator minimap. | |
| * | |
| * @property {String} [navigatorBorderColor='#555'] | |
| * Specifies the border color of the navigator minimap | |
| * | |
| * @property {String} [navigatorDisplayRegionColor='#900'] | |
| * Specifies the border color of the display region rectangle of the navigator minimap | |
| * | |
| * @property {Number} [controlsFadeDelay=2000] | |
| * The number of milliseconds to wait once the user has stopped interacting | |
| * with the interface before beginning to fade the controls. Assumes | |
| * showNavigationControl and autoHideControls are both true. | |
| * | |
| * @property {Number} [controlsFadeLength=1500] | |
| * The number of milliseconds to animate the controls fading out. | |
| * | |
| * @property {Number} [maxImageCacheCount=200] | |
| * The max number of images we should keep in memory (per drawer). | |
| * | |
| * @property {Number} [timeout=30000] | |
| * The max number of milliseconds that an image job may take to complete. | |
| * | |
| * @property {Number} [tileRetryMax=0] | |
| * The max number of retries when a tile download fails. By default it's 0, so retries are disabled. | |
| * | |
| * @property {Number} [tileRetryDelay=2500] | |
| * Milliseconds to wait after each tile retry if tileRetryMax is set. | |
| * | |
| * @property {Boolean} [useCanvas=true] | |
| * Deprecated. Use the `drawer` option to specify preferred renderer. | |
| * | |
| * @property {Number} [minPixelRatio=0.5] | |
| * The higher the minPixelRatio, the lower the quality of the image that | |
| * is considered sufficient to stop rendering a given zoom level. For | |
| * example, if you are targeting mobile devices with less bandwidth you may | |
| * try setting this to 1.5 or higher. | |
| * | |
| * @property {Boolean} [mouseNavEnabled=true] | |
| * Is the user able to interact with the image via mouse or touch. Default | |
| * interactions include draging the image in a plane, and zooming in toward | |
| * and away from the image. | |
| * | |
| * @property {Boolean} [showNavigationControl=true] | |
| * Set to false to prevent the appearance of the default navigation controls.<br> | |
| * Note that if set to false, the customs buttons set by the options | |
| * zoomInButton, zoomOutButton etc, are rendered inactive. | |
| * | |
| * @property {OpenSeadragon.ControlAnchor} [navigationControlAnchor=TOP_LEFT] | |
| * Placement of the default navigation controls. | |
| * To set the placement of the sequence controls, see the | |
| * sequenceControlAnchor option. | |
| * | |
| * @property {Boolean} [showZoomControl=true] | |
| * If true then + and - buttons to zoom in and out are displayed.<br> | |
| * Note: {@link OpenSeadragon.Options.showNavigationControl} is overriding | |
| * this setting when set to false. | |
| * | |
| * @property {Boolean} [showHomeControl=true] | |
| * If true then the 'Go home' button is displayed to go back to the original | |
| * zoom and pan.<br> | |
| * Note: {@link OpenSeadragon.Options.showNavigationControl} is overriding | |
| * this setting when set to false. | |
| * | |
| * @property {Boolean} [showFullPageControl=true] | |
| * If true then the 'Toggle full page' button is displayed to switch | |
| * between full page and normal mode.<br> | |
| * Note: {@link OpenSeadragon.Options.showNavigationControl} is overriding | |
| * this setting when set to false. | |
| * | |
| * @property {Boolean} [showRotationControl=false] | |
| * If true then the rotate left/right controls will be displayed as part of the | |
| * standard controls. This is also subject to the browser support for rotate | |
| * (e.g. viewer.drawer.canRotate()).<br> | |
| * Note: {@link OpenSeadragon.Options.showNavigationControl} is overriding | |
| * this setting when set to false. | |
| * | |
| * @property {Boolean} [showFlipControl=false] | |
| * If true then the flip controls will be displayed as part of the | |
| * standard controls. | |
| * | |
| * @property {Boolean} [showSequenceControl=true] | |
| * If sequenceMode is true, then provide buttons for navigating forward and | |
| * backward through the images. | |
| * | |
| * @property {OpenSeadragon.ControlAnchor} [sequenceControlAnchor=TOP_LEFT] | |
| * Placement of the default sequence controls. | |
| * | |
| * @property {Boolean} [navPrevNextWrap=false] | |
| * If true then the 'previous' button will wrap to the last image when | |
| * viewing the first image and the 'next' button will wrap to the first | |
| * image when viewing the last image. | |
| * | |
| *@property {String|Element} zoomInButton | |
| * Set the id or element of the custom 'Zoom in' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {String|Element} zoomOutButton | |
| * Set the id or element of the custom 'Zoom out' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {String|Element} homeButton | |
| * Set the id or element of the custom 'Go home' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {String|Element} fullPageButton | |
| * Set the id or element of the custom 'Toggle full page' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {String|Element} rotateLeftButton | |
| * Set the id or element of the custom 'Rotate left' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {String|Element} rotateRightButton | |
| * Set the id or element of the custom 'Rotate right' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {String|Element} previousButton | |
| * Set the id or element of the custom 'Previous page' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {String|Element} nextButton | |
| * Set the id or element of the custom 'Next page' button to use. | |
| * This is useful to have a custom button anywhere in the web page.<br> | |
| * To only change the button images, consider using | |
| * {@link OpenSeadragon.Options.navImages} | |
| * | |
| * @property {Boolean} [sequenceMode=false] | |
| * Set to true to have the viewer treat your tilesources as a sequence of images to | |
| * be opened one at a time rather than all at once. | |
| * | |
| * @property {Number} [initialPage=0] | |
| * If sequenceMode is true, display this page initially. | |
| * | |
| * @property {Boolean} [preserveViewport=false] | |
| * If sequenceMode is true, then normally navigating through each image resets the | |
| * viewport to 'home' position. If preserveViewport is set to true, then the viewport | |
| * position is preserved when navigating between images in the sequence. | |
| * | |
| * @property {Boolean} [preserveOverlays=false] | |
| * If sequenceMode is true, then normally navigating through each image | |
| * resets the overlays. | |
| * If preserveOverlays is set to true, then the overlays added with {@link OpenSeadragon.Viewer#addOverlay} | |
| * are preserved when navigating between images in the sequence. | |
| * Note: setting preserveOverlays overrides any overlays specified in the global | |
| * "overlays" option for the Viewer. It's also not compatible with specifying | |
| * per-tileSource overlays via the options, as those overlays will persist | |
| * even after the tileSource is closed. | |
| * | |
| * @property {Boolean} [showReferenceStrip=false] | |
| * If sequenceMode is true, then display a scrolling strip of image thumbnails for | |
| * navigating through the images. | |
| * | |
| * @property {String} [referenceStripScroll='horizontal'] | |
| * | |
| * @property {Element} [referenceStripElement=null] | |
| * | |
| * @property {Number} [referenceStripHeight=null] | |
| * | |
| * @property {Number} [referenceStripWidth=null] | |
| * | |
| * @property {String} [referenceStripPosition='BOTTOM_LEFT'] | |
| * | |
| * @property {Number} [referenceStripSizeRatio=0.2] | |
| * | |
| * @property {Boolean} [collectionMode=false] | |
| * Set to true to have the viewer arrange your TiledImages in a grid or line. | |
| * | |
| * @property {Number} [collectionRows=3] | |
| * If collectionMode is true, specifies how many rows the grid should have. Use 1 to make a line. | |
| * If collectionLayout is 'vertical', specifies how many columns instead. | |
| * | |
| * @property {Number} [collectionColumns=0] | |
| * If collectionMode is true, specifies how many columns the grid should have. Use 1 to make a line. | |
| * If collectionLayout is 'vertical', specifies how many rows instead. Ignored if collectionRows is not set to a falsy value. | |
| * | |
| * @property {String} [collectionLayout='horizontal'] | |
| * If collectionMode is true, specifies whether to arrange vertically or horizontally. | |
| * | |
| * @property {Number} [collectionTileSize=800] | |
| * If collectionMode is true, specifies the size, in viewport coordinates, for each TiledImage to fit into. | |
| * The TiledImage will be centered within a square of the specified size. | |
| * | |
| * @property {Number} [collectionTileMargin=80] | |
| * If collectionMode is true, specifies the margin, in viewport coordinates, between each TiledImage. | |
| * | |
| * @property {String|Boolean} [crossOriginPolicy=false] | |
| * Valid values are 'Anonymous', 'use-credentials', and false. If false, canvas requests will | |
| * not use CORS, and the canvas will be tainted. | |
| * | |
| * @property {Boolean} [ajaxWithCredentials=false] | |
| * Whether to set the withCredentials XHR flag for AJAX requests. | |
| * Note that this can be overridden at the {@link OpenSeadragon.TileSource} level. | |
| * | |
| * @property {Boolean} [loadTilesWithAjax=false] | |
| * Whether to load tile data using AJAX requests. | |
| * Note that this can be overridden at the {@link OpenSeadragon.TileSource} level. | |
| * | |
| * @property {Object} [ajaxHeaders={}] | |
| * A set of headers to include when making AJAX requests for tile sources or tiles. | |
| * | |
| * @property {Boolean} [splitHashDataForPost=false] | |
| * Allows to treat _first_ hash ('#') symbol as a separator for POST data: | |
| * URL to be opened by a {@link OpenSeadragon.TileSource} can thus look like: http://some.url#postdata=here. | |
| * The whole URL is used to fetch image info metadata and it is then split to 'http://some.url' and | |
| * 'postdata=here'; post data is given to the {@link OpenSeadragon.TileSource} of the choice and can be further | |
| * used within tile requests (see TileSource methods). | |
| * NOTE: {@link OpenSeadragon.TileSource.prototype.configure} return value should contain the post data | |
| * if you want to use it later - so that it is given to your constructor later. | |
| * NOTE: usually, post data is expected to be ampersand-separated (just like GET parameters), and is NOT USED | |
| * to fetch tile image data unless explicitly programmed, or if loadTilesWithAjax=false 4 | |
| * (but it is still used for the initial image info request). | |
| * NOTE: passing POST data from URL by this feature only supports string values, however, | |
| * TileSource can send any data using POST as long as the header is correct | |
| * (@see OpenSeadragon.TileSource.prototype.getTilePostData) | |
| * | |
| * @property {Boolean} [callTileLoadedWithCachedData=false] | |
| * tile-loaded event is called only for tiles that downloaded new data or | |
| * their data is stored in the original form in a suplementary cache object. | |
| * Caches that render directly from re-used cache does not trigger this event again, | |
| * as possible modifications would be applied twice. | |
| */ | |
| /** | |
| * Settings for gestures generated by a pointer device. | |
| * | |
| * @typedef {Object} GestureSettings | |
| * @memberof OpenSeadragon | |
| * | |
| * @property {Boolean} dragToPan | |
| * Set to false to disable panning on drag gestures. | |
| * | |
| * @property {Boolean} scrollToZoom | |
| * Set to false to disable zooming on scroll gestures. | |
| * | |
| * @property {Boolean} clickToZoom | |
| * Set to false to disable zooming on click gestures. | |
| * | |
| * @property {Boolean} dblClickToZoom | |
| * Set to false to disable zooming on double-click gestures. Note: If set to true | |
| * then clickToZoom should be set to false to prevent multiple zooms. | |
| * | |
| * @property {Boolean} pinchToZoom | |
| * Set to false to disable zooming on pinch gestures. | |
| * | |
| * @property {Boolean} flickEnabled | |
| * Set to false to disable the kinetic panning effect (flick) at the end of a drag gesture. | |
| * | |
| * @property {Number} flickMinSpeed | |
| * If flickEnabled is true, the minimum speed (in pixels-per-second) required to cause the kinetic panning effect (flick) at the end of a drag gesture. | |
| * | |
| * @property {Number} flickMomentum | |
| * If flickEnabled is true, a constant multiplied by the velocity to determine the distance of the kinetic panning effect (flick) at the end of a drag gesture. | |
| * A larger value will make the flick feel "lighter", while a smaller value will make the flick feel "heavier". | |
| * Note: springStiffness and animationTime also affect the "spring" used to stop the flick animation. | |
| * | |
| */ | |
| /** | |
| * @typedef {Object.<string, Object>} DrawerOptions - give the renderer options (both shared - BaseDrawerOptions, and custom). | |
| * Supports arbitrary keys: you can register any drawer on the OpenSeadragon namespace, it will get automatically recognized | |
| * and its getType() implementation will define what key to specify the options with. | |
| * @memberof OpenSeadragon | |
| * @property {BaseDrawerOptions} [webgl] - options if the WebGLDrawer is used. | |
| * @property {BaseDrawerOptions} [canvas] - options if the CanvasDrawer is used. | |
| * @property {BaseDrawerOptions} [html] - options if the HTMLDrawer is used. | |
| * @property {BaseDrawerOptions} [custom] - options if a custom drawer is used. | |
| * | |
| * //Note: if you want to add change options for target drawer change type to {BaseDrawerOptions & MyDrawerOpts} | |
| */ | |
| /** | |
| * The names for the image resources used for the image navigation buttons. | |
| * | |
| * @typedef {Object} NavImages | |
| * @memberof OpenSeadragon | |
| * | |
| * @property {Object} zoomIn - Images for the zoom-in button. | |
| * @property {String} zoomIn.REST | |
| * @property {String} zoomIn.GROUP | |
| * @property {String} zoomIn.HOVER | |
| * @property {String} zoomIn.DOWN | |
| * | |
| * @property {Object} zoomOut - Images for the zoom-out button. | |
| * @property {String} zoomOut.REST | |
| * @property {String} zoomOut.GROUP | |
| * @property {String} zoomOut.HOVER | |
| * @property {String} zoomOut.DOWN | |
| * | |
| * @property {Object} home - Images for the home button. | |
| * @property {String} home.REST | |
| * @property {String} home.GROUP | |
| * @property {String} home.HOVER | |
| * @property {String} home.DOWN | |
| * | |
| * @property {Object} fullpage - Images for the full-page button. | |
| * @property {String} fullpage.REST | |
| * @property {String} fullpage.GROUP | |
| * @property {String} fullpage.HOVER | |
| * @property {String} fullpage.DOWN | |
| * | |
| * @property {Object} rotateleft - Images for the rotate left button. | |
| * @property {String} rotateleft.REST | |
| * @property {String} rotateleft.GROUP | |
| * @property {String} rotateleft.HOVER | |
| * @property {String} rotateleft.DOWN | |
| * | |
| * @property {Object} rotateright - Images for the rotate right button. | |
| * @property {String} rotateright.REST | |
| * @property {String} rotateright.GROUP | |
| * @property {String} rotateright.HOVER | |
| * @property {String} rotateright.DOWN | |
| * | |
| * @property {Object} flip - Images for the flip button. | |
| * @property {String} flip.REST | |
| * @property {String} flip.GROUP | |
| * @property {String} flip.HOVER | |
| * @property {String} flip.DOWN | |
| * | |
| * @property {Object} previous - Images for the previous button. | |
| * @property {String} previous.REST | |
| * @property {String} previous.GROUP | |
| * @property {String} previous.HOVER | |
| * @property {String} previous.DOWN | |
| * | |
| * @property {Object} next - Images for the next button. | |
| * @property {String} next.REST | |
| * @property {String} next.GROUP | |
| * @property {String} next.HOVER | |
| * @property {String} next.DOWN | |
| * | |
| */ | |
| /* eslint-disable no-redeclare */ | |
| function OpenSeadragon( options ){ | |
| return new OpenSeadragon.Viewer( options ); | |
| } | |
| (function( $ ){ | |
| /** | |
| * The OpenSeadragon version. | |
| * | |
| * @member {Object} OpenSeadragon.version | |
| * @property {String} versionStr - The version number as a string ('major.minor.revision'). | |
| * @property {Number} major - The major version number. | |
| * @property {Number} minor - The minor version number. | |
| * @property {Number} revision - The revision number. | |
| * @since 1.0.0 | |
| */ | |
| $.version = { | |
| versionStr: '5.0.1', | |
| major: parseInt('5', 10), | |
| minor: parseInt('0', 10), | |
| revision: parseInt('1', 10) | |
| }; | |
| /** | |
| * Taken from jquery 1.6.1 | |
| * [[Class]] -> type pairs | |
| * @private | |
| */ | |
| var class2type = { | |
| '[object Boolean]': 'boolean', | |
| '[object Number]': 'number', | |
| '[object String]': 'string', | |
| '[object Function]': 'function', | |
| '[object AsyncFunction]': 'function', | |
| '[object Promise]': 'promise', | |
| '[object Array]': 'array', | |
| '[object Date]': 'date', | |
| '[object RegExp]': 'regexp', | |
| '[object Object]': 'object', | |
| '[object HTMLUnknownElement]': 'dom-node', | |
| '[object HTMLImageElement]': 'image', | |
| '[object HTMLCanvasElement]': 'canvas', | |
| '[object CanvasRenderingContext2D]': 'context2d' | |
| }, | |
| // Save a reference to some core methods | |
| toString = Object.prototype.toString, | |
| hasOwn = Object.prototype.hasOwnProperty; | |
| /** | |
| * Taken from jQuery 1.6.1 | |
| * @function isFunction | |
| * @memberof OpenSeadragon | |
| * @see {@link http://www.jquery.com/ jQuery} | |
| */ | |
| $.isFunction = function( obj ) { | |
| return $.type(obj) === "function"; | |
| }; | |
| /** | |
| * Taken from jQuery 1.6.1 | |
| * @function isArray | |
| * @memberof OpenSeadragon | |
| * @see {@link http://www.jquery.com/ jQuery} | |
| */ | |
| $.isArray = Array.isArray || function( obj ) { | |
| return $.type(obj) === "array"; | |
| }; | |
| /** | |
| * A crude way of determining if an object is a window. | |
| * Taken from jQuery 1.6.1 | |
| * @function isWindow | |
| * @memberof OpenSeadragon | |
| * @see {@link http://www.jquery.com/ jQuery} | |
| */ | |
| $.isWindow = function( obj ) { | |
| return obj && typeof obj === "object" && "setInterval" in obj; | |
| }; | |
| /** | |
| * Taken from jQuery 1.6.1 | |
| * @function type | |
| * @memberof OpenSeadragon | |
| * @see {@link http://www.jquery.com/ jQuery} | |
| */ | |
| $.type = function( obj ) { | |
| return ( obj === null ) || ( obj === undefined ) ? | |
| String( obj ) : | |
| class2type[ toString.call(obj) ] || "object"; | |
| }; | |
| /** | |
| * Taken from jQuery 1.6.1 | |
| * @function isPlainObject | |
| * @memberof OpenSeadragon | |
| * @see {@link http://www.jquery.com/ jQuery} | |
| */ | |
| $.isPlainObject = function( obj ) { | |
| // Must be an Object. | |
| // Because of IE, we also have to check the presence of the constructor property. | |
| // Make sure that DOM nodes and window objects don't pass through, as well | |
| if ( !obj || OpenSeadragon.type(obj) !== "object" || obj.nodeType || $.isWindow( obj ) ) { | |
| return false; | |
| } | |
| // Not own constructor property must be Object | |
| if ( obj.constructor && | |
| !hasOwn.call(obj, "constructor") && | |
| !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) { | |
| return false; | |
| } | |
| // Own properties are enumerated firstly, so to speed up, | |
| // if last one is own, then all properties are own. | |
| var lastKey; | |
| for (var key in obj ) { | |
| lastKey = key; | |
| } | |
| return lastKey === undefined || hasOwn.call( obj, lastKey ); | |
| }; | |
| /** | |
| * Taken from jQuery 1.6.1 | |
| * @function isEmptyObject | |
| * @memberof OpenSeadragon | |
| * @see {@link http://www.jquery.com/ jQuery} | |
| */ | |
| $.isEmptyObject = function( obj ) { | |
| for ( var name in obj ) { | |
| return false; | |
| } | |
| return true; | |
| }; | |
| /** | |
| * Shim around Object.freeze. Does nothing if Object.freeze is not supported. | |
| * @param {Object} obj The object to freeze. | |
| * @returns {Object} obj The frozen object. | |
| */ | |
| $.freezeObject = function(obj) { | |
| if (Object.freeze) { | |
| $.freezeObject = Object.freeze; | |
| } else { | |
| $.freezeObject = function(obj) { | |
| return obj; | |
| }; | |
| } | |
| return $.freezeObject(obj); | |
| }; | |
| /** | |
| * True if the browser supports the HTML5 canvas element | |
| * @member {Boolean} supportsCanvas | |
| * @memberof OpenSeadragon | |
| */ | |
| $.supportsCanvas = (function () { | |
| var canvasElement = document.createElement( 'canvas' ); | |
| return !!( $.isFunction( canvasElement.getContext ) && | |
| canvasElement.getContext( '2d' ) ); | |
| }()); | |
| /** | |
| * Test whether the submitted canvas is tainted or not. | |
| * @argument {Canvas} canvas The canvas to test. | |
| * @returns {Boolean} True if the canvas is tainted. | |
| */ | |
| $.isCanvasTainted = function(canvas) { | |
| var isTainted = false; | |
| try { | |
| // We test if the canvas is tainted by retrieving data from it. | |
| // An exception will be raised if the canvas is tainted. | |
| canvas.getContext('2d').getImageData(0, 0, 1, 1); | |
| } catch (e) { | |
| isTainted = true; | |
| } | |
| return isTainted; | |
| }; | |
| /** | |
| * True if the browser supports the EventTarget.addEventListener() method | |
| * @member {Boolean} supportsAddEventListener | |
| * @memberof OpenSeadragon | |
| */ | |
| $.supportsAddEventListener = (function () { | |
| return !!(document.documentElement.addEventListener && document.addEventListener); | |
| }()); | |
| /** | |
| * True if the browser supports the EventTarget.removeEventListener() method | |
| * @member {Boolean} supportsRemoveEventListener | |
| * @memberof OpenSeadragon | |
| */ | |
| $.supportsRemoveEventListener = (function () { | |
| return !!(document.documentElement.removeEventListener && document.removeEventListener); | |
| }()); | |
| /** | |
| * True if the browser supports the newer EventTarget.addEventListener options argument | |
| * @member {Boolean} supportsEventListenerOptions | |
| * @memberof OpenSeadragon | |
| */ | |
| $.supportsEventListenerOptions = (function () { | |
| var supported = 0; | |
| if ( $.supportsAddEventListener ) { | |
| try { | |
| var options = { | |
| get capture() { | |
| supported++; | |
| return false; | |
| }, | |
| get once() { | |
| supported++; | |
| return false; | |
| }, | |
| get passive() { | |
| supported++; | |
| return false; | |
| } | |
| }; | |
| window.addEventListener("test", null, options); | |
| window.removeEventListener("test", null, options); | |
| } catch ( e ) { | |
| supported = 0; | |
| } | |
| } | |
| return supported >= 3; | |
| }()); | |
| /** | |
| * If true, OpenSeadragon uses async execution, else it uses synchronous execution. | |
| * Note that disabling async means no plugins that use Promises / async will work with OSD. | |
| * @member {boolean} | |
| * @memberof OpenSeadragon | |
| */ | |
| $.supportsAsync = true; | |
| /** | |
| * 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. | |
| * @function getCurrentPixelDensityRatio | |
| * @memberof OpenSeadragon | |
| * @returns {Number} | |
| */ | |
| $.getCurrentPixelDensityRatio = function() { | |
| if ( $.supportsCanvas ) { | |
| var context = document.createElement('canvas').getContext('2d'); | |
| var devicePixelRatio = window.devicePixelRatio || 1; | |
| var backingStoreRatio = context.webkitBackingStorePixelRatio || | |
| context.mozBackingStorePixelRatio || | |
| context.msBackingStorePixelRatio || | |
| context.oBackingStorePixelRatio || | |
| context.backingStorePixelRatio || 1; | |
| return Math.max(devicePixelRatio, 1) / backingStoreRatio; | |
| } else { | |
| return 1; | |
| } | |
| }; | |
| /** | |
| * 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 | |
| * @memberof OpenSeadragon | |
| */ | |
| $.pixelDensityRatio = $.getCurrentPixelDensityRatio(); | |
| }( OpenSeadragon )); | |
| /** | |
| * This closure defines all static methods available to the OpenSeadragon | |
| * namespace. Many, if not most, are taken directly from jQuery for use | |
| * to simplify and reduce common programming patterns. More static methods | |
| * from jQuery may eventually make their way into this though we are | |
| * attempting to avoid an explicit dependency on jQuery only because | |
| * OpenSeadragon is a broadly useful code base and would be made less broad | |
| * by requiring jQuery fully. | |
| * | |
| * Some static methods have also been refactored from the original OpenSeadragon | |
| * project. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * Taken from jQuery 1.6.1 | |
| * @function extend | |
| * @memberof OpenSeadragon | |
| * @see {@link http://www.jquery.com/ jQuery} | |
| */ | |
| $.extend = function() { | |
| var options, | |
| name, | |
| src, | |
| copy, | |
| copyIsArray, | |
| clone, | |
| target = arguments[ 0 ] || {}, | |
| length = arguments.length, | |
| deep = false, | |
| i = 1; | |
| // Handle a deep copy situation | |
| if ( typeof target === "boolean" ) { | |
| deep = target; | |
| target = arguments[ 1 ] || {}; | |
| // skip the boolean and the target | |
| i = 2; | |
| } | |
| // Handle case when target is a string or something (possible in deep copy) | |
| if ( typeof target !== "object" && !OpenSeadragon.isFunction( target ) ) { | |
| target = {}; | |
| } | |
| // extend jQuery itself if only one argument is passed | |
| if ( length === i ) { | |
| target = this; | |
| --i; | |
| } | |
| for ( ; i < length; i++ ) { | |
| // Only deal with non-null/undefined values | |
| options = arguments[ i ]; | |
| if ( options !== null || options !== undefined ) { | |
| // Extend the base object | |
| for ( name in options ) { | |
| var descriptor = Object.getOwnPropertyDescriptor(options, name); | |
| if (descriptor !== undefined) { | |
| if (descriptor.get || descriptor.set) { | |
| Object.defineProperty(target, name, descriptor); | |
| continue; | |
| } | |
| copy = descriptor.value; | |
| } else { | |
| $.console.warn('Could not copy inherited property "' + name + '".'); | |
| continue; | |
| } | |
| // Prevent never-ending loop | |
| if ( target === copy ) { | |
| continue; | |
| } | |
| // Recurse if we're merging plain objects or arrays | |
| if ( deep && copy && ( OpenSeadragon.isPlainObject( copy ) || ( copyIsArray = OpenSeadragon.isArray( copy ) ) ) ) { | |
| src = target[ name ]; | |
| if ( copyIsArray ) { | |
| copyIsArray = false; | |
| clone = src && OpenSeadragon.isArray( src ) ? src : []; | |
| } else { | |
| clone = src && OpenSeadragon.isPlainObject( src ) ? src : {}; | |
| } | |
| // Never move original objects, clone them | |
| target[ name ] = OpenSeadragon.extend( deep, clone, copy ); | |
| // Don't bring in undefined values | |
| } else if ( copy !== undefined ) { | |
| target[ name ] = copy; | |
| } | |
| } | |
| } | |
| } | |
| // Return the modified object | |
| return target; | |
| }; | |
| var isIOSDevice = function () { | |
| if (typeof navigator !== 'object') { | |
| return false; | |
| } | |
| var userAgent = navigator.userAgent; | |
| if (typeof userAgent !== 'string') { | |
| return false; | |
| } | |
| return userAgent.indexOf('iPhone') !== -1 || | |
| userAgent.indexOf('iPad') !== -1 || | |
| userAgent.indexOf('iPod') !== -1; | |
| }; | |
| $.extend( $, /** @lends OpenSeadragon */{ | |
| /** | |
| * The default values for the optional settings documented at {@link OpenSeadragon.Options}. | |
| * @static | |
| * @type {Object} | |
| */ | |
| DEFAULT_SETTINGS: { | |
| //DATA SOURCE DETAILS | |
| xmlPath: null, | |
| tileSources: null, | |
| tileHost: null, | |
| initialPage: 0, | |
| crossOriginPolicy: false, | |
| ajaxWithCredentials: false, | |
| loadTilesWithAjax: false, | |
| ajaxHeaders: {}, | |
| splitHashDataForPost: false, | |
| callTileLoadedWithCachedData: false, | |
| //PAN AND ZOOM SETTINGS AND CONSTRAINTS | |
| panHorizontal: true, | |
| panVertical: true, | |
| constrainDuringPan: false, | |
| wrapHorizontal: false, | |
| wrapVertical: false, | |
| visibilityRatio: 0.5, //-> how much of the viewer can be negative space | |
| minPixelRatio: 0.5, //->closer to 0 draws tiles meant for a higher zoom at this zoom | |
| defaultZoomLevel: 0, | |
| minZoomLevel: null, | |
| maxZoomLevel: null, | |
| homeFillsViewer: false, | |
| //UI RESPONSIVENESS AND FEEL | |
| clickTimeThreshold: 300, | |
| clickDistThreshold: 5, | |
| dblClickTimeThreshold: 300, | |
| dblClickDistThreshold: 20, | |
| springStiffness: 6.5, | |
| animationTime: 1.2, | |
| loadDestinationTilesOnAnimation: true, | |
| gestureSettingsMouse: { | |
| dragToPan: true, | |
| scrollToZoom: true, | |
| clickToZoom: true, | |
| dblClickToZoom: false, | |
| dblClickDragToZoom: false, | |
| pinchToZoom: false, | |
| zoomToRefPoint: true, | |
| flickEnabled: false, | |
| flickMinSpeed: 120, | |
| flickMomentum: 0.25, | |
| pinchRotate: false | |
| }, | |
| gestureSettingsTouch: { | |
| dragToPan: true, | |
| scrollToZoom: false, | |
| clickToZoom: false, | |
| dblClickToZoom: true, | |
| dblClickDragToZoom: true, | |
| pinchToZoom: true, | |
| zoomToRefPoint: true, | |
| flickEnabled: true, | |
| flickMinSpeed: 120, | |
| flickMomentum: 0.25, | |
| pinchRotate: false | |
| }, | |
| gestureSettingsPen: { | |
| dragToPan: true, | |
| scrollToZoom: false, | |
| clickToZoom: true, | |
| dblClickToZoom: false, | |
| dblClickDragToZoom: false, | |
| pinchToZoom: false, | |
| zoomToRefPoint: true, | |
| flickEnabled: false, | |
| flickMinSpeed: 120, | |
| flickMomentum: 0.25, | |
| pinchRotate: false | |
| }, | |
| gestureSettingsUnknown: { | |
| dragToPan: true, | |
| scrollToZoom: false, | |
| clickToZoom: false, | |
| dblClickToZoom: true, | |
| dblClickDragToZoom: false, | |
| pinchToZoom: true, | |
| zoomToRefPoint: true, | |
| flickEnabled: true, | |
| flickMinSpeed: 120, | |
| flickMomentum: 0.25, | |
| pinchRotate: false | |
| }, | |
| zoomPerClick: 2, | |
| zoomPerScroll: 1.2, | |
| zoomPerDblClickDrag: 1.2, | |
| zoomPerSecond: 1.0, | |
| blendTime: 0, | |
| alwaysBlend: false, | |
| autoHideControls: true, | |
| immediateRender: false, | |
| minZoomImageRatio: 0.9, //-> closer to 0 allows zoom out to infinity | |
| maxZoomPixelRatio: 1.1, //-> higher allows 'over zoom' into pixels | |
| smoothTileEdgesMinZoom: 1.1, //-> higher than maxZoomPixelRatio disables it | |
| iOSDevice: isIOSDevice(), | |
| pixelsPerWheelLine: 40, | |
| pixelsPerArrowPress: 40, | |
| autoResize: true, | |
| preserveImageSizeOnResize: false, // requires autoResize=true | |
| minScrollDeltaTime: 50, | |
| rotationIncrement: 90, | |
| maxTilesPerFrame: 1, | |
| //DEFAULT CONTROL SETTINGS | |
| showSequenceControl: true, //SEQUENCE | |
| sequenceControlAnchor: null, //SEQUENCE | |
| preserveViewport: false, //SEQUENCE | |
| preserveOverlays: false, //SEQUENCE | |
| navPrevNextWrap: false, //SEQUENCE | |
| showNavigationControl: true, //ZOOM/HOME/FULL/ROTATION | |
| navigationControlAnchor: null, //ZOOM/HOME/FULL/ROTATION | |
| showZoomControl: true, //ZOOM | |
| showHomeControl: true, //HOME | |
| showFullPageControl: true, //FULL | |
| showRotationControl: false, //ROTATION | |
| showFlipControl: false, //FLIP | |
| controlsFadeDelay: 2000, //ZOOM/HOME/FULL/SEQUENCE | |
| controlsFadeLength: 1500, //ZOOM/HOME/FULL/SEQUENCE | |
| mouseNavEnabled: true, //GENERAL MOUSE INTERACTIVITY | |
| //VIEWPORT NAVIGATOR SETTINGS | |
| showNavigator: false, | |
| navigatorElement: null, | |
| navigatorId: null, | |
| navigatorPosition: null, | |
| navigatorSizeRatio: 0.2, | |
| navigatorMaintainSizeRatio: false, | |
| navigatorTop: null, | |
| navigatorLeft: null, | |
| navigatorHeight: null, | |
| navigatorWidth: null, | |
| navigatorAutoResize: true, | |
| navigatorAutoFade: true, | |
| navigatorRotate: true, | |
| navigatorBackground: '#000', | |
| navigatorOpacity: 0.8, | |
| navigatorBorderColor: '#555', | |
| navigatorDisplayRegionColor: '#900', | |
| // INITIAL ROTATION | |
| degrees: 0, | |
| // INITIAL FLIP STATE | |
| flipped: false, | |
| overlayPreserveContentDirection: true, | |
| // APPEARANCE | |
| opacity: 1, // to be passed into each TiledImage | |
| compositeOperation: null, // to be passed into each TiledImage | |
| // DRAWER SETTINGS | |
| drawer: ['webgl', 'canvas', 'html'], // prefer using webgl, then canvas (i.e. context2d), then fallback to html | |
| drawerOptions: { | |
| webgl: { | |
| }, | |
| canvas: { | |
| }, | |
| html: { | |
| }, | |
| custom: { | |
| } | |
| }, | |
| // TILED IMAGE SETTINGS | |
| preload: false, // to be passed into each TiledImage | |
| imageSmoothingEnabled: true, // to be passed into each TiledImage | |
| placeholderFillStyle: null, // to be passed into each TiledImage | |
| subPixelRoundingForTransparency: null, // to be passed into each TiledImage | |
| //REFERENCE STRIP SETTINGS | |
| showReferenceStrip: false, | |
| referenceStripScroll: 'horizontal', | |
| referenceStripElement: null, | |
| referenceStripHeight: null, | |
| referenceStripWidth: null, | |
| referenceStripPosition: 'BOTTOM_LEFT', | |
| referenceStripSizeRatio: 0.2, | |
| //COLLECTION VISUALIZATION SETTINGS | |
| collectionRows: 3, //or columns depending on layout | |
| collectionColumns: 0, //columns in horizontal layout, rows in vertical layout | |
| collectionLayout: 'horizontal', //vertical | |
| collectionMode: false, | |
| collectionTileSize: 800, | |
| collectionTileMargin: 80, | |
| //PERFORMANCE SETTINGS | |
| imageLoaderLimit: 0, | |
| maxImageCacheCount: 200, | |
| timeout: 30000, | |
| tileRetryMax: 0, | |
| tileRetryDelay: 2500, | |
| //INTERFACE RESOURCE SETTINGS | |
| prefixUrl: "/images/", | |
| navImages: { | |
| zoomIn: { | |
| REST: 'zoomin_rest.png', | |
| GROUP: 'zoomin_grouphover.png', | |
| HOVER: 'zoomin_hover.png', | |
| DOWN: 'zoomin_pressed.png' | |
| }, | |
| zoomOut: { | |
| REST: 'zoomout_rest.png', | |
| GROUP: 'zoomout_grouphover.png', | |
| HOVER: 'zoomout_hover.png', | |
| DOWN: 'zoomout_pressed.png' | |
| }, | |
| home: { | |
| REST: 'home_rest.png', | |
| GROUP: 'home_grouphover.png', | |
| HOVER: 'home_hover.png', | |
| DOWN: 'home_pressed.png' | |
| }, | |
| fullpage: { | |
| REST: 'fullpage_rest.png', | |
| GROUP: 'fullpage_grouphover.png', | |
| HOVER: 'fullpage_hover.png', | |
| DOWN: 'fullpage_pressed.png' | |
| }, | |
| rotateleft: { | |
| REST: 'rotateleft_rest.png', | |
| GROUP: 'rotateleft_grouphover.png', | |
| HOVER: 'rotateleft_hover.png', | |
| DOWN: 'rotateleft_pressed.png' | |
| }, | |
| rotateright: { | |
| REST: 'rotateright_rest.png', | |
| GROUP: 'rotateright_grouphover.png', | |
| HOVER: 'rotateright_hover.png', | |
| DOWN: 'rotateright_pressed.png' | |
| }, | |
| flip: { // Flip icon designed by Yaroslav Samoylov from the Noun Project and modified by Nelson Campos ncampos@criteriamarathon.com, https://thenounproject.com/term/flip/136289/ | |
| REST: 'flip_rest.png', | |
| GROUP: 'flip_grouphover.png', | |
| HOVER: 'flip_hover.png', | |
| DOWN: 'flip_pressed.png' | |
| }, | |
| previous: { | |
| REST: 'previous_rest.png', | |
| GROUP: 'previous_grouphover.png', | |
| HOVER: 'previous_hover.png', | |
| DOWN: 'previous_pressed.png' | |
| }, | |
| next: { | |
| REST: 'next_rest.png', | |
| GROUP: 'next_grouphover.png', | |
| HOVER: 'next_hover.png', | |
| DOWN: 'next_pressed.png' | |
| } | |
| }, | |
| //DEVELOPER SETTINGS | |
| debugMode: false, | |
| debugGridColor: ['#437AB2', '#1B9E77', '#D95F02', '#7570B3', '#E7298A', '#66A61E', '#E6AB02', '#A6761D', '#666666'], | |
| silenceMultiImageWarnings: false | |
| }, | |
| /** | |
| * Returns a function which invokes the method as if it were a method belonging to the object. | |
| * @function | |
| * @param {Object} object | |
| * @param {Function} method | |
| * @returns {Function} | |
| */ | |
| delegate: function( object, method ) { | |
| return function(){ | |
| var args = arguments; | |
| if ( args === undefined ){ | |
| args = []; | |
| } | |
| return method.apply( object, args ); | |
| }; | |
| }, | |
| /** | |
| * An enumeration of Browser vendors. | |
| * @static | |
| * @type {Object} | |
| * @property {Number} UNKNOWN | |
| * @property {Number} IE | |
| * @property {Number} FIREFOX | |
| * @property {Number} SAFARI | |
| * @property {Number} CHROME | |
| * @property {Number} OPERA | |
| * @property {Number} EDGE | |
| * @property {Number} CHROMEEDGE | |
| */ | |
| BROWSERS: { | |
| UNKNOWN: 0, | |
| IE: 1, | |
| FIREFOX: 2, | |
| SAFARI: 3, | |
| CHROME: 4, | |
| OPERA: 5, | |
| EDGE: 6, | |
| CHROMEEDGE: 7 | |
| }, | |
| /** | |
| * An enumeration of when subpixel rounding should occur. | |
| * @static | |
| * @type {Object} | |
| * @property {Number} NEVER Never apply subpixel rounding for transparency. | |
| * @property {Number} ONLY_AT_REST Do not apply subpixel rounding for transparency during animation (panning, zoom, rotation) and apply it once animation is over. | |
| * @property {Number} ALWAYS Apply subpixel rounding for transparency during animation and when animation is over. | |
| */ | |
| SUBPIXEL_ROUNDING_OCCURRENCES: { | |
| NEVER: 0, | |
| ONLY_AT_REST: 1, | |
| ALWAYS: 2 | |
| }, | |
| /** | |
| * Keep track of which {@link Viewer}s have been created. | |
| * - Key: {@link Element} to which a Viewer is attached. | |
| * - Value: {@link Viewer} of the element defined by the key. | |
| * @private | |
| * @static | |
| * @type {Object} | |
| */ | |
| _viewers: new Map(), | |
| /** | |
| * Returns the {@link Viewer} attached to a given DOM element. If there is | |
| * no viewer attached to the provided element, undefined is returned. | |
| * @function | |
| * @param {String|Element} element Accepts an id or element. | |
| * @returns {Viewer} The viewer attached to the given element, or undefined. | |
| */ | |
| getViewer: function(element) { | |
| return $._viewers.get(this.getElement(element)); | |
| }, | |
| /** | |
| * Returns a DOM Element for the given id or element. | |
| * @function | |
| * @param {String|Element} element Accepts an id or element. | |
| * @returns {Element} The element with the given id, null, or the element itself. | |
| */ | |
| getElement: function( element ) { | |
| if ( typeof ( element ) === "string" ) { | |
| element = document.getElementById( element ); | |
| } | |
| return element; | |
| }, | |
| /** | |
| * Determines the position of the upper-left corner of the element. | |
| * @function | |
| * @param {Element|String} element - the element we want the position for. | |
| * @returns {OpenSeadragon.Point} - the position of the upper left corner of the element. | |
| */ | |
| getElementPosition: function( element ) { | |
| var result = new $.Point(), | |
| isFixed, | |
| offsetParent; | |
| element = $.getElement( element ); | |
| isFixed = $.getElementStyle( element ).position === "fixed"; | |
| offsetParent = getOffsetParent( element, isFixed ); | |
| while ( offsetParent ) { | |
| result.x += element.offsetLeft; | |
| result.y += element.offsetTop; | |
| if ( isFixed ) { | |
| result = result.plus( $.getPageScroll() ); | |
| } | |
| element = offsetParent; | |
| isFixed = $.getElementStyle( element ).position === "fixed"; | |
| offsetParent = getOffsetParent( element, isFixed ); | |
| } | |
| return result; | |
| }, | |
| /** | |
| * Determines the position of the upper-left corner of the element adjusted for current page and/or element scroll. | |
| * @function | |
| * @param {Element|String} element - the element we want the position for. | |
| * @returns {OpenSeadragon.Point} - the position of the upper left corner of the element adjusted for current page and/or element scroll. | |
| */ | |
| getElementOffset: function( element ) { | |
| element = $.getElement( element ); | |
| var doc = element && element.ownerDocument, | |
| docElement, | |
| win, | |
| boundingRect = { top: 0, left: 0 }; | |
| if ( !doc ) { | |
| return new $.Point(); | |
| } | |
| docElement = doc.documentElement; | |
| if ( typeof element.getBoundingClientRect !== typeof undefined ) { | |
| boundingRect = element.getBoundingClientRect(); | |
| } | |
| win = ( doc === doc.window ) ? | |
| doc : | |
| ( doc.nodeType === 9 ) ? | |
| doc.defaultView || doc.parentWindow : | |
| false; | |
| return new $.Point( | |
| boundingRect.left + ( win.pageXOffset || docElement.scrollLeft ) - ( docElement.clientLeft || 0 ), | |
| boundingRect.top + ( win.pageYOffset || docElement.scrollTop ) - ( docElement.clientTop || 0 ) | |
| ); | |
| }, | |
| /** | |
| * Determines the height and width of the given element. | |
| * @function | |
| * @param {Element|String} element | |
| * @returns {OpenSeadragon.Point} | |
| */ | |
| getElementSize: function( element ) { | |
| element = $.getElement( element ); | |
| return new $.Point( | |
| element.clientWidth, | |
| element.clientHeight | |
| ); | |
| }, | |
| /** | |
| * Returns the CSSStyle object for the given element. | |
| * @function | |
| * @param {Element|String} element | |
| * @returns {CSSStyle} | |
| */ | |
| getElementStyle: | |
| document.documentElement.currentStyle ? | |
| function( element ) { | |
| element = $.getElement( element ); | |
| return element.currentStyle; | |
| } : | |
| function( element ) { | |
| element = $.getElement( element ); | |
| return window.getComputedStyle( element, "" ); | |
| }, | |
| /** | |
| * Returns the property with the correct vendor prefix appended. | |
| * @param {String} property the property name | |
| * @returns {String} the property with the correct prefix or null if not | |
| * supported. | |
| */ | |
| getCssPropertyWithVendorPrefix: function(property) { | |
| var memo = {}; | |
| $.getCssPropertyWithVendorPrefix = function(property) { | |
| if (memo[property] !== undefined) { | |
| return memo[property]; | |
| } | |
| var style = document.createElement('div').style; | |
| var result = null; | |
| if (style[property] !== undefined) { | |
| result = property; | |
| } else { | |
| var prefixes = ['Webkit', 'Moz', 'MS', 'O', | |
| 'webkit', 'moz', 'ms', 'o']; | |
| var suffix = $.capitalizeFirstLetter(property); | |
| for (var i = 0; i < prefixes.length; i++) { | |
| var prop = prefixes[i] + suffix; | |
| if (style[prop] !== undefined) { | |
| result = prop; | |
| break; | |
| } | |
| } | |
| } | |
| memo[property] = result; | |
| return result; | |
| }; | |
| return $.getCssPropertyWithVendorPrefix(property); | |
| }, | |
| /** | |
| * Capitalizes the first letter of a string | |
| * @param {String} string | |
| * @returns {String} The string with the first letter capitalized | |
| */ | |
| capitalizeFirstLetter: function(string) { | |
| return string.charAt(0).toUpperCase() + string.slice(1); | |
| }, | |
| /** | |
| * Compute the modulo of a number but makes sure to always return | |
| * a positive value (also known as Euclidean modulo). | |
| * @param {Number} number the number to compute the modulo of | |
| * @param {Number} modulo the modulo | |
| * @returns {Number} the result of the modulo of number | |
| */ | |
| positiveModulo: function(number, modulo) { | |
| var result = number % modulo; | |
| if (result < 0) { | |
| result += modulo; | |
| } | |
| return result; | |
| }, | |
| /** | |
| * Determines if a point is within the bounding rectangle of the given element (hit-test). | |
| * @function | |
| * @param {Element|String} element | |
| * @param {OpenSeadragon.Point} point | |
| * @returns {Boolean} | |
| */ | |
| pointInElement: function( element, point ) { | |
| element = $.getElement( element ); | |
| var offset = $.getElementOffset( element ), | |
| size = $.getElementSize( element ); | |
| return point.x >= offset.x && point.x < offset.x + size.x && point.y < offset.y + size.y && point.y >= offset.y; | |
| }, | |
| /** | |
| * Gets the position of the mouse on the screen for a given event. | |
| * @function | |
| * @param {Event} [event] | |
| * @returns {OpenSeadragon.Point} | |
| */ | |
| getMousePosition: function( event ) { | |
| if ( typeof ( event.pageX ) === "number" ) { | |
| $.getMousePosition = function( event ){ | |
| var result = new $.Point(); | |
| result.x = event.pageX; | |
| result.y = event.pageY; | |
| return result; | |
| }; | |
| } else if ( typeof ( event.clientX ) === "number" ) { | |
| $.getMousePosition = function( event ){ | |
| var result = new $.Point(); | |
| result.x = | |
| event.clientX + | |
| document.body.scrollLeft + | |
| document.documentElement.scrollLeft; | |
| result.y = | |
| event.clientY + | |
| document.body.scrollTop + | |
| document.documentElement.scrollTop; | |
| return result; | |
| }; | |
| } else { | |
| throw new Error( | |
| "Unknown event mouse position, no known technique." | |
| ); | |
| } | |
| return $.getMousePosition( event ); | |
| }, | |
| /** | |
| * Determines the page's current scroll position. | |
| * @function | |
| * @returns {OpenSeadragon.Point} | |
| */ | |
| getPageScroll: function() { | |
| var docElement = document.documentElement || {}, | |
| body = document.body || {}; | |
| if ( typeof ( window.pageXOffset ) === "number" ) { | |
| $.getPageScroll = function(){ | |
| return new $.Point( | |
| window.pageXOffset, | |
| window.pageYOffset | |
| ); | |
| }; | |
| } else if ( body.scrollLeft || body.scrollTop ) { | |
| $.getPageScroll = function(){ | |
| return new $.Point( | |
| document.body.scrollLeft, | |
| document.body.scrollTop | |
| ); | |
| }; | |
| } else if ( docElement.scrollLeft || docElement.scrollTop ) { | |
| $.getPageScroll = function(){ | |
| return new $.Point( | |
| document.documentElement.scrollLeft, | |
| document.documentElement.scrollTop | |
| ); | |
| }; | |
| } else { | |
| // We can't reassign the function yet, as there was no scroll. | |
| return new $.Point(0, 0); | |
| } | |
| return $.getPageScroll(); | |
| }, | |
| /** | |
| * Set the page scroll position. | |
| * @function | |
| * @returns {OpenSeadragon.Point} | |
| */ | |
| setPageScroll: function( scroll ) { | |
| if ( typeof ( window.scrollTo ) !== "undefined" ) { | |
| $.setPageScroll = function( scroll ) { | |
| window.scrollTo( scroll.x, scroll.y ); | |
| }; | |
| } else { | |
| var originalScroll = $.getPageScroll(); | |
| if ( originalScroll.x === scroll.x && | |
| originalScroll.y === scroll.y ) { | |
| // We are already correctly positioned and there | |
| // is no way to detect the correct method. | |
| return; | |
| } | |
| document.body.scrollLeft = scroll.x; | |
| document.body.scrollTop = scroll.y; | |
| var currentScroll = $.getPageScroll(); | |
| if ( currentScroll.x !== originalScroll.x && | |
| currentScroll.y !== originalScroll.y ) { | |
| $.setPageScroll = function( scroll ) { | |
| document.body.scrollLeft = scroll.x; | |
| document.body.scrollTop = scroll.y; | |
| }; | |
| return; | |
| } | |
| document.documentElement.scrollLeft = scroll.x; | |
| document.documentElement.scrollTop = scroll.y; | |
| currentScroll = $.getPageScroll(); | |
| if ( currentScroll.x !== originalScroll.x && | |
| currentScroll.y !== originalScroll.y ) { | |
| $.setPageScroll = function( scroll ) { | |
| document.documentElement.scrollLeft = scroll.x; | |
| document.documentElement.scrollTop = scroll.y; | |
| }; | |
| return; | |
| } | |
| // We can't find anything working, so we do nothing. | |
| $.setPageScroll = function( scroll ) { | |
| }; | |
| } | |
| $.setPageScroll( scroll ); | |
| }, | |
| /** | |
| * Determines the size of the browsers window. | |
| * @function | |
| * @returns {OpenSeadragon.Point} | |
| */ | |
| getWindowSize: function() { | |
| var docElement = document.documentElement || {}, | |
| body = document.body || {}; | |
| if ( typeof ( window.innerWidth ) === 'number' ) { | |
| $.getWindowSize = function(){ | |
| return new $.Point( | |
| window.innerWidth, | |
| window.innerHeight | |
| ); | |
| }; | |
| } else if ( docElement.clientWidth || docElement.clientHeight ) { | |
| $.getWindowSize = function(){ | |
| return new $.Point( | |
| document.documentElement.clientWidth, | |
| document.documentElement.clientHeight | |
| ); | |
| }; | |
| } else if ( body.clientWidth || body.clientHeight ) { | |
| $.getWindowSize = function(){ | |
| return new $.Point( | |
| document.body.clientWidth, | |
| document.body.clientHeight | |
| ); | |
| }; | |
| } else { | |
| throw new Error("Unknown window size, no known technique."); | |
| } | |
| return $.getWindowSize(); | |
| }, | |
| /** | |
| * Wraps the given element in a nest of divs so that the element can | |
| * be easily centered using CSS tables | |
| * @function | |
| * @param {Element|String} element | |
| * @returns {Element} outermost wrapper element | |
| */ | |
| makeCenteredNode: function( element ) { | |
| // Convert a possible ID to an actual HTMLElement | |
| element = $.getElement( element ); | |
| /* | |
| CSS tables require you to have a display:table/row/cell hierarchy so we need to create | |
| three nested wrapper divs: | |
| */ | |
| var wrappers = [ | |
| $.makeNeutralElement( 'div' ), | |
| $.makeNeutralElement( 'div' ), | |
| $.makeNeutralElement( 'div' ) | |
| ]; | |
| // It feels like we should be able to pass style dicts to makeNeutralElement: | |
| $.extend(wrappers[0].style, { | |
| display: "table", | |
| height: "100%", | |
| width: "100%" | |
| }); | |
| $.extend(wrappers[1].style, { | |
| display: "table-row" | |
| }); | |
| $.extend(wrappers[2].style, { | |
| display: "table-cell", | |
| verticalAlign: "middle", | |
| textAlign: "center" | |
| }); | |
| wrappers[0].appendChild(wrappers[1]); | |
| wrappers[1].appendChild(wrappers[2]); | |
| wrappers[2].appendChild(element); | |
| return wrappers[0]; | |
| }, | |
| /** | |
| * Creates an easily positionable element of the given type that therefor | |
| * serves as an excellent container element. | |
| * @function | |
| * @param {String} tagName | |
| * @returns {Element} | |
| */ | |
| makeNeutralElement: function( tagName ) { | |
| var element = document.createElement( tagName ), | |
| style = element.style; | |
| style.background = "transparent none"; | |
| style.border = "none"; | |
| style.margin = "0px"; | |
| style.padding = "0px"; | |
| style.position = "static"; | |
| return element; | |
| }, | |
| /** | |
| * Returns the current milliseconds, using Date.now() if available | |
| * @function | |
| */ | |
| now: function( ) { | |
| if (Date.now) { | |
| $.now = Date.now; | |
| } else { | |
| $.now = function() { | |
| return new Date().getTime(); | |
| }; | |
| } | |
| return $.now(); | |
| }, | |
| /** | |
| * Ensures an image is loaded correctly to support alpha transparency. | |
| * @function | |
| * @param {String} src | |
| * @returns {Element} | |
| */ | |
| makeTransparentImage: function( src ) { | |
| var img = $.makeNeutralElement( "img" ); | |
| img.src = src; | |
| return img; | |
| }, | |
| /** | |
| * Sets the opacity of the specified element. | |
| * @function | |
| * @param {Element|String} element | |
| * @param {Number} opacity | |
| * @param {Boolean} [usesAlpha] | |
| */ | |
| setElementOpacity: function( element, opacity, usesAlpha ) { | |
| var ieOpacity, | |
| ieFilter; | |
| element = $.getElement( element ); | |
| if ( usesAlpha && !$.Browser.alpha ) { | |
| opacity = Math.round( opacity ); | |
| } | |
| if ( $.Browser.opacity ) { | |
| element.style.opacity = opacity < 1 ? opacity : ""; | |
| } else { | |
| if ( opacity < 1 ) { | |
| ieOpacity = Math.round( 100 * opacity ); | |
| ieFilter = "alpha(opacity=" + ieOpacity + ")"; | |
| element.style.filter = ieFilter; | |
| } else { | |
| element.style.filter = ""; | |
| } | |
| } | |
| }, | |
| /** | |
| * Sets the specified element's touch-action style attribute to 'none'. | |
| * @function | |
| * @param {Element|String} element | |
| */ | |
| setElementTouchActionNone: function( element ) { | |
| element = $.getElement( element ); | |
| if ( typeof element.style.touchAction !== 'undefined' ) { | |
| element.style.touchAction = 'none'; | |
| } else if ( typeof element.style.msTouchAction !== 'undefined' ) { | |
| element.style.msTouchAction = 'none'; | |
| } | |
| }, | |
| /** | |
| * Sets the specified element's pointer-events style attribute to the passed value. | |
| * @function | |
| * @param {Element|String} element | |
| * @param {String} value | |
| */ | |
| setElementPointerEvents: function( element, value ) { | |
| element = $.getElement( element ); | |
| if (typeof element.style !== 'undefined' && typeof element.style.pointerEvents !== 'undefined' ) { | |
| element.style.pointerEvents = value; | |
| } | |
| }, | |
| /** | |
| * Sets the specified element's pointer-events style attribute to 'none'. | |
| * @function | |
| * @param {Element|String} element | |
| */ | |
| setElementPointerEventsNone: function( element ) { | |
| $.setElementPointerEvents( element, 'none' ); | |
| }, | |
| /** | |
| * Add the specified CSS class to the element if not present. | |
| * @function | |
| * @param {Element|String} element | |
| * @param {String} className | |
| */ | |
| addClass: function( element, className ) { | |
| element = $.getElement( element ); | |
| if (!element.className) { | |
| element.className = className; | |
| } else if ( ( ' ' + element.className + ' ' ). | |
| indexOf( ' ' + className + ' ' ) === -1 ) { | |
| element.className += ' ' + className; | |
| } | |
| }, | |
| /** | |
| * Find the first index at which an element is found in an array or -1 | |
| * if not present. | |
| * | |
| * Code taken and adapted from | |
| * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf#Compatibility | |
| * | |
| * @function | |
| * @param {Array} array The array from which to find the element | |
| * @param {Object} searchElement The element to find | |
| * @param {Number} [fromIndex=0] Index to start research. | |
| * @returns {Number} The index of the element in the array. | |
| */ | |
| indexOf: function( array, searchElement, fromIndex ) { | |
| if ( Array.prototype.indexOf ) { | |
| this.indexOf = function( array, searchElement, fromIndex ) { | |
| return array.indexOf( searchElement, fromIndex ); | |
| }; | |
| } else { | |
| this.indexOf = function( array, searchElement, fromIndex ) { | |
| var i, | |
| pivot = ( fromIndex ) ? fromIndex : 0, | |
| length; | |
| if ( !array ) { | |
| throw new TypeError( ); | |
| } | |
| length = array.length; | |
| if ( length === 0 || pivot >= length ) { | |
| return -1; | |
| } | |
| if ( pivot < 0 ) { | |
| pivot = length - Math.abs( pivot ); | |
| } | |
| for ( i = pivot; i < length; i++ ) { | |
| if ( array[i] === searchElement ) { | |
| return i; | |
| } | |
| } | |
| return -1; | |
| }; | |
| } | |
| return this.indexOf( array, searchElement, fromIndex ); | |
| }, | |
| /** | |
| * Remove the specified CSS class from the element. | |
| * @function | |
| * @param {Element|String} element | |
| * @param {String} className | |
| */ | |
| removeClass: function( element, className ) { | |
| var oldClasses, | |
| newClasses = [], | |
| i; | |
| element = $.getElement( element ); | |
| oldClasses = element.className.split( /\s+/ ); | |
| for ( i = 0; i < oldClasses.length; i++ ) { | |
| if ( oldClasses[ i ] && oldClasses[ i ] !== className ) { | |
| newClasses.push( oldClasses[ i ] ); | |
| } | |
| } | |
| element.className = newClasses.join(' '); | |
| }, | |
| /** | |
| * Convert passed addEventListener() options to boolean or options object, | |
| * depending on browser support. | |
| * @function | |
| * @param {Boolean|Object} [options] Boolean useCapture, or if [supportsEventListenerOptions]{@link OpenSeadragon.supportsEventListenerOptions}, can be an object | |
| * @param {Boolean} [options.capture] | |
| * @param {Boolean} [options.passive] | |
| * @param {Boolean} [options.once] | |
| * @returns {String} The protocol (http:, https:, file:, ftp: ...) | |
| */ | |
| normalizeEventListenerOptions: function (options) { | |
| var opts; | |
| if ( typeof options !== 'undefined' ) { | |
| if ( typeof options === 'boolean' ) { | |
| // Legacy Boolean useCapture | |
| opts = $.supportsEventListenerOptions ? { capture: options } : options; | |
| } else { | |
| // Options object | |
| opts = $.supportsEventListenerOptions ? options : | |
| ( ( typeof options.capture !== 'undefined' ) ? options.capture : false ); | |
| } | |
| } else { | |
| // No options specified - Legacy optional useCapture argument | |
| // (for IE, first supported on version 9, so we'll pass a Boolean) | |
| opts = $.supportsEventListenerOptions ? { capture: false } : false; | |
| } | |
| return opts; | |
| }, | |
| /** | |
| * Adds an event listener for the given element, eventName and handler. | |
| * @function | |
| * @param {Element|String} element | |
| * @param {String} eventName | |
| * @param {Function} handler | |
| * @param {Boolean|Object} [options] Boolean useCapture, or if [supportsEventListenerOptions]{@link OpenSeadragon.supportsEventListenerOptions}, can be an object | |
| * @param {Boolean} [options.capture] | |
| * @param {Boolean} [options.passive] | |
| * @param {Boolean} [options.once] | |
| */ | |
| addEvent: (function () { | |
| if ( $.supportsAddEventListener ) { | |
| return function ( element, eventName, handler, options ) { | |
| options = $.normalizeEventListenerOptions(options); | |
| element = $.getElement( element ); | |
| element.addEventListener( eventName, handler, options ); | |
| }; | |
| } else if ( document.documentElement.attachEvent && document.attachEvent ) { | |
| return function ( element, eventName, handler ) { | |
| element = $.getElement( element ); | |
| element.attachEvent( 'on' + eventName, handler ); | |
| }; | |
| } else { | |
| throw new Error( "No known event model." ); | |
| } | |
| }()), | |
| /** | |
| * Remove a given event listener for the given element, event type and | |
| * handler. | |
| * @function | |
| * @param {Element|String} element | |
| * @param {String} eventName | |
| * @param {Function} handler | |
| * @param {Boolean|Object} [options] Boolean useCapture, or if [supportsEventListenerOptions]{@link OpenSeadragon.supportsEventListenerOptions}, can be an object | |
| * @param {Boolean} [options.capture] | |
| */ | |
| removeEvent: (function () { | |
| if ( $.supportsRemoveEventListener ) { | |
| return function ( element, eventName, handler, options ) { | |
| options = $.normalizeEventListenerOptions(options); | |
| element = $.getElement( element ); | |
| element.removeEventListener( eventName, handler, options ); | |
| }; | |
| } else if ( document.documentElement.detachEvent && document.detachEvent ) { | |
| return function( element, eventName, handler ) { | |
| element = $.getElement( element ); | |
| element.detachEvent( 'on' + eventName, handler ); | |
| }; | |
| } else { | |
| throw new Error( "No known event model." ); | |
| } | |
| }()), | |
| /** | |
| * Cancels the default browser behavior had the event propagated all | |
| * the way up the DOM to the window object. | |
| * @function | |
| * @param {Event} [event] | |
| */ | |
| cancelEvent: function( event ) { | |
| event.preventDefault(); | |
| }, | |
| /** | |
| * Returns true if {@link OpenSeadragon.cancelEvent|cancelEvent} has been called on | |
| * the event, otherwise returns false. | |
| * @function | |
| * @param {Event} [event] | |
| */ | |
| eventIsCanceled: function( event ) { | |
| return event.defaultPrevented; | |
| }, | |
| /** | |
| * Stops the propagation of the event through the DOM in the capturing and bubbling phases. | |
| * @function | |
| * @param {Event} [event] | |
| */ | |
| stopEvent: function( event ) { | |
| event.stopPropagation(); | |
| }, | |
| /** | |
| * Retrieves the value of a url parameter from the window.location string. | |
| * @function | |
| * @param {String} key | |
| * @returns {String} The value of the url parameter or null if no param matches. | |
| */ | |
| getUrlParameter: function( key ) { | |
| // eslint-disable-next-line no-use-before-define | |
| var value = URLPARAMS[ key ]; | |
| return value ? value : null; | |
| }, | |
| /** | |
| * Retrieves the protocol used by the url. The url can either be absolute | |
| * or relative. | |
| * @function | |
| * @private | |
| * @param {String} url The url to retrieve the protocol from. | |
| * @returns {String} The protocol (http:, https:, file:, ftp: ...) | |
| */ | |
| getUrlProtocol: function( url ) { | |
| var match = url.match(/^([a-z]+:)\/\//i); | |
| if ( match === null ) { | |
| // Relative URL, retrive the protocol from window.location | |
| return window.location.protocol; | |
| } | |
| return match[1].toLowerCase(); | |
| }, | |
| /** | |
| * Create an XHR object | |
| * @private | |
| * @param {type} [local] Deprecated. Ignored (IE/ActiveXObject file protocol no longer supported). | |
| * @returns {XMLHttpRequest} | |
| */ | |
| createAjaxRequest: function() { | |
| if ( window.XMLHttpRequest ) { | |
| $.createAjaxRequest = function() { | |
| return new XMLHttpRequest(); | |
| }; | |
| return new XMLHttpRequest(); | |
| } else { | |
| throw new Error( "Browser doesn't support XMLHttpRequest." ); | |
| } | |
| }, | |
| /** | |
| * Makes an AJAX request. | |
| * @param {String} url - the url to request | |
| * @param {Function} onSuccess | |
| * @param {Function} onError | |
| * @throws {Error} | |
| * @returns {XMLHttpRequest} | |
| * @deprecated deprecated way of calling this function | |
| *//** | |
| * Makes an AJAX request. | |
| * @param {Object} options | |
| * @param {String} options.url - the url to request | |
| * @param {Function} options.success - a function to call on a successful response | |
| * @param {Function} options.error - a function to call on when an error occurs | |
| * @param {Object} options.headers - headers to add to the AJAX request | |
| * @param {String} options.responseType - the response type of the AJAX request | |
| * @param {String} options.postData - HTTP POST data (usually but not necessarily in k=v&k2=v2... form, | |
| * see TileSource::getTilePostData), GET method used if null | |
| * @param {Boolean} [options.withCredentials=false] - whether to set the XHR's withCredentials | |
| * @throws {Error} | |
| * @returns {XMLHttpRequest} | |
| */ | |
| makeAjaxRequest: function( url, onSuccess, onError ) { | |
| var withCredentials; | |
| var headers; | |
| var responseType; | |
| var postData; | |
| // Note that our preferred API is that you pass in a single object; the named | |
| // arguments are for legacy support. | |
| if( $.isPlainObject( url ) ){ | |
| onSuccess = url.success; | |
| onError = url.error; | |
| withCredentials = url.withCredentials; | |
| headers = url.headers; | |
| responseType = url.responseType || null; | |
| postData = url.postData || null; | |
| url = url.url; | |
| } else { | |
| $.console.warn("OpenSeadragon.makeAjaxRequest() deprecated usage!"); | |
| } | |
| var protocol = $.getUrlProtocol( url ); | |
| var request = $.createAjaxRequest(); | |
| if ( !$.isFunction( onSuccess ) ) { | |
| throw new Error( "makeAjaxRequest requires a success callback" ); | |
| } | |
| request.onreadystatechange = function() { | |
| // 4 = DONE (https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest#Properties) | |
| if ( request.readyState === 4 ) { | |
| request.onreadystatechange = function(){}; | |
| // With protocols other than http/https, a successful request status is in | |
| // the 200's on Firefox and 0 on other browsers | |
| if ( (request.status >= 200 && request.status < 300) || | |
| ( request.status === 0 && | |
| protocol !== "http:" && | |
| protocol !== "https:" )) { | |
| onSuccess( request ); | |
| } else { | |
| if ( $.isFunction( onError ) ) { | |
| onError( request ); | |
| } else { | |
| $.console.error( "AJAX request returned %d: %s", request.status, url ); | |
| } | |
| } | |
| } | |
| }; | |
| var method = postData ? "POST" : "GET"; | |
| try { | |
| request.open( method, url, true ); | |
| if (responseType) { | |
| request.responseType = responseType; | |
| } | |
| if (headers) { | |
| for (var headerName in headers) { | |
| if (Object.prototype.hasOwnProperty.call(headers, headerName) && headers[headerName]) { | |
| request.setRequestHeader(headerName, headers[headerName]); | |
| } | |
| } | |
| } | |
| if (withCredentials) { | |
| request.withCredentials = true; | |
| } | |
| request.send(postData); | |
| } catch (e) { | |
| $.console.error( "%s while making AJAX request: %s", e.name, e.message ); | |
| request.onreadystatechange = function(){}; | |
| if ( $.isFunction( onError ) ) { | |
| onError( request, e ); | |
| } | |
| } | |
| return request; | |
| }, | |
| /** | |
| * Taken from jQuery 1.6.1 | |
| * @function | |
| * @param {Object} options | |
| * @param {String} options.url | |
| * @param {Function} options.callback | |
| * @param {String} [options.param='callback'] The name of the url parameter | |
| * to request the jsonp provider with. | |
| * @param {String} [options.callbackName=] The name of the callback to | |
| * request the jsonp provider with. | |
| */ | |
| jsonp: function( options ){ | |
| var script, | |
| url = options.url, | |
| head = document.head || | |
| document.getElementsByTagName( "head" )[ 0 ] || | |
| document.documentElement, | |
| jsonpCallback = options.callbackName || 'openseadragon' + $.now(), | |
| previous = window[ jsonpCallback ], | |
| replace = "$1" + jsonpCallback + "$2", | |
| callbackParam = options.param || 'callback', | |
| callback = options.callback; | |
| url = url.replace( /(=)\?(&|$)|\?\?/i, replace ); | |
| // Add callback manually | |
| url += (/\?/.test( url ) ? "&" : "?") + callbackParam + "=" + jsonpCallback; | |
| // Install callback | |
| window[ jsonpCallback ] = function( response ) { | |
| if ( !previous ){ | |
| try{ | |
| delete window[ jsonpCallback ]; | |
| }catch(e){ | |
| //swallow | |
| } | |
| } else { | |
| window[ jsonpCallback ] = previous; | |
| } | |
| if( callback && $.isFunction( callback ) ){ | |
| callback( response ); | |
| } | |
| }; | |
| script = document.createElement( "script" ); | |
| //TODO: having an issue with async info requests | |
| if( undefined !== options.async || false !== options.async ){ | |
| script.async = "async"; | |
| } | |
| if ( options.scriptCharset ) { | |
| script.charset = options.scriptCharset; | |
| } | |
| script.src = url; | |
| // Attach handlers for all browsers | |
| script.onload = script.onreadystatechange = function( _, isAbort ) { | |
| if ( isAbort || !script.readyState || /loaded|complete/.test( script.readyState ) ) { | |
| // Handle memory leak in IE | |
| script.onload = script.onreadystatechange = null; | |
| // Remove the script | |
| if ( head && script.parentNode ) { | |
| head.removeChild( script ); | |
| } | |
| // Dereference the script | |
| script = undefined; | |
| } | |
| }; | |
| // Use insertBefore instead of appendChild to circumvent an IE6 bug. | |
| // This arises when a base node is used (#2709 and #4378). | |
| head.insertBefore( script, head.firstChild ); | |
| }, | |
| /** | |
| * Fully deprecated. Will throw an error. | |
| * @function | |
| * @deprecated use {@link OpenSeadragon.Viewer#open} | |
| */ | |
| createFromDZI: function() { | |
| throw "OpenSeadragon.createFromDZI is deprecated, use Viewer.open."; | |
| }, | |
| /** | |
| * Parses an XML string into a DOM Document. | |
| * @function | |
| * @param {String} string | |
| * @returns {Document} | |
| */ | |
| parseXml: function( string ) { | |
| if ( window.DOMParser ) { | |
| $.parseXml = function( string ) { | |
| var xmlDoc = null, | |
| parser; | |
| parser = new DOMParser(); | |
| xmlDoc = parser.parseFromString( string, "text/xml" ); | |
| return xmlDoc; | |
| }; | |
| } else { | |
| throw new Error( "Browser doesn't support XML DOM." ); | |
| } | |
| return $.parseXml( string ); | |
| }, | |
| /** | |
| * Parses a JSON string into a Javascript object. | |
| * @function | |
| * @param {String} string | |
| * @returns {Object} | |
| */ | |
| parseJSON: function(string) { | |
| $.parseJSON = window.JSON.parse; | |
| return $.parseJSON(string); | |
| }, | |
| /** | |
| * Reports whether the image format is supported for tiling in this | |
| * version. | |
| * @function | |
| * @param {String} [extension] | |
| * @returns {Boolean} | |
| */ | |
| imageFormatSupported: function( extension ) { | |
| extension = extension ? extension : ""; | |
| // eslint-disable-next-line no-use-before-define | |
| return !!FILEFORMATS[ extension.toLowerCase() ]; | |
| }, | |
| /** | |
| * Updates supported image formats with user-specified values. | |
| * Preexisting formats that are not being updated are left unchanged. | |
| * By default, the defined formats are | |
| * <pre><code>{ | |
| * avif: true, | |
| * bmp: false, | |
| * jpeg: true, | |
| * jpg: true, | |
| * png: true, | |
| * tif: false, | |
| * wdp: false, | |
| * webp: true | |
| * } | |
| * </code></pre> | |
| * @function | |
| * @example | |
| * // sets bmp as supported and png as unsupported | |
| * setImageFormatsSupported({bmp: true, png: false}); | |
| * @param {Object} formats An object containing format extensions as | |
| * keys and booleans as values. | |
| */ | |
| setImageFormatsSupported: function(formats) { | |
| //TODO: how to deal with this within the data pipeline? | |
| // $.console.warn("setImageFormatsSupported method is deprecated. You should check that" + | |
| // " the system supports your TileSources by implementing corresponding data type convertors."); | |
| // eslint-disable-next-line no-use-before-define | |
| $.extend(FILEFORMATS, formats); | |
| }, | |
| }); | |
| //TODO: $.console is often used inside a try/catch block which generally | |
| // prevents allowings errors to occur with detection until a debugger | |
| // is attached. Although I've been guilty of the same anti-pattern | |
| // I eventually was convinced that errors should naturally propagate in | |
| // all but the most special cases. | |
| /** | |
| * A convenient alias for console when available, and a simple null | |
| * function when console is unavailable. | |
| * @static | |
| * @private | |
| */ | |
| var nullfunction = function( msg ){ | |
| //document.location.hash = msg; | |
| }; | |
| $.console = window.console || { | |
| log: nullfunction, | |
| debug: nullfunction, | |
| info: nullfunction, | |
| warn: nullfunction, | |
| error: nullfunction, | |
| assert: nullfunction | |
| }; | |
| /** | |
| * The current browser vendor, version, and related information regarding detected features. | |
| * @member {Object} Browser | |
| * @memberof OpenSeadragon | |
| * @static | |
| * @type {Object} | |
| * @property {OpenSeadragon.BROWSERS} vendor - One of the {@link OpenSeadragon.BROWSERS} enumeration values. | |
| * @property {Number} version | |
| * @property {Boolean} alpha - Does the browser support image alpha transparency. | |
| */ | |
| $.Browser = { | |
| vendor: $.BROWSERS.UNKNOWN, | |
| version: 0, | |
| alpha: true | |
| }; | |
| var FILEFORMATS = { | |
| avif: true, | |
| bmp: false, | |
| jpeg: true, | |
| jpg: true, | |
| png: true, | |
| tif: false, | |
| wdp: false, | |
| webp: true | |
| }, | |
| URLPARAMS = {}; | |
| (function() { | |
| //A small auto-executing routine to determine the browser vendor, | |
| //version and supporting feature sets. | |
| var ver = navigator.appVersion, | |
| ua = navigator.userAgent, | |
| regex; | |
| //console.error( 'appName: ' + navigator.appName ); | |
| //console.error( 'appVersion: ' + navigator.appVersion ); | |
| //console.error( 'userAgent: ' + navigator.userAgent ); | |
| //TODO navigator.appName is deprecated. Should be 'Netscape' for all browsers | |
| // but could be dropped at any time | |
| // See https://developer.mozilla.org/en-US/docs/Web/API/Navigator/appName | |
| // https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent | |
| switch( navigator.appName ){ | |
| case "Microsoft Internet Explorer": | |
| if( !!window.attachEvent && | |
| !!window.ActiveXObject ) { | |
| $.Browser.vendor = $.BROWSERS.IE; | |
| $.Browser.version = parseFloat( | |
| ua.substring( | |
| ua.indexOf( "MSIE" ) + 5, | |
| ua.indexOf( ";", ua.indexOf( "MSIE" ) ) ) | |
| ); | |
| } | |
| break; | |
| case "Netscape": | |
| if (window.addEventListener) { | |
| if ( ua.indexOf( "Edge" ) >= 0 ) { | |
| $.Browser.vendor = $.BROWSERS.EDGE; | |
| $.Browser.version = parseFloat( | |
| ua.substring( ua.indexOf( "Edge" ) + 5 ) | |
| ); | |
| } else if ( ua.indexOf( "Edg" ) >= 0 ) { | |
| $.Browser.vendor = $.BROWSERS.CHROMEEDGE; | |
| $.Browser.version = parseFloat( | |
| ua.substring( ua.indexOf( "Edg" ) + 4 ) | |
| ); | |
| } else if ( ua.indexOf( "Firefox" ) >= 0 ) { | |
| $.Browser.vendor = $.BROWSERS.FIREFOX; | |
| $.Browser.version = parseFloat( | |
| ua.substring( ua.indexOf( "Firefox" ) + 8 ) | |
| ); | |
| } else if ( ua.indexOf( "Safari" ) >= 0 ) { | |
| $.Browser.vendor = ua.indexOf( "Chrome" ) >= 0 ? | |
| $.BROWSERS.CHROME : | |
| $.BROWSERS.SAFARI; | |
| $.Browser.version = parseFloat( | |
| ua.substring( | |
| ua.substring( 0, ua.indexOf( "Safari" ) ).lastIndexOf( "/" ) + 1, | |
| ua.indexOf( "Safari" ) | |
| ) | |
| ); | |
| } else { | |
| regex = new RegExp( "Trident/.*rv:([0-9]{1,}[.0-9]{0,})"); | |
| if ( regex.exec( ua ) !== null ) { | |
| $.Browser.vendor = $.BROWSERS.IE; | |
| $.Browser.version = parseFloat( RegExp.$1 ); | |
| } | |
| } | |
| } | |
| break; | |
| case "Opera": | |
| $.Browser.vendor = $.BROWSERS.OPERA; | |
| $.Browser.version = parseFloat( ver ); | |
| break; | |
| } | |
| // ignore '?' portion of query string | |
| var query = window.location.search.substring( 1 ), | |
| parts = query.split('&'), | |
| part, | |
| sep, | |
| i; | |
| for ( i = 0; i < parts.length; i++ ) { | |
| part = parts[ i ]; | |
| sep = part.indexOf( '=' ); | |
| if ( sep > 0 ) { | |
| var key = part.substring( 0, sep ), | |
| value = part.substring( sep + 1 ); | |
| try { | |
| URLPARAMS[ key ] = decodeURIComponent( value ); | |
| } catch (e) { | |
| $.console.error( "Ignoring malformed URL parameter: %s=%s", key, value ); | |
| } | |
| } | |
| } | |
| //determine if this browser supports image alpha transparency | |
| $.Browser.alpha = !( | |
| $.Browser.vendor === $.BROWSERS.CHROME && $.Browser.version < 2 | |
| ); | |
| //determine if this browser supports element.style.opacity | |
| $.Browser.opacity = true; | |
| if ( $.Browser.vendor === $.BROWSERS.IE ) { | |
| $.console.error('Internet Explorer is not supported by OpenSeadragon'); | |
| } | |
| })(); | |
| // Adding support for HTML5's requestAnimationFrame as suggested by acdha. | |
| // Implementation taken from matt synder's post here: | |
| // http://mattsnider.com/cross-browser-and-legacy-supported-requestframeanimation/ | |
| (function( w ) { | |
| // most browsers have an implementation | |
| var requestAnimationFrame = w.requestAnimationFrame || | |
| w.mozRequestAnimationFrame || | |
| w.webkitRequestAnimationFrame || | |
| w.msRequestAnimationFrame; | |
| var cancelAnimationFrame = w.cancelAnimationFrame || | |
| w.mozCancelAnimationFrame || | |
| w.webkitCancelAnimationFrame || | |
| w.msCancelAnimationFrame; | |
| // polyfill, when necessary | |
| if ( requestAnimationFrame && cancelAnimationFrame ) { | |
| // We can't assign these window methods directly to $ because they | |
| // expect their "this" to be "window", so we call them in wrappers. | |
| $.requestAnimationFrame = function(){ | |
| return requestAnimationFrame.apply( w, arguments ); | |
| }; | |
| $.cancelAnimationFrame = function(){ | |
| return cancelAnimationFrame.apply( w, arguments ); | |
| }; | |
| } else { | |
| var aAnimQueue = [], | |
| processing = [], | |
| iRequestId = 0, | |
| iIntervalId; | |
| // create a mock requestAnimationFrame function | |
| $.requestAnimationFrame = function( callback ) { | |
| aAnimQueue.push( [ ++iRequestId, callback ] ); | |
| if ( !iIntervalId ) { | |
| iIntervalId = setInterval( function() { | |
| if ( aAnimQueue.length ) { | |
| var time = $.now(); | |
| // Process all of the currently outstanding frame | |
| // requests, but none that get added during the | |
| // processing. | |
| // Swap the arrays so we don't have to create a new | |
| // array every frame. | |
| var temp = processing; | |
| processing = aAnimQueue; | |
| aAnimQueue = temp; | |
| while ( processing.length ) { | |
| processing.shift()[ 1 ]( time ); | |
| } | |
| } else { | |
| // don't continue the interval, if unnecessary | |
| clearInterval( iIntervalId ); | |
| iIntervalId = undefined; | |
| } | |
| }, 1000 / 50); // estimating support for 50 frames per second | |
| } | |
| return iRequestId; | |
| }; | |
| // create a mock cancelAnimationFrame function | |
| $.cancelAnimationFrame = function( requestId ) { | |
| // find the request ID and remove it | |
| var i, j; | |
| for ( i = 0, j = aAnimQueue.length; i < j; i += 1 ) { | |
| if ( aAnimQueue[ i ][ 0 ] === requestId ) { | |
| aAnimQueue.splice( i, 1 ); | |
| return; | |
| } | |
| } | |
| // If it's not in the queue, it may be in the set we're currently | |
| // processing (if cancelAnimationFrame is called from within a | |
| // requestAnimationFrame callback). | |
| for ( i = 0, j = processing.length; i < j; i += 1 ) { | |
| if ( processing[ i ][ 0 ] === requestId ) { | |
| processing.splice( i, 1 ); | |
| return; | |
| } | |
| } | |
| }; | |
| } | |
| })( window ); | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| * @param {Element} element | |
| * @param {Boolean} [isFixed] | |
| * @returns {Element} | |
| */ | |
| function getOffsetParent( element, isFixed ) { | |
| if ( isFixed && element !== document.body ) { | |
| return document.body; | |
| } else { | |
| return element.offsetParent; | |
| } | |
| } | |
| /** | |
| * @template T | |
| * @typedef {function(): OpenSeadragon.Promise<T>} AsyncNullaryFunction | |
| * Represents an asynchronous function that takes no arguments and returns a promise of type T. | |
| */ | |
| /** | |
| * @template T, A | |
| * @typedef {function(A): OpenSeadragon.Promise<T>} AsyncUnaryFunction | |
| * Represents an asynchronous function that: | |
| * @param {A} arg - The single argument of type A. | |
| * @returns {OpenSeadragon.Promise<T>} A promise that resolves to a value of type T. | |
| */ | |
| /** | |
| * @template T, A, B | |
| * @typedef {function(A, B): OpenSeadragon.Promise<T>} AsyncBinaryFunction | |
| * Represents an asynchronous function that: | |
| * @param {A} arg1 - The first argument of type A. | |
| * @param {B} arg2 - The second argument of type B. | |
| * @returns {OpenSeadragon.Promise<T>} A promise that resolves to a value of type T. | |
| */ | |
| /** | |
| * Promise proxy in OpenSeadragon, enables $.supportsAsync feature. | |
| * This proxy is also necessary because OperaMini does not implement Promises (checks fail). | |
| * @type {PromiseConstructor} | |
| */ | |
| $.Promise = window["Promise"] && $.supportsAsync ? window["Promise"] : class { | |
| constructor(handler) { | |
| this._error = false; | |
| this.__value = undefined; | |
| try { | |
| // Make sure to unwrap all nested promises! | |
| handler( | |
| (value) => { | |
| while (value instanceof $.Promise) { | |
| value = value._value; | |
| } | |
| this._value = value; | |
| }, | |
| (error) => { | |
| while (error instanceof $.Promise) { | |
| error = error._value; | |
| } | |
| this._value = error; | |
| this._error = true; | |
| } | |
| ); | |
| } catch (e) { | |
| this._value = e; | |
| this._error = true; | |
| } | |
| } | |
| then(handler) { | |
| if (!this._error) { | |
| try { | |
| this._value = handler(this._value); | |
| } catch (e) { | |
| this._value = e; | |
| this._error = true; | |
| } | |
| } | |
| return this; | |
| } | |
| catch(handler) { | |
| if (this._error) { | |
| try { | |
| this._value = handler(this._value); | |
| this._error = false; | |
| } catch (e) { | |
| this._value = e; | |
| this._error = true; | |
| } | |
| } | |
| return this; | |
| } | |
| get _value() { | |
| return this.__value; | |
| } | |
| set _value(val) { | |
| if (val && val.constructor === this.constructor) { | |
| val = val._value; //unwrap | |
| } | |
| this.__value = val; | |
| } | |
| static resolve(value) { | |
| return new this((resolve) => resolve(value)); | |
| } | |
| static reject(error) { | |
| return new this((_, reject) => reject(error)); | |
| } | |
| static all(functions) { | |
| return new this((resolve) => { | |
| // no async support, just execute them | |
| return resolve(functions.map(fn => fn())); | |
| }); | |
| } | |
| static race(functions) { | |
| if (functions.length < 1) { | |
| return this.resolve(); | |
| } | |
| // no async support, just execute the first | |
| return new this((resolve) => { | |
| return resolve(functions[0]()); | |
| }); | |
| } | |
| }; | |
| }(OpenSeadragon)); | |
| // Universal Module Definition, supports CommonJS, AMD and simple script tag | |
| (function (root, $) { | |
| if (typeof define === 'function' && define.amd) { | |
| // expose as amd module | |
| define([], function () { | |
| return $; | |
| }); | |
| } else if (typeof module === 'object' && module.exports) { | |
| // expose as commonjs module | |
| module.exports = $; | |
| } else { | |
| if (!root) { | |
| root = typeof window === 'object' && window; | |
| if (!root) { | |
| $.console.error("OpenSeadragon must run in browser environment!"); | |
| } | |
| } | |
| // expose as window.OpenSeadragon | |
| root.OpenSeadragon = $; | |
| } | |
| }(this, OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - Mat3 | |
| * | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| * | |
| */ | |
| /* | |
| * Portions of this source file are taken from WegGL Fundamentals: | |
| * | |
| * Copyright 2012, Gregg Tavares. | |
| * All rights reserved. | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * * Redistributions of source code must retain the above copyright | |
| * notice, this list of conditions and the following disclaimer. | |
| * * Redistributions in binary form must reproduce the above | |
| * copyright notice, this list of conditions and the following disclaimer | |
| * in the documentation and/or other materials provided with the | |
| * distribution. | |
| * * Neither the name of Gregg Tavares. nor the names of his | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| * | |
| */ | |
| (function( $ ){ | |
| // Modified from https://webglfundamentals.org/webgl/lessons/webgl-2d-matrices.html | |
| /** | |
| * | |
| * | |
| * @class Mat3 | |
| * @classdesc A left-to-right matrix representation, useful for affine transforms for | |
| * positioning tiles for drawing | |
| * | |
| * @memberof OpenSeadragon | |
| * | |
| * @param {Array} [values] - Initial values for the matrix | |
| * | |
| **/ | |
| class Mat3{ | |
| constructor(values){ | |
| if(!values) { | |
| values = [ | |
| 0, 0, 0, | |
| 0, 0, 0, | |
| 0, 0, 0 | |
| ]; | |
| } | |
| this.values = values; | |
| } | |
| /** | |
| * @function makeIdentity | |
| * @memberof OpenSeadragon.Mat3 | |
| * @static | |
| * @returns {OpenSeadragon.Mat3} an identity matrix | |
| */ | |
| static makeIdentity(){ | |
| return new Mat3([ | |
| 1, 0, 0, | |
| 0, 1, 0, | |
| 0, 0, 1 | |
| ]); | |
| } | |
| /** | |
| * @function makeTranslation | |
| * @memberof OpenSeadragon.Mat3 | |
| * @static | |
| * @param {Number} tx The x value of the translation | |
| * @param {Number} ty The y value of the translation | |
| * @returns {OpenSeadragon.Mat3} A translation matrix | |
| */ | |
| static makeTranslation(tx, ty) { | |
| return new Mat3([ | |
| 1, 0, 0, | |
| 0, 1, 0, | |
| tx, ty, 1, | |
| ]); | |
| } | |
| /** | |
| * @function makeRotation | |
| * @memberof OpenSeadragon.Mat3 | |
| * @static | |
| * @param {Number} angleInRadians The desired rotation angle, in radians | |
| * @returns {OpenSeadragon.Mat3} A rotation matrix | |
| */ | |
| static makeRotation(angleInRadians) { | |
| var c = Math.cos(angleInRadians); | |
| var s = Math.sin(angleInRadians); | |
| return new Mat3([ | |
| c, -s, 0, | |
| s, c, 0, | |
| 0, 0, 1, | |
| ]); | |
| } | |
| /** | |
| * @function makeScaling | |
| * @memberof OpenSeadragon.Mat3 | |
| * @static | |
| * @param {Number} sx The x value of the scaling | |
| * @param {Number} sy The y value of the scaling | |
| * @returns {OpenSeadragon.Mat3} A scaling matrix | |
| */ | |
| static makeScaling(sx, sy) { | |
| return new Mat3([ | |
| sx, 0, 0, | |
| 0, sy, 0, | |
| 0, 0, 1, | |
| ]); | |
| } | |
| /** | |
| * @alias multiply | |
| * @memberof! OpenSeadragon.Mat3 | |
| * @param {OpenSeadragon.Mat3} other the matrix to multiply with | |
| * @returns {OpenSeadragon.Mat3} The result of matrix multiplication | |
| */ | |
| multiply(other) { | |
| let a = this.values; | |
| let b = other.values; | |
| var a00 = a[0 * 3 + 0]; | |
| var a01 = a[0 * 3 + 1]; | |
| var a02 = a[0 * 3 + 2]; | |
| var a10 = a[1 * 3 + 0]; | |
| var a11 = a[1 * 3 + 1]; | |
| var a12 = a[1 * 3 + 2]; | |
| var a20 = a[2 * 3 + 0]; | |
| var a21 = a[2 * 3 + 1]; | |
| var a22 = a[2 * 3 + 2]; | |
| var b00 = b[0 * 3 + 0]; | |
| var b01 = b[0 * 3 + 1]; | |
| var b02 = b[0 * 3 + 2]; | |
| var b10 = b[1 * 3 + 0]; | |
| var b11 = b[1 * 3 + 1]; | |
| var b12 = b[1 * 3 + 2]; | |
| var b20 = b[2 * 3 + 0]; | |
| var b21 = b[2 * 3 + 1]; | |
| var b22 = b[2 * 3 + 2]; | |
| return new Mat3([ | |
| b00 * a00 + b01 * a10 + b02 * a20, | |
| b00 * a01 + b01 * a11 + b02 * a21, | |
| b00 * a02 + b01 * a12 + b02 * a22, | |
| b10 * a00 + b11 * a10 + b12 * a20, | |
| b10 * a01 + b11 * a11 + b12 * a21, | |
| b10 * a02 + b11 * a12 + b12 * a22, | |
| b20 * a00 + b21 * a10 + b22 * a20, | |
| b20 * a01 + b21 * a11 + b22 * a21, | |
| b20 * a02 + b21 * a12 + b22 * a22, | |
| ]); | |
| } | |
| } | |
| $.Mat3 = Mat3; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - full-screen support functions | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ) { | |
| /** | |
| * Determine native full screen support we can get from the browser. | |
| * @member fullScreenApi | |
| * @memberof OpenSeadragon | |
| * @type {object} | |
| * @property {Boolean} supportsFullScreen Return true if full screen API is supported. | |
| * @property {Function} isFullScreen Return true if currently in full screen mode. | |
| * @property {Function} getFullScreenElement Return the element currently in full screen mode. | |
| * @property {Function} requestFullScreen Make a request to go in full screen mode. | |
| * @property {Function} exitFullScreen Make a request to exit full screen mode. | |
| * @property {Function} cancelFullScreen Deprecated, use exitFullScreen instead. | |
| * @property {String} fullScreenEventName Event fired when the full screen mode change. | |
| * @property {String} fullScreenErrorEventName Event fired when a request to go | |
| * in full screen mode failed. | |
| */ | |
| var fullScreenApi = { | |
| supportsFullScreen: false, | |
| isFullScreen: function() { return false; }, | |
| getFullScreenElement: function() { return null; }, | |
| requestFullScreen: function() {}, | |
| exitFullScreen: function() {}, | |
| cancelFullScreen: function() {}, | |
| fullScreenEventName: '', | |
| fullScreenErrorEventName: '' | |
| }; | |
| // check for native support | |
| if ( document.exitFullscreen ) { | |
| // W3C standard | |
| fullScreenApi.supportsFullScreen = true; | |
| fullScreenApi.getFullScreenElement = function() { | |
| return document.fullscreenElement; | |
| }; | |
| fullScreenApi.requestFullScreen = function( element ) { | |
| return element.requestFullscreen().catch(function (msg) { | |
| $.console.error('Fullscreen request failed: ', msg); | |
| }); | |
| }; | |
| fullScreenApi.exitFullScreen = function() { | |
| document.exitFullscreen().catch(function (msg) { | |
| $.console.error('Error while exiting fullscreen: ', msg); | |
| }); | |
| }; | |
| fullScreenApi.fullScreenEventName = "fullscreenchange"; | |
| fullScreenApi.fullScreenErrorEventName = "fullscreenerror"; | |
| } else if ( document.msExitFullscreen ) { | |
| // IE 11 | |
| fullScreenApi.supportsFullScreen = true; | |
| fullScreenApi.getFullScreenElement = function() { | |
| return document.msFullscreenElement; | |
| }; | |
| fullScreenApi.requestFullScreen = function( element ) { | |
| return element.msRequestFullscreen(); | |
| }; | |
| fullScreenApi.exitFullScreen = function() { | |
| document.msExitFullscreen(); | |
| }; | |
| fullScreenApi.fullScreenEventName = "MSFullscreenChange"; | |
| fullScreenApi.fullScreenErrorEventName = "MSFullscreenError"; | |
| } else if ( document.webkitExitFullscreen ) { | |
| // Recent webkit | |
| fullScreenApi.supportsFullScreen = true; | |
| fullScreenApi.getFullScreenElement = function() { | |
| return document.webkitFullscreenElement; | |
| }; | |
| fullScreenApi.requestFullScreen = function( element ) { | |
| return element.webkitRequestFullscreen(); | |
| }; | |
| fullScreenApi.exitFullScreen = function() { | |
| document.webkitExitFullscreen(); | |
| }; | |
| fullScreenApi.fullScreenEventName = "webkitfullscreenchange"; | |
| fullScreenApi.fullScreenErrorEventName = "webkitfullscreenerror"; | |
| } else if ( document.webkitCancelFullScreen ) { | |
| // Old webkit | |
| fullScreenApi.supportsFullScreen = true; | |
| fullScreenApi.getFullScreenElement = function() { | |
| return document.webkitCurrentFullScreenElement; | |
| }; | |
| fullScreenApi.requestFullScreen = function( element ) { | |
| return element.webkitRequestFullScreen(); | |
| }; | |
| fullScreenApi.exitFullScreen = function() { | |
| document.webkitCancelFullScreen(); | |
| }; | |
| fullScreenApi.fullScreenEventName = "webkitfullscreenchange"; | |
| fullScreenApi.fullScreenErrorEventName = "webkitfullscreenerror"; | |
| } else if ( document.mozCancelFullScreen ) { | |
| // Firefox | |
| fullScreenApi.supportsFullScreen = true; | |
| fullScreenApi.getFullScreenElement = function() { | |
| return document.mozFullScreenElement; | |
| }; | |
| fullScreenApi.requestFullScreen = function( element ) { | |
| return element.mozRequestFullScreen(); | |
| }; | |
| fullScreenApi.exitFullScreen = function() { | |
| document.mozCancelFullScreen(); | |
| }; | |
| fullScreenApi.fullScreenEventName = "mozfullscreenchange"; | |
| fullScreenApi.fullScreenErrorEventName = "mozfullscreenerror"; | |
| } | |
| fullScreenApi.isFullScreen = function() { | |
| return fullScreenApi.getFullScreenElement() !== null; | |
| }; | |
| fullScreenApi.cancelFullScreen = function() { | |
| $.console.error("cancelFullScreen is deprecated. Use exitFullScreen instead."); | |
| fullScreenApi.exitFullScreen(); | |
| }; | |
| // export api | |
| $.extend( $, fullScreenApi ); | |
| })( OpenSeadragon ); | |
| /* | |
| * OpenSeadragon - EventSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function($){ | |
| /** | |
| * Event handler method signature used by all OpenSeadragon events. | |
| * | |
| * @typedef {function(OpenSeadragon.Event): void} OpenSeadragon.EventHandler | |
| * @memberof OpenSeadragon | |
| * @param {OpenSeadragon.Event} event - The event object containing event-specific properties. | |
| * @returns {void} This handler does not return a value. | |
| */ | |
| /** | |
| * Event handler method signature used by all OpenSeadragon events. | |
| * | |
| * @typedef {function(OpenSeadragon.Event): Promise<void>} OpenSeadragon.AsyncEventHandler | |
| * @memberof OpenSeadragon | |
| * @param {OpenSeadragon.Event} event - The event object containing event-specific properties. | |
| * @returns {Promise<void>} This handler does not return a value. | |
| */ | |
| /** | |
| * @class EventSource | |
| * @classdesc For use by classes which want to support custom, non-browser events. | |
| * | |
| * @memberof OpenSeadragon | |
| */ | |
| $.EventSource = function() { | |
| this.events = {}; | |
| this._rejectedEventList = {}; | |
| }; | |
| /** @lends OpenSeadragon.EventSource.prototype */ | |
| $.EventSource.prototype = { | |
| /** | |
| * Add an event handler to be triggered only once (or a given number of times) | |
| * for a given event. It is not removable with removeHandler(). | |
| * @function | |
| * @param {String} eventName - Name of event to register. | |
| * @param {OpenSeadragon.EventHandler|OpenSeadragon.AsyncEventHandler} handler - Function to call when event | |
| * is triggered. | |
| * @param {Object} [userData=null] - Arbitrary object to be passed unchanged | |
| * to the handler. | |
| * @param {Number} [times=1] - The number of times to handle the event | |
| * before removing it. | |
| * @param {Number} [priority=0] - Handler priority. By default, all priorities are 0. Higher number = priority. | |
| * @returns {Boolean} - True if the handler was added, false if it was rejected | |
| */ | |
| addOnceHandler: function(eventName, handler, userData, times, priority) { | |
| const self = this; | |
| times = times || 1; | |
| let count = 0; | |
| const onceHandler = function(event) { | |
| count++; | |
| if (count === times) { | |
| self.removeHandler(eventName, onceHandler); | |
| } | |
| return handler(event); | |
| }; | |
| return this.addHandler(eventName, onceHandler, userData, priority); | |
| }, | |
| /** | |
| * Add an event handler for a given event. | |
| * @function | |
| * @param {String} eventName - Name of event to register. | |
| * @param {OpenSeadragon.EventHandler|OpenSeadragon.AsyncEventHandler} handler - Function to call when event is triggered. | |
| * @param {Object} [userData=null] - Arbitrary object to be passed unchanged to the handler. | |
| * @param {Number} [priority=0] - Handler priority. By default, all priorities are 0. Higher number = priority. | |
| * @returns {Boolean} - True if the handler was added, false if it was rejected | |
| */ | |
| addHandler: function ( eventName, handler, userData, priority ) { | |
| if(Object.prototype.hasOwnProperty.call(this._rejectedEventList, eventName)){ | |
| $.console.error(`Error adding handler for ${eventName}. ${this._rejectedEventList[eventName]}`); | |
| return false; | |
| } | |
| let events = this.events[ eventName ]; | |
| if ( !events ) { | |
| this.events[ eventName ] = events = []; | |
| } | |
| if ( handler && $.isFunction( handler ) ) { | |
| let index = events.length, | |
| event = { handler: handler, userData: userData || null, priority: priority || 0 }; | |
| events[ index ] = event; | |
| while ( index > 0 && events[ index - 1 ].priority < events[ index ].priority ) { | |
| events[ index ] = events[ index - 1 ]; | |
| events[ index - 1 ] = event; | |
| index--; | |
| } | |
| } | |
| return true; | |
| }, | |
| /** | |
| * Remove a specific event handler for a given event. | |
| * @function | |
| * @param {String} eventName - Name of event for which the handler is to be removed. | |
| * @param {OpenSeadragon.EventHandler|OpenSeadragon.AsyncEventHandler} handler - Function to be removed. | |
| */ | |
| removeHandler: function ( eventName, handler ) { | |
| const events = this.events[ eventName ], | |
| handlers = []; | |
| if ( !events ) { | |
| return; | |
| } | |
| if ( $.isArray( events ) ) { | |
| for ( let i = 0; i < events.length; i++ ) { | |
| if ( events[i].handler !== handler ) { | |
| handlers.push( events[ i ] ); | |
| } | |
| } | |
| this.events[ eventName ] = handlers; | |
| } | |
| }, | |
| /** | |
| * Get the amount of handlers registered for a given event. | |
| * @param {String} eventName - Name of event to inspect. | |
| * @returns {number} amount of events | |
| */ | |
| numberOfHandlers: function (eventName) { | |
| const events = this.events[ eventName ]; | |
| if ( !events ) { | |
| return 0; | |
| } | |
| return events.length; | |
| }, | |
| /** | |
| * Remove all event handlers for a given event type. If no type is given all | |
| * event handlers for every event type are removed. | |
| * @function | |
| * @param {String} eventName - Name of event for which all handlers are to be removed. | |
| */ | |
| removeAllHandlers: function( eventName ) { | |
| if ( eventName ){ | |
| this.events[ eventName ] = []; | |
| } else{ | |
| for ( let eventType in this.events ) { | |
| this.events[ eventType ] = []; | |
| } | |
| } | |
| }, | |
| /** | |
| * Get a function which iterates the list of all handlers registered for a given event, calling the handler for each. | |
| * @function | |
| * @param {String} eventName - Name of event to get handlers for. | |
| */ | |
| getHandler: function ( eventName) { | |
| let events = this.events[ eventName ]; | |
| if ( !events || !events.length ) { | |
| return null; | |
| } | |
| events = events.length === 1 ? | |
| [ events[ 0 ] ] : | |
| Array.apply( null, events ); | |
| return function ( source, args ) { | |
| let length = events.length; | |
| for ( let i = 0; i < length; i++ ) { | |
| if ( events[ i ] ) { | |
| args.eventSource = source; | |
| args.userData = events[ i ].userData; | |
| events[ i ].handler( args ); | |
| } | |
| } | |
| }; | |
| }, | |
| /** | |
| * Get a function which iterates the list of all handlers registered for a given event, | |
| * calling the handler for each and awaiting async ones. | |
| * @function | |
| * @param {String} eventName - Name of event to get handlers for. | |
| * @param {any} bindTarget - Bound target to return with the promise on finish | |
| */ | |
| getAwaitingHandler: function ( eventName, bindTarget ) { | |
| let events = this.events[ eventName ]; | |
| if ( !events || !events.length ) { | |
| return null; | |
| } | |
| events = events.length === 1 ? | |
| [ events[ 0 ] ] : | |
| Array.apply( null, events ); | |
| return function ( source, args ) { | |
| // We return a promise that gets resolved after all the events finish. | |
| // Returning loop result is not correct, loop promises chain dynamically | |
| // and outer code could process finishing logics in the middle of event loop. | |
| return new $.Promise(resolve => { | |
| const length = events.length; | |
| function loop(index) { | |
| if ( index >= length || !events[ index ] ) { | |
| resolve(bindTarget); | |
| return null; | |
| } | |
| args.eventSource = source; | |
| args.userData = events[ index ].userData; | |
| let result = events[ index ].handler( args ); | |
| result = (!result || $.type(result) !== "promise") ? $.Promise.resolve() : result; | |
| return result.then(() => loop(index + 1)); | |
| } | |
| loop(0); | |
| }); | |
| }; | |
| }, | |
| /** | |
| * Trigger an event, optionally passing additional information. Does not await async handlers, i.e. | |
| * OpenSeadragon.AsyncEventHandler. | |
| * @function | |
| * @param {String} eventName - Name of event to register. | |
| * @param {Object} eventArgs - Event-specific data. | |
| * @returns {Boolean} True if the event was fired, false if it was rejected because of rejectEventHandler(eventName) | |
| */ | |
| raiseEvent: function( eventName, eventArgs ) { | |
| //uncomment if you want to get a log of all events | |
| //$.console.log( "Event fired:", eventName ); | |
| if(Object.prototype.hasOwnProperty.call(this._rejectedEventList, eventName)){ | |
| $.console.error(`Error adding handler for ${eventName}. ${this._rejectedEventList[eventName]}`); | |
| return false; | |
| } | |
| const handler = this.getHandler( eventName ); | |
| if ( handler ) { | |
| handler( this, eventArgs || {} ); | |
| } | |
| return true; | |
| }, | |
| /** | |
| * Trigger an event, optionally passing additional information. | |
| * This events awaits every asynchronous or promise-returning function, i.e. | |
| * OpenSeadragon.AsyncEventHandler. | |
| * @param {String} eventName - Name of event to register. | |
| * @param {Object} eventArgs - Event-specific data. | |
| * @param {?} [bindTarget = null] - Promise-resolved value on the event finish | |
| * @return {OpenSeadragon.Promise|undefined} - Promise resolved upon the event completion. | |
| */ | |
| raiseEventAwaiting: function ( eventName, eventArgs, bindTarget = null ) { | |
| //uncomment if you want to get a log of all events | |
| //$.console.log( "Awaiting event fired:", eventName ); | |
| const awaitingHandler = this.getAwaitingHandler(eventName, bindTarget); | |
| if (awaitingHandler) { | |
| return awaitingHandler(this, eventArgs || {}); | |
| } | |
| return $.Promise.resolve(bindTarget); | |
| }, | |
| /** | |
| * Set an event name as being disabled, and provide an optional error message | |
| * to be printed to the console | |
| * @param {String} eventName - Name of the event | |
| * @param {String} [errorMessage] - Optional string to print to the console | |
| * @private | |
| */ | |
| rejectEventHandler(eventName, errorMessage = ''){ | |
| this._rejectedEventList[eventName] = errorMessage; | |
| }, | |
| /** | |
| * Explicitly allow an event handler to be added for this event type, undoing | |
| * the effects of rejectEventHandler | |
| * @param {String} eventName - Name of the event | |
| * @private | |
| */ | |
| allowEventHandler(eventName){ | |
| delete this._rejectedEventList[eventName]; | |
| } | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - MouseTracker | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function ( $ ) { | |
| // All MouseTracker instances | |
| var MOUSETRACKERS = []; | |
| // dictionary from hash to private properties | |
| var THIS = {}; | |
| /** | |
| * @class MouseTracker | |
| * @classdesc Provides simplified handling of common pointer device (mouse, touch, pen, etc.) gestures | |
| * and keyboard events on a specified element. | |
| * @memberof OpenSeadragon | |
| * @param {Object} options | |
| * Allows configurable properties to be entirely specified by passing | |
| * an options object to the constructor. The constructor also supports | |
| * the original positional arguments 'element', 'clickTimeThreshold', | |
| * and 'clickDistThreshold' in that order. | |
| * @param {Element|String} options.element | |
| * A reference to an element or an element id for which the pointer/key | |
| * events will be monitored. | |
| * @param {Boolean} [options.startDisabled=false] | |
| * If true, event tracking on the element will not start until | |
| * {@link OpenSeadragon.MouseTracker.setTracking|setTracking} is called. | |
| * @param {Number} [options.clickTimeThreshold=300] | |
| * The number of milliseconds within which a pointer down-up event combination | |
| * will be treated as a click gesture. | |
| * @param {Number} [options.clickDistThreshold=5] | |
| * The maximum distance allowed between a pointer down event and a pointer up event | |
| * to be treated as a click gesture. | |
| * @param {Number} [options.dblClickTimeThreshold=300] | |
| * The number of milliseconds within which two pointer down-up event combinations | |
| * will be treated as a double-click gesture. | |
| * @param {Number} [options.dblClickDistThreshold=20] | |
| * The maximum distance allowed between two pointer click events | |
| * to be treated as a click gesture. | |
| * @param {Number} [options.stopDelay=50] | |
| * The number of milliseconds without pointer move before the stop | |
| * event is fired. | |
| * @param {OpenSeadragon.EventHandler} [options.preProcessEventHandler=null] | |
| * An optional handler for controlling DOM event propagation and processing. | |
| * @param {OpenSeadragon.EventHandler} [options.contextMenuHandler=null] | |
| * An optional handler for contextmenu. | |
| * @param {OpenSeadragon.EventHandler} [options.enterHandler=null] | |
| * An optional handler for pointer enter. | |
| * @param {OpenSeadragon.EventHandler} [options.leaveHandler=null] | |
| * An optional handler for pointer leave. | |
| * @param {OpenSeadragon.EventHandler} [options.exitHandler=null] | |
| * An optional handler for pointer leave. <span style="color:red;">Deprecated. Use leaveHandler instead.</span> | |
| * @param {OpenSeadragon.EventHandler} [options.overHandler=null] | |
| * An optional handler for pointer over. | |
| * @param {OpenSeadragon.EventHandler} [options.outHandler=null] | |
| * An optional handler for pointer out. | |
| * @param {OpenSeadragon.EventHandler} [options.pressHandler=null] | |
| * An optional handler for pointer press. | |
| * @param {OpenSeadragon.EventHandler} [options.nonPrimaryPressHandler=null] | |
| * An optional handler for pointer non-primary button press. | |
| * @param {OpenSeadragon.EventHandler} [options.releaseHandler=null] | |
| * An optional handler for pointer release. | |
| * @param {OpenSeadragon.EventHandler} [options.nonPrimaryReleaseHandler=null] | |
| * An optional handler for pointer non-primary button release. | |
| * @param {OpenSeadragon.EventHandler} [options.moveHandler=null] | |
| * An optional handler for pointer move. | |
| * @param {OpenSeadragon.EventHandler} [options.scrollHandler=null] | |
| * An optional handler for mouse wheel scroll. | |
| * @param {OpenSeadragon.EventHandler} [options.clickHandler=null] | |
| * An optional handler for pointer click. | |
| * @param {OpenSeadragon.EventHandler} [options.dblClickHandler=null] | |
| * An optional handler for pointer double-click. | |
| * @param {OpenSeadragon.EventHandler} [options.dragHandler=null] | |
| * An optional handler for the drag gesture. | |
| * @param {OpenSeadragon.EventHandler} [options.dragEndHandler=null] | |
| * An optional handler for after a drag gesture. | |
| * @param {OpenSeadragon.EventHandler} [options.pinchHandler=null] | |
| * An optional handler for the pinch gesture. | |
| * @param {OpenSeadragon.EventHandler} [options.keyDownHandler=null] | |
| * An optional handler for keydown. | |
| * @param {OpenSeadragon.EventHandler} [options.keyUpHandler=null] | |
| * An optional handler for keyup. | |
| * @param {OpenSeadragon.EventHandler} [options.keyHandler=null] | |
| * An optional handler for keypress. | |
| * @param {OpenSeadragon.EventHandler} [options.focusHandler=null] | |
| * An optional handler for focus. | |
| * @param {OpenSeadragon.EventHandler} [options.blurHandler=null] | |
| * An optional handler for blur. | |
| * @param {Object} [options.userData=null] | |
| * Arbitrary object to be passed unchanged to any attached handler methods. | |
| */ | |
| $.MouseTracker = function ( options ) { | |
| MOUSETRACKERS.push( this ); | |
| var args = arguments; | |
| if ( !$.isPlainObject( options ) ) { | |
| options = { | |
| element: args[ 0 ], | |
| clickTimeThreshold: args[ 1 ], | |
| clickDistThreshold: args[ 2 ] | |
| }; | |
| } | |
| this.hash = uniqueHash(); // An unique hash for this tracker. | |
| /** | |
| * The element for which pointer events are being monitored. | |
| * @member {Element} element | |
| * @memberof OpenSeadragon.MouseTracker# | |
| */ | |
| this.element = $.getElement( options.element ); | |
| /** | |
| * The number of milliseconds within which a pointer down-up event combination | |
| * will be treated as a click gesture. | |
| * @member {Number} clickTimeThreshold | |
| * @memberof OpenSeadragon.MouseTracker# | |
| */ | |
| this.clickTimeThreshold = options.clickTimeThreshold || $.DEFAULT_SETTINGS.clickTimeThreshold; | |
| /** | |
| * The maximum distance allowed between a pointer down event and a pointer up event | |
| * to be treated as a click gesture. | |
| * @member {Number} clickDistThreshold | |
| * @memberof OpenSeadragon.MouseTracker# | |
| */ | |
| this.clickDistThreshold = options.clickDistThreshold || $.DEFAULT_SETTINGS.clickDistThreshold; | |
| /** | |
| * The number of milliseconds within which two pointer down-up event combinations | |
| * will be treated as a double-click gesture. | |
| * @member {Number} dblClickTimeThreshold | |
| * @memberof OpenSeadragon.MouseTracker# | |
| */ | |
| this.dblClickTimeThreshold = options.dblClickTimeThreshold || $.DEFAULT_SETTINGS.dblClickTimeThreshold; | |
| /** | |
| * The maximum distance allowed between two pointer click events | |
| * to be treated as a double-click gesture. | |
| * @member {Number} dblClickDistThreshold | |
| * @memberof OpenSeadragon.MouseTracker# | |
| */ | |
| this.dblClickDistThreshold = options.dblClickDistThreshold || $.DEFAULT_SETTINGS.dblClickDistThreshold; | |
| /*eslint-disable no-multi-spaces*/ | |
| this.userData = options.userData || null; | |
| this.stopDelay = options.stopDelay || 50; | |
| this.preProcessEventHandler = options.preProcessEventHandler || null; | |
| this.contextMenuHandler = options.contextMenuHandler || null; | |
| this.enterHandler = options.enterHandler || null; | |
| this.leaveHandler = options.leaveHandler || null; | |
| this.exitHandler = options.exitHandler || null; // Deprecated v2.5.0 | |
| this.overHandler = options.overHandler || null; | |
| this.outHandler = options.outHandler || null; | |
| this.pressHandler = options.pressHandler || null; | |
| this.nonPrimaryPressHandler = options.nonPrimaryPressHandler || null; | |
| this.releaseHandler = options.releaseHandler || null; | |
| this.nonPrimaryReleaseHandler = options.nonPrimaryReleaseHandler || null; | |
| this.moveHandler = options.moveHandler || null; | |
| this.scrollHandler = options.scrollHandler || null; | |
| this.clickHandler = options.clickHandler || null; | |
| this.dblClickHandler = options.dblClickHandler || null; | |
| this.dragHandler = options.dragHandler || null; | |
| this.dragEndHandler = options.dragEndHandler || null; | |
| this.pinchHandler = options.pinchHandler || null; | |
| this.stopHandler = options.stopHandler || null; | |
| this.keyDownHandler = options.keyDownHandler || null; | |
| this.keyUpHandler = options.keyUpHandler || null; | |
| this.keyHandler = options.keyHandler || null; | |
| this.focusHandler = options.focusHandler || null; | |
| this.blurHandler = options.blurHandler || null; | |
| /*eslint-enable no-multi-spaces*/ | |
| //Store private properties in a scope sealed hash map | |
| var _this = this; | |
| /** | |
| * @private | |
| * @property {Boolean} tracking | |
| * Are we currently tracking pointer events for this element. | |
| */ | |
| THIS[ this.hash ] = { | |
| click: function ( event ) { onClick( _this, event ); }, | |
| dblclick: function ( event ) { onDblClick( _this, event ); }, | |
| keydown: function ( event ) { onKeyDown( _this, event ); }, | |
| keyup: function ( event ) { onKeyUp( _this, event ); }, | |
| keypress: function ( event ) { onKeyPress( _this, event ); }, | |
| focus: function ( event ) { onFocus( _this, event ); }, | |
| blur: function ( event ) { onBlur( _this, event ); }, | |
| contextmenu: function ( event ) { onContextMenu( _this, event ); }, | |
| wheel: function ( event ) { onWheel( _this, event ); }, | |
| mousewheel: function ( event ) { onMouseWheel( _this, event ); }, | |
| DOMMouseScroll: function ( event ) { onMouseWheel( _this, event ); }, | |
| MozMousePixelScroll: function ( event ) { onMouseWheel( _this, event ); }, | |
| losecapture: function ( event ) { onLoseCapture( _this, event ); }, | |
| mouseenter: function ( event ) { onPointerEnter( _this, event ); }, | |
| mouseleave: function ( event ) { onPointerLeave( _this, event ); }, | |
| mouseover: function ( event ) { onPointerOver( _this, event ); }, | |
| mouseout: function ( event ) { onPointerOut( _this, event ); }, | |
| mousedown: function ( event ) { onPointerDown( _this, event ); }, | |
| mouseup: function ( event ) { onPointerUp( _this, event ); }, | |
| mousemove: function ( event ) { onPointerMove( _this, event ); }, | |
| touchstart: function ( event ) { onTouchStart( _this, event ); }, | |
| touchend: function ( event ) { onTouchEnd( _this, event ); }, | |
| touchmove: function ( event ) { onTouchMove( _this, event ); }, | |
| touchcancel: function ( event ) { onTouchCancel( _this, event ); }, | |
| gesturestart: function ( event ) { onGestureStart( _this, event ); }, // Safari/Safari iOS | |
| gesturechange: function ( event ) { onGestureChange( _this, event ); }, // Safari/Safari iOS | |
| gotpointercapture: function ( event ) { onGotPointerCapture( _this, event ); }, | |
| lostpointercapture: function ( event ) { onLostPointerCapture( _this, event ); }, | |
| pointerenter: function ( event ) { onPointerEnter( _this, event ); }, | |
| pointerleave: function ( event ) { onPointerLeave( _this, event ); }, | |
| pointerover: function ( event ) { onPointerOver( _this, event ); }, | |
| pointerout: function ( event ) { onPointerOut( _this, event ); }, | |
| pointerdown: function ( event ) { onPointerDown( _this, event ); }, | |
| pointerup: function ( event ) { onPointerUp( _this, event ); }, | |
| pointermove: function ( event ) { onPointerMove( _this, event ); }, | |
| pointercancel: function ( event ) { onPointerCancel( _this, event ); }, | |
| pointerupcaptured: function ( event ) { onPointerUpCaptured( _this, event ); }, | |
| pointermovecaptured: function ( event ) { onPointerMoveCaptured( _this, event ); }, | |
| tracking: false, | |
| // Active pointers lists. Array of GesturePointList objects, one for each pointer device type. | |
| // GesturePointList objects are added each time a pointer is tracked by a new pointer device type (see getActivePointersListByType()). | |
| // Active pointers are any pointer being tracked for this element which are in the hit-test area | |
| // of the element (for hover-capable devices) and/or have contact or a button press initiated in the element. | |
| activePointersLists: [], | |
| // Tracking for double-click gesture | |
| lastClickPos: null, | |
| dblClickTimeOut: null, | |
| // Tracking for pinch gesture | |
| pinchGPoints: [], | |
| lastPinchDist: 0, | |
| currentPinchDist: 0, | |
| lastPinchCenter: null, | |
| currentPinchCenter: null, | |
| // Tracking for drag | |
| sentDragEvent: false | |
| }; | |
| if ( $.MouseTracker.havePointerEvents ) { | |
| $.setElementPointerEvents( this.element, 'auto' ); | |
| } | |
| if (this.exitHandler) { | |
| $.console.error("MouseTracker.exitHandler is deprecated. Use MouseTracker.leaveHandler instead."); | |
| } | |
| if ( !options.startDisabled ) { | |
| this.setTracking( true ); | |
| } | |
| }; | |
| /** @lends OpenSeadragon.MouseTracker.prototype */ | |
| $.MouseTracker.prototype = { | |
| /** | |
| * Clean up any events or objects created by the tracker. | |
| * @function | |
| */ | |
| destroy: function () { | |
| var i; | |
| stopTracking( this ); | |
| this.element = null; | |
| for ( i = 0; i < MOUSETRACKERS.length; i++ ) { | |
| if ( MOUSETRACKERS[ i ] === this ) { | |
| MOUSETRACKERS.splice( i, 1 ); | |
| break; | |
| } | |
| } | |
| THIS[ this.hash ] = null; | |
| delete THIS[ this.hash ]; | |
| }, | |
| /** | |
| * Are we currently tracking events on this element. | |
| * @deprecated Just use this.tracking | |
| * @function | |
| * @returns {Boolean} Are we currently tracking events on this element. | |
| */ | |
| isTracking: function () { | |
| return THIS[ this.hash ].tracking; | |
| }, | |
| /** | |
| * Enable or disable whether or not we are tracking events on this element. | |
| * @function | |
| * @param {Boolean} track True to start tracking, false to stop tracking. | |
| * @returns {OpenSeadragon.MouseTracker} Chainable. | |
| */ | |
| setTracking: function ( track ) { | |
| if ( track ) { | |
| startTracking( this ); | |
| } else { | |
| stopTracking( this ); | |
| } | |
| //chain | |
| return this; | |
| }, | |
| /** | |
| * Returns the {@link OpenSeadragon.MouseTracker.GesturePointList|GesturePointList} for the given pointer device type, | |
| * creating and caching a new {@link OpenSeadragon.MouseTracker.GesturePointList|GesturePointList} if one doesn't already exist for the type. | |
| * @function | |
| * @param {String} type - The pointer device type: "mouse", "touch", "pen", etc. | |
| * @returns {OpenSeadragon.MouseTracker.GesturePointList} | |
| */ | |
| getActivePointersListByType: function ( type ) { | |
| var delegate = THIS[ this.hash ], | |
| i, | |
| len = delegate ? delegate.activePointersLists.length : 0, | |
| list; | |
| for ( i = 0; i < len; i++ ) { | |
| if ( delegate.activePointersLists[ i ].type === type ) { | |
| return delegate.activePointersLists[ i ]; | |
| } | |
| } | |
| list = new $.MouseTracker.GesturePointList( type ); | |
| if(delegate){ | |
| delegate.activePointersLists.push( list ); | |
| } | |
| return list; | |
| }, | |
| /** | |
| * Returns the total number of pointers currently active on the tracked element. | |
| * @function | |
| * @returns {Number} | |
| */ | |
| getActivePointerCount: function () { | |
| var delegate = THIS[ this.hash ], | |
| i, | |
| len = delegate.activePointersLists.length, | |
| count = 0; | |
| for ( i = 0; i < len; i++ ) { | |
| count += delegate.activePointersLists[ i ].getLength(); | |
| } | |
| return count; | |
| }, | |
| /** | |
| * Do we currently have any assigned gesture handlers. | |
| * @returns {Boolean} Do we currently have any assigned gesture handlers. | |
| */ | |
| get hasGestureHandlers() { | |
| return !!(this.pressHandler || | |
| this.nonPrimaryPressHandler || | |
| this.releaseHandler || | |
| this.nonPrimaryReleaseHandler || | |
| this.clickHandler || | |
| this.dblClickHandler || | |
| this.dragHandler || | |
| this.dragEndHandler || | |
| this.pinchHandler); | |
| }, | |
| /** | |
| * Do we currently have a scroll handler. | |
| * @returns {Boolean} Do we currently have a scroll handler. | |
| */ | |
| get hasScrollHandler() { | |
| return !!this.scrollHandler; | |
| }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| */ | |
| preProcessEventHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Boolean} event.preventDefault | |
| * Set to true to prevent the default user-agent's handling of the contextmenu event. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| contextMenuHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Number} event.pointers | |
| * Number of pointers (all types) active in the tracked element. | |
| * @param {Boolean} event.insideElementPressed | |
| * True if the left mouse button is currently being pressed and was | |
| * initiated inside the tracked element, otherwise false. | |
| * @param {Boolean} event.buttonDownAny | |
| * Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| enterHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @since v2.5.0 | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Number} event.pointers | |
| * Number of pointers (all types) active in the tracked element. | |
| * @param {Boolean} event.insideElementPressed | |
| * True if the left mouse button is currently being pressed and was | |
| * initiated inside the tracked element, otherwise false. | |
| * @param {Boolean} event.buttonDownAny | |
| * Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| leaveHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @deprecated v2.5.0 Use leaveHandler instead | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Number} event.pointers | |
| * Number of pointers (all types) active in the tracked element. | |
| * @param {Boolean} event.insideElementPressed | |
| * True if the left mouse button is currently being pressed and was | |
| * initiated inside the tracked element, otherwise false. | |
| * @param {Boolean} event.buttonDownAny | |
| * Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| exitHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @since v2.5.0 | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Number} event.pointers | |
| * Number of pointers (all types) active in the tracked element. | |
| * @param {Boolean} event.insideElementPressed | |
| * True if the left mouse button is currently being pressed and was | |
| * initiated inside the tracked element, otherwise false. | |
| * @param {Boolean} event.buttonDownAny | |
| * Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| overHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @since v2.5.0 | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Number} event.pointers | |
| * Number of pointers (all types) active in the tracked element. | |
| * @param {Boolean} event.insideElementPressed | |
| * True if the left mouse button is currently being pressed and was | |
| * initiated inside the tracked element, otherwise false. | |
| * @param {Boolean} event.buttonDownAny | |
| * Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| outHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| pressHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.button | |
| * Button which caused the event. | |
| * -1: none, 0: primary/left, 1: aux/middle, 2: secondary/right, 3: X1/back, 4: X2/forward, 5: pen eraser. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| nonPrimaryPressHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Boolean} event.insideElementPressed | |
| * True if the left mouse button is currently being pressed and was | |
| * initiated inside the tracked element, otherwise false. | |
| * @param {Boolean} event.insideElementReleased | |
| * True if the cursor inside the tracked element when the button was released. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| releaseHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.button | |
| * Button which caused the event. | |
| * -1: none, 0: primary/left, 1: aux/middle, 2: secondary/right, 3: X1/back, 4: X2/forward, 5: pen eraser. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| nonPrimaryReleaseHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| moveHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.scroll | |
| * The scroll delta for the event. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead. Touch devices no longer generate scroll event.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Boolean} event.preventDefault | |
| * Set to true to prevent the default user-agent's handling of the wheel event. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| scrollHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Boolean} event.quick | |
| * True only if the clickDistThreshold and clickTimeThreshold are both passed. Useful for ignoring drag events. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Element} event.originalTarget | |
| * The DOM element clicked on. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| clickHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| dblClickHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {OpenSeadragon.Point} event.delta | |
| * The x,y components of the difference between the current position and the last drag event position. Useful for ignoring or weighting the events. | |
| * @param {Number} event.speed | |
| * Current computed speed, in pixels per second. | |
| * @param {Number} event.direction | |
| * Current computed direction, expressed as an angle counterclockwise relative to the positive X axis (-pi to pi, in radians). Only valid if speed > 0. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| dragHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.speed | |
| * Speed at the end of a drag gesture, in pixels per second. | |
| * @param {Number} event.direction | |
| * Direction at the end of a drag gesture, expressed as an angle counterclockwise relative to the positive X axis (-pi to pi, in radians). Only valid if speed > 0. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| dragEndHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {Array.<OpenSeadragon.MouseTracker.GesturePoint>} event.gesturePoints | |
| * Gesture points associated with the gesture. Velocity data can be found here. | |
| * @param {OpenSeadragon.Point} event.lastCenter | |
| * The previous center point of the two pinch contact points relative to the tracked element. | |
| * @param {OpenSeadragon.Point} event.center | |
| * The center point of the two pinch contact points relative to the tracked element. | |
| * @param {Number} event.lastDistance | |
| * The previous distance between the two pinch contact points in CSS pixels. | |
| * @param {Number} event.distance | |
| * The distance between the two pinch contact points in CSS pixels. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| pinchHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {String} event.pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @param {OpenSeadragon.Point} event.position | |
| * The position of the event relative to the tracked element. | |
| * @param {Number} event.buttons | |
| * Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @param {Boolean} event.isTouchEvent | |
| * True if the original event is a touch event, otherwise false. <span style="color:red;">Deprecated. Use pointerType and/or originalEvent instead.</span> | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| stopHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {Number} event.keyCode | |
| * The key code that was pressed. | |
| * @param {Boolean} event.ctrl | |
| * True if the ctrl key was pressed during this event. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.alt | |
| * True if the alt key was pressed during this event. | |
| * @param {Boolean} event.meta | |
| * True if the meta key was pressed during this event. | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Boolean} event.preventDefault | |
| * Set to true to prevent the default user-agent's handling of the keydown event. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| keyDownHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {Number} event.keyCode | |
| * The key code that was pressed. | |
| * @param {Boolean} event.ctrl | |
| * True if the ctrl key was pressed during this event. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.alt | |
| * True if the alt key was pressed during this event. | |
| * @param {Boolean} event.meta | |
| * True if the meta key was pressed during this event. | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Boolean} event.preventDefault | |
| * Set to true to prevent the default user-agent's handling of the keyup event. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| keyUpHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {Number} event.keyCode | |
| * The key code that was pressed. | |
| * @param {Boolean} event.ctrl | |
| * True if the ctrl key was pressed during this event. | |
| * @param {Boolean} event.shift | |
| * True if the shift key was pressed during this event. | |
| * @param {Boolean} event.alt | |
| * True if the alt key was pressed during this event. | |
| * @param {Boolean} event.meta | |
| * True if the meta key was pressed during this event. | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Boolean} event.preventDefault | |
| * Set to true to prevent the default user-agent's handling of the keypress event. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| keyHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| focusHandler: function () { }, | |
| /** | |
| * Implement or assign implementation to these handlers during or after | |
| * calling the constructor. | |
| * @function | |
| * @param {Object} event | |
| * @param {OpenSeadragon.MouseTracker} event.eventSource | |
| * A reference to the tracker instance. | |
| * @param {Object} event.originalEvent | |
| * The original event object. | |
| * @param {Object} event.userData | |
| * Arbitrary user-defined object. | |
| */ | |
| blurHandler: function () { } | |
| }; | |
| // https://github.com/openseadragon/openseadragon/pull/790 | |
| /** | |
| * True if inside an iframe, otherwise false. | |
| * @member {Boolean} isInIframe | |
| * @private | |
| * @inner | |
| */ | |
| var isInIframe = (function() { | |
| try { | |
| return window.self !== window.top; | |
| } catch (e) { | |
| return true; | |
| } | |
| })(); | |
| // https://github.com/openseadragon/openseadragon/pull/790 | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @returns {Boolean} True if the target supports DOM Level 2 event subscription methods, otherwise false. | |
| */ | |
| function canAccessEvents (target) { | |
| try { | |
| return target.addEventListener && target.removeEventListener; | |
| } catch (e) { | |
| return false; | |
| } | |
| } | |
| /** | |
| * Provides continuous computation of velocity (speed and direction) of active pointers. | |
| * This is a singleton, used by all MouseTracker instances, as it is unlikely there will ever be more than | |
| * two active gesture pointers at a time. | |
| * | |
| * @private | |
| * @member gesturePointVelocityTracker | |
| * @memberof OpenSeadragon.MouseTracker | |
| */ | |
| $.MouseTracker.gesturePointVelocityTracker = (function () { | |
| var trackerPoints = [], | |
| intervalId = 0, | |
| lastTime = 0; | |
| // Generates a unique identifier for a tracked gesture point | |
| var _generateGuid = function ( tracker, gPoint ) { | |
| return tracker.hash.toString() + gPoint.type + gPoint.id.toString(); | |
| }; | |
| // Interval timer callback. Computes velocity for all tracked gesture points. | |
| var _doTracking = function () { | |
| var i, | |
| len = trackerPoints.length, | |
| trackPoint, | |
| gPoint, | |
| now = $.now(), | |
| elapsedTime, | |
| distance, | |
| speed; | |
| elapsedTime = now - lastTime; | |
| lastTime = now; | |
| for ( i = 0; i < len; i++ ) { | |
| trackPoint = trackerPoints[ i ]; | |
| gPoint = trackPoint.gPoint; | |
| // Math.atan2 gives us just what we need for a velocity vector, as we can simply | |
| // use cos()/sin() to extract the x/y velocity components. | |
| gPoint.direction = Math.atan2( gPoint.currentPos.y - trackPoint.lastPos.y, gPoint.currentPos.x - trackPoint.lastPos.x ); | |
| // speed = distance / elapsed time | |
| distance = trackPoint.lastPos.distanceTo( gPoint.currentPos ); | |
| trackPoint.lastPos = gPoint.currentPos; | |
| speed = 1000 * distance / ( elapsedTime + 1 ); | |
| // Simple biased average, favors the most recent speed computation. Smooths out erratic gestures a bit. | |
| gPoint.speed = 0.75 * speed + 0.25 * gPoint.speed; | |
| } | |
| }; | |
| // Public. Add a gesture point to be tracked | |
| var addPoint = function ( tracker, gPoint ) { | |
| var guid = _generateGuid( tracker, gPoint ); | |
| trackerPoints.push( | |
| { | |
| guid: guid, | |
| gPoint: gPoint, | |
| lastPos: gPoint.currentPos | |
| } ); | |
| // Only fire up the interval timer when there's gesture pointers to track | |
| if ( trackerPoints.length === 1 ) { | |
| lastTime = $.now(); | |
| intervalId = window.setInterval( _doTracking, 50 ); | |
| } | |
| }; | |
| // Public. Stop tracking a gesture point | |
| var removePoint = function ( tracker, gPoint ) { | |
| var guid = _generateGuid( tracker, gPoint ), | |
| i, | |
| len = trackerPoints.length; | |
| for ( i = 0; i < len; i++ ) { | |
| if ( trackerPoints[ i ].guid === guid ) { | |
| trackerPoints.splice( i, 1 ); | |
| // Only run the interval timer if theres gesture pointers to track | |
| len--; | |
| if ( len === 0 ) { | |
| window.clearInterval( intervalId ); | |
| } | |
| break; | |
| } | |
| } | |
| }; | |
| return { | |
| addPoint: addPoint, | |
| removePoint: removePoint | |
| }; | |
| } )(); | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Pointer event model and feature detection | |
| /////////////////////////////////////////////////////////////////////////////// | |
| $.MouseTracker.captureElement = document; | |
| /** | |
| * Detect available mouse wheel event name. | |
| */ | |
| $.MouseTracker.wheelEventName = ( 'onwheel' in document.createElement( 'div' ) ) ? 'wheel' : // Modern browsers support 'wheel' | |
| document.onmousewheel !== undefined ? 'mousewheel' : // Webkit (and unsupported IE) support at least 'mousewheel' | |
| 'DOMMouseScroll'; // Assume old Firefox (deprecated) | |
| /** | |
| * Detect browser pointer device event model(s) and build appropriate list of events to subscribe to. | |
| */ | |
| $.MouseTracker.subscribeEvents = [ "click", "dblclick", "keydown", "keyup", "keypress", "focus", "blur", "contextmenu", $.MouseTracker.wheelEventName ]; | |
| if( $.MouseTracker.wheelEventName === "DOMMouseScroll" ) { | |
| // Older Firefox | |
| $.MouseTracker.subscribeEvents.push( "MozMousePixelScroll" ); | |
| } | |
| if ( window.PointerEvent ) { | |
| // W3C Pointer Event implementations (see http://www.w3.org/TR/pointerevents) | |
| $.MouseTracker.havePointerEvents = true; | |
| $.MouseTracker.subscribeEvents.push( "pointerenter", "pointerleave", "pointerover", "pointerout", "pointerdown", "pointerup", "pointermove", "pointercancel" ); | |
| // Pointer events capture support | |
| $.MouseTracker.havePointerCapture = (function () { | |
| var divElement = document.createElement( 'div' ); | |
| return $.isFunction( divElement.setPointerCapture ) && $.isFunction( divElement.releasePointerCapture ); | |
| }()); | |
| if ( $.MouseTracker.havePointerCapture ) { | |
| $.MouseTracker.subscribeEvents.push( "gotpointercapture", "lostpointercapture" ); | |
| } | |
| } else { | |
| // Legacy W3C mouse events | |
| $.MouseTracker.havePointerEvents = false; | |
| $.MouseTracker.subscribeEvents.push( "mouseenter", "mouseleave", "mouseover", "mouseout", "mousedown", "mouseup", "mousemove" ); | |
| $.MouseTracker.mousePointerId = "legacy-mouse"; | |
| // Legacy mouse events capture support (IE/Firefox only?) | |
| $.MouseTracker.havePointerCapture = (function () { | |
| var divElement = document.createElement( 'div' ); | |
| return $.isFunction( divElement.setCapture ) && $.isFunction( divElement.releaseCapture ); | |
| }()); | |
| if ( $.MouseTracker.havePointerCapture ) { | |
| $.MouseTracker.subscribeEvents.push( "losecapture" ); | |
| } | |
| // Legacy touch events | |
| if ( 'ontouchstart' in window ) { | |
| // iOS, Android, and other W3c Touch Event implementations | |
| // (see http://www.w3.org/TR/touch-events/) | |
| // (see https://developer.apple.com/library/ios/documentation/AppleApplications/Reference/SafariWebContent/HandlingEvents/HandlingEvents.html) | |
| // (see https://developer.apple.com/library/safari/documentation/AppleApplications/Reference/SafariWebContent/HandlingEvents/HandlingEvents.html) | |
| $.MouseTracker.subscribeEvents.push( "touchstart", "touchend", "touchmove", "touchcancel" ); | |
| } | |
| if ( 'ongesturestart' in window ) { | |
| // iOS (see https://developer.apple.com/library/ios/documentation/AppleApplications/Reference/SafariWebContent/HandlingEvents/HandlingEvents.html) | |
| // Subscribe to these to prevent default gesture handling | |
| $.MouseTracker.subscribeEvents.push( "gesturestart", "gesturechange" ); | |
| } | |
| } | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Classes and typedefs | |
| /////////////////////////////////////////////////////////////////////////////// | |
| /** | |
| * Used for the processing/disposition of DOM events (propagation, default handling, capture, etc.) | |
| * | |
| * @typedef {Object} EventProcessInfo | |
| * @memberof OpenSeadragon.MouseTracker | |
| * @since v2.5.0 | |
| * | |
| * @property {OpenSeadragon.MouseTracker} eventSource | |
| * A reference to the tracker instance. | |
| * @property {Object} originalEvent | |
| * The original DOM event object. | |
| * @property {Number} eventPhase | |
| * 0 == NONE, 1 == CAPTURING_PHASE, 2 == AT_TARGET, 3 == BUBBLING_PHASE. | |
| * @property {String} eventType | |
| * "keydown", "keyup", "keypress", "focus", "blur", "contextmenu", "gotpointercapture", "lostpointercapture", "pointerenter", "pointerleave", "pointerover", "pointerout", "pointerdown", "pointerup", "pointermove", "pointercancel", "wheel", "click", "dblclick". | |
| * @property {String} pointerType | |
| * "mouse", "touch", "pen", etc. | |
| * @property {Boolean} isEmulated | |
| * True if this is an emulated event. If true, originalEvent is either the event that caused | |
| * the emulated event, a synthetic event object created with values from the actual DOM event, | |
| * or null if no DOM event applies. Emulated events can occur on eventType "wheel" on legacy mouse-scroll | |
| * event emitting user agents. | |
| * @property {Boolean} isStoppable | |
| * True if propagation of the event (e.g. bubbling) can be stopped with stopPropagation/stopImmediatePropagation. | |
| * @property {Boolean} isCancelable | |
| * True if the event's default handling by the browser can be prevented with preventDefault. | |
| * @property {Boolean} defaultPrevented | |
| * True if the event's default handling has already been prevented by a descendent element. | |
| * @property {Boolean} preventDefault | |
| * Set to true to prevent the event's default handling by the browser. | |
| * @property {Boolean} preventGesture | |
| * Set to true to prevent this MouseTracker from generating a gesture from the event. | |
| * Valid on eventType "pointerdown". | |
| * @property {Boolean} stopPropagation | |
| * Set to true prevent the event from propagating to ancestor/descendent elements on capture/bubble phase. | |
| * @property {Boolean} shouldCapture | |
| * (Internal Use) Set to true if the pointer should be captured (events (re)targeted to tracker element). | |
| * @property {Boolean} shouldReleaseCapture | |
| * (Internal Use) Set to true if the captured pointer should be released. | |
| * @property {Object} userData | |
| * Arbitrary user-defined object. | |
| */ | |
| /** | |
| * Represents a point of contact on the screen made by a mouse cursor, pen, touch, or other pointer device. | |
| * | |
| * @typedef {Object} GesturePoint | |
| * @memberof OpenSeadragon.MouseTracker | |
| * | |
| * @property {Number} id | |
| * Identifier unique from all other active GesturePoints for a given pointer device. | |
| * @property {String} type | |
| * The pointer device type: "mouse", "touch", "pen", etc. | |
| * @property {Boolean} captured | |
| * True if events for the gesture point are captured to the tracked element. | |
| * @property {Boolean} isPrimary | |
| * True if the gesture point is a master pointer amongst the set of active pointers for each pointer type. True for mouse and primary (first) touch/pen pointers. | |
| * @property {Boolean} insideElementPressed | |
| * True if button pressed or contact point initiated inside the screen area of the tracked element. | |
| * @property {Boolean} insideElement | |
| * True if pointer or contact point is currently inside the bounds of the tracked element. | |
| * @property {Number} speed | |
| * Current computed speed, in pixels per second. | |
| * @property {Number} direction | |
| * Current computed direction, expressed as an angle counterclockwise relative to the positive X axis (-pi to pi, in radians). Only valid if speed > 0. | |
| * @property {OpenSeadragon.Point} contactPos | |
| * The initial pointer contact position, relative to the page including any scrolling. Only valid if the pointer has contact (pressed, touch contact, pen contact). | |
| * @property {Number} contactTime | |
| * The initial pointer contact time, in milliseconds. Only valid if the pointer has contact (pressed, touch contact, pen contact). | |
| * @property {OpenSeadragon.Point} lastPos | |
| * The last pointer position, relative to the page including any scrolling. | |
| * @property {Number} lastTime | |
| * The last pointer contact time, in milliseconds. | |
| * @property {OpenSeadragon.Point} currentPos | |
| * The current pointer position, relative to the page including any scrolling. | |
| * @property {Number} currentTime | |
| * The current pointer contact time, in milliseconds. | |
| */ | |
| /** | |
| * @class GesturePointList | |
| * @classdesc Provides an abstraction for a set of active {@link OpenSeadragon.MouseTracker.GesturePoint|GesturePoint} objects for a given pointer device type. | |
| * Active pointers are any pointer being tracked for this element which are in the hit-test area | |
| * of the element (for hover-capable devices) and/or have contact or a button press initiated in the element. | |
| * @memberof OpenSeadragon.MouseTracker | |
| * @param {String} type - The pointer device type: "mouse", "touch", "pen", etc. | |
| */ | |
| $.MouseTracker.GesturePointList = function ( type ) { | |
| this._gPoints = []; | |
| /** | |
| * The pointer device type: "mouse", "touch", "pen", etc. | |
| * @member {String} type | |
| * @memberof OpenSeadragon.MouseTracker.GesturePointList# | |
| */ | |
| this.type = type; | |
| /** | |
| * Current buttons pressed for the device. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @member {Number} buttons | |
| * @memberof OpenSeadragon.MouseTracker.GesturePointList# | |
| */ | |
| this.buttons = 0; | |
| /** | |
| * Current number of contact points (touch points, mouse down, etc.) for the device. | |
| * @member {Number} contacts | |
| * @memberof OpenSeadragon.MouseTracker.GesturePointList# | |
| */ | |
| this.contacts = 0; | |
| /** | |
| * Current number of clicks for the device. Used for multiple click gesture tracking. | |
| * @member {Number} clicks | |
| * @memberof OpenSeadragon.MouseTracker.GesturePointList# | |
| */ | |
| this.clicks = 0; | |
| /** | |
| * Current number of captured pointers for the device. | |
| * @member {Number} captureCount | |
| * @memberof OpenSeadragon.MouseTracker.GesturePointList# | |
| */ | |
| this.captureCount = 0; | |
| }; | |
| /** @lends OpenSeadragon.MouseTracker.GesturePointList.prototype */ | |
| $.MouseTracker.GesturePointList.prototype = { | |
| /** | |
| * @function | |
| * @returns {Number} Number of gesture points in the list. | |
| */ | |
| getLength: function () { | |
| return this._gPoints.length; | |
| }, | |
| /** | |
| * @function | |
| * @returns {Array.<OpenSeadragon.MouseTracker.GesturePoint>} The list of gesture points in the list as an array (read-only). | |
| */ | |
| asArray: function () { | |
| return this._gPoints; | |
| }, | |
| /** | |
| * @function | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gesturePoint - A gesture point to add to the list. | |
| * @returns {Number} Number of gesture points in the list. | |
| */ | |
| add: function ( gp ) { | |
| return this._gPoints.push( gp ); | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} id - The id of the gesture point to remove from the list. | |
| * @returns {Number} Number of gesture points in the list. | |
| */ | |
| removeById: function ( id ) { | |
| var i, | |
| len = this._gPoints.length; | |
| for ( i = 0; i < len; i++ ) { | |
| if ( this._gPoints[ i ].id === id ) { | |
| this._gPoints.splice( i, 1 ); | |
| break; | |
| } | |
| } | |
| return this._gPoints.length; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} index - The index of the gesture point to retrieve from the list. | |
| * @returns {OpenSeadragon.MouseTracker.GesturePoint|null} The gesture point at the given index, or null if not found. | |
| */ | |
| getByIndex: function ( index ) { | |
| if ( index < this._gPoints.length) { | |
| return this._gPoints[ index ]; | |
| } | |
| return null; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} id - The id of the gesture point to retrieve from the list. | |
| * @returns {OpenSeadragon.MouseTracker.GesturePoint|null} The gesture point with the given id, or null if not found. | |
| */ | |
| getById: function ( id ) { | |
| var i, | |
| len = this._gPoints.length; | |
| for ( i = 0; i < len; i++ ) { | |
| if ( this._gPoints[ i ].id === id ) { | |
| return this._gPoints[ i ]; | |
| } | |
| } | |
| return null; | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.MouseTracker.GesturePoint|null} The primary gesture point in the list, or null if not found. | |
| */ | |
| getPrimary: function ( id ) { | |
| var i, | |
| len = this._gPoints.length; | |
| for ( i = 0; i < len; i++ ) { | |
| if ( this._gPoints[ i ].isPrimary ) { | |
| return this._gPoints[ i ]; | |
| } | |
| } | |
| return null; | |
| }, | |
| /** | |
| * Increment this pointer list's contact count. | |
| * It will evaluate whether this pointer type is allowed to have multiple contacts. | |
| * @function | |
| */ | |
| addContact: function() { | |
| ++this.contacts; | |
| if (this.contacts > 1 && (this.type === "mouse" || this.type === "pen")) { | |
| $.console.warn('GesturePointList.addContact() Implausible contacts value'); | |
| this.contacts = 1; | |
| } | |
| }, | |
| /** | |
| * Decrement this pointer list's contact count. | |
| * It will make sure the count does not go below 0. | |
| * @function | |
| */ | |
| removeContact: function() { | |
| --this.contacts; | |
| if (this.contacts < 0) { | |
| this.contacts = 0; | |
| } | |
| } | |
| }; | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Utility functions | |
| /////////////////////////////////////////////////////////////////////////////// | |
| /** | |
| * Removes all tracked pointers. | |
| * @private | |
| * @inner | |
| */ | |
| function clearTrackedPointers( tracker ) { | |
| var delegate = THIS[ tracker.hash ], | |
| i, j, | |
| pointsList, | |
| gPoints, | |
| gPointsToRemove, | |
| pointerListCount = delegate.activePointersLists.length; | |
| for ( i = 0; i < pointerListCount; i++ ) { | |
| pointsList = delegate.activePointersLists[ i ]; | |
| if ( pointsList.getLength() > 0 ) { | |
| // Make an array containing references to the gPoints in the pointer list | |
| // (because calls to stopTrackingPointer() are going to modify the pointer list) | |
| gPointsToRemove = []; | |
| gPoints = pointsList.asArray(); | |
| for ( j = 0; j < gPoints.length; j++ ) { | |
| gPointsToRemove.push( gPoints[ j ] ); | |
| } | |
| // Release and remove all gPoints from the pointer list | |
| for ( j = 0; j < gPointsToRemove.length; j++ ) { | |
| stopTrackingPointer( tracker, pointsList, gPointsToRemove[ j ] ); | |
| } | |
| } | |
| } | |
| for ( i = 0; i < pointerListCount; i++ ) { | |
| delegate.activePointersLists.pop(); | |
| } | |
| delegate.sentDragEvent = false; | |
| } | |
| /** | |
| * Starts tracking pointer events on the tracked element. | |
| * @private | |
| * @inner | |
| */ | |
| function startTracking( tracker ) { | |
| var delegate = THIS[ tracker.hash ], | |
| event, | |
| i; | |
| if ( !delegate.tracking ) { | |
| for ( i = 0; i < $.MouseTracker.subscribeEvents.length; i++ ) { | |
| event = $.MouseTracker.subscribeEvents[ i ]; | |
| $.addEvent( | |
| tracker.element, | |
| event, | |
| delegate[ event ], | |
| event === $.MouseTracker.wheelEventName ? { passive: false, capture: false } : false | |
| ); | |
| } | |
| clearTrackedPointers( tracker ); | |
| delegate.tracking = true; | |
| } | |
| } | |
| /** | |
| * Stops tracking pointer events on the tracked element. | |
| * @private | |
| * @inner | |
| */ | |
| function stopTracking( tracker ) { | |
| var delegate = THIS[ tracker.hash ], | |
| event, | |
| i; | |
| if ( delegate.tracking ) { | |
| for ( i = 0; i < $.MouseTracker.subscribeEvents.length; i++ ) { | |
| event = $.MouseTracker.subscribeEvents[ i ]; | |
| $.removeEvent( | |
| tracker.element, | |
| event, | |
| delegate[ event ], | |
| false | |
| ); | |
| } | |
| clearTrackedPointers( tracker ); | |
| delegate.tracking = false; | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function getCaptureEventParams( tracker, pointerType ) { | |
| var delegate = THIS[ tracker.hash ]; | |
| if ( pointerType === 'pointerevent' ) { | |
| return { | |
| upName: 'pointerup', | |
| upHandler: delegate.pointerupcaptured, | |
| moveName: 'pointermove', | |
| moveHandler: delegate.pointermovecaptured | |
| }; | |
| } else if ( pointerType === 'mouse' ) { | |
| return { | |
| upName: 'pointerup', | |
| upHandler: delegate.pointerupcaptured, | |
| moveName: 'pointermove', | |
| moveHandler: delegate.pointermovecaptured | |
| }; | |
| } else if ( pointerType === 'touch' ) { | |
| return { | |
| upName: 'touchend', | |
| upHandler: delegate.touchendcaptured, | |
| moveName: 'touchmove', | |
| moveHandler: delegate.touchmovecaptured | |
| }; | |
| } else { | |
| throw new Error( "MouseTracker.getCaptureEventParams: Unknown pointer type." ); | |
| } | |
| } | |
| /** | |
| * Begin capturing pointer events to the tracked element. | |
| * @private | |
| * @inner | |
| */ | |
| function capturePointer( tracker, gPoint ) { | |
| var eventParams; | |
| if ( $.MouseTracker.havePointerCapture ) { | |
| if ( $.MouseTracker.havePointerEvents ) { | |
| // Can throw NotFoundError (InvalidPointerId Firefox < 82) | |
| // (should never happen so we'll log a warning) | |
| try { | |
| tracker.element.setPointerCapture( gPoint.id ); | |
| //$.console.log('element.setPointerCapture() called'); | |
| } catch ( e ) { | |
| $.console.warn('setPointerCapture() called on invalid pointer ID'); | |
| return; | |
| } | |
| } else { | |
| tracker.element.setCapture( true ); | |
| //$.console.log('element.setCapture() called'); | |
| } | |
| } else { | |
| // Emulate mouse capture by hanging listeners on the document object. | |
| // (Note we listen on the capture phase so the captured handlers will get called first) | |
| // eslint-disable-next-line no-use-before-define | |
| //$.console.log('Emulated mouse capture set'); | |
| eventParams = getCaptureEventParams( tracker, $.MouseTracker.havePointerEvents ? 'pointerevent' : gPoint.type ); | |
| // https://github.com/openseadragon/openseadragon/pull/790 | |
| if (isInIframe && canAccessEvents(window.top)) { | |
| $.addEvent( | |
| window.top, | |
| eventParams.upName, | |
| eventParams.upHandler, | |
| true | |
| ); | |
| } | |
| $.addEvent( | |
| $.MouseTracker.captureElement, | |
| eventParams.upName, | |
| eventParams.upHandler, | |
| true | |
| ); | |
| $.addEvent( | |
| $.MouseTracker.captureElement, | |
| eventParams.moveName, | |
| eventParams.moveHandler, | |
| true | |
| ); | |
| } | |
| updatePointerCaptured( tracker, gPoint, true ); | |
| } | |
| /** | |
| * Stop capturing pointer events to the tracked element. | |
| * @private | |
| * @inner | |
| */ | |
| function releasePointer( tracker, gPoint ) { | |
| var eventParams; | |
| var pointsList; | |
| var cachedGPoint; | |
| if ( $.MouseTracker.havePointerCapture ) { | |
| if ( $.MouseTracker.havePointerEvents ) { | |
| pointsList = tracker.getActivePointersListByType( gPoint.type ); | |
| cachedGPoint = pointsList.getById( gPoint.id ); | |
| if ( !cachedGPoint || !cachedGPoint.captured ) { | |
| return; | |
| } | |
| // Can throw NotFoundError (InvalidPointerId Firefox < 82) | |
| // (should never happen, but it does on Firefox 79 touch so we won't log a warning) | |
| try { | |
| tracker.element.releasePointerCapture( gPoint.id ); | |
| //$.console.log('element.releasePointerCapture() called'); | |
| } catch ( e ) { | |
| //$.console.warn('releasePointerCapture() called on invalid pointer ID'); | |
| } | |
| } else { | |
| tracker.element.releaseCapture(); | |
| //$.console.log('element.releaseCapture() called'); | |
| } | |
| } else { | |
| // Emulate mouse capture by hanging listeners on the document object. | |
| // (Note we listen on the capture phase so the captured handlers will get called first) | |
| //$.console.log('Emulated mouse capture release'); | |
| eventParams = getCaptureEventParams( tracker, $.MouseTracker.havePointerEvents ? 'pointerevent' : gPoint.type ); | |
| // https://github.com/openseadragon/openseadragon/pull/790 | |
| if (isInIframe && canAccessEvents(window.top)) { | |
| $.removeEvent( | |
| window.top, | |
| eventParams.upName, | |
| eventParams.upHandler, | |
| true | |
| ); | |
| } | |
| $.removeEvent( | |
| $.MouseTracker.captureElement, | |
| eventParams.moveName, | |
| eventParams.moveHandler, | |
| true | |
| ); | |
| $.removeEvent( | |
| $.MouseTracker.captureElement, | |
| eventParams.upName, | |
| eventParams.upHandler, | |
| true | |
| ); | |
| } | |
| updatePointerCaptured( tracker, gPoint, false ); | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * @private | |
| * @inner | |
| */ | |
| function getPointerId( event ) { | |
| return ( $.MouseTracker.havePointerEvents ) ? event.pointerId : $.MouseTracker.mousePointerId; | |
| } | |
| /** | |
| * Gets a W3C Pointer Events model compatible pointer type string from a DOM pointer event. | |
| * | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * @private | |
| * @inner | |
| */ | |
| function getPointerType( event ) { | |
| return $.MouseTracker.havePointerEvents && event.pointerType ? event.pointerType : 'mouse'; | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * @private | |
| * @inner | |
| */ | |
| function getIsPrimary( event ) { | |
| return ( $.MouseTracker.havePointerEvents ) ? event.isPrimary : true; | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function getMouseAbsolute( event ) { | |
| return $.getMousePosition( event ); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function getMouseRelative( event, element ) { | |
| return getPointRelativeToAbsolute( getMouseAbsolute( event ), element ); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function getPointRelativeToAbsolute( point, element ) { | |
| var offset = $.getElementOffset( element ); | |
| return point.minus( offset ); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function getCenterPoint( point1, point2 ) { | |
| return new $.Point( ( point1.x + point2.x ) / 2, ( point1.y + point2.y ) / 2 ); | |
| } | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Device-specific DOM event handlers | |
| /////////////////////////////////////////////////////////////////////////////// | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onClick( tracker, event ) { | |
| //$.console.log('click ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'click', | |
| pointerType: 'mouse', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onDblClick( tracker, event ) { | |
| //$.console.log('dblclick ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'dblclick', | |
| pointerType: 'mouse', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onKeyDown( tracker, event ) { | |
| //$.console.log( "keydown %s %s %s %s %s", event.keyCode, event.charCode, event.ctrlKey, event.shiftKey, event.altKey ); | |
| var eventArgs = null; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'keydown', | |
| pointerType: '', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( tracker.keyDownHandler && !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| eventArgs = { | |
| eventSource: tracker, | |
| keyCode: event.keyCode ? event.keyCode : event.charCode, | |
| ctrl: event.ctrlKey, | |
| shift: event.shiftKey, | |
| alt: event.altKey, | |
| meta: event.metaKey, | |
| originalEvent: event, | |
| preventDefault: eventInfo.preventDefault || eventInfo.defaultPrevented, | |
| userData: tracker.userData | |
| }; | |
| tracker.keyDownHandler( eventArgs ); | |
| } | |
| if ( ( eventArgs && eventArgs.preventDefault ) || ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onKeyUp( tracker, event ) { | |
| //$.console.log( "keyup %s %s %s %s %s", event.keyCode, event.charCode, event.ctrlKey, event.shiftKey, event.altKey ); | |
| var eventArgs = null; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'keyup', | |
| pointerType: '', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( tracker.keyUpHandler && !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| eventArgs = { | |
| eventSource: tracker, | |
| keyCode: event.keyCode ? event.keyCode : event.charCode, | |
| ctrl: event.ctrlKey, | |
| shift: event.shiftKey, | |
| alt: event.altKey, | |
| meta: event.metaKey, | |
| originalEvent: event, | |
| preventDefault: eventInfo.preventDefault || eventInfo.defaultPrevented, | |
| userData: tracker.userData | |
| }; | |
| tracker.keyUpHandler( eventArgs ); | |
| } | |
| if ( ( eventArgs && eventArgs.preventDefault ) || ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onKeyPress( tracker, event ) { | |
| //$.console.log( "keypress %s %s %s %s %s", event.keyCode, event.charCode, event.ctrlKey, event.shiftKey, event.altKey ); | |
| var eventArgs = null; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'keypress', | |
| pointerType: '', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( tracker.keyHandler && !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| eventArgs = { | |
| eventSource: tracker, | |
| keyCode: event.keyCode ? event.keyCode : event.charCode, | |
| ctrl: event.ctrlKey, | |
| shift: event.shiftKey, | |
| alt: event.altKey, | |
| meta: event.metaKey, | |
| originalEvent: event, | |
| preventDefault: eventInfo.preventDefault || eventInfo.defaultPrevented, | |
| userData: tracker.userData | |
| }; | |
| tracker.keyHandler( eventArgs ); | |
| } | |
| if ( ( eventArgs && eventArgs.preventDefault ) || ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onFocus( tracker, event ) { | |
| //$.console.log('focus ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| // focus doesn't bubble and is not cancelable, but we call | |
| // preProcessEvent() so it's dispatched to preProcessEventHandler | |
| // if necessary | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'focus', | |
| pointerType: '', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( tracker.focusHandler && !eventInfo.preventGesture ) { | |
| tracker.focusHandler( | |
| { | |
| eventSource: tracker, | |
| originalEvent: event, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onBlur( tracker, event ) { | |
| //$.console.log('blur ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| // blur doesn't bubble and is not cancelable, but we call | |
| // preProcessEvent() so it's dispatched to preProcessEventHandler | |
| // if necessary | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'blur', | |
| pointerType: '', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( tracker.blurHandler && !eventInfo.preventGesture ) { | |
| tracker.blurHandler( | |
| { | |
| eventSource: tracker, | |
| originalEvent: event, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onContextMenu( tracker, event ) { | |
| //$.console.log('contextmenu ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var eventArgs = null; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'contextmenu', | |
| pointerType: 'mouse', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| // ContextMenu | |
| if ( tracker.contextMenuHandler && !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| eventArgs = { | |
| eventSource: tracker, | |
| position: getPointRelativeToAbsolute( getMouseAbsolute( event ), tracker.element ), | |
| originalEvent: eventInfo.originalEvent, | |
| preventDefault: eventInfo.preventDefault || eventInfo.defaultPrevented, | |
| userData: tracker.userData | |
| }; | |
| tracker.contextMenuHandler( eventArgs ); | |
| } | |
| if ( ( eventArgs && eventArgs.preventDefault ) || ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * Handler for 'wheel' events | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onWheel( tracker, event ) { | |
| handleWheelEvent( tracker, event, event ); | |
| } | |
| /** | |
| * Handler for 'mousewheel', 'DOMMouseScroll', and 'MozMousePixelScroll' events | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onMouseWheel( tracker, event ) { | |
| // Simulate a 'wheel' event | |
| var simulatedEvent = { | |
| target: event.target || event.srcElement, | |
| type: "wheel", | |
| shiftKey: event.shiftKey || false, | |
| clientX: event.clientX, | |
| clientY: event.clientY, | |
| pageX: event.pageX ? event.pageX : event.clientX, | |
| pageY: event.pageY ? event.pageY : event.clientY, | |
| deltaMode: event.type === "MozMousePixelScroll" ? 0 : 1, // 0=pixel, 1=line, 2=page | |
| deltaX: 0, | |
| deltaZ: 0 | |
| }; | |
| // Calculate deltaY | |
| if ( $.MouseTracker.wheelEventName === "mousewheel" ) { | |
| simulatedEvent.deltaY = -event.wheelDelta / $.DEFAULT_SETTINGS.pixelsPerWheelLine; | |
| } else { | |
| simulatedEvent.deltaY = event.detail; | |
| } | |
| handleWheelEvent( tracker, simulatedEvent, event ); | |
| } | |
| /** | |
| * Handles 'wheel' events. | |
| * The event may be simulated by the legacy mouse wheel event handler (onMouseWheel()). | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function handleWheelEvent( tracker, event, originalEvent ) { | |
| var nDelta = 0, | |
| eventInfo; | |
| var eventArgs = null; | |
| // The nDelta variable is gated to provide smooth z-index scrolling | |
| // since the mouse wheel allows for substantial deltas meant for rapid | |
| // y-index scrolling. | |
| // event.deltaMode: 0=pixel, 1=line, 2=page | |
| // TODO: Deltas in pixel mode should be accumulated then a scroll value computed after $.DEFAULT_SETTINGS.pixelsPerWheelLine threshold reached | |
| nDelta = event.deltaY ? (event.deltaY < 0 ? 1 : -1) : 0; | |
| eventInfo = { | |
| originalEvent: event, | |
| eventType: 'wheel', | |
| pointerType: 'mouse', | |
| isEmulated: event !== originalEvent | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( tracker.scrollHandler && !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| eventArgs = { | |
| eventSource: tracker, | |
| pointerType: 'mouse', | |
| position: getMouseRelative( event, tracker.element ), | |
| scroll: nDelta, | |
| shift: event.shiftKey, | |
| isTouchEvent: false, | |
| originalEvent: originalEvent, | |
| preventDefault: eventInfo.preventDefault || eventInfo.defaultPrevented, | |
| userData: tracker.userData | |
| }; | |
| tracker.scrollHandler( eventArgs ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( originalEvent ); | |
| } | |
| if ( ( eventArgs && eventArgs.preventDefault ) || ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) ) { | |
| $.cancelEvent( originalEvent ); | |
| } | |
| } | |
| /** | |
| * TODO Never actually seen this event fired, and documentation is tough to find | |
| * @private | |
| * @inner | |
| */ | |
| function onLoseCapture( tracker, event ) { | |
| //$.console.log('losecapture ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var gPoint = { | |
| id: $.MouseTracker.mousePointerId, | |
| type: 'mouse' | |
| }; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'lostpointercapture', | |
| pointerType: 'mouse', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( event.target === tracker.element ) { | |
| updatePointerCaptured( tracker, gPoint, false ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onTouchStart( tracker, event ) { | |
| var time, | |
| i, | |
| touchCount = event.changedTouches.length, | |
| gPoint, | |
| pointsList = tracker.getActivePointersListByType( 'touch' ); | |
| time = $.now(); | |
| //$.console.log('touchstart ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| if ( pointsList.getLength() > event.touches.length - touchCount ) { | |
| $.console.warn('Tracked touch contact count doesn\'t match event.touches.length'); | |
| } | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerdown', | |
| pointerType: 'touch', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| for ( i = 0; i < touchCount; i++ ) { | |
| gPoint = { | |
| id: event.changedTouches[ i ].identifier, | |
| type: 'touch', | |
| // Simulate isPrimary | |
| isPrimary: pointsList.getLength() === 0, | |
| currentPos: getMouseAbsolute( event.changedTouches[ i ] ), | |
| currentTime: time | |
| }; | |
| // simulate touchenter on our tracked element | |
| updatePointerEnter( tracker, eventInfo, gPoint ); | |
| updatePointerDown( tracker, eventInfo, gPoint, 0 ); | |
| updatePointerCaptured( tracker, gPoint, true ); | |
| } | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onTouchEnd( tracker, event ) { | |
| var time, | |
| i, | |
| touchCount = event.changedTouches.length, | |
| gPoint; | |
| time = $.now(); | |
| //$.console.log('touchend ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerup', | |
| pointerType: 'touch', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| for ( i = 0; i < touchCount; i++ ) { | |
| gPoint = { | |
| id: event.changedTouches[ i ].identifier, | |
| type: 'touch', | |
| currentPos: getMouseAbsolute( event.changedTouches[ i ] ), | |
| currentTime: time | |
| }; | |
| updatePointerUp( tracker, eventInfo, gPoint, 0 ); | |
| updatePointerCaptured( tracker, gPoint, false ); | |
| // simulate touchleave on our tracked element | |
| updatePointerLeave( tracker, eventInfo, gPoint ); | |
| } | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onTouchMove( tracker, event ) { | |
| var time, | |
| i, | |
| touchCount = event.changedTouches.length, | |
| gPoint; | |
| time = $.now(); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointermove', | |
| pointerType: 'touch', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| for ( i = 0; i < touchCount; i++ ) { | |
| gPoint = { | |
| id: event.changedTouches[ i ].identifier, | |
| type: 'touch', | |
| currentPos: getMouseAbsolute( event.changedTouches[ i ] ), | |
| currentTime: time | |
| }; | |
| updatePointerMove( tracker, eventInfo, gPoint ); | |
| } | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onTouchCancel( tracker, event ) { | |
| var touchCount = event.changedTouches.length, | |
| i, | |
| gPoint; | |
| //$.console.log('touchcancel ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointercancel', | |
| pointerType: 'touch', | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| for ( i = 0; i < touchCount; i++ ) { | |
| gPoint = { | |
| id: event.changedTouches[ i ].identifier, | |
| type: 'touch' | |
| }; | |
| //TODO need to only do this if our element is target? | |
| updatePointerCancel( tracker, eventInfo, gPoint ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onGestureStart( tracker, event ) { | |
| if ( !$.eventIsCanceled( event ) ) { | |
| event.preventDefault(); | |
| } | |
| return false; | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onGestureChange( tracker, event ) { | |
| if ( !$.eventIsCanceled( event ) ) { | |
| event.preventDefault(); | |
| } | |
| return false; | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onGotPointerCapture( tracker, event ) { | |
| //$.console.log('gotpointercapture ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'gotpointercapture', | |
| pointerType: getPointerType( event ), | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( event.target === tracker.element ) { | |
| //$.console.log('gotpointercapture ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| updatePointerCaptured( tracker, { | |
| id: event.pointerId, | |
| type: getPointerType( event ) | |
| }, true ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onLostPointerCapture( tracker, event ) { | |
| //$.console.log('lostpointercapture ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'lostpointercapture', | |
| pointerType: getPointerType( event ), | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| if ( event.target === tracker.element ) { | |
| //$.console.log('lostpointercapture ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| updatePointerCaptured( tracker, { | |
| id: event.pointerId, | |
| type: getPointerType( event ) | |
| }, false ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerEnter( tracker, event ) { | |
| //$.console.log('pointerenter ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| var gPoint = { | |
| id: getPointerId( event ), | |
| type: getPointerType( event ), | |
| isPrimary: getIsPrimary( event ), | |
| currentPos: getMouseAbsolute( event ), | |
| currentTime: $.now() | |
| }; | |
| // pointerenter doesn't bubble and is not cancelable, but we call | |
| // preProcessEvent() so it's dispatched to preProcessEventHandler | |
| // if necessary | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerenter', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| updatePointerEnter( tracker, eventInfo, gPoint ); | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerLeave( tracker, event ) { | |
| //$.console.log('pointerleave ' + (tracker.userData ? tracker.userData.toString() : '')); | |
| var gPoint = { | |
| id: getPointerId( event ), | |
| type: getPointerType( event ), | |
| isPrimary: getIsPrimary( event ), | |
| currentPos: getMouseAbsolute( event ), | |
| currentTime: $.now() | |
| }; | |
| // pointerleave doesn't bubble and is not cancelable, but we call | |
| // preProcessEvent() so it's dispatched to preProcessEventHandler | |
| // if necessary | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerleave', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| updatePointerLeave( tracker, eventInfo, gPoint ); | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerOver( tracker, event ) { | |
| //$.console.log('pointerover ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var gPoint = { | |
| id: getPointerId( event ), | |
| type: getPointerType( event ), | |
| isPrimary: getIsPrimary( event ), | |
| currentPos: getMouseAbsolute( event ), | |
| currentTime: $.now() | |
| }; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerover', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| updatePointerOver( tracker, eventInfo, gPoint ); | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerOut( tracker, event ) { | |
| //$.console.log('pointerout ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var gPoint = { | |
| id: getPointerId( event ), | |
| type: getPointerType( event ), | |
| isPrimary: getIsPrimary( event ), | |
| currentPos: getMouseAbsolute( event ), | |
| currentTime: $.now() | |
| }; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerout', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| updatePointerOut( tracker, eventInfo, gPoint ); | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerDown( tracker, event ) { | |
| var gPoint = { | |
| id: getPointerId( event ), | |
| type: getPointerType( event ), | |
| isPrimary: getIsPrimary( event ), | |
| currentPos: getMouseAbsolute( event ), | |
| currentTime: $.now() | |
| }; | |
| // Most browsers implicitly capture touch pointer events | |
| // Note no IE versions (unsupported) have element.hasPointerCapture() so | |
| // no implicit pointer capture possible | |
| // var implicitlyCaptured = ($.MouseTracker.havePointerEvents && | |
| // event.target.hasPointerCapture && | |
| // $.Browser.vendor !== $.BROWSERS.IE) ? | |
| // event.target.hasPointerCapture(event.pointerId) : false; | |
| var implicitlyCaptured = $.MouseTracker.havePointerEvents && | |
| gPoint.type === 'touch'; | |
| //$.console.log('pointerdown ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerdown', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| updatePointerDown( tracker, eventInfo, gPoint, event.button ); | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| if ( eventInfo.shouldCapture ) { | |
| if ( implicitlyCaptured ) { | |
| updatePointerCaptured( tracker, gPoint, true ); | |
| } else { | |
| capturePointer( tracker, gPoint ); | |
| } | |
| } | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerUp( tracker, event ) { | |
| handlePointerUp( tracker, event ); | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * This handler is attached to the window object (on the capture phase) to emulate mouse capture. | |
| * onPointerUp is still attached to the tracked element, so stop propagation to avoid processing twice. | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerUpCaptured( tracker, event ) { | |
| var pointsList = tracker.getActivePointersListByType( getPointerType( event ) ); | |
| if ( pointsList.getById( event.pointerId ) ) { | |
| handlePointerUp( tracker, event ); | |
| } | |
| $.stopEvent( event ); | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function handlePointerUp( tracker, event ) { | |
| var gPoint; | |
| //$.console.log('pointerup ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| gPoint = { | |
| id: getPointerId( event ), | |
| type: getPointerType( event ), | |
| isPrimary: getIsPrimary( event ), | |
| currentPos: getMouseAbsolute( event ), | |
| currentTime: $.now() | |
| }; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointerup', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| updatePointerUp( tracker, eventInfo, gPoint, event.button ); | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| // Per spec, pointerup events are supposed to release capture. Not all browser | |
| // versions have adhered to the spec, and there's no harm in releasing | |
| // explicitly | |
| if ( eventInfo.shouldReleaseCapture ) { | |
| if ( event.target === tracker.element ) { | |
| releasePointer( tracker, gPoint ); | |
| } else { | |
| updatePointerCaptured( tracker, gPoint, false ); | |
| } | |
| } | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerMove( tracker, event ) { | |
| handlePointerMove( tracker, event ); | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * This handler is attached to the window object (on the capture phase) to emulate mouse capture. | |
| * onPointerMove is still attached to the tracked element, so stop propagation to avoid processing twice. | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerMoveCaptured( tracker, event ) { | |
| var pointsList = tracker.getActivePointersListByType( getPointerType( event ) ); | |
| if ( pointsList.getById( event.pointerId ) ) { | |
| handlePointerMove( tracker, event ); | |
| } | |
| $.stopEvent( event ); | |
| } | |
| /** | |
| * Note: Called for both pointer events and legacy mouse events | |
| * ($.MouseTracker.havePointerEvents determines which) | |
| * | |
| * @private | |
| * @inner | |
| */ | |
| function handlePointerMove( tracker, event ) { | |
| // Pointer changed coordinates, button state, pressure, tilt, or contact geometry (e.g. width and height) | |
| var gPoint = { | |
| id: getPointerId( event ), | |
| type: getPointerType( event ), | |
| isPrimary: getIsPrimary( event ), | |
| currentPos: getMouseAbsolute( event ), | |
| currentTime: $.now() | |
| }; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointermove', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| updatePointerMove( tracker, eventInfo, gPoint ); | |
| if ( eventInfo.preventDefault && !eventInfo.defaultPrevented ) { | |
| $.cancelEvent( event ); | |
| } | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function onPointerCancel( tracker, event ) { | |
| //$.console.log('pointercancel ' + (tracker.userData ? tracker.userData.toString() : '') + ' ' + (event.target === tracker.element ? 'tracker.element' : '')); | |
| var gPoint = { | |
| id: event.pointerId, | |
| type: getPointerType( event ) | |
| }; | |
| var eventInfo = { | |
| originalEvent: event, | |
| eventType: 'pointercancel', | |
| pointerType: gPoint.type, | |
| isEmulated: false | |
| }; | |
| preProcessEvent( tracker, eventInfo ); | |
| //TODO need to only do this if our element is target? | |
| updatePointerCancel( tracker, eventInfo, gPoint ); | |
| if ( eventInfo.stopPropagation ) { | |
| $.stopEvent( event ); | |
| } | |
| } | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Device-agnostic DOM event handlers | |
| /////////////////////////////////////////////////////////////////////////////// | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker.GesturePointList} pointsList | |
| * The GesturePointList to track the pointer in. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture point to track. | |
| * @returns {Number} Number of gesture points in pointsList. | |
| */ | |
| function startTrackingPointer( pointsList, gPoint ) { | |
| //$.console.log('startTrackingPointer *** ' + pointsList.type + ' ' + gPoint.id.toString()); | |
| gPoint.speed = 0; | |
| gPoint.direction = 0; | |
| gPoint.contactPos = gPoint.currentPos; | |
| gPoint.contactTime = gPoint.currentTime; | |
| gPoint.lastPos = gPoint.currentPos; | |
| gPoint.lastTime = gPoint.currentTime; | |
| return pointsList.add( gPoint ); | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.GesturePointList} pointsList | |
| * The GesturePointList to stop tracking the pointer on. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture point to stop tracking. | |
| * @returns {Number} Number of gesture points in pointsList. | |
| */ | |
| function stopTrackingPointer( tracker, pointsList, gPoint ) { | |
| //$.console.log('stopTrackingPointer *** ' + pointsList.type + ' ' + gPoint.id.toString()); | |
| var listLength; | |
| var trackedGPoint = pointsList.getById( gPoint.id ); | |
| if ( trackedGPoint ) { | |
| if ( trackedGPoint.captured ) { | |
| $.console.warn('stopTrackingPointer() called on captured pointer'); | |
| releasePointer( tracker, trackedGPoint ); | |
| } | |
| // If child element relinquishes capture to a parent we may get here | |
| // from a pointerleave event while a pointerup event will never be received. | |
| // In that case, we'll clean up the contact count | |
| pointsList.removeContact(); | |
| listLength = pointsList.removeById( gPoint.id ); | |
| } else { | |
| listLength = pointsList.getLength(); | |
| } | |
| return listLength; | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| */ | |
| function getEventProcessDefaults( tracker, eventInfo ) { | |
| switch ( eventInfo.eventType ) { | |
| case 'pointermove': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = true; | |
| eventInfo.preventDefault = false; | |
| eventInfo.preventGesture = !tracker.hasGestureHandlers; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'pointerover': | |
| case 'pointerout': | |
| case 'contextmenu': | |
| case 'keydown': | |
| case 'keyup': | |
| case 'keypress': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = true; | |
| eventInfo.preventDefault = false; // onContextMenu(), onKeyDown(), onKeyUp(), onKeyPress() may set true | |
| eventInfo.preventGesture = false; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'pointerdown': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = true; | |
| eventInfo.preventDefault = false; // updatePointerDown() may set true (tracker.hasGestureHandlers) | |
| eventInfo.preventGesture = !tracker.hasGestureHandlers; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'pointerup': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = true; | |
| eventInfo.preventDefault = false; | |
| eventInfo.preventGesture = !tracker.hasGestureHandlers; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'wheel': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = true; | |
| eventInfo.preventDefault = false; // handleWheelEvent() may set true | |
| eventInfo.preventGesture = !tracker.hasScrollHandler; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'gotpointercapture': | |
| case 'lostpointercapture': | |
| case 'pointercancel': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = false; | |
| eventInfo.preventDefault = false; | |
| eventInfo.preventGesture = false; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'click': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = true; | |
| eventInfo.preventDefault = !!tracker.clickHandler; | |
| eventInfo.preventGesture = false; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'dblclick': | |
| eventInfo.isStoppable = true; | |
| eventInfo.isCancelable = true; | |
| eventInfo.preventDefault = !!tracker.dblClickHandler; | |
| eventInfo.preventGesture = false; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| case 'focus': | |
| case 'blur': | |
| case 'pointerenter': | |
| case 'pointerleave': | |
| default: | |
| eventInfo.isStoppable = false; | |
| eventInfo.isCancelable = false; | |
| eventInfo.preventDefault = false; | |
| eventInfo.preventGesture = false; | |
| eventInfo.stopPropagation = false; | |
| break; | |
| } | |
| } | |
| /** | |
| * Sets up for and calls preProcessEventHandler. Call with the following parameters - | |
| * this function will fill in the rest of the preProcessEventHandler event object | |
| * properties | |
| * | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * @param {Object} eventInfo.originalEvent | |
| * @param {String} eventInfo.eventType | |
| * @param {String} eventInfo.pointerType | |
| * @param {Boolean} eventInfo.isEmulated | |
| */ | |
| function preProcessEvent( tracker, eventInfo ) { | |
| eventInfo.eventSource = tracker; | |
| eventInfo.eventPhase = eventInfo.originalEvent ? | |
| ((typeof eventInfo.originalEvent.eventPhase !== 'undefined') ? | |
| eventInfo.originalEvent.eventPhase : 0) : 0; | |
| eventInfo.defaultPrevented = $.eventIsCanceled( eventInfo.originalEvent ); | |
| eventInfo.shouldCapture = false; | |
| eventInfo.shouldReleaseCapture = false; | |
| eventInfo.userData = tracker.userData; | |
| getEventProcessDefaults( tracker, eventInfo ); | |
| if ( tracker.preProcessEventHandler ) { | |
| tracker.preProcessEventHandler( eventInfo ); | |
| } | |
| } | |
| /** | |
| * Sets or resets the captured property on the tracked pointer matching the passed gPoint's id/type | |
| * | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {Object} gPoint | |
| * An object with id and type properties describing the pointer to update. | |
| * @param {Boolean} isCaptured | |
| * Value to set the captured property to. | |
| */ | |
| function updatePointerCaptured( tracker, gPoint, isCaptured ) { | |
| var pointsList = tracker.getActivePointersListByType( gPoint.type ); | |
| var updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| if ( isCaptured && !updateGPoint.captured ) { | |
| updateGPoint.captured = true; | |
| pointsList.captureCount++; | |
| } else if ( !isCaptured && updateGPoint.captured ) { | |
| updateGPoint.captured = false; | |
| pointsList.captureCount--; | |
| if ( pointsList.captureCount < 0 ) { | |
| pointsList.captureCount = 0; | |
| $.console.warn('updatePointerCaptured() - pointsList.captureCount went negative'); | |
| } | |
| } | |
| } else { | |
| $.console.warn('updatePointerCaptured() called on untracked pointer'); | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture point associated with the event. | |
| */ | |
| function updatePointerEnter( tracker, eventInfo, gPoint ) { | |
| var pointsList = tracker.getActivePointersListByType( gPoint.type ), | |
| updateGPoint; | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| // Already tracking the pointer...update it | |
| updateGPoint.insideElement = true; | |
| updateGPoint.lastPos = updateGPoint.currentPos; | |
| updateGPoint.lastTime = updateGPoint.currentTime; | |
| updateGPoint.currentPos = gPoint.currentPos; | |
| updateGPoint.currentTime = gPoint.currentTime; | |
| gPoint = updateGPoint; | |
| } else { | |
| // Initialize for tracking and add to the tracking list | |
| gPoint.captured = false; // Handled by updatePointerCaptured() | |
| gPoint.insideElementPressed = false; | |
| gPoint.insideElement = true; | |
| startTrackingPointer( pointsList, gPoint ); | |
| } | |
| // Enter (doesn't bubble and not cancelable) | |
| if ( tracker.enterHandler ) { | |
| tracker.enterHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| position: getPointRelativeToAbsolute( gPoint.currentPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| pointers: tracker.getActivePointerCount(), | |
| insideElementPressed: gPoint.insideElementPressed, | |
| buttonDownAny: pointsList.buttons !== 0, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture point associated with the event. | |
| */ | |
| function updatePointerLeave( tracker, eventInfo, gPoint ) { | |
| var pointsList = tracker.getActivePointersListByType(gPoint.type), | |
| updateGPoint, | |
| dispatchEventObj; | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| // Already tracking the pointer. If captured then update it, else stop tracking it | |
| if ( updateGPoint.captured ) { | |
| updateGPoint.insideElement = false; | |
| updateGPoint.lastPos = updateGPoint.currentPos; | |
| updateGPoint.lastTime = updateGPoint.currentTime; | |
| updateGPoint.currentPos = gPoint.currentPos; | |
| updateGPoint.currentTime = gPoint.currentTime; | |
| } else { | |
| stopTrackingPointer( tracker, pointsList, updateGPoint ); | |
| } | |
| gPoint = updateGPoint; | |
| } else { | |
| gPoint.captured = false; // Handled by updatePointerCaptured() | |
| gPoint.insideElementPressed = false; | |
| } | |
| // Leave (doesn't bubble and not cancelable) | |
| // Note: exitHandler is deprecated (v2.5.0), replaced by leaveHandler | |
| if ( tracker.leaveHandler || tracker.exitHandler ) { | |
| dispatchEventObj = { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| // GitHub PR: https://github.com/openseadragon/openseadragon/pull/1754 (gPoint.currentPos && ) | |
| position: gPoint.currentPos && getPointRelativeToAbsolute( gPoint.currentPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| pointers: tracker.getActivePointerCount(), | |
| insideElementPressed: gPoint.insideElementPressed, | |
| buttonDownAny: pointsList.buttons !== 0, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| }; | |
| if ( tracker.leaveHandler ) { | |
| tracker.leaveHandler( dispatchEventObj ); | |
| } | |
| // Deprecated | |
| if ( tracker.exitHandler ) { | |
| tracker.exitHandler( dispatchEventObj ); | |
| } | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture point associated with the event. | |
| */ | |
| function updatePointerOver( tracker, eventInfo, gPoint ) { | |
| var pointsList, | |
| updateGPoint; | |
| pointsList = tracker.getActivePointersListByType( gPoint.type ); | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| gPoint = updateGPoint; | |
| } else { | |
| gPoint.captured = false; | |
| gPoint.insideElementPressed = false; | |
| //gPoint.insideElement = true; // Tracked by updatePointerEnter | |
| } | |
| if ( tracker.overHandler ) { | |
| // Over | |
| tracker.overHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| position: getPointRelativeToAbsolute( gPoint.currentPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| pointers: tracker.getActivePointerCount(), | |
| insideElementPressed: gPoint.insideElementPressed, | |
| buttonDownAny: pointsList.buttons !== 0, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture point associated with the event. | |
| */ | |
| function updatePointerOut( tracker, eventInfo, gPoint ) { | |
| var pointsList, | |
| updateGPoint; | |
| pointsList = tracker.getActivePointersListByType(gPoint.type); | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| gPoint = updateGPoint; | |
| } else { | |
| gPoint.captured = false; | |
| gPoint.insideElementPressed = false; | |
| //gPoint.insideElement = true; // Tracked by updatePointerEnter | |
| } | |
| if ( tracker.outHandler ) { | |
| // Out | |
| tracker.outHandler( { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| position: gPoint.currentPos && getPointRelativeToAbsolute( gPoint.currentPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| pointers: tracker.getActivePointerCount(), | |
| insideElementPressed: gPoint.insideElementPressed, | |
| buttonDownAny: pointsList.buttons !== 0, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } ); | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture point associated with the event. | |
| * @param {Number} buttonChanged | |
| * The button involved in the event: -1: none, 0: primary/left, 1: aux/middle, 2: secondary/right, 3: X1/back, 4: X2/forward, 5: pen eraser. | |
| * Note on chorded button presses (a button pressed when another button is already pressed): In the W3C Pointer Events model, | |
| * only one pointerdown/pointerup event combo is fired. Chorded button state changes instead fire pointermove events. | |
| */ | |
| function updatePointerDown( tracker, eventInfo, gPoint, buttonChanged ) { | |
| var delegate = THIS[ tracker.hash ], | |
| pointsList = tracker.getActivePointersListByType( gPoint.type ), | |
| updateGPoint; | |
| if ( typeof eventInfo.originalEvent.buttons !== 'undefined' ) { | |
| pointsList.buttons = eventInfo.originalEvent.buttons; | |
| } else { | |
| if ( buttonChanged === 0 ) { | |
| // Primary | |
| pointsList.buttons |= 1; | |
| } else if ( buttonChanged === 1 ) { | |
| // Aux | |
| pointsList.buttons |= 4; | |
| } else if ( buttonChanged === 2 ) { | |
| // Secondary | |
| pointsList.buttons |= 2; | |
| } else if ( buttonChanged === 3 ) { | |
| // X1 (Back) | |
| pointsList.buttons |= 8; | |
| } else if ( buttonChanged === 4 ) { | |
| // X2 (Forward) | |
| pointsList.buttons |= 16; | |
| } else if ( buttonChanged === 5 ) { | |
| // Pen Eraser | |
| pointsList.buttons |= 32; | |
| } | |
| } | |
| // Only capture and track primary button, pen, and touch contacts | |
| if ( buttonChanged !== 0 ) { | |
| eventInfo.shouldCapture = false; | |
| eventInfo.shouldReleaseCapture = false; | |
| // Aux Press | |
| if ( tracker.nonPrimaryPressHandler && | |
| !eventInfo.preventGesture && | |
| !eventInfo.defaultPrevented ) { | |
| eventInfo.preventDefault = true; | |
| tracker.nonPrimaryPressHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| position: getPointRelativeToAbsolute( gPoint.currentPos, tracker.element ), | |
| button: buttonChanged, | |
| buttons: pointsList.buttons, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| return; | |
| } | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| // Already tracking the pointer...update it | |
| //updateGPoint.captured = true; // Handled by updatePointerCaptured() | |
| updateGPoint.insideElementPressed = true; | |
| updateGPoint.insideElement = true; | |
| updateGPoint.originalTarget = eventInfo.originalEvent.target; | |
| updateGPoint.contactPos = gPoint.currentPos; | |
| updateGPoint.contactTime = gPoint.currentTime; | |
| updateGPoint.lastPos = updateGPoint.currentPos; | |
| updateGPoint.lastTime = updateGPoint.currentTime; | |
| updateGPoint.currentPos = gPoint.currentPos; | |
| updateGPoint.currentTime = gPoint.currentTime; | |
| gPoint = updateGPoint; | |
| } else { | |
| // Initialize for tracking and add to the tracking list (no pointerenter event occurred before this) | |
| // NOTE: pointerdown event on untracked pointer | |
| gPoint.captured = false; // Handled by updatePointerCaptured() | |
| gPoint.insideElementPressed = true; | |
| gPoint.insideElement = true; | |
| gPoint.originalTarget = eventInfo.originalEvent.target; | |
| startTrackingPointer( pointsList, gPoint ); | |
| } | |
| pointsList.addContact(); | |
| //$.console.log('contacts++ ', pointsList.contacts); | |
| if ( !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| eventInfo.shouldCapture = true; | |
| eventInfo.shouldReleaseCapture = false; | |
| eventInfo.preventDefault = true; | |
| if ( tracker.dragHandler || tracker.dragEndHandler || tracker.pinchHandler ) { | |
| $.MouseTracker.gesturePointVelocityTracker.addPoint( tracker, gPoint ); | |
| } | |
| if ( pointsList.contacts === 1 ) { | |
| // Press | |
| if ( tracker.pressHandler && !eventInfo.preventGesture ) { | |
| tracker.pressHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| position: getPointRelativeToAbsolute( gPoint.contactPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| } else if ( pointsList.contacts === 2 ) { | |
| if ( tracker.pinchHandler && gPoint.type === 'touch' ) { | |
| // Initialize for pinch | |
| delegate.pinchGPoints = pointsList.asArray(); | |
| delegate.lastPinchDist = delegate.currentPinchDist = delegate.pinchGPoints[ 0 ].currentPos.distanceTo( delegate.pinchGPoints[ 1 ].currentPos ); | |
| delegate.lastPinchCenter = delegate.currentPinchCenter = getCenterPoint( delegate.pinchGPoints[ 0 ].currentPos, delegate.pinchGPoints[ 1 ].currentPos ); | |
| } | |
| } | |
| } else { | |
| eventInfo.shouldCapture = false; | |
| eventInfo.shouldReleaseCapture = false; | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture points associated with the event. | |
| * @param {Number} buttonChanged | |
| * The button involved in the event: -1: none, 0: primary/left, 1: aux/middle, 2: secondary/right, 3: X1/back, 4: X2/forward, 5: pen eraser. | |
| * Note on chorded button presses (a button pressed when another button is already pressed): In the W3C Pointer Events model, | |
| * only one pointerdown/pointerup event combo is fired. Chorded button state changes instead fire pointermove events. | |
| */ | |
| function updatePointerUp( tracker, eventInfo, gPoint, buttonChanged ) { | |
| var delegate = THIS[ tracker.hash ], | |
| pointsList = tracker.getActivePointersListByType( gPoint.type ), | |
| releasePoint, | |
| releaseTime, | |
| updateGPoint, | |
| wasCaptured = false, | |
| quick; | |
| if ( typeof eventInfo.originalEvent.buttons !== 'undefined' ) { | |
| pointsList.buttons = eventInfo.originalEvent.buttons; | |
| } else { | |
| if ( buttonChanged === 0 ) { | |
| // Primary | |
| pointsList.buttons ^= ~1; | |
| } else if ( buttonChanged === 1 ) { | |
| // Aux | |
| pointsList.buttons ^= ~4; | |
| } else if ( buttonChanged === 2 ) { | |
| // Secondary | |
| pointsList.buttons ^= ~2; | |
| } else if ( buttonChanged === 3 ) { | |
| // X1 (Back) | |
| pointsList.buttons ^= ~8; | |
| } else if ( buttonChanged === 4 ) { | |
| // X2 (Forward) | |
| pointsList.buttons ^= ~16; | |
| } else if ( buttonChanged === 5 ) { | |
| // Pen Eraser | |
| pointsList.buttons ^= ~32; | |
| } | |
| } | |
| eventInfo.shouldCapture = false; | |
| // Only capture and track primary button, pen, and touch contacts | |
| if ( buttonChanged !== 0 ) { | |
| eventInfo.shouldReleaseCapture = false; | |
| // Aux Release | |
| if ( tracker.nonPrimaryReleaseHandler && | |
| !eventInfo.preventGesture && | |
| !eventInfo.defaultPrevented ) { | |
| eventInfo.preventDefault = true; | |
| tracker.nonPrimaryReleaseHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| position: getPointRelativeToAbsolute(gPoint.currentPos, tracker.element), | |
| button: buttonChanged, | |
| buttons: pointsList.buttons, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| return; | |
| } | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| pointsList.removeContact(); | |
| //$.console.log('contacts-- ', pointsList.contacts); | |
| // Update the pointer, stop tracking it if not still in this element | |
| if ( updateGPoint.captured ) { | |
| //updateGPoint.captured = false; // Handled by updatePointerCaptured() | |
| wasCaptured = true; | |
| } | |
| updateGPoint.lastPos = updateGPoint.currentPos; | |
| updateGPoint.lastTime = updateGPoint.currentTime; | |
| updateGPoint.currentPos = gPoint.currentPos; | |
| updateGPoint.currentTime = gPoint.currentTime; | |
| if ( !updateGPoint.insideElement ) { | |
| stopTrackingPointer( tracker, pointsList, updateGPoint ); | |
| } | |
| releasePoint = updateGPoint.currentPos; | |
| releaseTime = updateGPoint.currentTime; | |
| } else { | |
| // NOTE: updatePointerUp(): pointerup on untracked gPoint | |
| // ...we'll start to track pointer again | |
| gPoint.captured = false; // Handled by updatePointerCaptured() | |
| gPoint.insideElementPressed = false; | |
| gPoint.insideElement = true; | |
| startTrackingPointer( pointsList, gPoint ); | |
| updateGPoint = gPoint; | |
| } | |
| if ( !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| if ( wasCaptured ) { | |
| // Pointer was activated in our element but could have been removed in any element since events are captured to our element | |
| eventInfo.shouldReleaseCapture = true; | |
| eventInfo.preventDefault = true; | |
| if ( tracker.dragHandler || tracker.dragEndHandler || tracker.pinchHandler ) { | |
| $.MouseTracker.gesturePointVelocityTracker.removePoint( tracker, updateGPoint ); | |
| } | |
| if ( pointsList.contacts === 0 ) { | |
| // Release (pressed in our element) | |
| if ( tracker.releaseHandler && releasePoint ) { | |
| tracker.releaseHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: updateGPoint.type, | |
| position: getPointRelativeToAbsolute( releasePoint, tracker.element ), | |
| buttons: pointsList.buttons, | |
| insideElementPressed: updateGPoint.insideElementPressed, | |
| insideElementReleased: updateGPoint.insideElement, | |
| isTouchEvent: updateGPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| // Drag End | |
| if ( tracker.dragEndHandler && delegate.sentDragEvent ) { | |
| tracker.dragEndHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: updateGPoint.type, | |
| position: getPointRelativeToAbsolute( updateGPoint.currentPos, tracker.element ), | |
| speed: updateGPoint.speed, | |
| direction: updateGPoint.direction, | |
| shift: eventInfo.originalEvent.shiftKey, | |
| isTouchEvent: updateGPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| // We want to clear this flag regardless of whether we fired the dragEndHandler | |
| delegate.sentDragEvent = false; | |
| // Click / Double-Click | |
| if ( ( tracker.clickHandler || tracker.dblClickHandler ) && updateGPoint.insideElement ) { | |
| quick = releaseTime - updateGPoint.contactTime <= tracker.clickTimeThreshold && | |
| updateGPoint.contactPos.distanceTo( releasePoint ) <= tracker.clickDistThreshold; | |
| // Click | |
| if ( tracker.clickHandler ) { | |
| tracker.clickHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: updateGPoint.type, | |
| position: getPointRelativeToAbsolute( updateGPoint.currentPos, tracker.element ), | |
| quick: quick, | |
| shift: eventInfo.originalEvent.shiftKey, | |
| isTouchEvent: updateGPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| originalTarget: updateGPoint.originalTarget, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| // Double-Click | |
| if ( tracker.dblClickHandler && quick ) { | |
| pointsList.clicks++; | |
| if ( pointsList.clicks === 1 ) { | |
| delegate.lastClickPos = releasePoint; | |
| /*jshint loopfunc:true*/ | |
| delegate.dblClickTimeOut = setTimeout( function() { | |
| pointsList.clicks = 0; | |
| }, tracker.dblClickTimeThreshold ); | |
| /*jshint loopfunc:false*/ | |
| } else if ( pointsList.clicks === 2 ) { | |
| clearTimeout( delegate.dblClickTimeOut ); | |
| pointsList.clicks = 0; | |
| if ( delegate.lastClickPos.distanceTo( releasePoint ) <= tracker.dblClickDistThreshold ) { | |
| tracker.dblClickHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: updateGPoint.type, | |
| position: getPointRelativeToAbsolute( updateGPoint.currentPos, tracker.element ), | |
| shift: eventInfo.originalEvent.shiftKey, | |
| isTouchEvent: updateGPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| delegate.lastClickPos = null; | |
| } | |
| } | |
| } | |
| } else if ( pointsList.contacts === 2 ) { | |
| if ( tracker.pinchHandler && updateGPoint.type === 'touch' ) { | |
| // Reset for pinch | |
| delegate.pinchGPoints = pointsList.asArray(); | |
| delegate.lastPinchDist = delegate.currentPinchDist = delegate.pinchGPoints[ 0 ].currentPos.distanceTo( delegate.pinchGPoints[ 1 ].currentPos ); | |
| delegate.lastPinchCenter = delegate.currentPinchCenter = getCenterPoint( delegate.pinchGPoints[ 0 ].currentPos, delegate.pinchGPoints[ 1 ].currentPos ); | |
| } | |
| } | |
| } else { | |
| // Pointer was activated in another element but removed in our element | |
| eventInfo.shouldReleaseCapture = false; | |
| // Release (pressed in another element) | |
| if ( tracker.releaseHandler && releasePoint ) { | |
| tracker.releaseHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: updateGPoint.type, | |
| position: getPointRelativeToAbsolute( releasePoint, tracker.element ), | |
| buttons: pointsList.buttons, | |
| insideElementPressed: updateGPoint.insideElementPressed, | |
| insideElementReleased: updateGPoint.insideElement, | |
| isTouchEvent: updateGPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| eventInfo.preventDefault = true; | |
| } | |
| } | |
| } | |
| } | |
| /** | |
| * Call when pointer(s) change coordinates, button state, pressure, tilt, or contact geometry (e.g. width and height) | |
| * | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture points associated with the event. | |
| */ | |
| function updatePointerMove( tracker, eventInfo, gPoint ) { | |
| var delegate = THIS[ tracker.hash ], | |
| pointsList = tracker.getActivePointersListByType( gPoint.type ), | |
| updateGPoint, | |
| gPointArray, | |
| delta; | |
| if ( typeof eventInfo.originalEvent.buttons !== 'undefined' ) { | |
| pointsList.buttons = eventInfo.originalEvent.buttons; | |
| } | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| // Already tracking the pointer...update it | |
| updateGPoint.lastPos = updateGPoint.currentPos; | |
| updateGPoint.lastTime = updateGPoint.currentTime; | |
| updateGPoint.currentPos = gPoint.currentPos; | |
| updateGPoint.currentTime = gPoint.currentTime; | |
| } else { | |
| // Should never get here, but due to user agent bugs (e.g. legacy touch) it sometimes happens | |
| return; | |
| } | |
| eventInfo.shouldCapture = false; | |
| eventInfo.shouldReleaseCapture = false; | |
| // Stop (mouse only) | |
| if ( tracker.stopHandler && gPoint.type === 'mouse' ) { | |
| clearTimeout( tracker.stopTimeOut ); | |
| tracker.stopTimeOut = setTimeout( function() { | |
| handlePointerStop( tracker, eventInfo.originalEvent, gPoint.type ); | |
| }, tracker.stopDelay ); | |
| } | |
| if ( pointsList.contacts === 0 ) { | |
| // Move (no contacts: hovering mouse or other hover-capable device) | |
| if ( tracker.moveHandler ) { | |
| tracker.moveHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: gPoint.type, | |
| position: getPointRelativeToAbsolute( gPoint.currentPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| isTouchEvent: gPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| } else if ( pointsList.contacts === 1 ) { | |
| // Move (1 contact) | |
| if ( tracker.moveHandler ) { | |
| updateGPoint = pointsList.asArray()[ 0 ]; | |
| tracker.moveHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: updateGPoint.type, | |
| position: getPointRelativeToAbsolute( updateGPoint.currentPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| isTouchEvent: updateGPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| // Drag | |
| if ( tracker.dragHandler && !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| updateGPoint = pointsList.asArray()[ 0 ]; | |
| delta = updateGPoint.currentPos.minus( updateGPoint.lastPos ); | |
| tracker.dragHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: updateGPoint.type, | |
| position: getPointRelativeToAbsolute( updateGPoint.currentPos, tracker.element ), | |
| buttons: pointsList.buttons, | |
| delta: delta, | |
| speed: updateGPoint.speed, | |
| direction: updateGPoint.direction, | |
| shift: eventInfo.originalEvent.shiftKey, | |
| isTouchEvent: updateGPoint.type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| eventInfo.preventDefault = true; | |
| delegate.sentDragEvent = true; | |
| } | |
| } else if ( pointsList.contacts === 2 ) { | |
| // Move (2 contacts, use center) | |
| if ( tracker.moveHandler ) { | |
| gPointArray = pointsList.asArray(); | |
| tracker.moveHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: gPointArray[ 0 ].type, | |
| position: getPointRelativeToAbsolute( getCenterPoint( gPointArray[ 0 ].currentPos, gPointArray[ 1 ].currentPos ), tracker.element ), | |
| buttons: pointsList.buttons, | |
| isTouchEvent: gPointArray[ 0 ].type === 'touch', | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| } | |
| // Pinch | |
| if ( tracker.pinchHandler && gPoint.type === 'touch' && | |
| !eventInfo.preventGesture && !eventInfo.defaultPrevented ) { | |
| delta = delegate.pinchGPoints[ 0 ].currentPos.distanceTo( delegate.pinchGPoints[ 1 ].currentPos ); | |
| if ( delta !== delegate.currentPinchDist ) { | |
| delegate.lastPinchDist = delegate.currentPinchDist; | |
| delegate.currentPinchDist = delta; | |
| delegate.lastPinchCenter = delegate.currentPinchCenter; | |
| delegate.currentPinchCenter = getCenterPoint( delegate.pinchGPoints[ 0 ].currentPos, delegate.pinchGPoints[ 1 ].currentPos ); | |
| tracker.pinchHandler( | |
| { | |
| eventSource: tracker, | |
| pointerType: 'touch', | |
| gesturePoints: delegate.pinchGPoints, | |
| lastCenter: getPointRelativeToAbsolute( delegate.lastPinchCenter, tracker.element ), | |
| center: getPointRelativeToAbsolute( delegate.currentPinchCenter, tracker.element ), | |
| lastDistance: delegate.lastPinchDist, | |
| distance: delegate.currentPinchDist, | |
| shift: eventInfo.originalEvent.shiftKey, | |
| originalEvent: eventInfo.originalEvent, | |
| userData: tracker.userData | |
| } | |
| ); | |
| eventInfo.preventDefault = true; | |
| } | |
| } | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| * @param {OpenSeadragon.MouseTracker} tracker | |
| * A reference to the MouseTracker instance. | |
| * @param {OpenSeadragon.MouseTracker.EventProcessInfo} eventInfo | |
| * Processing info for originating DOM event. | |
| * @param {OpenSeadragon.MouseTracker.GesturePoint} gPoint | |
| * Gesture points associated with the event. | |
| */ | |
| function updatePointerCancel( tracker, eventInfo, gPoint ) { | |
| var pointsList = tracker.getActivePointersListByType( gPoint.type ), | |
| updateGPoint; | |
| updateGPoint = pointsList.getById( gPoint.id ); | |
| if ( updateGPoint ) { | |
| stopTrackingPointer( tracker, pointsList, updateGPoint ); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| */ | |
| function handlePointerStop( tracker, originalMoveEvent, pointerType ) { | |
| if ( tracker.stopHandler ) { | |
| tracker.stopHandler( { | |
| eventSource: tracker, | |
| pointerType: pointerType, | |
| position: getMouseRelative( originalMoveEvent, tracker.element ), | |
| buttons: tracker.getActivePointersListByType( pointerType ).buttons, | |
| isTouchEvent: pointerType === 'touch', | |
| originalEvent: originalMoveEvent, | |
| userData: tracker.userData | |
| } ); | |
| } | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @inner | |
| */ | |
| function uniqueHash( ) { | |
| let uniqueId = Date.now().toString(36) + Math.random().toString(36).substring(2); | |
| while (uniqueId in THIS) { | |
| // rehash when not unique | |
| uniqueId = Date.now().toString(36) + Math.random().toString(36).substring(2); | |
| } | |
| return uniqueId; | |
| } | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - Control | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * An enumeration of supported locations where controls can be anchored. | |
| * The anchoring is always relative to the container. | |
| * @member ControlAnchor | |
| * @memberof OpenSeadragon | |
| * @static | |
| * @type {Object} | |
| * @property {Number} NONE | |
| * @property {Number} TOP_LEFT | |
| * @property {Number} TOP_RIGHT | |
| * @property {Number} BOTTOM_LEFT | |
| * @property {Number} BOTTOM_RIGHT | |
| * @property {Number} ABSOLUTE | |
| */ | |
| $.ControlAnchor = { | |
| NONE: 0, | |
| TOP_LEFT: 1, | |
| TOP_RIGHT: 2, | |
| BOTTOM_RIGHT: 3, | |
| BOTTOM_LEFT: 4, | |
| ABSOLUTE: 5 | |
| }; | |
| /** | |
| * @class Control | |
| * @classdesc A Control represents any interface element which is meant to allow the user | |
| * to interact with the zoomable interface. Any control can be anchored to any | |
| * element. | |
| * | |
| * @memberof OpenSeadragon | |
| * @param {Element} element - the control element to be anchored in the container. | |
| * @param {Object } options - All required and optional settings for configuring a control element. | |
| * @param {OpenSeadragon.ControlAnchor} [options.anchor=OpenSeadragon.ControlAnchor.NONE] - the position of the control | |
| * relative to the container. | |
| * @param {Boolean} [options.attachToViewer=true] - Whether the control should be added directly to the viewer, or | |
| * directly to the container | |
| * @param {Boolean} [options.autoFade=true] - Whether the control should have the autofade behavior | |
| * @param {Element} container - the element to control will be anchored too. | |
| */ | |
| $.Control = function ( element, options, container ) { | |
| var parent = element.parentNode; | |
| if (typeof options === 'number') | |
| { | |
| $.console.error("Passing an anchor directly into the OpenSeadragon.Control constructor is deprecated; " + | |
| "please use an options object instead. " + | |
| "Support for this deprecated variant is scheduled for removal in December 2013"); | |
| options = {anchor: options}; | |
| } | |
| options.attachToViewer = (typeof options.attachToViewer === 'undefined') ? true : options.attachToViewer; | |
| /** | |
| * True if the control should have autofade behavior. | |
| * @member {Boolean} autoFade | |
| * @memberof OpenSeadragon.Control# | |
| */ | |
| this.autoFade = (typeof options.autoFade === 'undefined') ? true : options.autoFade; | |
| /** | |
| * The element providing the user interface with some type of control (e.g. a zoom-in button). | |
| * @member {Element} element | |
| * @memberof OpenSeadragon.Control# | |
| */ | |
| this.element = element; | |
| /** | |
| * The position of the Control relative to its container. | |
| * @member {OpenSeadragon.ControlAnchor} anchor | |
| * @memberof OpenSeadragon.Control# | |
| */ | |
| this.anchor = options.anchor; | |
| /** | |
| * The Control's containing element. | |
| * @member {Element} container | |
| * @memberof OpenSeadragon.Control# | |
| */ | |
| this.container = container; | |
| /** | |
| * A neutral element surrounding the control element. | |
| * @member {Element} wrapper | |
| * @memberof OpenSeadragon.Control# | |
| */ | |
| if ( this.anchor === $.ControlAnchor.ABSOLUTE ) { | |
| this.wrapper = $.makeNeutralElement( "div" ); | |
| this.wrapper.style.position = "absolute"; | |
| this.wrapper.style.top = typeof (options.top) === "number" ? (options.top + 'px') : options.top; | |
| this.wrapper.style.left = typeof (options.left) === "number" ? (options.left + 'px') : options.left; | |
| this.wrapper.style.height = typeof (options.height) === "number" ? (options.height + 'px') : options.height; | |
| this.wrapper.style.width = typeof (options.width) === "number" ? (options.width + 'px') : options.width; | |
| this.wrapper.style.margin = "0px"; | |
| this.wrapper.style.padding = "0px"; | |
| this.element.style.position = "relative"; | |
| this.element.style.top = "0px"; | |
| this.element.style.left = "0px"; | |
| this.element.style.height = "100%"; | |
| this.element.style.width = "100%"; | |
| } else { | |
| this.wrapper = $.makeNeutralElement( "div" ); | |
| this.wrapper.style.display = "inline-block"; | |
| if ( this.anchor === $.ControlAnchor.NONE ) { | |
| // IE6 fix | |
| this.wrapper.style.width = this.wrapper.style.height = "100%"; | |
| } | |
| } | |
| this.wrapper.appendChild( this.element ); | |
| if (options.attachToViewer ) { | |
| if ( this.anchor === $.ControlAnchor.TOP_RIGHT || | |
| this.anchor === $.ControlAnchor.BOTTOM_RIGHT ) { | |
| this.container.insertBefore( | |
| this.wrapper, | |
| this.container.firstChild | |
| ); | |
| } else { | |
| this.container.appendChild( this.wrapper ); | |
| } | |
| } else { | |
| parent.appendChild( this.wrapper ); | |
| } | |
| }; | |
| /** @lends OpenSeadragon.Control.prototype */ | |
| $.Control.prototype = { | |
| /** | |
| * Removes the control from the container. | |
| * @function | |
| */ | |
| destroy: function() { | |
| this.wrapper.removeChild( this.element ); | |
| if (this.anchor !== $.ControlAnchor.NONE) { | |
| this.container.removeChild(this.wrapper); | |
| } | |
| }, | |
| /** | |
| * Determines if the control is currently visible. | |
| * @function | |
| * @returns {Boolean} true if currently visible, false otherwise. | |
| */ | |
| isVisible: function() { | |
| return this.wrapper.style.display !== "none"; | |
| }, | |
| /** | |
| * Toggles the visibility of the control. | |
| * @function | |
| * @param {Boolean} visible - true to make visible, false to hide. | |
| */ | |
| setVisible: function( visible ) { | |
| this.wrapper.style.display = visible ? | |
| ( this.anchor === $.ControlAnchor.ABSOLUTE ? 'block' : 'inline-block' ) : | |
| "none"; | |
| }, | |
| /** | |
| * Sets the opacity level for the control. | |
| * @function | |
| * @param {Number} opactiy - a value between 1 and 0 inclusively. | |
| */ | |
| setOpacity: function( opacity ) { | |
| $.setElementOpacity( this.wrapper, opacity, true ); | |
| } | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - ControlDock | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class ControlDock | |
| * @classdesc Provides a container element (a <form> element) with support for the layout of control elements. | |
| * | |
| * @memberof OpenSeadragon | |
| */ | |
| $.ControlDock = function( options ){ | |
| var layouts = [ 'topleft', 'topright', 'bottomright', 'bottomleft'], | |
| layout, | |
| i; | |
| $.extend( true, this, { | |
| id: 'controldock-' + $.now() + '-' + Math.floor(Math.random() * 1000000), | |
| container: $.makeNeutralElement( 'div' ), | |
| controls: [] | |
| }, options ); | |
| // Disable the form's submit; otherwise button clicks and return keys | |
| // can trigger it. | |
| this.container.onsubmit = function() { | |
| return false; | |
| }; | |
| if( this.element ){ | |
| this.element = $.getElement( this.element ); | |
| this.element.appendChild( this.container ); | |
| if( $.getElementStyle(this.element).position === 'static' ){ | |
| this.element.style.position = 'relative'; | |
| } | |
| this.container.style.width = '100%'; | |
| this.container.style.height = '100%'; | |
| } | |
| for( i = 0; i < layouts.length; i++ ){ | |
| layout = layouts[ i ]; | |
| this.controls[ layout ] = $.makeNeutralElement( "div" ); | |
| this.controls[ layout ].style.position = 'absolute'; | |
| if ( layout.match( 'left' ) ){ | |
| this.controls[ layout ].style.left = '0px'; | |
| } | |
| if ( layout.match( 'right' ) ){ | |
| this.controls[ layout ].style.right = '0px'; | |
| } | |
| if ( layout.match( 'top' ) ){ | |
| this.controls[ layout ].style.top = '0px'; | |
| } | |
| if ( layout.match( 'bottom' ) ){ | |
| this.controls[ layout ].style.bottom = '0px'; | |
| } | |
| } | |
| this.container.appendChild( this.controls.topleft ); | |
| this.container.appendChild( this.controls.topright ); | |
| this.container.appendChild( this.controls.bottomright ); | |
| this.container.appendChild( this.controls.bottomleft ); | |
| }; | |
| /** @lends OpenSeadragon.ControlDock.prototype */ | |
| $.ControlDock.prototype = { | |
| /** | |
| * @function | |
| */ | |
| addControl: function ( element, controlOptions ) { | |
| element = $.getElement( element ); | |
| var div = null; | |
| if ( getControlIndex( this, element ) >= 0 ) { | |
| return; // they're trying to add a duplicate control | |
| } | |
| switch ( controlOptions.anchor ) { | |
| case $.ControlAnchor.TOP_RIGHT: | |
| div = this.controls.topright; | |
| element.style.position = "relative"; | |
| element.style.paddingRight = "0px"; | |
| element.style.paddingTop = "0px"; | |
| break; | |
| case $.ControlAnchor.BOTTOM_RIGHT: | |
| div = this.controls.bottomright; | |
| element.style.position = "relative"; | |
| element.style.paddingRight = "0px"; | |
| element.style.paddingBottom = "0px"; | |
| break; | |
| case $.ControlAnchor.BOTTOM_LEFT: | |
| div = this.controls.bottomleft; | |
| element.style.position = "relative"; | |
| element.style.paddingLeft = "0px"; | |
| element.style.paddingBottom = "0px"; | |
| break; | |
| case $.ControlAnchor.TOP_LEFT: | |
| div = this.controls.topleft; | |
| element.style.position = "relative"; | |
| element.style.paddingLeft = "0px"; | |
| element.style.paddingTop = "0px"; | |
| break; | |
| case $.ControlAnchor.ABSOLUTE: | |
| div = this.container; | |
| element.style.margin = "0px"; | |
| element.style.padding = "0px"; | |
| break; | |
| default: | |
| case $.ControlAnchor.NONE: | |
| div = this.container; | |
| element.style.margin = "0px"; | |
| element.style.padding = "0px"; | |
| break; | |
| } | |
| this.controls.push( | |
| new $.Control( element, controlOptions, div ) | |
| ); | |
| element.style.display = "inline-block"; | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.ControlDock} Chainable. | |
| */ | |
| removeControl: function ( element ) { | |
| element = $.getElement( element ); | |
| var i = getControlIndex( this, element ); | |
| if ( i >= 0 ) { | |
| this.controls[ i ].destroy(); | |
| this.controls.splice( i, 1 ); | |
| } | |
| return this; | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.ControlDock} Chainable. | |
| */ | |
| clearControls: function () { | |
| while ( this.controls.length > 0 ) { | |
| this.controls.pop().destroy(); | |
| } | |
| return this; | |
| }, | |
| /** | |
| * @function | |
| * @returns {Boolean} | |
| */ | |
| areControlsEnabled: function () { | |
| var i; | |
| for ( i = this.controls.length - 1; i >= 0; i-- ) { | |
| if ( this.controls[ i ].isVisible() ) { | |
| return true; | |
| } | |
| } | |
| return false; | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.ControlDock} Chainable. | |
| */ | |
| setControlsEnabled: function( enabled ) { | |
| var i; | |
| for ( i = this.controls.length - 1; i >= 0; i-- ) { | |
| this.controls[ i ].setVisible( enabled ); | |
| } | |
| return this; | |
| } | |
| }; | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Utility methods | |
| /////////////////////////////////////////////////////////////////////////////// | |
| function getControlIndex( dock, element ) { | |
| var controls = dock.controls, | |
| i; | |
| for ( i = controls.length - 1; i >= 0; i-- ) { | |
| if ( controls[ i ].element === element ) { | |
| return i; | |
| } | |
| } | |
| return -1; | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - Placement | |
| * | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function($) { | |
| /** | |
| * An enumeration of positions to anchor an element. | |
| * @member Placement | |
| * @memberOf OpenSeadragon | |
| * @static | |
| * @readonly | |
| * @property {OpenSeadragon.Placement} CENTER | |
| * @property {OpenSeadragon.Placement} TOP_LEFT | |
| * @property {OpenSeadragon.Placement} TOP | |
| * @property {OpenSeadragon.Placement} TOP_RIGHT | |
| * @property {OpenSeadragon.Placement} RIGHT | |
| * @property {OpenSeadragon.Placement} BOTTOM_RIGHT | |
| * @property {OpenSeadragon.Placement} BOTTOM | |
| * @property {OpenSeadragon.Placement} BOTTOM_LEFT | |
| * @property {OpenSeadragon.Placement} LEFT | |
| */ | |
| $.Placement = $.freezeObject({ | |
| CENTER: 0, | |
| TOP_LEFT: 1, | |
| TOP: 2, | |
| TOP_RIGHT: 3, | |
| RIGHT: 4, | |
| BOTTOM_RIGHT: 5, | |
| BOTTOM: 6, | |
| BOTTOM_LEFT: 7, | |
| LEFT: 8, | |
| properties: { | |
| 0: { | |
| isLeft: false, | |
| isHorizontallyCentered: true, | |
| isRight: false, | |
| isTop: false, | |
| isVerticallyCentered: true, | |
| isBottom: false | |
| }, | |
| 1: { | |
| isLeft: true, | |
| isHorizontallyCentered: false, | |
| isRight: false, | |
| isTop: true, | |
| isVerticallyCentered: false, | |
| isBottom: false | |
| }, | |
| 2: { | |
| isLeft: false, | |
| isHorizontallyCentered: true, | |
| isRight: false, | |
| isTop: true, | |
| isVerticallyCentered: false, | |
| isBottom: false | |
| }, | |
| 3: { | |
| isLeft: false, | |
| isHorizontallyCentered: false, | |
| isRight: true, | |
| isTop: true, | |
| isVerticallyCentered: false, | |
| isBottom: false | |
| }, | |
| 4: { | |
| isLeft: false, | |
| isHorizontallyCentered: false, | |
| isRight: true, | |
| isTop: false, | |
| isVerticallyCentered: true, | |
| isBottom: false | |
| }, | |
| 5: { | |
| isLeft: false, | |
| isHorizontallyCentered: false, | |
| isRight: true, | |
| isTop: false, | |
| isVerticallyCentered: false, | |
| isBottom: true | |
| }, | |
| 6: { | |
| isLeft: false, | |
| isHorizontallyCentered: true, | |
| isRight: false, | |
| isTop: false, | |
| isVerticallyCentered: false, | |
| isBottom: true | |
| }, | |
| 7: { | |
| isLeft: true, | |
| isHorizontallyCentered: false, | |
| isRight: false, | |
| isTop: false, | |
| isVerticallyCentered: false, | |
| isBottom: true | |
| }, | |
| 8: { | |
| isLeft: true, | |
| isHorizontallyCentered: false, | |
| isRight: false, | |
| isTop: false, | |
| isVerticallyCentered: true, | |
| isBottom: false | |
| } | |
| } | |
| }); | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - Viewer | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| // dictionary from hash to private properties | |
| var THIS = {}; | |
| var nextHash = 1; | |
| /** | |
| * | |
| * The main point of entry into creating a zoomable image on the page.<br> | |
| * <br> | |
| * We have provided an idiomatic javascript constructor which takes | |
| * a single object, but still support the legacy positional arguments.<br> | |
| * <br> | |
| * The options below are given in order that they appeared in the constructor | |
| * as arguments and we translate a positional call into an idiomatic call.<br> | |
| * <br> | |
| * To create a viewer, you can use either of this methods:<br> | |
| * <ul> | |
| * <li><code>var viewer = new OpenSeadragon.Viewer(options);</code></li> | |
| * <li><code>var viewer = OpenSeadragon(options);</code></li> | |
| * </ul> | |
| * @class Viewer | |
| * @classdesc The main OpenSeadragon viewer class. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.EventSource | |
| * @extends OpenSeadragon.ControlDock | |
| * @param {OpenSeadragon.Options} options - Viewer options. | |
| * | |
| **/ | |
| $.Viewer = function( options ) { | |
| var args = arguments, | |
| _this = this, | |
| i; | |
| //backward compatibility for positional args while preferring more | |
| //idiomatic javascript options object as the only argument | |
| if( !$.isPlainObject( options ) ){ | |
| options = { | |
| id: args[ 0 ], | |
| xmlPath: args.length > 1 ? args[ 1 ] : undefined, | |
| prefixUrl: args.length > 2 ? args[ 2 ] : undefined, | |
| controls: args.length > 3 ? args[ 3 ] : undefined, | |
| overlays: args.length > 4 ? args[ 4 ] : undefined | |
| }; | |
| } | |
| //options.config and the general config argument are deprecated | |
| //in favor of the more direct specification of optional settings | |
| //being pass directly on the options object | |
| if ( options.config ){ | |
| $.extend( true, options, options.config ); | |
| delete options.config; | |
| } | |
| // Move deprecated drawer options from the base options object into a sub-object | |
| // This is an array to make it easy to add additional properties to convert to | |
| // drawer options later if it makes sense to set at the drawer level rather than | |
| // per tiled image (for example, subPixelRoundingForTransparency). | |
| let drawerOptionList = [ | |
| 'useCanvas', // deprecated | |
| ]; | |
| options.drawerOptions = Object.assign({}, | |
| drawerOptionList.reduce((drawerOptions, option) => { | |
| drawerOptions[option] = options[option]; | |
| delete options[option]; | |
| return drawerOptions; | |
| }, {}), | |
| options.drawerOptions); | |
| //Public properties | |
| //Allow the options object to override global defaults | |
| $.extend( true, this, { | |
| //internal state and dom identifiers | |
| id: options.id, | |
| hash: options.hash || nextHash++, | |
| /** | |
| * Index for page to be shown first next time open() is called (only used in sequenceMode). | |
| * @member {Number} initialPage | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| initialPage: 0, | |
| //dom nodes | |
| /** | |
| * The parent element of this Viewer instance, passed in when the Viewer was created. | |
| * @member {Element} element | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| element: null, | |
| /** | |
| * A <div> element (provided by {@link OpenSeadragon.ControlDock}), the base element of this Viewer instance.<br><br> | |
| * Child element of {@link OpenSeadragon.Viewer#element}. | |
| * @member {Element} container | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| container: null, | |
| /** | |
| * A <div> element, the element where user-input events are handled for panning and zooming.<br><br> | |
| * Child element of {@link OpenSeadragon.Viewer#container}, | |
| * positioned on top of {@link OpenSeadragon.Viewer#keyboardCommandArea}.<br><br> | |
| * The parent of {@link OpenSeadragon.Drawer#canvas} instances. | |
| * @member {Element} canvas | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| canvas: null, | |
| // Overlays list. An overlay allows to add html on top of the viewer. | |
| overlays: [], | |
| // Container inside the canvas where overlays are drawn. | |
| overlaysContainer: null, | |
| //private state properties | |
| previousBody: [], | |
| //This was originally initialized in the constructor and so could never | |
| //have anything in it. now it can because we allow it to be specified | |
| //in the options and is only empty by default if not specified. Also | |
| //this array was returned from get_controls which I find confusing | |
| //since this object has a controls property which is treated in other | |
| //functions like clearControls. I'm removing the accessors. | |
| customControls: [], | |
| //These are originally not part options but declared as members | |
| //in initialize. It's still considered idiomatic to put them here | |
| //source is here for backwards compatibility. It is not an official | |
| //part of the API and should not be relied upon. | |
| source: null, | |
| /** | |
| * Handles rendering of tiles in the viewer. Created for each TileSource opened. | |
| * @member {OpenSeadragon.Drawer} drawer | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| drawer: null, | |
| /** | |
| * Keeps track of all of the tiled images in the scene. | |
| * @member {OpenSeadragon.World} world | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| world: null, | |
| /** | |
| * Handles coordinate-related functionality - zoom, pan, rotation, etc. Created for each TileSource opened. | |
| * @member {OpenSeadragon.Viewport} viewport | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| viewport: null, | |
| /** | |
| * @member {OpenSeadragon.Navigator} navigator | |
| * @memberof OpenSeadragon.Viewer# | |
| */ | |
| navigator: null, | |
| //A collection viewport is a separate viewport used to provide | |
| //simultaneous rendering of sets of tiles | |
| collectionViewport: null, | |
| collectionDrawer: null, | |
| //UI image resources | |
| //TODO: rename navImages to uiImages | |
| navImages: null, | |
| //interface button controls | |
| buttonGroup: null, | |
| //TODO: this is defunct so safely remove it | |
| profiler: null | |
| }, $.DEFAULT_SETTINGS, options ); | |
| if ( typeof ( this.hash) === "undefined" ) { | |
| throw new Error("A hash must be defined, either by specifying options.id or options.hash."); | |
| } | |
| if ( typeof ( THIS[ this.hash ] ) !== "undefined" ) { | |
| // We don't want to throw an error here, as the user might have discarded | |
| // the previous viewer with the same hash and now want to recreate it. | |
| $.console.warn("Hash " + this.hash + " has already been used."); | |
| } | |
| //Private state properties | |
| THIS[ this.hash ] = { | |
| fsBoundsDelta: new $.Point( 1, 1 ), | |
| prevContainerSize: null, | |
| animating: false, | |
| forceRedraw: false, | |
| needsResize: false, | |
| forceResize: false, | |
| mouseInside: false, | |
| group: null, | |
| // whether we should be continuously zooming | |
| zooming: false, | |
| // how much we should be continuously zooming by | |
| zoomFactor: null, | |
| lastZoomTime: null, | |
| fullPage: false, | |
| onfullscreenchange: null, | |
| lastClickTime: null, | |
| draggingToZoom: false, | |
| }; | |
| this._sequenceIndex = 0; | |
| this._firstOpen = true; | |
| this._updateRequestId = null; | |
| this._loadQueue = []; | |
| this.currentOverlays = []; | |
| this._updatePixelDensityRatioBind = null; | |
| this._lastScrollTime = $.now(); // variable used to help normalize the scroll event speed of different devices | |
| this._fullyLoaded = false; // variable used to track the viewer's aggregate loading state. | |
| //Inherit some behaviors and properties | |
| $.EventSource.call( this ); | |
| this.addHandler( 'open-failed', function ( event ) { | |
| var msg = $.getString( "Errors.OpenFailed", event.eventSource, event.message); | |
| _this._showMessage( msg ); | |
| }); | |
| $.ControlDock.call( this, options ); | |
| //Deal with tile sources | |
| if (this.xmlPath) { | |
| //Deprecated option. Now it is preferred to use the tileSources option | |
| this.tileSources = [ this.xmlPath ]; | |
| } | |
| this.element = this.element || document.getElementById( this.id ); | |
| this.canvas = $.makeNeutralElement( "div" ); | |
| this.canvas.className = "openseadragon-canvas"; | |
| (function( style ){ | |
| style.width = "100%"; | |
| style.height = "100%"; | |
| style.overflow = "hidden"; | |
| style.position = "absolute"; | |
| style.top = "0px"; | |
| style.left = "0px"; | |
| }(this.canvas.style)); | |
| $.setElementTouchActionNone( this.canvas ); | |
| if (options.tabIndex !== "") { | |
| this.canvas.tabIndex = (options.tabIndex === undefined ? 0 : options.tabIndex); | |
| } | |
| //the container is created through applying the ControlDock constructor above | |
| this.container.className = "openseadragon-container"; | |
| (function( style ){ | |
| style.width = "100%"; | |
| style.height = "100%"; | |
| style.position = "relative"; | |
| style.overflow = "hidden"; | |
| style.left = "0px"; | |
| style.top = "0px"; | |
| style.textAlign = "left"; // needed to protect against | |
| }( this.container.style )); | |
| $.setElementTouchActionNone( this.container ); | |
| this.container.insertBefore( this.canvas, this.container.firstChild ); | |
| this.element.appendChild( this.container ); | |
| //Used for toggling between fullscreen and default container size | |
| //TODO: these can be closure private and shared across Viewer | |
| // instances. | |
| this.bodyWidth = document.body.style.width; | |
| this.bodyHeight = document.body.style.height; | |
| this.bodyOverflow = document.body.style.overflow; | |
| this.docOverflow = document.documentElement.style.overflow; | |
| this.innerTracker = new $.MouseTracker({ | |
| userData: 'Viewer.innerTracker', | |
| element: this.canvas, | |
| startDisabled: !this.mouseNavEnabled, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| dblClickTimeThreshold: this.dblClickTimeThreshold, | |
| dblClickDistThreshold: this.dblClickDistThreshold, | |
| contextMenuHandler: $.delegate( this, onCanvasContextMenu ), | |
| keyDownHandler: $.delegate( this, onCanvasKeyDown ), | |
| keyHandler: $.delegate( this, onCanvasKeyPress ), | |
| clickHandler: $.delegate( this, onCanvasClick ), | |
| dblClickHandler: $.delegate( this, onCanvasDblClick ), | |
| dragHandler: $.delegate( this, onCanvasDrag ), | |
| dragEndHandler: $.delegate( this, onCanvasDragEnd ), | |
| enterHandler: $.delegate( this, onCanvasEnter ), | |
| leaveHandler: $.delegate( this, onCanvasLeave ), | |
| pressHandler: $.delegate( this, onCanvasPress ), | |
| releaseHandler: $.delegate( this, onCanvasRelease ), | |
| nonPrimaryPressHandler: $.delegate( this, onCanvasNonPrimaryPress ), | |
| nonPrimaryReleaseHandler: $.delegate( this, onCanvasNonPrimaryRelease ), | |
| scrollHandler: $.delegate( this, onCanvasScroll ), | |
| pinchHandler: $.delegate( this, onCanvasPinch ), | |
| focusHandler: $.delegate( this, onCanvasFocus ), | |
| blurHandler: $.delegate( this, onCanvasBlur ), | |
| }); | |
| this.outerTracker = new $.MouseTracker({ | |
| userData: 'Viewer.outerTracker', | |
| element: this.container, | |
| startDisabled: !this.mouseNavEnabled, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| dblClickTimeThreshold: this.dblClickTimeThreshold, | |
| dblClickDistThreshold: this.dblClickDistThreshold, | |
| enterHandler: $.delegate( this, onContainerEnter ), | |
| leaveHandler: $.delegate( this, onContainerLeave ) | |
| }); | |
| if( this.toolbar ){ | |
| this.toolbar = new $.ControlDock({ element: this.toolbar }); | |
| } | |
| this.bindStandardControls(); | |
| THIS[ this.hash ].prevContainerSize = _getSafeElemSize( this.container ); | |
| if(window.ResizeObserver){ | |
| this._autoResizePolling = false; | |
| this._resizeObserver = new ResizeObserver(function(){ | |
| THIS[_this.hash].needsResize = true; | |
| }); | |
| this._resizeObserver.observe(this.container, {}); | |
| } else { | |
| this._autoResizePolling = true; | |
| } | |
| // Create the world | |
| this.world = new $.World({ | |
| viewer: this | |
| }); | |
| this.world.addHandler('add-item', function(event) { | |
| // For backwards compatibility, we maintain the source property | |
| _this.source = _this.world.getItemAt(0).source; | |
| THIS[ _this.hash ].forceRedraw = true; | |
| if (!_this._updateRequestId) { | |
| _this._updateRequestId = scheduleUpdate( _this, updateMulti ); | |
| } | |
| var tiledImage = event.item; | |
| var fullyLoadedHandler = function() { | |
| var newFullyLoaded = _this._areAllFullyLoaded(); | |
| if (newFullyLoaded !== _this._fullyLoaded) { | |
| _this._fullyLoaded = newFullyLoaded; | |
| /** | |
| * Fired when the viewer's aggregate "fully loaded" state changes (when all | |
| * TiledImages in the world have loaded tiles for the current view resolution). | |
| * | |
| * @event fully-loaded-change | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {Boolean} fullyLoaded - The new aggregate "fully loaded" value | |
| * @property {OpenSeadragon.Viewer} eventSource - Reference to the Viewer instance | |
| * @property {?Object} userData - Arbitrary subscriber-defined object | |
| */ | |
| _this.raiseEvent('fully-loaded-change', { | |
| fullyLoaded: newFullyLoaded | |
| }); | |
| } | |
| }; | |
| tiledImage._fullyLoadedHandlerForViewer = fullyLoadedHandler; | |
| tiledImage.addHandler('fully-loaded-change', fullyLoadedHandler); | |
| }); | |
| this.world.addHandler('remove-item', function(event) { | |
| var tiledImage = event.item; | |
| // SAFE cleanup with existence check | |
| if (tiledImage._fullyLoadedHandlerForViewer) { | |
| tiledImage.removeHandler('fully-loaded-change', tiledImage._fullyLoadedHandlerForViewer); | |
| delete tiledImage._fullyLoadedHandlerForViewer; // Remove the reference | |
| } | |
| // For backwards compatibility, we maintain the source property | |
| if (_this.world.getItemCount()) { | |
| _this.source = _this.world.getItemAt(0).source; | |
| } else { | |
| _this.source = null; | |
| } | |
| THIS[ _this.hash ].forceRedraw = true; | |
| }); | |
| this.world.addHandler('metrics-change', function(event) { | |
| if (_this.viewport) { | |
| _this.viewport._setContentBounds(_this.world.getHomeBounds(), _this.world.getContentFactor()); | |
| } | |
| }); | |
| this.world.addHandler('item-index-change', function(event) { | |
| // For backwards compatibility, we maintain the source property | |
| _this.source = _this.world.getItemAt(0).source; | |
| }); | |
| // Create the viewport | |
| this.viewport = new $.Viewport({ | |
| containerSize: THIS[ this.hash ].prevContainerSize, | |
| springStiffness: this.springStiffness, | |
| animationTime: this.animationTime, | |
| minZoomImageRatio: this.minZoomImageRatio, | |
| maxZoomPixelRatio: this.maxZoomPixelRatio, | |
| visibilityRatio: this.visibilityRatio, | |
| wrapHorizontal: this.wrapHorizontal, | |
| wrapVertical: this.wrapVertical, | |
| defaultZoomLevel: this.defaultZoomLevel, | |
| minZoomLevel: this.minZoomLevel, | |
| maxZoomLevel: this.maxZoomLevel, | |
| viewer: this, | |
| degrees: this.degrees, | |
| flipped: this.flipped, | |
| overlayPreserveContentDirection: this.overlayPreserveContentDirection, | |
| navigatorRotate: this.navigatorRotate, | |
| homeFillsViewer: this.homeFillsViewer, | |
| margins: this.viewportMargins, | |
| silenceMultiImageWarnings: this.silenceMultiImageWarnings | |
| }); | |
| this.viewport._setContentBounds(this.world.getHomeBounds(), this.world.getContentFactor()); | |
| // Create the image loader | |
| this.imageLoader = new $.ImageLoader({ | |
| jobLimit: this.imageLoaderLimit, | |
| timeout: options.timeout, | |
| tileRetryMax: this.tileRetryMax, | |
| tileRetryDelay: this.tileRetryDelay | |
| }); | |
| // Create the tile cache | |
| this.tileCache = new $.TileCache({ | |
| viewer: this, | |
| maxImageCacheCount: this.maxImageCacheCount | |
| }); | |
| //Create the drawer based on selected options | |
| if (Object.prototype.hasOwnProperty.call(this.drawerOptions, 'useCanvas') ){ | |
| $.console.error('useCanvas is deprecated, use the "drawer" option to indicate preferred drawer(s)'); | |
| // for backwards compatibility, use HTMLDrawer if useCanvas is defined and is falsey | |
| if (!this.drawerOptions.useCanvas){ | |
| this.drawer = $.HTMLDrawer; | |
| } | |
| delete this.drawerOptions.useCanvas; | |
| } | |
| let drawerCandidates = Array.isArray(this.drawer) ? this.drawer : [this.drawer]; | |
| if (drawerCandidates.length === 0){ | |
| // if an empty array was passed in, throw a warning and use the defaults | |
| // note: if the drawer option is not specified, the defaults will already be set so this won't apply | |
| drawerCandidates = [$.DEFAULT_SETTINGS.drawer].flat(); // ensure it is a list | |
| $.console.warn('No valid drawers were selected. Using the default value.'); | |
| } | |
| this.drawer = null; | |
| for (const drawerCandidate of drawerCandidates){ | |
| let success = this.requestDrawer(drawerCandidate, {mainDrawer: true, redrawImmediately: false}); | |
| if(success){ | |
| break; | |
| } | |
| } | |
| if (!this.drawer){ | |
| $.console.error('No drawer could be created!'); | |
| throw('Error with creating the selected drawer(s)'); | |
| } | |
| // Pass the imageSmoothingEnabled option along to the drawer | |
| this.drawer.setImageSmoothingEnabled(this.imageSmoothingEnabled); | |
| // Overlay container | |
| this.overlaysContainer = $.makeNeutralElement( "div" ); | |
| this.canvas.appendChild( this.overlaysContainer ); | |
| // Now that we have a drawer, see if it supports rotate. If not we need to remove the rotate buttons | |
| if (!this.drawer.canRotate()) { | |
| // Disable/remove the rotate left/right buttons since they aren't supported | |
| if (this.rotateLeft) { | |
| i = this.buttonGroup.buttons.indexOf(this.rotateLeft); | |
| this.buttonGroup.buttons.splice(i, 1); | |
| this.buttonGroup.element.removeChild(this.rotateLeft.element); | |
| } | |
| if (this.rotateRight) { | |
| i = this.buttonGroup.buttons.indexOf(this.rotateRight); | |
| this.buttonGroup.buttons.splice(i, 1); | |
| this.buttonGroup.element.removeChild(this.rotateRight.element); | |
| } | |
| } | |
| this._addUpdatePixelDensityRatioEvent(); | |
| //Instantiate a navigator if configured | |
| if ( this.showNavigator){ | |
| this.navigator = new $.Navigator({ | |
| element: this.navigatorElement, | |
| id: this.navigatorId, | |
| position: this.navigatorPosition, | |
| sizeRatio: this.navigatorSizeRatio, | |
| maintainSizeRatio: this.navigatorMaintainSizeRatio, | |
| top: this.navigatorTop, | |
| left: this.navigatorLeft, | |
| width: this.navigatorWidth, | |
| height: this.navigatorHeight, | |
| autoResize: this.navigatorAutoResize, | |
| autoFade: this.navigatorAutoFade, | |
| prefixUrl: this.prefixUrl, | |
| viewer: this, | |
| navigatorRotate: this.navigatorRotate, | |
| background: this.navigatorBackground, | |
| opacity: this.navigatorOpacity, | |
| borderColor: this.navigatorBorderColor, | |
| displayRegionColor: this.navigatorDisplayRegionColor, | |
| crossOriginPolicy: this.crossOriginPolicy, | |
| animationTime: this.animationTime, | |
| drawer: this.drawer.getType(), | |
| loadTilesWithAjax: this.loadTilesWithAjax, | |
| ajaxHeaders: this.ajaxHeaders, | |
| ajaxWithCredentials: this.ajaxWithCredentials, | |
| }); | |
| } | |
| // Sequence mode | |
| if (this.sequenceMode) { | |
| this.bindSequenceControls(); | |
| } | |
| // Open initial tilesources | |
| if (this.tileSources) { | |
| this.open( this.tileSources ); | |
| } | |
| // Add custom controls | |
| for ( i = 0; i < this.customControls.length; i++ ) { | |
| this.addControl( | |
| this.customControls[ i ].id, | |
| {anchor: this.customControls[ i ].anchor} | |
| ); | |
| } | |
| // Initial fade out | |
| $.requestAnimationFrame( function(){ | |
| beginControlsAutoHide( _this ); | |
| } ); | |
| // Register the viewer | |
| $._viewers.set(this.element, this); | |
| }; | |
| $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype, /** @lends OpenSeadragon.Viewer.prototype */{ | |
| /** | |
| * @function | |
| * @returns {Boolean} | |
| */ | |
| isOpen: function () { | |
| return !!this.world.getItemCount(); | |
| }, | |
| /** | |
| * Checks whether all TiledImage instances in the viewer's world are fully loaded. | |
| * This determines if the entire viewer content is ready for optimal display without partial tile loading. | |
| * @private | |
| * @returns {Boolean} True if all TiledImages report being fully loaded, | |
| * false if any image still has pending tiles | |
| */ | |
| _areAllFullyLoaded: function() { | |
| var tiledImage; | |
| var count = this.world.getItemCount(); | |
| // Iterate through all TiledImages in the viewer's world | |
| for (var i = 0; i < count; i++) { | |
| tiledImage = this.world.getItemAt(i); | |
| // Return immediately if any image isn't fully loaded | |
| if (!tiledImage.getFullyLoaded()) { | |
| return false; | |
| } | |
| } | |
| // All images passed the check | |
| return true; | |
| }, | |
| /** | |
| * @function | |
| * @returns {Boolean} True if all required tiles are loaded, false otherwise | |
| */ | |
| getFullyLoaded: function() { | |
| return this._fullyLoaded; | |
| }, | |
| /** | |
| * Executes the provided callback when the TiledImage is fully loaded. If already loaded, | |
| * schedules the callback asynchronously. Otherwise, attaches a one-time event listener | |
| * for the 'fully-loaded-change' event. | |
| * @param {Function} callback - Function to execute when loading completes | |
| * @memberof OpenSeadragon.Viewer.prototype | |
| */ | |
| whenFullyLoaded: function(callback) { | |
| if (this.getFullyLoaded()) { | |
| setTimeout(callback, 1); // Asynchronous execution | |
| } else { | |
| this.addOnceHandler('fully-loaded-change', function() { | |
| callback(); // Maintain context | |
| }); | |
| } | |
| }, | |
| // deprecated | |
| openDzi: function ( dzi ) { | |
| $.console.error( "[Viewer.openDzi] this function is deprecated; use Viewer.open() instead." ); | |
| return this.open( dzi ); | |
| }, | |
| // deprecated | |
| openTileSource: function ( tileSource ) { | |
| $.console.error( "[Viewer.openTileSource] this function is deprecated; use Viewer.open() instead." ); | |
| return this.open( tileSource ); | |
| }, | |
| //deprecated | |
| get buttons () { | |
| $.console.warn('Viewer.buttons is deprecated; Please use Viewer.buttonGroup'); | |
| return this.buttonGroup; | |
| }, | |
| /** | |
| * Open tiled images into the viewer, closing any others. | |
| * To get the TiledImage instance created by open, add an event listener for | |
| * {@link OpenSeadragon.Viewer.html#.event:open}, which when fired can be used to get access | |
| * to the instance, i.e., viewer.world.getItemAt(0). | |
| * @function | |
| * @param {Array|String|Object|Function} tileSources - This can be a TiledImage | |
| * specifier, a TileSource specifier, or an array of either. A TiledImage specifier | |
| * is the same as the options parameter for {@link OpenSeadragon.Viewer#addTiledImage}, | |
| * except for the index property; images are added in sequence. | |
| * A TileSource specifier is anything you could pass as the tileSource property | |
| * of the options parameter for {@link OpenSeadragon.Viewer#addTiledImage}. | |
| * @param {Number} initialPage - If sequenceMode is true, display this page initially | |
| * for the given tileSources. If specified, will overwrite the Viewer's existing initialPage property. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:open | |
| * @fires OpenSeadragon.Viewer.event:open-failed | |
| */ | |
| open: function (tileSources, initialPage) { | |
| var _this = this; | |
| this.close(); | |
| if (!tileSources) { | |
| return this; | |
| } | |
| if (this.sequenceMode && $.isArray(tileSources)) { | |
| if (this.referenceStrip) { | |
| this.referenceStrip.destroy(); | |
| this.referenceStrip = null; | |
| } | |
| if (typeof initialPage !== 'undefined' && !isNaN(initialPage)) { | |
| this.initialPage = initialPage; | |
| } | |
| this.tileSources = tileSources; | |
| this._sequenceIndex = Math.max(0, Math.min(this.tileSources.length - 1, this.initialPage)); | |
| if (this.tileSources.length) { | |
| this.open(this.tileSources[this._sequenceIndex]); | |
| if ( this.showReferenceStrip ){ | |
| this.addReferenceStrip(); | |
| } | |
| } | |
| this._updateSequenceButtons( this._sequenceIndex ); | |
| return this; | |
| } | |
| if (!$.isArray(tileSources)) { | |
| tileSources = [tileSources]; | |
| } | |
| if (!tileSources.length) { | |
| return this; | |
| } | |
| this._opening = true; | |
| var expected = tileSources.length; | |
| var successes = 0; | |
| var failures = 0; | |
| var failEvent; | |
| var checkCompletion = function() { | |
| if (successes + failures === expected) { | |
| if (successes) { | |
| if (_this._firstOpen || !_this.preserveViewport) { | |
| _this.viewport.goHome( true ); | |
| _this.viewport.update(); | |
| } | |
| _this._firstOpen = false; | |
| var source = tileSources[0]; | |
| if (source.tileSource) { | |
| source = source.tileSource; | |
| } | |
| // Global overlays | |
| if( _this.overlays && !_this.preserveOverlays ){ | |
| for ( var i = 0; i < _this.overlays.length; i++ ) { | |
| _this.currentOverlays[ i ] = getOverlayObject( _this, _this.overlays[ i ] ); | |
| } | |
| } | |
| _this._drawOverlays(); | |
| _this._opening = false; | |
| /** | |
| * Raised when the viewer has opened and loaded one or more TileSources. | |
| * | |
| * @event open | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {OpenSeadragon.TileSource} source - The tile source that was opened. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| // TODO: what if there are multiple sources? | |
| _this.raiseEvent( 'open', { source: source } ); | |
| } else { | |
| _this._opening = false; | |
| /** | |
| * Raised when an error occurs loading a TileSource. | |
| * | |
| * @event open-failed | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {String} message - Information about what failed. | |
| * @property {String} source - The tile source that failed. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( 'open-failed', failEvent ); | |
| } | |
| } | |
| }; | |
| var doOne = function(options) { | |
| if (!$.isPlainObject(options) || !options.tileSource) { | |
| options = { | |
| tileSource: options | |
| }; | |
| } | |
| if (options.index !== undefined) { | |
| $.console.error('[Viewer.open] setting indexes here is not supported; use addTiledImage instead'); | |
| delete options.index; | |
| } | |
| if (options.collectionImmediately === undefined) { | |
| options.collectionImmediately = true; | |
| } | |
| var originalSuccess = options.success; | |
| options.success = function(event) { | |
| successes++; | |
| // TODO: now that options has other things besides tileSource, the overlays | |
| // should probably be at the options level, not the tileSource level. | |
| if (options.tileSource.overlays) { | |
| for (var i = 0; i < options.tileSource.overlays.length; i++) { | |
| _this.addOverlay(options.tileSource.overlays[i]); | |
| } | |
| } | |
| if (originalSuccess) { | |
| originalSuccess(event); | |
| } | |
| checkCompletion(); | |
| }; | |
| var originalError = options.error; | |
| options.error = function(event) { | |
| failures++; | |
| if (!failEvent) { | |
| failEvent = event; | |
| } | |
| if (originalError) { | |
| originalError(event); | |
| } | |
| checkCompletion(); | |
| }; | |
| _this.addTiledImage(options); | |
| }; | |
| // TileSources | |
| for (var i = 0; i < tileSources.length; i++) { | |
| doOne(tileSources[i]); | |
| } | |
| return this; | |
| }, | |
| /** | |
| * Updates data within every tile in the viewer. Should be called | |
| * when tiles are outdated and should be re-processed. Useful mainly | |
| * for plugins that change tile data. | |
| * @function | |
| * @param {Boolean} [restoreTiles=true] if true, tile processing starts from the tile original data | |
| * @fires OpenSeadragon.Viewer.event:tile-invalidated | |
| * @return {OpenSeadragon.Promise<?>} | |
| */ | |
| requestInvalidate: function (restoreTiles = true) { | |
| if ( !THIS[ this.hash ] ) { | |
| //this viewer has already been destroyed: returning immediately | |
| return $.Promise.resolve(); | |
| } | |
| const tStamp = $.now(); | |
| const worldPromise = this.world.requestInvalidate(restoreTiles, tStamp); | |
| if (!this.navigator) { | |
| return worldPromise; | |
| } | |
| const navigatorPromise = this.navigator.world.requestInvalidate(restoreTiles, tStamp); | |
| return $.Promise.all([worldPromise, navigatorPromise]); | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:close | |
| */ | |
| close: function ( ) { | |
| if ( !THIS[ this.hash ] ) { | |
| //this viewer has already been destroyed: returning immediately | |
| return this; | |
| } | |
| this._opening = false; | |
| if ( this.navigator ) { | |
| this.navigator.close(); | |
| } | |
| if (!this.preserveOverlays) { | |
| this.clearOverlays(); | |
| this.overlaysContainer.innerHTML = ""; | |
| } | |
| THIS[ this.hash ].animating = false; | |
| this.world.removeAll(); | |
| this.tileCache.clear(); | |
| this.imageLoader.clear(); | |
| /** | |
| * Raised when the viewer is closed (see {@link OpenSeadragon.Viewer#close}). | |
| * | |
| * @event close | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'close' ); | |
| return this; | |
| }, | |
| /** | |
| * Function to destroy the viewer and clean up everything created by OpenSeadragon. | |
| * | |
| * Example: | |
| * var viewer = OpenSeadragon({ | |
| * [...] | |
| * }); | |
| * | |
| * //when you are done with the viewer: | |
| * viewer.destroy(); | |
| * viewer = null; //important | |
| * | |
| * @function | |
| * @fires OpenSeadragon.Viewer.event:before-destroy | |
| * @fires OpenSeadragon.Viewer.event:destroy | |
| */ | |
| destroy: function( ) { | |
| if ( !THIS[ this.hash ] ) { | |
| //this viewer has already been destroyed: returning immediately | |
| return; | |
| } | |
| /** | |
| * Raised when the viewer is about to be destroyed (see {@link OpenSeadragon.Viewer#before-destroy}). | |
| * | |
| * @event before-destroy | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'before-destroy' ); | |
| this._removeUpdatePixelDensityRatioEvent(); | |
| this.close(); | |
| this.clearOverlays(); | |
| this.overlaysContainer.innerHTML = ""; | |
| //TODO: implement this... | |
| //this.unbindSequenceControls() | |
| //this.unbindStandardControls() | |
| if (this._resizeObserver){ | |
| this._resizeObserver.disconnect(); | |
| } | |
| if (this.referenceStrip) { | |
| this.referenceStrip.destroy(); | |
| this.referenceStrip = null; | |
| } | |
| if ( this._updateRequestId !== null ) { | |
| $.cancelAnimationFrame( this._updateRequestId ); | |
| this._updateRequestId = null; | |
| } | |
| if ( this.drawer ) { | |
| this.drawer.destroy(); | |
| } | |
| if ( this.navigator ) { | |
| this.navigator.destroy(); | |
| THIS[ this.navigator.hash ] = null; | |
| delete THIS[ this.navigator.hash ]; | |
| this.navigator = null; | |
| } | |
| if (this.buttonGroup) { | |
| this.buttonGroup.destroy(); | |
| } else if (this.customButtons) { | |
| while (this.customButtons.length) { | |
| this.customButtons.pop().destroy(); | |
| } | |
| } | |
| if (this.paging) { | |
| this.paging.destroy(); | |
| } | |
| // Go through top element (passed to us) and remove all children | |
| // Use removeChild to make sure it handles SVG or any non-html | |
| // also it performs better - http://jsperf.com/innerhtml-vs-removechild/15 | |
| if (this.element){ | |
| while (this.element.firstChild) { | |
| this.element.removeChild(this.element.firstChild); | |
| } | |
| } | |
| this.container.onsubmit = null; | |
| this.clearControls(); | |
| // destroy the mouse trackers | |
| if (this.innerTracker){ | |
| this.innerTracker.destroy(); | |
| } | |
| if (this.outerTracker){ | |
| this.outerTracker.destroy(); | |
| } | |
| THIS[ this.hash ] = null; | |
| delete THIS[ this.hash ]; | |
| // clear all our references to dom objects | |
| this.canvas = null; | |
| this.container = null; | |
| // Unregister the viewer | |
| $._viewers.delete(this.element); | |
| // clear our reference to the main element - they will need to pass it in again, creating a new viewer | |
| this.element = null; | |
| /** | |
| * Raised when the viewer is destroyed (see {@link OpenSeadragon.Viewer#destroy}). | |
| * | |
| * @event destroy | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'destroy' ); | |
| this.removeAllHandlers(); | |
| }, | |
| /** | |
| * 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 { Object } options | |
| * @param { Boolean } [options.mainDrawer] Whether to use this as the viewer's main drawer. Default = true. | |
| * @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}. | |
| * @returns {Object | Boolean} The drawer that was created, or false if the requested drawer is not supported | |
| */ | |
| 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; | |
| let Drawer = null; | |
| //if the candidate inherits from a drawer base, use it | |
| if (drawerCandidate && drawerCandidate.prototype instanceof $.DrawerBase) { | |
| Drawer = drawerCandidate; | |
| drawerCandidate = 'custom'; | |
| } else if (typeof drawerCandidate === "string") { | |
| Drawer = $.determineDrawer(drawerCandidate); | |
| } | |
| if(!Drawer){ | |
| $.console.warn('Unsupported drawer! Drawer must be an existing string type, or a class that extends OpenSeadragon.DrawerBase.'); | |
| } | |
| // if the drawer is supported, create it and return true | |
| if (Drawer && Drawer.isSupported()) { | |
| // first destroy the previous drawer | |
| if(oldDrawer && mainDrawer){ | |
| oldDrawer.destroy(); | |
| } | |
| // create the new drawer | |
| const newDrawer = new Drawer({ | |
| viewer: this, | |
| viewport: this.viewport, | |
| element: this.canvas, | |
| debugGridColor: this.debugGridColor, | |
| options: drawerOptions || this.drawerOptions[drawerCandidate], | |
| }); | |
| if(mainDrawer){ | |
| this.drawer = newDrawer; | |
| if(redrawImmediately){ | |
| this.forceRedraw(); | |
| } | |
| } | |
| return newDrawer; | |
| } | |
| return false; | |
| }, | |
| /** | |
| * @function | |
| * @returns {Boolean} | |
| */ | |
| isMouseNavEnabled: function () { | |
| return this.innerTracker.tracking; | |
| }, | |
| /** | |
| * @function | |
| * @param {Boolean} enabled - true to enable, false to disable | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:mouse-enabled | |
| */ | |
| setMouseNavEnabled: function( enabled ){ | |
| this.innerTracker.setTracking( enabled ); | |
| this.outerTracker.setTracking( enabled ); | |
| /** | |
| * Raised when mouse/touch navigation is enabled or disabled (see {@link OpenSeadragon.Viewer#setMouseNavEnabled}). | |
| * | |
| * @event mouse-enabled | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Boolean} enabled | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'mouse-enabled', { enabled: enabled } ); | |
| return this; | |
| }, | |
| /** | |
| * @function | |
| * @returns {Boolean} | |
| */ | |
| areControlsEnabled: function () { | |
| var enabled = this.controls.length, | |
| i; | |
| for( i = 0; i < this.controls.length; i++ ){ | |
| enabled = enabled && this.controls[ i ].isVisible(); | |
| } | |
| return enabled; | |
| }, | |
| /** | |
| * Shows or hides the controls (e.g. the default navigation buttons). | |
| * | |
| * @function | |
| * @param {Boolean} true to show, false to hide. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:controls-enabled | |
| */ | |
| setControlsEnabled: function( enabled ) { | |
| if( enabled ){ | |
| abortControlsAutoHide( this ); | |
| } else { | |
| beginControlsAutoHide( this ); | |
| } | |
| /** | |
| * Raised when the navigation controls are shown or hidden (see {@link OpenSeadragon.Viewer#setControlsEnabled}). | |
| * | |
| * @event controls-enabled | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Boolean} enabled | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'controls-enabled', { enabled: enabled } ); | |
| return this; | |
| }, | |
| /** | |
| * Turns debugging mode on or off for this viewer. | |
| * | |
| * @function | |
| * @param {Boolean} debugMode true to turn debug on, false to turn debug off. | |
| */ | |
| setDebugMode: function(debugMode){ | |
| for (var i = 0; i < this.world.getItemCount(); i++) { | |
| this.world.getItemAt(i).debugMode = debugMode; | |
| } | |
| this.debugMode = debugMode; | |
| this.forceRedraw(); | |
| }, | |
| /** | |
| * Update headers to include when making AJAX requests. | |
| * | |
| * Unless `propagate` is set to false (which is likely only useful in rare circumstances), | |
| * the updated headers are propagated to all tiled images, each of which will subsequently | |
| * propagate the changed headers to all their tiles. | |
| * If applicable, the headers of the viewer's navigator and reference strip will also be updated. | |
| * | |
| * Note that the rules for merging headers still apply, i.e. headers returned by | |
| * {@link OpenSeadragon.TileSource#getTileAjaxHeaders} take precedence over | |
| * `TiledImage.ajaxHeaders`, which take precedence over the headers here in the viewer. | |
| * | |
| * @function | |
| * @param {Object} ajaxHeaders Updated AJAX headers. | |
| * @param {Boolean} [propagate=true] Whether to propagate updated headers to tiled images, etc. | |
| */ | |
| setAjaxHeaders: function(ajaxHeaders, propagate) { | |
| if (ajaxHeaders === null) { | |
| ajaxHeaders = {}; | |
| } | |
| if (!$.isPlainObject(ajaxHeaders)) { | |
| $.console.error('[Viewer.setAjaxHeaders] Ignoring invalid headers, must be a plain object'); | |
| return; | |
| } | |
| if (propagate === undefined) { | |
| propagate = true; | |
| } | |
| this.ajaxHeaders = ajaxHeaders; | |
| if (propagate) { | |
| for (var i = 0; i < this.world.getItemCount(); i++) { | |
| this.world.getItemAt(i)._updateAjaxHeaders(true); | |
| } | |
| if (this.navigator) { | |
| this.navigator.setAjaxHeaders(this.ajaxHeaders, true); | |
| } | |
| if (this.referenceStrip && this.referenceStrip.miniViewers) { | |
| for (var key in this.referenceStrip.miniViewers) { | |
| this.referenceStrip.miniViewers[key].setAjaxHeaders(this.ajaxHeaders, true); | |
| } | |
| } | |
| } | |
| }, | |
| /** | |
| * Adds the given button to this viewer. | |
| * | |
| * @function | |
| * @param {OpenSeadragon.Button} button | |
| */ | |
| addButton: function( button ){ | |
| this.buttonGroup.addButton(button); | |
| }, | |
| /** | |
| * @function | |
| * @returns {Boolean} | |
| */ | |
| isFullPage: function () { | |
| return THIS[this.hash] && THIS[ this.hash ].fullPage; | |
| }, | |
| /** | |
| * Toggle full page mode. | |
| * @function | |
| * @param {Boolean} fullPage | |
| * If true, enter full page mode. If false, exit full page mode. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:pre-full-page | |
| * @fires OpenSeadragon.Viewer.event:full-page | |
| */ | |
| setFullPage: function( fullPage ) { | |
| var body = document.body, | |
| bodyStyle = body.style, | |
| docStyle = document.documentElement.style, | |
| _this = this, | |
| nodes, | |
| i; | |
| //don't bother modifying the DOM if we are already in full page mode. | |
| if ( fullPage === this.isFullPage() ) { | |
| return this; | |
| } | |
| var fullPageEventArgs = { | |
| fullPage: fullPage, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when the viewer is about to change to/from full-page mode (see {@link OpenSeadragon.Viewer#setFullPage}). | |
| * | |
| * @event pre-full-page | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Boolean} fullPage - True if entering full-page mode, false if exiting full-page mode. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent full-page mode change. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'pre-full-page', fullPageEventArgs ); | |
| if ( fullPageEventArgs.preventDefaultAction ) { | |
| return this; | |
| } | |
| if ( fullPage && this.element ) { | |
| this.elementSize = $.getElementSize( this.element ); | |
| this.pageScroll = $.getPageScroll(); | |
| this.elementMargin = this.element.style.margin; | |
| this.element.style.margin = "0"; | |
| this.elementPadding = this.element.style.padding; | |
| this.element.style.padding = "0"; | |
| this.bodyMargin = bodyStyle.margin; | |
| this.docMargin = docStyle.margin; | |
| bodyStyle.margin = "0"; | |
| docStyle.margin = "0"; | |
| this.bodyPadding = bodyStyle.padding; | |
| this.docPadding = docStyle.padding; | |
| bodyStyle.padding = "0"; | |
| docStyle.padding = "0"; | |
| this.bodyWidth = bodyStyle.width; | |
| this.docWidth = docStyle.width; | |
| bodyStyle.width = "100%"; | |
| docStyle.width = "100%"; | |
| this.bodyHeight = bodyStyle.height; | |
| this.docHeight = docStyle.height; | |
| bodyStyle.height = "100%"; | |
| docStyle.height = "100%"; | |
| this.bodyDisplay = bodyStyle.display; | |
| bodyStyle.display = "block"; | |
| //when entering full screen on the ipad it wasn't sufficient to leave | |
| //the body intact as only only the top half of the screen would | |
| //respond to touch events on the canvas, while the bottom half treated | |
| //them as touch events on the document body. Thus we remove and store | |
| //the bodies elements and replace them when we leave full screen. | |
| this.previousBody = []; | |
| THIS[ this.hash ].prevElementParent = this.element.parentNode; | |
| THIS[ this.hash ].prevNextSibling = this.element.nextSibling; | |
| THIS[ this.hash ].prevElementWidth = this.element.style.width; | |
| THIS[ this.hash ].prevElementHeight = this.element.style.height; | |
| nodes = body.childNodes.length; | |
| for ( i = 0; i < nodes; i++ ) { | |
| this.previousBody.push( body.childNodes[ 0 ] ); | |
| body.removeChild( body.childNodes[ 0 ] ); | |
| } | |
| //If we've got a toolbar, we need to enable the user to use css to | |
| //preserve it in fullpage mode | |
| if ( this.toolbar && this.toolbar.element ) { | |
| //save a reference to the parent so we can put it back | |
| //in the long run we need a better strategy | |
| this.toolbar.parentNode = this.toolbar.element.parentNode; | |
| this.toolbar.nextSibling = this.toolbar.element.nextSibling; | |
| body.appendChild( this.toolbar.element ); | |
| //Make sure the user has some ability to style the toolbar based | |
| //on the mode | |
| $.addClass( this.toolbar.element, 'fullpage' ); | |
| } | |
| $.addClass( this.element, 'fullpage' ); | |
| body.appendChild( this.element ); | |
| this.element.style.height = '100vh'; | |
| this.element.style.width = '100vw'; | |
| if ( this.toolbar && this.toolbar.element ) { | |
| this.element.style.height = ( | |
| $.getElementSize( this.element ).y - $.getElementSize( this.toolbar.element ).y | |
| ) + 'px'; | |
| } | |
| THIS[ this.hash ].fullPage = true; | |
| // mouse will be inside container now | |
| $.delegate( this, onContainerEnter )( {} ); | |
| } else { | |
| this.element.style.margin = this.elementMargin; | |
| this.element.style.padding = this.elementPadding; | |
| bodyStyle.margin = this.bodyMargin; | |
| docStyle.margin = this.docMargin; | |
| bodyStyle.padding = this.bodyPadding; | |
| docStyle.padding = this.docPadding; | |
| bodyStyle.width = this.bodyWidth; | |
| docStyle.width = this.docWidth; | |
| bodyStyle.height = this.bodyHeight; | |
| docStyle.height = this.docHeight; | |
| bodyStyle.display = this.bodyDisplay; | |
| body.removeChild( this.element ); | |
| nodes = this.previousBody.length; | |
| for ( i = 0; i < nodes; i++ ) { | |
| body.appendChild( this.previousBody.shift() ); | |
| } | |
| $.removeClass( this.element, 'fullpage' ); | |
| THIS[ this.hash ].prevElementParent.insertBefore( | |
| this.element, | |
| THIS[ this.hash ].prevNextSibling | |
| ); | |
| //If we've got a toolbar, we need to enable the user to use css to | |
| //reset it to its original state | |
| if ( this.toolbar && this.toolbar.element ) { | |
| body.removeChild( this.toolbar.element ); | |
| //Make sure the user has some ability to style the toolbar based | |
| //on the mode | |
| $.removeClass( this.toolbar.element, 'fullpage' ); | |
| this.toolbar.parentNode.insertBefore( | |
| this.toolbar.element, | |
| this.toolbar.nextSibling | |
| ); | |
| delete this.toolbar.parentNode; | |
| delete this.toolbar.nextSibling; | |
| } | |
| this.element.style.width = THIS[ this.hash ].prevElementWidth; | |
| this.element.style.height = THIS[ this.hash ].prevElementHeight; | |
| // After exiting fullPage or fullScreen, it can take some time | |
| // before the browser can actually set the scroll. | |
| var restoreScrollCounter = 0; | |
| var restoreScroll = function() { | |
| $.setPageScroll( _this.pageScroll ); | |
| var pageScroll = $.getPageScroll(); | |
| restoreScrollCounter++; | |
| if (restoreScrollCounter < 10 && | |
| (pageScroll.x !== _this.pageScroll.x || | |
| pageScroll.y !== _this.pageScroll.y)) { | |
| $.requestAnimationFrame( restoreScroll ); | |
| } | |
| }; | |
| $.requestAnimationFrame( restoreScroll ); | |
| THIS[ this.hash ].fullPage = false; | |
| // mouse will likely be outside now | |
| $.delegate( this, onContainerLeave )( { } ); | |
| } | |
| if ( this.navigator && this.viewport ) { | |
| this.navigator.update( this.viewport ); | |
| } | |
| /** | |
| * Raised when the viewer has changed to/from full-page mode (see {@link OpenSeadragon.Viewer#setFullPage}). | |
| * | |
| * @event full-page | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Boolean} fullPage - True if changed to full-page mode, false if exited full-page mode. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'full-page', { fullPage: fullPage } ); | |
| return this; | |
| }, | |
| /** | |
| * Toggle full screen mode if supported. Toggle full page mode otherwise. | |
| * @function | |
| * @param {Boolean} fullScreen | |
| * If true, enter full screen mode. If false, exit full screen mode. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:pre-full-screen | |
| * @fires OpenSeadragon.Viewer.event:full-screen | |
| */ | |
| setFullScreen: function( fullScreen ) { | |
| var _this = this; | |
| if ( !$.supportsFullScreen ) { | |
| return this.setFullPage( fullScreen ); | |
| } | |
| if ( $.isFullScreen() === fullScreen ) { | |
| return this; | |
| } | |
| var fullScreeEventArgs = { | |
| fullScreen: fullScreen, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when the viewer is about to change to/from full-screen mode (see {@link OpenSeadragon.Viewer#setFullScreen}). | |
| * Note: the pre-full-screen event is not raised when the user is exiting | |
| * full-screen mode by pressing the Esc key. In that case, consider using | |
| * the full-screen, pre-full-page or full-page events. | |
| * | |
| * @event pre-full-screen | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Boolean} fullScreen - True if entering full-screen mode, false if exiting full-screen mode. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent full-screen mode change. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'pre-full-screen', fullScreeEventArgs ); | |
| if ( fullScreeEventArgs.preventDefaultAction ) { | |
| return this; | |
| } | |
| if ( fullScreen ) { | |
| this.setFullPage( true ); | |
| // If the full page mode is not actually entered, we need to prevent | |
| // the full screen mode. | |
| if ( !this.isFullPage() ) { | |
| return this; | |
| } | |
| this.fullPageStyleWidth = this.element.style.width; | |
| this.fullPageStyleHeight = this.element.style.height; | |
| this.element.style.width = '100%'; | |
| this.element.style.height = '100%'; | |
| var onFullScreenChange = function() { | |
| var isFullScreen = $.isFullScreen(); | |
| if ( !isFullScreen ) { | |
| $.removeEvent( document, $.fullScreenEventName, onFullScreenChange ); | |
| $.removeEvent( document, $.fullScreenErrorEventName, onFullScreenChange ); | |
| _this.setFullPage( false ); | |
| if ( _this.isFullPage() ) { | |
| _this.element.style.width = _this.fullPageStyleWidth; | |
| _this.element.style.height = _this.fullPageStyleHeight; | |
| } | |
| } | |
| if ( _this.navigator && _this.viewport ) { | |
| //09/08/2018 - Fabroh : Fix issue #1504 : Ensure to get the navigator updated on fullscreen out with custom location with a timeout | |
| setTimeout(function(){ | |
| _this.navigator.update( _this.viewport ); | |
| }); | |
| } | |
| /** | |
| * Raised when the viewer has changed to/from full-screen mode (see {@link OpenSeadragon.Viewer#setFullScreen}). | |
| * | |
| * @event full-screen | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Boolean} fullScreen - True if changed to full-screen mode, false if exited full-screen mode. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( 'full-screen', { fullScreen: isFullScreen } ); | |
| }; | |
| $.addEvent( document, $.fullScreenEventName, onFullScreenChange ); | |
| $.addEvent( document, $.fullScreenErrorEventName, onFullScreenChange ); | |
| $.requestFullScreen( document.body ); | |
| } else { | |
| $.exitFullScreen(); | |
| } | |
| return this; | |
| }, | |
| /** | |
| * @function | |
| * @returns {Boolean} | |
| */ | |
| isVisible: function () { | |
| return this.container.style.visibility !== "hidden"; | |
| }, | |
| // | |
| /** | |
| * @function | |
| * @returns {Boolean} returns true if the viewer is in fullscreen | |
| */ | |
| isFullScreen: function () { | |
| return $.isFullScreen() && this.isFullPage(); | |
| }, | |
| /** | |
| * @function | |
| * @param {Boolean} visible | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:visible | |
| */ | |
| setVisible: function( visible ){ | |
| this.container.style.visibility = visible ? "" : "hidden"; | |
| /** | |
| * Raised when the viewer is shown or hidden (see {@link OpenSeadragon.Viewer#setVisible}). | |
| * | |
| * @event visible | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Boolean} visible | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'visible', { visible: visible } ); | |
| return this; | |
| }, | |
| /** | |
| * Add a tiled image to the viewer. | |
| * options.tileSource can be anything that {@link OpenSeadragon.Viewer#open} | |
| * supports except arrays of images. | |
| * Note that you can specify options.width or options.height, but not both. | |
| * The other dimension will be calculated according to the item's aspect ratio. | |
| * If collectionMode is on (see {@link OpenSeadragon.Options}), the new image is | |
| * automatically arranged with the others. | |
| * @function | |
| * @param {Object} options | |
| * @param {String|Object|Function} options.tileSource - The TileSource specifier. | |
| * A String implies a url used to determine the tileSource implementation | |
| * based on the file extension of url. JSONP is implied by *.js, | |
| * otherwise the url is retrieved as text and the resulting text is | |
| * introspected to determine if its json, xml, or text and parsed. | |
| * An Object implies an inline configuration which has a single | |
| * property sufficient for being able to determine tileSource | |
| * implementation. If the object has a property which is a function | |
| * named 'getTileUrl', it is treated as a custom TileSource. | |
| * @param {Number} [options.index] The index of the item. Added on top of | |
| * all other items if not specified. | |
| * @param {Boolean} [options.replace=false] If true, the item at options.index will be | |
| * removed and the new item is added in its place. options.tileSource will be | |
| * interpreted and fetched if necessary before the old item is removed to avoid leaving | |
| * a gap in the world. | |
| * @param {Number} [options.x=0] The X position for the image in viewport coordinates. | |
| * @param {Number} [options.y=0] The Y position for the image in viewport coordinates. | |
| * @param {Number} [options.width=1] The width for the image in viewport coordinates. | |
| * @param {Number} [options.height] The height for the image in viewport coordinates. | |
| * @param {OpenSeadragon.Rect} [options.fitBounds] The bounds in viewport coordinates | |
| * to fit the image into. If specified, x, y, width and height get ignored. | |
| * @param {OpenSeadragon.Placement} [options.fitBoundsPlacement=OpenSeadragon.Placement.CENTER] | |
| * How to anchor the image in the bounds if options.fitBounds is set. | |
| * @param {OpenSeadragon.Rect} [options.clip] - An area, in image pixels, to clip to | |
| * (portions of the image outside of this area will not be visible). Only works on | |
| * browsers that support the HTML5 canvas. | |
| * @param {Number} [options.opacity=1] Proportional opacity of the tiled images (1=opaque, 0=hidden) | |
| * @param {Boolean} [options.preload=false] Default switch for loading hidden images (true loads, false blocks) | |
| * @param {Boolean} [options.zombieCache] In the case that this method removes any TiledImage instance, | |
| * allow the item-referenced cache to remain in memory even without active tiles. Default false. | |
| * @param {Number} [options.degrees=0] Initial rotation of the tiled image around | |
| * its top left corner in degrees. | |
| * @param {Boolean} [options.flipped=false] Whether to horizontally flip the image. | |
| * @param {String} [options.compositeOperation] How the image is composited onto other images. | |
| * @param {String} [options.crossOriginPolicy] The crossOriginPolicy for this specific image, | |
| * overriding viewer.crossOriginPolicy. | |
| * @param {Boolean} [options.ajaxWithCredentials] Whether to set withCredentials on tile AJAX | |
| * @param {Boolean} [options.loadTilesWithAjax] | |
| * Whether to load tile data using AJAX requests. | |
| * Defaults to the setting in {@link OpenSeadragon.Options}. | |
| * @param {Object} [options.ajaxHeaders] | |
| * A set of headers to include when making tile AJAX requests. | |
| * Note that these headers will be merged over any headers specified in {@link OpenSeadragon.Options}. | |
| * Specifying a falsy value for a header will clear its existing value set at the Viewer level (if any). | |
| * @param {Function} [options.success] A function that gets called when the image is | |
| * successfully added. It's passed the event object which contains a single property: | |
| * "item", which is the resulting instance of TiledImage. | |
| * @param {Function} [options.error] A function that gets called if the image is | |
| * unable to be added. It's passed the error event object, which contains "message" | |
| * and "source" properties. | |
| * @param {Boolean} [options.collectionImmediately=false] If collectionMode is on, | |
| * specifies whether to snap to the new arrangement immediately or to animate to it. | |
| * @param {String|CanvasGradient|CanvasPattern|Function} [options.placeholderFillStyle] - See {@link OpenSeadragon.Options}. | |
| * @fires OpenSeadragon.World.event:add-item | |
| * @fires OpenSeadragon.Viewer.event:add-item-failed | |
| */ | |
| addTiledImage: function( options ) { | |
| $.console.assert(options, "[Viewer.addTiledImage] options is required"); | |
| $.console.assert(options.tileSource, "[Viewer.addTiledImage] options.tileSource is required"); | |
| $.console.assert(!options.replace || (options.index > -1 && options.index < this.world.getItemCount()), | |
| "[Viewer.addTiledImage] if options.replace is used, options.index must be a valid index in Viewer.world"); | |
| var _this = this; | |
| if (options.replace) { | |
| options.replaceItem = _this.world.getItemAt(options.index); | |
| } | |
| this._hideMessage(); | |
| if (options.placeholderFillStyle === undefined) { | |
| options.placeholderFillStyle = this.placeholderFillStyle; | |
| } | |
| if (options.opacity === undefined) { | |
| options.opacity = this.opacity; | |
| } | |
| if (options.preload === undefined) { | |
| options.preload = this.preload; | |
| } | |
| if (options.compositeOperation === undefined) { | |
| options.compositeOperation = this.compositeOperation; | |
| } | |
| if (options.crossOriginPolicy === undefined) { | |
| options.crossOriginPolicy = options.tileSource.crossOriginPolicy !== undefined ? options.tileSource.crossOriginPolicy : this.crossOriginPolicy; | |
| } | |
| if (options.ajaxWithCredentials === undefined) { | |
| options.ajaxWithCredentials = this.ajaxWithCredentials; | |
| } | |
| if (options.loadTilesWithAjax === undefined) { | |
| options.loadTilesWithAjax = this.loadTilesWithAjax; | |
| } | |
| if (!$.isPlainObject(options.ajaxHeaders)) { | |
| options.ajaxHeaders = {}; | |
| } | |
| var myQueueItem = { | |
| options: options | |
| }; | |
| function raiseAddItemFailed( event ) { | |
| for (var i = 0; i < _this._loadQueue.length; i++) { | |
| if (_this._loadQueue[i] === myQueueItem) { | |
| _this._loadQueue.splice(i, 1); | |
| break; | |
| } | |
| } | |
| if (_this._loadQueue.length === 0) { | |
| refreshWorld(myQueueItem); | |
| } | |
| /** | |
| * Raised when an error occurs while adding a item. | |
| * @event add-item-failed | |
| * @memberOf OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {String} message | |
| * @property {String} source | |
| * @property {Object} options The options passed to the addTiledImage method. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( 'add-item-failed', event ); | |
| if (options.error) { | |
| options.error(event); | |
| } | |
| } | |
| function refreshWorld(theItem) { | |
| if (_this.collectionMode) { | |
| _this.world.arrange({ | |
| immediately: theItem.options.collectionImmediately, | |
| rows: _this.collectionRows, | |
| columns: _this.collectionColumns, | |
| layout: _this.collectionLayout, | |
| tileSize: _this.collectionTileSize, | |
| tileMargin: _this.collectionTileMargin | |
| }); | |
| _this.world.setAutoRefigureSizes(true); | |
| } | |
| } | |
| if ($.isArray(options.tileSource)) { | |
| setTimeout(function() { | |
| raiseAddItemFailed({ | |
| message: "[Viewer.addTiledImage] Sequences can not be added; add them one at a time instead.", | |
| source: options.tileSource, | |
| options: options | |
| }); | |
| }); | |
| return; | |
| } | |
| this._loadQueue.push(myQueueItem); | |
| function processReadyItems() { | |
| var queueItem, tiledImage, optionsClone; | |
| while (_this._loadQueue.length) { | |
| queueItem = _this._loadQueue[0]; | |
| if (!queueItem.tileSource) { | |
| break; | |
| } | |
| _this._loadQueue.splice(0, 1); | |
| if (queueItem.options.replace) { | |
| const replaced = queueItem.options.replaceItem; | |
| const newIndex = _this.world.getIndexOfItem(replaced); | |
| if (newIndex !== -1) { | |
| queueItem.options.index = newIndex; | |
| } | |
| if (!replaced._zombieCache && replaced.source.equals(queueItem.tileSource)) { | |
| replaced.allowZombieCache(true); | |
| } | |
| _this.world.removeItem(replaced); | |
| } | |
| tiledImage = new $.TiledImage({ | |
| viewer: _this, | |
| source: queueItem.tileSource, | |
| viewport: _this.viewport, | |
| drawer: _this.drawer, | |
| tileCache: _this.tileCache, | |
| imageLoader: _this.imageLoader, | |
| x: queueItem.options.x, | |
| y: queueItem.options.y, | |
| width: queueItem.options.width, | |
| height: queueItem.options.height, | |
| fitBounds: queueItem.options.fitBounds, | |
| fitBoundsPlacement: queueItem.options.fitBoundsPlacement, | |
| clip: queueItem.options.clip, | |
| placeholderFillStyle: queueItem.options.placeholderFillStyle, | |
| opacity: queueItem.options.opacity, | |
| preload: queueItem.options.preload, | |
| degrees: queueItem.options.degrees, | |
| flipped: queueItem.options.flipped, | |
| compositeOperation: queueItem.options.compositeOperation, | |
| springStiffness: _this.springStiffness, | |
| animationTime: _this.animationTime, | |
| minZoomImageRatio: _this.minZoomImageRatio, | |
| wrapHorizontal: _this.wrapHorizontal, | |
| wrapVertical: _this.wrapVertical, | |
| maxTilesPerFrame: _this.maxTilesPerFrame, | |
| loadDestinationTilesOnAnimation: _this.loadDestinationTilesOnAnimation, | |
| immediateRender: _this.immediateRender, | |
| blendTime: _this.blendTime, | |
| alwaysBlend: _this.alwaysBlend, | |
| minPixelRatio: _this.minPixelRatio, | |
| smoothTileEdgesMinZoom: _this.smoothTileEdgesMinZoom, | |
| iOSDevice: _this.iOSDevice, | |
| crossOriginPolicy: queueItem.options.crossOriginPolicy, | |
| ajaxWithCredentials: queueItem.options.ajaxWithCredentials, | |
| loadTilesWithAjax: queueItem.options.loadTilesWithAjax, | |
| ajaxHeaders: queueItem.options.ajaxHeaders, | |
| debugMode: _this.debugMode, | |
| subPixelRoundingForTransparency: _this.subPixelRoundingForTransparency, | |
| callTileLoadedWithCachedData: _this.callTileLoadedWithCachedData, | |
| }); | |
| if (_this.collectionMode) { | |
| _this.world.setAutoRefigureSizes(false); | |
| } | |
| if (_this.navigator) { | |
| optionsClone = $.extend({}, queueItem.options, { | |
| replace: false, // navigator already removed the layer, nothing to replace | |
| originalTiledImage: tiledImage, | |
| tileSource: queueItem.tileSource | |
| }); | |
| _this.navigator.addTiledImage(optionsClone); | |
| } | |
| _this.world.addItem( tiledImage, { | |
| index: queueItem.options.index | |
| }); | |
| if (_this._loadQueue.length === 0) { | |
| //this restores the autoRefigureSizes flag to true. | |
| refreshWorld(queueItem); | |
| } | |
| if (_this.world.getItemCount() === 1 && !_this.preserveViewport) { | |
| _this.viewport.goHome(true); | |
| } | |
| if (queueItem.options.success) { | |
| queueItem.options.success({ | |
| item: tiledImage | |
| }); | |
| } | |
| } | |
| } | |
| getTileSourceImplementation( this, options.tileSource, options, function( tileSource ) { | |
| myQueueItem.tileSource = tileSource; | |
| // add everybody at the front of the queue that's ready to go | |
| processReadyItems(); | |
| }, function( event ) { | |
| event.options = options; | |
| raiseAddItemFailed(event); | |
| // add everybody at the front of the queue that's ready to go | |
| processReadyItems(); | |
| } ); | |
| }, | |
| /** | |
| * Add a simple image to the viewer. | |
| * The options are the same as the ones in {@link OpenSeadragon.Viewer#addTiledImage} | |
| * except for options.tileSource which is replaced by options.url. | |
| * @function | |
| * @param {Object} options - See {@link OpenSeadragon.Viewer#addTiledImage} | |
| * for all the options | |
| * @param {String} options.url - The URL of the image to add. | |
| * @fires OpenSeadragon.World.event:add-item | |
| * @fires OpenSeadragon.Viewer.event:add-item-failed | |
| */ | |
| addSimpleImage: function(options) { | |
| $.console.assert(options, "[Viewer.addSimpleImage] options is required"); | |
| $.console.assert(options.url, "[Viewer.addSimpleImage] options.url is required"); | |
| var opts = $.extend({}, options, { | |
| tileSource: { | |
| type: 'image', | |
| url: options.url | |
| } | |
| }); | |
| delete opts.url; | |
| this.addTiledImage(opts); | |
| }, | |
| // deprecated | |
| addLayer: function( options ) { | |
| var _this = this; | |
| $.console.error( "[Viewer.addLayer] this function is deprecated; use Viewer.addTiledImage() instead." ); | |
| var optionsClone = $.extend({}, options, { | |
| success: function(event) { | |
| _this.raiseEvent("add-layer", { | |
| options: options, | |
| drawer: event.item | |
| }); | |
| }, | |
| error: function(event) { | |
| _this.raiseEvent("add-layer-failed", event); | |
| } | |
| }); | |
| this.addTiledImage(optionsClone); | |
| return this; | |
| }, | |
| // deprecated | |
| getLayerAtLevel: function( level ) { | |
| $.console.error( "[Viewer.getLayerAtLevel] this function is deprecated; use World.getItemAt() instead." ); | |
| return this.world.getItemAt(level); | |
| }, | |
| // deprecated | |
| getLevelOfLayer: function( drawer ) { | |
| $.console.error( "[Viewer.getLevelOfLayer] this function is deprecated; use World.getIndexOfItem() instead." ); | |
| return this.world.getIndexOfItem(drawer); | |
| }, | |
| // deprecated | |
| getLayersCount: function() { | |
| $.console.error( "[Viewer.getLayersCount] this function is deprecated; use World.getItemCount() instead." ); | |
| return this.world.getItemCount(); | |
| }, | |
| // deprecated | |
| setLayerLevel: function( drawer, level ) { | |
| $.console.error( "[Viewer.setLayerLevel] this function is deprecated; use World.setItemIndex() instead." ); | |
| return this.world.setItemIndex(drawer, level); | |
| }, | |
| // deprecated | |
| removeLayer: function( drawer ) { | |
| $.console.error( "[Viewer.removeLayer] this function is deprecated; use World.removeItem() instead." ); | |
| return this.world.removeItem(drawer); | |
| }, | |
| /** | |
| * Force the viewer to redraw its contents. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| */ | |
| forceRedraw: function() { | |
| THIS[ this.hash ].forceRedraw = true; | |
| return this; | |
| }, | |
| /** | |
| * Force the viewer to reset its size to match its container. | |
| */ | |
| forceResize: function() { | |
| THIS[this.hash].needsResize = true; | |
| THIS[this.hash].forceResize = true; | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| */ | |
| bindSequenceControls: function(){ | |
| ////////////////////////////////////////////////////////////////////////// | |
| // Image Sequence Controls | |
| ////////////////////////////////////////////////////////////////////////// | |
| var onFocusHandler = $.delegate( this, onFocus ), | |
| onBlurHandler = $.delegate( this, onBlur ), | |
| onNextHandler = $.delegate( this, this.goToNextPage ), | |
| onPreviousHandler = $.delegate( this, this.goToPreviousPage ), | |
| navImages = this.navImages, | |
| useGroup = true; | |
| if( this.showSequenceControl ){ | |
| if( this.previousButton || this.nextButton ){ | |
| //if we are binding to custom buttons then layout and | |
| //grouping is the responsibility of the page author | |
| useGroup = false; | |
| } | |
| this.previousButton = new $.Button({ | |
| element: this.previousButton ? $.getElement( this.previousButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.PreviousPage" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.previous.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.previous.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.previous.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.previous.DOWN ), | |
| onRelease: onPreviousHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| }); | |
| this.nextButton = new $.Button({ | |
| element: this.nextButton ? $.getElement( this.nextButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.NextPage" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.next.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.next.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.next.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.next.DOWN ), | |
| onRelease: onNextHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| }); | |
| if( !this.navPrevNextWrap ){ | |
| this.previousButton.disable(); | |
| } | |
| if (!this.tileSources || !this.tileSources.length) { | |
| this.nextButton.disable(); | |
| } | |
| if( useGroup ){ | |
| this.paging = new $.ButtonGroup({ | |
| buttons: [ | |
| this.previousButton, | |
| this.nextButton | |
| ], | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold | |
| }); | |
| this.pagingControl = this.paging.element; | |
| if( this.toolbar ){ | |
| this.toolbar.addControl( | |
| this.pagingControl, | |
| {anchor: $.ControlAnchor.BOTTOM_RIGHT} | |
| ); | |
| }else{ | |
| this.addControl( | |
| this.pagingControl, | |
| {anchor: this.sequenceControlAnchor || $.ControlAnchor.TOP_LEFT} | |
| ); | |
| } | |
| } | |
| } | |
| return this; | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| */ | |
| bindStandardControls: function(){ | |
| ////////////////////////////////////////////////////////////////////////// | |
| // Navigation Controls | |
| ////////////////////////////////////////////////////////////////////////// | |
| var beginZoomingInHandler = $.delegate( this, this.startZoomInAction ), | |
| endZoomingHandler = $.delegate( this, this.endZoomAction ), | |
| doSingleZoomInHandler = $.delegate( this, this.singleZoomInAction ), | |
| beginZoomingOutHandler = $.delegate( this, this.startZoomOutAction ), | |
| doSingleZoomOutHandler = $.delegate( this, this.singleZoomOutAction ), | |
| onHomeHandler = $.delegate( this, onHome ), | |
| onFullScreenHandler = $.delegate( this, onFullScreen ), | |
| onRotateLeftHandler = $.delegate( this, onRotateLeft ), | |
| onRotateRightHandler = $.delegate( this, onRotateRight ), | |
| onFlipHandler = $.delegate( this, onFlip), | |
| onFocusHandler = $.delegate( this, onFocus ), | |
| onBlurHandler = $.delegate( this, onBlur ), | |
| navImages = this.navImages, | |
| buttons = [], | |
| useGroup = true; | |
| if ( this.showNavigationControl ) { | |
| if( this.zoomInButton || this.zoomOutButton || | |
| this.homeButton || this.fullPageButton || | |
| this.rotateLeftButton || this.rotateRightButton || | |
| this.flipButton ) { | |
| //if we are binding to custom buttons then layout and | |
| //grouping is the responsibility of the page author | |
| useGroup = false; | |
| } | |
| if ( this.showZoomControl ) { | |
| buttons.push( this.zoomInButton = new $.Button({ | |
| element: this.zoomInButton ? $.getElement( this.zoomInButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.ZoomIn" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.zoomIn.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.zoomIn.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.zoomIn.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.zoomIn.DOWN ), | |
| onPress: beginZoomingInHandler, | |
| onRelease: endZoomingHandler, | |
| onClick: doSingleZoomInHandler, | |
| onEnter: beginZoomingInHandler, | |
| onExit: endZoomingHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| })); | |
| buttons.push( this.zoomOutButton = new $.Button({ | |
| element: this.zoomOutButton ? $.getElement( this.zoomOutButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.ZoomOut" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.zoomOut.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.zoomOut.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.zoomOut.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.zoomOut.DOWN ), | |
| onPress: beginZoomingOutHandler, | |
| onRelease: endZoomingHandler, | |
| onClick: doSingleZoomOutHandler, | |
| onEnter: beginZoomingOutHandler, | |
| onExit: endZoomingHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| })); | |
| } | |
| if ( this.showHomeControl ) { | |
| buttons.push( this.homeButton = new $.Button({ | |
| element: this.homeButton ? $.getElement( this.homeButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.Home" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.home.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.home.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.home.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.home.DOWN ), | |
| onRelease: onHomeHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| })); | |
| } | |
| if ( this.showFullPageControl ) { | |
| buttons.push( this.fullPageButton = new $.Button({ | |
| element: this.fullPageButton ? $.getElement( this.fullPageButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.FullPage" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.fullpage.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.fullpage.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.fullpage.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.fullpage.DOWN ), | |
| onRelease: onFullScreenHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| })); | |
| } | |
| if ( this.showRotationControl ) { | |
| buttons.push( this.rotateLeftButton = new $.Button({ | |
| element: this.rotateLeftButton ? $.getElement( this.rotateLeftButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.RotateLeft" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.rotateleft.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.rotateleft.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.rotateleft.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.rotateleft.DOWN ), | |
| onRelease: onRotateLeftHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| })); | |
| buttons.push( this.rotateRightButton = new $.Button({ | |
| element: this.rotateRightButton ? $.getElement( this.rotateRightButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.RotateRight" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.rotateright.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.rotateright.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.rotateright.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.rotateright.DOWN ), | |
| onRelease: onRotateRightHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| })); | |
| } | |
| if ( this.showFlipControl ) { | |
| buttons.push( this.flipButton = new $.Button({ | |
| element: this.flipButton ? $.getElement( this.flipButton ) : null, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| tooltip: $.getString( "Tooltips.Flip" ), | |
| srcRest: resolveUrl( this.prefixUrl, navImages.flip.REST ), | |
| srcGroup: resolveUrl( this.prefixUrl, navImages.flip.GROUP ), | |
| srcHover: resolveUrl( this.prefixUrl, navImages.flip.HOVER ), | |
| srcDown: resolveUrl( this.prefixUrl, navImages.flip.DOWN ), | |
| onRelease: onFlipHandler, | |
| onFocus: onFocusHandler, | |
| onBlur: onBlurHandler | |
| })); | |
| } | |
| if ( useGroup ) { | |
| this.buttonGroup = new $.ButtonGroup({ | |
| buttons: buttons, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold | |
| }); | |
| this.navControl = this.buttonGroup.element; | |
| this.addHandler( 'open', $.delegate( this, lightUp ) ); | |
| if( this.toolbar ){ | |
| this.toolbar.addControl( | |
| this.navControl, | |
| {anchor: this.navigationControlAnchor || $.ControlAnchor.TOP_LEFT} | |
| ); | |
| } else { | |
| this.addControl( | |
| this.navControl, | |
| {anchor: this.navigationControlAnchor || $.ControlAnchor.TOP_LEFT} | |
| ); | |
| } | |
| } else { | |
| this.customButtons = buttons; | |
| } | |
| } | |
| return this; | |
| }, | |
| /** | |
| * Gets the active page of a sequence | |
| * @function | |
| * @returns {Number} | |
| */ | |
| currentPage: function() { | |
| return this._sequenceIndex; | |
| }, | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:page | |
| */ | |
| goToPage: function( page ){ | |
| if( this.tileSources && page >= 0 && page < this.tileSources.length ){ | |
| this._sequenceIndex = page; | |
| this._updateSequenceButtons( page ); | |
| this.open( this.tileSources[ page ] ); | |
| if( this.referenceStrip ){ | |
| this.referenceStrip.setFocus( page ); | |
| } | |
| /** | |
| * Raised when the page is changed on a viewer configured with multiple image sources (see {@link OpenSeadragon.Viewer#goToPage}). | |
| * | |
| * @event page | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {Object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Number} page - The page index. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'page', { page: page } ); | |
| } | |
| return this; | |
| }, | |
| /** | |
| * Adds an html element as an overlay to the current viewport. Useful for | |
| * highlighting words or areas of interest on an image or other zoomable | |
| * interface. Unless the viewer has been configured with the preserveOverlays | |
| * option, overlays added via this method are removed when the viewport | |
| * is closed (including in sequence mode when changing page). | |
| * @method | |
| * @param {Element|String|Object} element - A reference to an element or an id for | |
| * the element which will be overlaid. Or an Object specifying the configuration for the overlay. | |
| * If using an object, see {@link OpenSeadragon.Overlay} for a list of | |
| * all available options. | |
| * @param {OpenSeadragon.Point|OpenSeadragon.Rect} location - The point or | |
| * rectangle which will be overlaid. This is a viewport relative location. | |
| * @param {OpenSeadragon.Placement} [placement=OpenSeadragon.Placement.TOP_LEFT] - The position of the | |
| * viewport which the location coordinates will be treated as relative | |
| * to. | |
| * @param {function} [onDraw] - If supplied the callback is called when the overlay | |
| * needs to be drawn. It is the responsibility of the callback to do any drawing/positioning. | |
| * It is passed position, size and element. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:add-overlay | |
| */ | |
| addOverlay: function( element, location, placement, onDraw ) { | |
| var options; | |
| if( $.isPlainObject( element ) ){ | |
| options = element; | |
| } else { | |
| options = { | |
| element: element, | |
| location: location, | |
| placement: placement, | |
| onDraw: onDraw | |
| }; | |
| } | |
| element = $.getElement( options.element ); | |
| if ( getOverlayIndex( this.currentOverlays, element ) >= 0 ) { | |
| // they're trying to add a duplicate overlay | |
| return this; | |
| } | |
| var overlay = getOverlayObject( this, options); | |
| this.currentOverlays.push(overlay); | |
| overlay.drawHTML( this.overlaysContainer, this.viewport ); | |
| /** | |
| * Raised when an overlay is added to the viewer (see {@link OpenSeadragon.Viewer#addOverlay}). | |
| * | |
| * @event add-overlay | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {Element} element - The overlay element. | |
| * @property {OpenSeadragon.Point|OpenSeadragon.Rect} location | |
| * @property {OpenSeadragon.Placement} placement | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'add-overlay', { | |
| element: element, | |
| location: options.location, | |
| placement: options.placement | |
| }); | |
| return this; | |
| }, | |
| /** | |
| * Updates the overlay represented by the reference to the element or | |
| * element id moving it to the new location, relative to the new placement. | |
| * @method | |
| * @param {Element|String} element - A reference to an element or an id for | |
| * the element which is overlaid. | |
| * @param {OpenSeadragon.Point|OpenSeadragon.Rect} location - The point or | |
| * rectangle which will be overlaid. This is a viewport relative location. | |
| * @param {OpenSeadragon.Placement} [placement=OpenSeadragon.Placement.TOP_LEFT] - The position of the | |
| * viewport which the location coordinates will be treated as relative | |
| * to. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:update-overlay | |
| */ | |
| updateOverlay: function( element, location, placement ) { | |
| var i; | |
| element = $.getElement( element ); | |
| i = getOverlayIndex( this.currentOverlays, element ); | |
| if ( i >= 0 ) { | |
| this.currentOverlays[ i ].update( location, placement ); | |
| THIS[ this.hash ].forceRedraw = true; | |
| /** | |
| * Raised when an overlay's location or placement changes | |
| * (see {@link OpenSeadragon.Viewer#updateOverlay}). | |
| * | |
| * @event update-overlay | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the | |
| * Viewer which raised the event. | |
| * @property {Element} element | |
| * @property {OpenSeadragon.Point|OpenSeadragon.Rect} location | |
| * @property {OpenSeadragon.Placement} placement | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'update-overlay', { | |
| element: element, | |
| location: location, | |
| placement: placement | |
| }); | |
| } | |
| return this; | |
| }, | |
| /** | |
| * Removes an overlay identified by the reference element or element id | |
| * and schedules an update. | |
| * @method | |
| * @param {Element|String} element - A reference to the element or an | |
| * element id which represent the ovelay content to be removed. | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:remove-overlay | |
| */ | |
| removeOverlay: function( element ) { | |
| var i; | |
| element = $.getElement( element ); | |
| i = getOverlayIndex( this.currentOverlays, element ); | |
| if ( i >= 0 ) { | |
| this.currentOverlays[ i ].destroy(); | |
| this.currentOverlays.splice( i, 1 ); | |
| THIS[ this.hash ].forceRedraw = true; | |
| /** | |
| * Raised when an overlay is removed from the viewer | |
| * (see {@link OpenSeadragon.Viewer#removeOverlay}). | |
| * | |
| * @event remove-overlay | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the | |
| * Viewer which raised the event. | |
| * @property {Element} element - The overlay element. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'remove-overlay', { | |
| element: element | |
| }); | |
| } | |
| return this; | |
| }, | |
| /** | |
| * Removes all currently configured Overlays from this Viewer and schedules | |
| * an update. | |
| * @method | |
| * @returns {OpenSeadragon.Viewer} Chainable. | |
| * @fires OpenSeadragon.Viewer.event:clear-overlay | |
| */ | |
| clearOverlays: function() { | |
| while ( this.currentOverlays.length > 0 ) { | |
| this.currentOverlays.pop().destroy(); | |
| } | |
| THIS[ this.hash ].forceRedraw = true; | |
| /** | |
| * Raised when all overlays are removed from the viewer (see {@link OpenSeadragon.Drawer#clearOverlays}). | |
| * | |
| * @event clear-overlay | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'clear-overlay', {} ); | |
| return this; | |
| }, | |
| /** | |
| * Finds an overlay identified by the reference element or element id | |
| * and returns it as an object, return null if not found. | |
| * @method | |
| * @param {Element|String} element - A reference to the element or an | |
| * element id which represents the overlay content. | |
| * @returns {OpenSeadragon.Overlay} the matching overlay or null if none found. | |
| */ | |
| getOverlayById: function( element ) { | |
| var i; | |
| element = $.getElement( element ); | |
| i = getOverlayIndex( this.currentOverlays, element ); | |
| if (i >= 0) { | |
| return this.currentOverlays[i]; | |
| } else { | |
| return null; | |
| } | |
| }, | |
| /** | |
| * Updates the sequence buttons. | |
| * @function OpenSeadragon.Viewer.prototype._updateSequenceButtons | |
| * @private | |
| * @param {Number} Sequence Value | |
| */ | |
| _updateSequenceButtons: function( page ) { | |
| if ( this.nextButton ) { | |
| if(!this.tileSources || this.tileSources.length - 1 === page) { | |
| //Disable next button | |
| if ( !this.navPrevNextWrap ) { | |
| this.nextButton.disable(); | |
| } | |
| } else { | |
| this.nextButton.enable(); | |
| } | |
| } | |
| if ( this.previousButton ) { | |
| if ( page > 0 ) { | |
| //Enable previous button | |
| this.previousButton.enable(); | |
| } else { | |
| if ( !this.navPrevNextWrap ) { | |
| this.previousButton.disable(); | |
| } | |
| } | |
| } | |
| }, | |
| /** | |
| * Display a message in the viewport | |
| * @function OpenSeadragon.Viewer.prototype._showMessage | |
| * @private | |
| * @param {String} text message | |
| */ | |
| _showMessage: function ( message ) { | |
| this._hideMessage(); | |
| var div = $.makeNeutralElement( "div" ); | |
| div.appendChild( document.createTextNode( message ) ); | |
| this.messageDiv = $.makeCenteredNode( div ); | |
| $.addClass(this.messageDiv, "openseadragon-message"); | |
| this.container.appendChild( this.messageDiv ); | |
| }, | |
| /** | |
| * Hide any currently displayed viewport message | |
| * @function OpenSeadragon.Viewer.prototype._hideMessage | |
| * @private | |
| */ | |
| _hideMessage: function () { | |
| var div = this.messageDiv; | |
| if (div) { | |
| div.parentNode.removeChild(div); | |
| delete this.messageDiv; | |
| } | |
| }, | |
| /** | |
| * Gets this viewer's gesture settings for the given pointer device type. | |
| * @method | |
| * @param {String} type - The pointer device type to get the gesture settings for ("mouse", "touch", "pen", etc.). | |
| * @returns {OpenSeadragon.GestureSettings} | |
| */ | |
| gestureSettingsByDeviceType: function ( type ) { | |
| switch ( type ) { | |
| case 'mouse': | |
| return this.gestureSettingsMouse; | |
| case 'touch': | |
| return this.gestureSettingsTouch; | |
| case 'pen': | |
| return this.gestureSettingsPen; | |
| default: | |
| return this.gestureSettingsUnknown; | |
| } | |
| }, | |
| // private | |
| _drawOverlays: function() { | |
| var i, | |
| length = this.currentOverlays.length; | |
| for ( i = 0; i < length; i++ ) { | |
| this.currentOverlays[ i ].drawHTML( this.overlaysContainer, this.viewport ); | |
| } | |
| }, | |
| /** | |
| * Cancel the "in flight" images. | |
| */ | |
| _cancelPendingImages: function() { | |
| this._loadQueue = []; | |
| }, | |
| /** | |
| * Removes the reference strip and disables displaying it. | |
| * @function | |
| */ | |
| removeReferenceStrip: function() { | |
| this.showReferenceStrip = false; | |
| if (this.referenceStrip) { | |
| this.referenceStrip.destroy(); | |
| this.referenceStrip = null; | |
| } | |
| }, | |
| /** | |
| * Enables and displays the reference strip based on the currently set tileSources. | |
| * Works only when the Viewer has sequenceMode set to true. | |
| * @function | |
| */ | |
| addReferenceStrip: function() { | |
| this.showReferenceStrip = true; | |
| if (this.sequenceMode) { | |
| if (this.referenceStrip) { | |
| return; | |
| } | |
| if (this.tileSources.length && this.tileSources.length > 1) { | |
| this.referenceStrip = new $.ReferenceStrip({ | |
| id: this.referenceStripElement, | |
| position: this.referenceStripPosition, | |
| sizeRatio: this.referenceStripSizeRatio, | |
| scroll: this.referenceStripScroll, | |
| height: this.referenceStripHeight, | |
| width: this.referenceStripWidth, | |
| tileSources: this.tileSources, | |
| prefixUrl: this.prefixUrl, | |
| viewer: this | |
| }); | |
| this.referenceStrip.setFocus( this._sequenceIndex ); | |
| } | |
| } else { | |
| $.console.warn('Attempting to display a reference strip while "sequenceMode" is off.'); | |
| } | |
| }, | |
| /** | |
| * Adds _updatePixelDensityRatio to the window resize event. | |
| * @private | |
| */ | |
| _addUpdatePixelDensityRatioEvent: function() { | |
| this._updatePixelDensityRatioBind = this._updatePixelDensityRatio.bind(this); | |
| $.addEvent( window, 'resize', this._updatePixelDensityRatioBind ); | |
| }, | |
| /** | |
| * Removes _updatePixelDensityRatio from the window resize event. | |
| * @private | |
| */ | |
| _removeUpdatePixelDensityRatioEvent: function() { | |
| $.removeEvent( window, 'resize', this._updatePixelDensityRatioBind ); | |
| }, | |
| /** | |
| * Update pixel density ratio and forces a resize operation. | |
| * @private | |
| */ | |
| _updatePixelDensityRatio: function() { | |
| var previusPixelDensityRatio = $.pixelDensityRatio; | |
| var currentPixelDensityRatio = $.getCurrentPixelDensityRatio(); | |
| if (previusPixelDensityRatio !== currentPixelDensityRatio) { | |
| $.pixelDensityRatio = currentPixelDensityRatio; | |
| this.forceResize(); | |
| } | |
| }, | |
| /** | |
| * Sets the image source to the source with index equal to | |
| * currentIndex - 1. Changes current image in sequence mode. | |
| * If specified, wraps around (see navPrevNextWrap in | |
| * {@link OpenSeadragon.Options}) | |
| * | |
| * @method | |
| */ | |
| goToPreviousPage: function () { | |
| var previous = this._sequenceIndex - 1; | |
| if(this.navPrevNextWrap && previous < 0){ | |
| previous += this.tileSources.length; | |
| } | |
| this.goToPage( previous ); | |
| }, | |
| /** | |
| * Sets the image source to the source with index equal to | |
| * currentIndex + 1. Changes current image in sequence mode. | |
| * If specified, wraps around (see navPrevNextWrap in | |
| * {@link OpenSeadragon.Options}) | |
| * | |
| * @method | |
| */ | |
| goToNextPage: function () { | |
| var next = this._sequenceIndex + 1; | |
| if(this.navPrevNextWrap && next >= this.tileSources.length){ | |
| next = 0; | |
| } | |
| this.goToPage( next ); | |
| }, | |
| isAnimating: function () { | |
| return THIS[ this.hash ].animating; | |
| }, | |
| /** | |
| * Starts continuous zoom-in animation (typically bound to mouse-down on the zoom-in button). | |
| * @function | |
| * @memberof OpenSeadragon.Viewer.prototype | |
| */ | |
| startZoomInAction: function () { | |
| THIS[ this.hash ].lastZoomTime = $.now(); | |
| THIS[ this.hash ].zoomFactor = this.zoomPerSecond; | |
| THIS[ this.hash ].zooming = true; | |
| scheduleZoom( this ); | |
| }, | |
| /** | |
| * Starts continuous zoom-out animation (typically bound to mouse-down on the zoom-out button). | |
| * @function | |
| * @memberof OpenSeadragon.Viewer.prototype | |
| */ | |
| startZoomOutAction: function () { | |
| THIS[ this.hash ].lastZoomTime = $.now(); | |
| THIS[ this.hash ].zoomFactor = 1.0 / this.zoomPerSecond; | |
| THIS[ this.hash ].zooming = true; | |
| scheduleZoom( this ); | |
| }, | |
| /** | |
| * Stops any continuous zoom animation (typically bound to mouse-up/leave events on a button). | |
| * @function | |
| * @memberof OpenSeadragon.Viewer.prototype | |
| */ | |
| endZoomAction: function () { | |
| THIS[ this.hash ].zooming = false; | |
| }, | |
| /** | |
| * Performs single-step zoom-in operation (typically bound to click/enter on the zoom-in button). | |
| * @function | |
| * @memberof OpenSeadragon.Viewer.prototype | |
| */ | |
| singleZoomInAction: function () { | |
| if ( this.viewport ) { | |
| THIS[ this.hash ].zooming = false; | |
| this.viewport.zoomBy( | |
| this.zoomPerClick / 1.0 | |
| ); | |
| this.viewport.applyConstraints(); | |
| } | |
| }, | |
| /** | |
| * Performs single-step zoom-out operation (typically bound to click/enter on the zoom-out button). | |
| * @function | |
| * @memberof OpenSeadragon.Viewer.prototype | |
| */ | |
| singleZoomOutAction: function () { | |
| if ( this.viewport ) { | |
| THIS[ this.hash ].zooming = false; | |
| this.viewport.zoomBy( | |
| 1.0 / this.zoomPerClick | |
| ); | |
| this.viewport.applyConstraints(); | |
| } | |
| }, | |
| }); | |
| /** | |
| * _getSafeElemSize is like getElementSize(), but refuses to return 0 for x or y, | |
| * which was causing some calling operations to return NaN. | |
| * @returns {Point} | |
| * @private | |
| */ | |
| function _getSafeElemSize (oElement) { | |
| oElement = $.getElement( oElement ); | |
| return new $.Point( | |
| (oElement.clientWidth === 0 ? 1 : oElement.clientWidth), | |
| (oElement.clientHeight === 0 ? 1 : oElement.clientHeight) | |
| ); | |
| } | |
| /** | |
| * @function | |
| * @private | |
| */ | |
| function getTileSourceImplementation( viewer, tileSource, imgOptions, successCallback, | |
| failCallback ) { | |
| var _this = viewer; | |
| //allow plain xml strings or json strings to be parsed here | |
| if ( $.type( tileSource ) === 'string' ) { | |
| //xml should start with "<" and end with ">" | |
| if ( tileSource.match( /^\s*<.*>\s*$/ ) ) { | |
| tileSource = $.parseXml( tileSource ); | |
| //json should start with "{" or "[" and end with "}" or "]" | |
| } else if ( tileSource.match(/^\s*[{[].*[}\]]\s*$/ ) ) { | |
| try { | |
| var tileSourceJ = $.parseJSON(tileSource); | |
| tileSource = tileSourceJ; | |
| } catch (e) { | |
| //tileSource = tileSource; | |
| } | |
| } | |
| } | |
| function waitUntilReady(tileSource, originalTileSource) { | |
| if (tileSource.ready) { | |
| successCallback(tileSource); | |
| } else { | |
| tileSource.addHandler('ready', function () { | |
| successCallback(tileSource); | |
| }); | |
| tileSource.addHandler('open-failed', function (event) { | |
| failCallback({ | |
| message: event.message, | |
| source: originalTileSource | |
| }); | |
| }); | |
| } | |
| } | |
| setTimeout( function() { | |
| if ( $.type( tileSource ) === 'string' ) { | |
| //If its still a string it means it must be a url at this point | |
| tileSource = new $.TileSource({ | |
| url: tileSource, | |
| crossOriginPolicy: imgOptions.crossOriginPolicy !== undefined ? | |
| imgOptions.crossOriginPolicy : viewer.crossOriginPolicy, | |
| ajaxWithCredentials: viewer.ajaxWithCredentials, | |
| ajaxHeaders: imgOptions.ajaxHeaders ? | |
| imgOptions.ajaxHeaders : viewer.ajaxHeaders, | |
| splitHashDataForPost: viewer.splitHashDataForPost, | |
| success: function( event ) { | |
| successCallback( event.tileSource ); | |
| } | |
| }); | |
| tileSource.addHandler( 'open-failed', function( event ) { | |
| failCallback( event ); | |
| } ); | |
| } else if ($.isPlainObject(tileSource) || tileSource.nodeType) { | |
| if (tileSource.crossOriginPolicy === undefined && | |
| (imgOptions.crossOriginPolicy !== undefined || viewer.crossOriginPolicy !== undefined)) { | |
| tileSource.crossOriginPolicy = imgOptions.crossOriginPolicy !== undefined ? | |
| imgOptions.crossOriginPolicy : viewer.crossOriginPolicy; | |
| } | |
| if (tileSource.ajaxWithCredentials === undefined) { | |
| tileSource.ajaxWithCredentials = viewer.ajaxWithCredentials; | |
| } | |
| if ( $.isFunction( tileSource.getTileUrl ) ) { | |
| //Custom tile source | |
| var customTileSource = new $.TileSource( tileSource ); | |
| customTileSource.getTileUrl = tileSource.getTileUrl; | |
| successCallback( customTileSource ); | |
| } else { | |
| //inline configuration | |
| var $TileSource = $.TileSource.determineType( _this, tileSource ); | |
| if ( !$TileSource ) { | |
| failCallback( { | |
| message: "Unable to load TileSource", | |
| source: tileSource | |
| }); | |
| return; | |
| } | |
| var options = $TileSource.prototype.configure.apply( _this, [ tileSource ] ); | |
| waitUntilReady(new $TileSource(options), tileSource); | |
| } | |
| } else { | |
| //can assume it's already a tile source implementation, force inheritance | |
| waitUntilReady(tileSource, tileSource); | |
| } | |
| }); | |
| } | |
| function getOverlayObject( viewer, overlay ) { | |
| if ( overlay instanceof $.Overlay ) { | |
| return overlay; | |
| } | |
| var element = null; | |
| if ( overlay.element ) { | |
| element = $.getElement( overlay.element ); | |
| } else { | |
| var id = overlay.id ? | |
| overlay.id : | |
| "openseadragon-overlay-" + Math.floor( Math.random() * 10000000 ); | |
| element = $.getElement( overlay.id ); | |
| if ( !element ) { | |
| element = document.createElement( "a" ); | |
| element.href = "#/overlay/" + id; | |
| } | |
| element.id = id; | |
| $.addClass( element, overlay.className ? | |
| overlay.className : | |
| "openseadragon-overlay" | |
| ); | |
| } | |
| var location = overlay.location; | |
| var width = overlay.width; | |
| var height = overlay.height; | |
| if (!location) { | |
| var x = overlay.x; | |
| var y = overlay.y; | |
| if (overlay.px !== undefined) { | |
| var rect = viewer.viewport.imageToViewportRectangle(new $.Rect( | |
| overlay.px, | |
| overlay.py, | |
| width || 0, | |
| height || 0)); | |
| x = rect.x; | |
| y = rect.y; | |
| width = width !== undefined ? rect.width : undefined; | |
| height = height !== undefined ? rect.height : undefined; | |
| } | |
| location = new $.Point(x, y); | |
| } | |
| var placement = overlay.placement; | |
| if (placement && $.type(placement) === "string") { | |
| placement = $.Placement[overlay.placement.toUpperCase()]; | |
| } | |
| return new $.Overlay({ | |
| element: element, | |
| location: location, | |
| placement: placement, | |
| onDraw: overlay.onDraw, | |
| checkResize: overlay.checkResize, | |
| width: width, | |
| height: height, | |
| rotationMode: overlay.rotationMode | |
| }); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * Determines the index of the given overlay in the given overlays array. | |
| */ | |
| function getOverlayIndex( overlays, element ) { | |
| var i; | |
| for ( i = overlays.length - 1; i >= 0; i-- ) { | |
| if ( overlays[ i ].element === element ) { | |
| return i; | |
| } | |
| } | |
| return -1; | |
| } | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Schedulers provide the general engine for animation | |
| /////////////////////////////////////////////////////////////////////////////// | |
| function scheduleUpdate( viewer, updateFunc ){ | |
| return $.requestAnimationFrame( function(){ | |
| updateFunc( viewer ); | |
| } ); | |
| } | |
| //provides a sequence in the fade animation | |
| function scheduleControlsFade( viewer ) { | |
| $.requestAnimationFrame( function(){ | |
| updateControlsFade( viewer ); | |
| }); | |
| } | |
| //initiates an animation to hide the controls | |
| function beginControlsAutoHide( viewer ) { | |
| if ( !viewer.autoHideControls ) { | |
| return; | |
| } | |
| viewer.controlsShouldFade = true; | |
| viewer.controlsFadeBeginTime = | |
| $.now() + | |
| viewer.controlsFadeDelay; | |
| window.setTimeout( function(){ | |
| scheduleControlsFade( viewer ); | |
| }, viewer.controlsFadeDelay ); | |
| } | |
| //determines if fade animation is done or continues the animation | |
| function updateControlsFade( viewer ) { | |
| var currentTime, | |
| deltaTime, | |
| opacity, | |
| i; | |
| if ( viewer.controlsShouldFade ) { | |
| currentTime = $.now(); | |
| deltaTime = currentTime - viewer.controlsFadeBeginTime; | |
| opacity = 1.0 - deltaTime / viewer.controlsFadeLength; | |
| opacity = Math.min( 1.0, opacity ); | |
| opacity = Math.max( 0.0, opacity ); | |
| for ( i = viewer.controls.length - 1; i >= 0; i--) { | |
| if (viewer.controls[ i ].autoFade) { | |
| viewer.controls[ i ].setOpacity( opacity ); | |
| } | |
| } | |
| if ( opacity > 0 ) { | |
| // fade again | |
| scheduleControlsFade( viewer ); | |
| } | |
| } | |
| } | |
| //stop the fade animation on the controls and show them | |
| function abortControlsAutoHide( viewer ) { | |
| var i; | |
| viewer.controlsShouldFade = false; | |
| for ( i = viewer.controls.length - 1; i >= 0; i-- ) { | |
| viewer.controls[ i ].setOpacity( 1.0 ); | |
| } | |
| } | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Default view event handlers. | |
| /////////////////////////////////////////////////////////////////////////////// | |
| function onFocus(){ | |
| abortControlsAutoHide( this ); | |
| } | |
| function onBlur(){ | |
| beginControlsAutoHide( this ); | |
| } | |
| function onCanvasContextMenu( event ) { | |
| var eventArgs = { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| originalEvent: event.originalEvent, | |
| preventDefault: event.preventDefault | |
| }; | |
| /** | |
| * Raised when a contextmenu event occurs in the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-contextmenu | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefault - Set to true to prevent the default user-agent's handling of the contextmenu event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-contextmenu', eventArgs ); | |
| event.preventDefault = eventArgs.preventDefault; | |
| } | |
| function onCanvasKeyDown( event ) { | |
| var canvasKeyDownEventArgs = { | |
| originalEvent: event.originalEvent, | |
| preventDefaultAction: false, | |
| preventVerticalPan: event.preventVerticalPan || !this.panVertical, | |
| preventHorizontalPan: event.preventHorizontalPan || !this.panHorizontal | |
| }; | |
| /** | |
| * Raised when a keyboard key is pressed and the focus is on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-key | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default keyboard behaviour. Default: false. | |
| * @property {Boolean} preventVerticalPan - Set to true to prevent keyboard vertical panning. Default: false. | |
| * @property {Boolean} preventHorizontalPan - Set to true to prevent keyboard horizontal panning. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent('canvas-key', canvasKeyDownEventArgs); | |
| if ( !canvasKeyDownEventArgs.preventDefaultAction && !event.ctrl && !event.alt && !event.meta ) { | |
| switch( event.keyCode ){ | |
| case 38://up arrow/shift uparrow | |
| if (!canvasKeyDownEventArgs.preventVerticalPan) { | |
| if ( event.shift ) { | |
| this.viewport.zoomBy(1.1); | |
| } else { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(0, -this.pixelsPerArrowPress))); | |
| } | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 40://down arrow/shift downarrow | |
| if (!canvasKeyDownEventArgs.preventVerticalPan) { | |
| if ( event.shift ) { | |
| this.viewport.zoomBy(0.9); | |
| } else { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(0, this.pixelsPerArrowPress))); | |
| } | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 37://left arrow | |
| if (!canvasKeyDownEventArgs.preventHorizontalPan) { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(-this.pixelsPerArrowPress, 0))); | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 39://right arrow | |
| if (!canvasKeyDownEventArgs.preventHorizontalPan) { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(this.pixelsPerArrowPress, 0))); | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 187://=|+ | |
| this.viewport.zoomBy(1.1); | |
| this.viewport.applyConstraints(); | |
| event.preventDefault = true; | |
| break; | |
| case 189://-|_ | |
| this.viewport.zoomBy(0.9); | |
| this.viewport.applyConstraints(); | |
| event.preventDefault = true; | |
| break; | |
| case 48://0|) | |
| this.viewport.goHome(); | |
| this.viewport.applyConstraints(); | |
| event.preventDefault = true; | |
| break; | |
| case 87://W/w | |
| if (!canvasKeyDownEventArgs.preventVerticalPan) { | |
| if ( event.shift ) { | |
| this.viewport.zoomBy(1.1); | |
| } else { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(0, -40))); | |
| } | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 83://S/s | |
| if (!canvasKeyDownEventArgs.preventVerticalPan) { | |
| if ( event.shift ) { | |
| this.viewport.zoomBy(0.9); | |
| } else { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(0, 40))); | |
| } | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 65://a/A | |
| if (!canvasKeyDownEventArgs.preventHorizontalPan) { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(-40, 0))); | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 68://d/D | |
| if (!canvasKeyDownEventArgs.preventHorizontalPan) { | |
| this.viewport.panBy(this.viewport.deltaPointsFromPixels(new $.Point(40, 0))); | |
| this.viewport.applyConstraints(); | |
| } | |
| event.preventDefault = true; | |
| break; | |
| case 82: //r - clockwise rotation/R - counterclockwise rotation | |
| if(event.shift){ | |
| if(this.viewport.flipped){ | |
| this.viewport.setRotation(this.viewport.getRotation() + this.rotationIncrement); | |
| } else{ | |
| this.viewport.setRotation(this.viewport.getRotation() - this.rotationIncrement); | |
| } | |
| }else{ | |
| if(this.viewport.flipped){ | |
| this.viewport.setRotation(this.viewport.getRotation() - this.rotationIncrement); | |
| } else{ | |
| this.viewport.setRotation(this.viewport.getRotation() + this.rotationIncrement); | |
| } | |
| } | |
| this.viewport.applyConstraints(); | |
| event.preventDefault = true; | |
| break; | |
| case 70: //f/F | |
| this.viewport.toggleFlip(); | |
| event.preventDefault = true; | |
| break; | |
| case 74: //j - previous image source | |
| this.goToPreviousPage(); | |
| break; | |
| case 75: //k - next image source | |
| this.goToNextPage(); | |
| break; | |
| default: | |
| //console.log( 'navigator keycode %s', event.keyCode ); | |
| event.preventDefault = false; | |
| break; | |
| } | |
| } else { | |
| event.preventDefault = false; | |
| } | |
| } | |
| function onCanvasKeyPress( event ) { | |
| var canvasKeyPressEventArgs = { | |
| originalEvent: event.originalEvent, | |
| }; | |
| /** | |
| * Raised when a keyboard key is pressed and the focus is on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-key-press | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent('canvas-key-press', canvasKeyPressEventArgs); | |
| } | |
| function onCanvasClick( event ) { | |
| var gestureSettings; | |
| var haveKeyboardFocus = document.activeElement === this.canvas; | |
| // If we don't have keyboard focus, request it. | |
| if ( !haveKeyboardFocus ) { | |
| this.canvas.focus(); | |
| } | |
| if(this.viewport.flipped){ | |
| event.position.x = this.viewport.getContainerSize().x - event.position.x; | |
| } | |
| var canvasClickEventArgs = { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| quick: event.quick, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| originalTarget: event.originalTarget, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when a mouse press/release or touch/remove occurs on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-click | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Boolean} quick - True only if the clickDistThreshold and clickTimeThreshold are both passed. Useful for differentiating between clicks and drags. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Element} originalTarget - The DOM element clicked on. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default click to zoom behaviour. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-click', canvasClickEventArgs); | |
| if ( !canvasClickEventArgs.preventDefaultAction && this.viewport && event.quick ) { | |
| gestureSettings = this.gestureSettingsByDeviceType( event.pointerType ); | |
| if (gestureSettings.clickToZoom === true){ | |
| this.viewport.zoomBy( | |
| event.shift ? 1.0 / this.zoomPerClick : this.zoomPerClick, | |
| gestureSettings.zoomToRefPoint ? this.viewport.pointFromPixel( event.position, true ) : null | |
| ); | |
| this.viewport.applyConstraints(); | |
| } | |
| if( gestureSettings.dblClickDragToZoom){ | |
| if(THIS[ this.hash ].draggingToZoom === true){ | |
| THIS[ this.hash ].lastClickTime = null; | |
| THIS[ this.hash ].draggingToZoom = false; | |
| } | |
| else{ | |
| THIS[ this.hash ].lastClickTime = $.now(); | |
| } | |
| } | |
| } | |
| } | |
| function onCanvasDblClick( event ) { | |
| var gestureSettings; | |
| var canvasDblClickEventArgs = { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when a double mouse press/release or touch/remove occurs on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-double-click | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default double tap to zoom behaviour. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-double-click', canvasDblClickEventArgs); | |
| if ( !canvasDblClickEventArgs.preventDefaultAction && this.viewport ) { | |
| gestureSettings = this.gestureSettingsByDeviceType( event.pointerType ); | |
| if ( gestureSettings.dblClickToZoom ) { | |
| this.viewport.zoomBy( | |
| event.shift ? 1.0 / this.zoomPerClick : this.zoomPerClick, | |
| gestureSettings.zoomToRefPoint ? this.viewport.pointFromPixel( event.position, true ) : null | |
| ); | |
| this.viewport.applyConstraints(); | |
| } | |
| } | |
| } | |
| function onCanvasDrag( event ) { | |
| var gestureSettings; | |
| var canvasDragEventArgs = { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| delta: event.delta, | |
| speed: event.speed, | |
| direction: event.direction, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when a mouse or touch drag operation occurs on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-drag | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {OpenSeadragon.Point} delta - The x,y components of the difference between start drag and end drag. | |
| * @property {Number} speed - Current computed speed, in pixels per second. | |
| * @property {Number} direction - Current computed direction, expressed as an angle counterclockwise relative to the positive X axis (-pi to pi, in radians). Only valid if speed > 0. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default drag to pan behaviour. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-drag', canvasDragEventArgs); | |
| gestureSettings = this.gestureSettingsByDeviceType( event.pointerType ); | |
| if(!canvasDragEventArgs.preventDefaultAction && this.viewport){ | |
| if (gestureSettings.dblClickDragToZoom && THIS[ this.hash ].draggingToZoom){ | |
| var factor = Math.pow( this.zoomPerDblClickDrag, event.delta.y / 50); | |
| this.viewport.zoomBy(factor); | |
| } | |
| else if (gestureSettings.dragToPan && !THIS[ this.hash ].draggingToZoom) { | |
| if( !this.panHorizontal ){ | |
| event.delta.x = 0; | |
| } | |
| if( !this.panVertical ){ | |
| event.delta.y = 0; | |
| } | |
| if(this.viewport.flipped){ | |
| event.delta.x = -event.delta.x; | |
| } | |
| if( this.constrainDuringPan ){ | |
| var delta = this.viewport.deltaPointsFromPixels( event.delta.negate() ); | |
| this.viewport.centerSpringX.target.value += delta.x; | |
| this.viewport.centerSpringY.target.value += delta.y; | |
| var constrainedBounds = this.viewport.getConstrainedBounds(); | |
| this.viewport.centerSpringX.target.value -= delta.x; | |
| this.viewport.centerSpringY.target.value -= delta.y; | |
| if (constrainedBounds.xConstrained) { | |
| event.delta.x = 0; | |
| } | |
| if (constrainedBounds.yConstrained) { | |
| event.delta.y = 0; | |
| } | |
| } | |
| this.viewport.panBy( this.viewport.deltaPointsFromPixels( event.delta.negate() ), gestureSettings.flickEnabled && !this.constrainDuringPan); | |
| } | |
| } | |
| } | |
| function onCanvasDragEnd( event ) { | |
| var gestureSettings; | |
| var canvasDragEndEventArgs = { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| speed: event.speed, | |
| direction: event.direction, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when a mouse or touch drag operation ends on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-drag-end | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Number} speed - Speed at the end of a drag gesture, in pixels per second. | |
| * @property {Number} direction - Direction at the end of a drag gesture, expressed as an angle counterclockwise relative to the positive X axis (-pi to pi, in radians). Only valid if speed > 0. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default drag-end flick behaviour. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent('canvas-drag-end', canvasDragEndEventArgs); | |
| gestureSettings = this.gestureSettingsByDeviceType( event.pointerType ); | |
| if (!canvasDragEndEventArgs.preventDefaultAction && this.viewport) { | |
| if ( !THIS[ this.hash ].draggingToZoom && | |
| gestureSettings.dragToPan && | |
| gestureSettings.flickEnabled && | |
| event.speed >= gestureSettings.flickMinSpeed) { | |
| var amplitudeX = 0; | |
| if (this.panHorizontal) { | |
| amplitudeX = gestureSettings.flickMomentum * event.speed * | |
| Math.cos(event.direction); | |
| } | |
| var amplitudeY = 0; | |
| if (this.panVertical) { | |
| amplitudeY = gestureSettings.flickMomentum * event.speed * | |
| Math.sin(event.direction); | |
| } | |
| var center = this.viewport.pixelFromPoint( | |
| this.viewport.getCenter(true)); | |
| var target = this.viewport.pointFromPixel( | |
| new $.Point(center.x - amplitudeX, center.y - amplitudeY)); | |
| this.viewport.panTo(target, false); | |
| } | |
| this.viewport.applyConstraints(); | |
| } | |
| if( gestureSettings.dblClickDragToZoom && THIS[ this.hash ].draggingToZoom === true ){ | |
| THIS[ this.hash ].draggingToZoom = false; | |
| } | |
| } | |
| function onCanvasEnter( event ) { | |
| /** | |
| * Raised when a pointer enters the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-enter | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Number} buttons - Current buttons pressed. A combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @property {Number} pointers - Number of pointers (all types) active in the tracked element. | |
| * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. | |
| * @property {Boolean} buttonDownAny - Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-enter', { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| buttons: event.buttons, | |
| pointers: event.pointers, | |
| insideElementPressed: event.insideElementPressed, | |
| buttonDownAny: event.buttonDownAny, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onCanvasLeave( event ) { | |
| /** | |
| * Raised when a pointer leaves the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-exit | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Number} buttons - Current buttons pressed. A combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @property {Number} pointers - Number of pointers (all types) active in the tracked element. | |
| * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. | |
| * @property {Boolean} buttonDownAny - Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-exit', { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| buttons: event.buttons, | |
| pointers: event.pointers, | |
| insideElementPressed: event.insideElementPressed, | |
| buttonDownAny: event.buttonDownAny, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onCanvasPress( event ) { | |
| var gestureSettings; | |
| /** | |
| * Raised when the primary mouse button is pressed or touch starts on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-press | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. | |
| * @property {Boolean} insideElementReleased - True if the cursor still inside the tracked element when the button was released. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-press', { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| insideElementPressed: event.insideElementPressed, | |
| insideElementReleased: event.insideElementReleased, | |
| originalEvent: event.originalEvent | |
| }); | |
| gestureSettings = this.gestureSettingsByDeviceType( event.pointerType ); | |
| if ( gestureSettings.dblClickDragToZoom ){ | |
| var lastClickTime = THIS[ this.hash ].lastClickTime; | |
| var currClickTime = $.now(); | |
| if ( lastClickTime === null) { | |
| return; | |
| } | |
| if ((currClickTime - lastClickTime) < this.dblClickTimeThreshold) { | |
| THIS[ this.hash ].draggingToZoom = true; | |
| } | |
| THIS[ this.hash ].lastClickTime = null; | |
| } | |
| } | |
| function onCanvasRelease( event ) { | |
| /** | |
| * Raised when the primary mouse button is released or touch ends on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-release | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. | |
| * @property {Boolean} insideElementReleased - True if the cursor still inside the tracked element when the button was released. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-release', { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| insideElementPressed: event.insideElementPressed, | |
| insideElementReleased: event.insideElementReleased, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onCanvasNonPrimaryPress( event ) { | |
| /** | |
| * Raised when any non-primary pointer button is pressed on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-nonprimary-press | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {Number} button - Button which caused the event. | |
| * -1: none, 0: primary/left, 1: aux/middle, 2: secondary/right, 3: X1/back, 4: X2/forward, 5: pen eraser. | |
| * @property {Number} buttons - Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-nonprimary-press', { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| pointerType: event.pointerType, | |
| button: event.button, | |
| buttons: event.buttons, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onCanvasNonPrimaryRelease( event ) { | |
| /** | |
| * Raised when any non-primary pointer button is released on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-nonprimary-release | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {Number} button - Button which caused the event. | |
| * -1: none, 0: primary/left, 1: aux/middle, 2: secondary/right, 3: X1/back, 4: X2/forward, 5: pen eraser. | |
| * @property {Number} buttons - Current buttons pressed. | |
| * Combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-nonprimary-release', { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| pointerType: event.pointerType, | |
| button: event.button, | |
| buttons: event.buttons, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onCanvasPinch( event ) { | |
| var gestureSettings, | |
| centerPt, | |
| lastCenterPt, | |
| panByPt; | |
| var canvasPinchEventArgs = { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| gesturePoints: event.gesturePoints, | |
| lastCenter: event.lastCenter, | |
| center: event.center, | |
| lastDistance: event.lastDistance, | |
| distance: event.distance, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefaultPanAction: false, | |
| preventDefaultZoomAction: false, | |
| preventDefaultRotateAction: false | |
| }; | |
| /** | |
| * Raised when a pinch event occurs on the {@link OpenSeadragon.Viewer#canvas} element. | |
| * | |
| * @event canvas-pinch | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {Array.<OpenSeadragon.MouseTracker.GesturePoint>} gesturePoints - Gesture points associated with the gesture. Velocity data can be found here. | |
| * @property {OpenSeadragon.Point} lastCenter - The previous center point of the two pinch contact points relative to the tracked element. | |
| * @property {OpenSeadragon.Point} center - The center point of the two pinch contact points relative to the tracked element. | |
| * @property {Number} lastDistance - The previous distance between the two pinch contact points in CSS pixels. | |
| * @property {Number} distance - The distance between the two pinch contact points in CSS pixels. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefaultPanAction - Set to true to prevent default pinch to pan behaviour. Default: false. | |
| * @property {Boolean} preventDefaultZoomAction - Set to true to prevent default pinch to zoom behaviour. Default: false. | |
| * @property {Boolean} preventDefaultRotateAction - Set to true to prevent default pinch to rotate behaviour. Default: false. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent('canvas-pinch', canvasPinchEventArgs); | |
| if ( this.viewport ) { | |
| gestureSettings = this.gestureSettingsByDeviceType( event.pointerType ); | |
| if ( gestureSettings.pinchToZoom && | |
| (!canvasPinchEventArgs.preventDefaultPanAction || !canvasPinchEventArgs.preventDefaultZoomAction) ) { | |
| centerPt = this.viewport.pointFromPixel( event.center, true ); | |
| if ( gestureSettings.zoomToRefPoint && !canvasPinchEventArgs.preventDefaultPanAction ) { | |
| lastCenterPt = this.viewport.pointFromPixel( event.lastCenter, true ); | |
| panByPt = lastCenterPt.minus( centerPt ); | |
| if( !this.panHorizontal ) { | |
| panByPt.x = 0; | |
| } | |
| if( !this.panVertical ) { | |
| panByPt.y = 0; | |
| } | |
| this.viewport.panBy(panByPt, true); | |
| } | |
| if ( !canvasPinchEventArgs.preventDefaultZoomAction ) { | |
| this.viewport.zoomBy( event.distance / event.lastDistance, centerPt, true ); | |
| } | |
| this.viewport.applyConstraints(); | |
| } | |
| if ( gestureSettings.pinchRotate && !canvasPinchEventArgs.preventDefaultRotateAction ) { | |
| // Pinch rotate | |
| var angle1 = Math.atan2(event.gesturePoints[0].currentPos.y - event.gesturePoints[1].currentPos.y, | |
| event.gesturePoints[0].currentPos.x - event.gesturePoints[1].currentPos.x); | |
| var angle2 = Math.atan2(event.gesturePoints[0].lastPos.y - event.gesturePoints[1].lastPos.y, | |
| event.gesturePoints[0].lastPos.x - event.gesturePoints[1].lastPos.x); | |
| centerPt = this.viewport.pointFromPixel( event.center, true ); | |
| this.viewport.rotateTo(this.viewport.getRotation(true) + ((angle1 - angle2) * (180 / Math.PI)), centerPt, true); | |
| } | |
| } | |
| } | |
| function onCanvasFocus( event ) { | |
| /** | |
| * Raised when the {@link OpenSeadragon.Viewer#canvas} element gets keyboard focus. | |
| * | |
| * @event canvas-focus | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-focus', { | |
| tracker: event.eventSource, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onCanvasBlur( event ) { | |
| /** | |
| * Raised when the {@link OpenSeadragon.Viewer#canvas} element loses keyboard focus. | |
| * | |
| * @event canvas-blur | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'canvas-blur', { | |
| tracker: event.eventSource, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onCanvasScroll( event ) { | |
| var canvasScrollEventArgs, | |
| gestureSettings, | |
| factor, | |
| thisScrollTime, | |
| deltaScrollTime; | |
| /* Certain scroll devices fire the scroll event way too fast so we are injecting a simple adjustment to keep things | |
| * partially normalized. If we have already fired an event within the last 'minScrollDelta' milliseconds we skip | |
| * this one and wait for the next event. */ | |
| thisScrollTime = $.now(); | |
| deltaScrollTime = thisScrollTime - this._lastScrollTime; | |
| if (deltaScrollTime > this.minScrollDeltaTime) { | |
| this._lastScrollTime = thisScrollTime; | |
| canvasScrollEventArgs = { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| scroll: event.scroll, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefaultAction: false, | |
| preventDefault: true | |
| }; | |
| /** | |
| * Raised when a scroll event occurs on the {@link OpenSeadragon.Viewer#canvas} element (mouse wheel). | |
| * | |
| * @event canvas-scroll | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Number} scroll - The scroll delta for the event. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default scroll to zoom behaviour. Default: false. | |
| * @property {Boolean} preventDefault - Set to true to prevent the default user-agent's handling of the wheel event. Default: true. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent('canvas-scroll', canvasScrollEventArgs ); | |
| if ( !canvasScrollEventArgs.preventDefaultAction && this.viewport ) { | |
| if(this.viewport.flipped){ | |
| event.position.x = this.viewport.getContainerSize().x - event.position.x; | |
| } | |
| gestureSettings = this.gestureSettingsByDeviceType( event.pointerType ); | |
| if ( gestureSettings.scrollToZoom ) { | |
| factor = Math.pow( this.zoomPerScroll, event.scroll ); | |
| this.viewport.zoomBy( | |
| factor, | |
| gestureSettings.zoomToRefPoint ? this.viewport.pointFromPixel( event.position, true ) : null | |
| ); | |
| this.viewport.applyConstraints(); | |
| } | |
| } | |
| event.preventDefault = canvasScrollEventArgs.preventDefault; | |
| } else { | |
| event.preventDefault = true; | |
| } | |
| } | |
| function onContainerEnter( event ) { | |
| THIS[ this.hash ].mouseInside = true; | |
| abortControlsAutoHide( this ); | |
| /** | |
| * Raised when the cursor enters the {@link OpenSeadragon.Viewer#container} element. | |
| * | |
| * @event container-enter | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Number} buttons - Current buttons pressed. A combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @property {Number} pointers - Number of pointers (all types) active in the tracked element. | |
| * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. | |
| * @property {Boolean} buttonDownAny - Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'container-enter', { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| buttons: event.buttons, | |
| pointers: event.pointers, | |
| insideElementPressed: event.insideElementPressed, | |
| buttonDownAny: event.buttonDownAny, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| function onContainerLeave( event ) { | |
| if ( event.pointers < 1 ) { | |
| THIS[ this.hash ].mouseInside = false; | |
| if ( !THIS[ this.hash ].animating ) { | |
| beginControlsAutoHide( this ); | |
| } | |
| } | |
| /** | |
| * Raised when the cursor leaves the {@link OpenSeadragon.Viewer#container} element. | |
| * | |
| * @event container-exit | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {String} pointerType - "mouse", "touch", "pen", etc. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Number} buttons - Current buttons pressed. A combination of bit flags 0: none, 1: primary (or touch contact), 2: secondary, 4: aux (often middle), 8: X1 (often back), 16: X2 (often forward), 32: pen eraser. | |
| * @property {Number} pointers - Number of pointers (all types) active in the tracked element. | |
| * @property {Boolean} insideElementPressed - True if the left mouse button is currently being pressed and was initiated inside the tracked element, otherwise false. | |
| * @property {Boolean} buttonDownAny - Was the button down anywhere in the screen during the event. <span style="color:red;">Deprecated. Use buttons instead.</span> | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.raiseEvent( 'container-exit', { | |
| tracker: event.eventSource, | |
| pointerType: event.pointerType, | |
| position: event.position, | |
| buttons: event.buttons, | |
| pointers: event.pointers, | |
| insideElementPressed: event.insideElementPressed, | |
| buttonDownAny: event.buttonDownAny, | |
| originalEvent: event.originalEvent | |
| }); | |
| } | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Page update routines ( aka Views - for future reference ) | |
| /////////////////////////////////////////////////////////////////////////////// | |
| function updateMulti( viewer ) { | |
| updateOnce( viewer ); | |
| // Request the next frame, unless we've been closed | |
| if ( viewer.isOpen() ) { | |
| viewer._updateRequestId = scheduleUpdate( viewer, updateMulti ); | |
| } else { | |
| viewer._updateRequestId = false; | |
| } | |
| } | |
| function doViewerResize(viewer, containerSize){ | |
| var viewport = viewer.viewport; | |
| var zoom = viewport.getZoom(); | |
| var center = viewport.getCenter(); | |
| viewport.resize(containerSize, viewer.preserveImageSizeOnResize); | |
| viewport.panTo(center, true); | |
| var resizeRatio; | |
| if (viewer.preserveImageSizeOnResize) { | |
| resizeRatio = THIS[viewer.hash].prevContainerSize.x / containerSize.x; | |
| } else { | |
| var origin = new $.Point(0, 0); | |
| var prevDiag = new $.Point(THIS[viewer.hash].prevContainerSize.x, THIS[viewer.hash].prevContainerSize.y).distanceTo(origin); | |
| var newDiag = new $.Point(containerSize.x, containerSize.y).distanceTo(origin); | |
| resizeRatio = newDiag / prevDiag * THIS[viewer.hash].prevContainerSize.x / containerSize.x; | |
| } | |
| viewport.zoomTo(zoom * resizeRatio, null, true); | |
| THIS[viewer.hash].prevContainerSize = containerSize; | |
| THIS[viewer.hash].forceRedraw = true; | |
| THIS[viewer.hash].needsResize = false; | |
| THIS[viewer.hash].forceResize = false; | |
| } | |
| function updateOnce( viewer ) { | |
| //viewer.profiler.beginUpdate(); | |
| if (viewer._opening || !THIS[viewer.hash]) { | |
| return; | |
| } | |
| if (viewer.autoResize || THIS[viewer.hash].forceResize){ | |
| var containerSize; | |
| if(viewer._autoResizePolling){ | |
| containerSize = _getSafeElemSize(viewer.container); | |
| var prevContainerSize = THIS[viewer.hash].prevContainerSize; | |
| if (!containerSize.equals(prevContainerSize)) { | |
| THIS[viewer.hash].needsResize = true; | |
| } | |
| } | |
| if(THIS[viewer.hash].needsResize){ | |
| doViewerResize(viewer, containerSize || _getSafeElemSize(viewer.container)); | |
| } | |
| } | |
| var viewportChange = viewer.viewport.update(); | |
| var animated = viewer.world.update(viewportChange) || viewportChange; | |
| if (viewportChange) { | |
| /** | |
| * Raised when any spring animation update occurs (zoom, pan, etc.), | |
| * before the viewer has drawn the new location. | |
| * | |
| * @event viewport-change | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| viewer.raiseEvent('viewport-change'); | |
| } | |
| if( viewer.referenceStrip ){ | |
| animated = viewer.referenceStrip.update( viewer.viewport ) || animated; | |
| } | |
| var currentAnimating = THIS[ viewer.hash ].animating; | |
| if ( !currentAnimating && animated ) { | |
| /** | |
| * Raised when any spring animation starts (zoom, pan, etc.). | |
| * | |
| * @event animation-start | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| viewer.raiseEvent( "animation-start" ); | |
| abortControlsAutoHide( viewer ); | |
| } | |
| var isAnimationFinished = currentAnimating && !animated; | |
| if ( isAnimationFinished ) { | |
| THIS[ viewer.hash ].animating = false; | |
| } | |
| if ( animated || isAnimationFinished || THIS[ viewer.hash ].forceRedraw || viewer.world.needsDraw() ) { | |
| drawWorld( viewer ); | |
| viewer._drawOverlays(); | |
| if( viewer.navigator ){ | |
| viewer.navigator.update( viewer.viewport ); | |
| } | |
| THIS[ viewer.hash ].forceRedraw = false; | |
| if (animated) { | |
| /** | |
| * Raised when any spring animation update occurs (zoom, pan, etc.), | |
| * after the viewer has drawn the new location. | |
| * | |
| * @event animation | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| viewer.raiseEvent( "animation" ); | |
| } | |
| } | |
| if ( isAnimationFinished ) { | |
| /** | |
| * Raised when any spring animation ends (zoom, pan, etc.). | |
| * | |
| * @event animation-finish | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| viewer.raiseEvent( "animation-finish" ); | |
| if ( !THIS[ viewer.hash ].mouseInside ) { | |
| beginControlsAutoHide( viewer ); | |
| } | |
| } | |
| THIS[ viewer.hash ].animating = animated; | |
| //viewer.profiler.endUpdate(); | |
| } | |
| function drawWorld( viewer ) { | |
| viewer.imageLoader.clear(); | |
| viewer.world.draw(); | |
| /** | |
| * <em>- Needs documentation -</em> | |
| * | |
| * @event update-viewport | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| viewer.raiseEvent( 'update-viewport', {} ); | |
| } | |
| /////////////////////////////////////////////////////////////////////////////// | |
| // Navigation Controls | |
| /////////////////////////////////////////////////////////////////////////////// | |
| function resolveUrl( prefix, url ) { | |
| return prefix ? prefix + url : url; | |
| } | |
| function scheduleZoom( viewer ) { | |
| $.requestAnimationFrame( $.delegate( viewer, doZoom ) ); | |
| } | |
| function doZoom() { | |
| var currentTime, | |
| deltaTime, | |
| adjustedFactor; | |
| if ( THIS[ this.hash ].zooming && this.viewport) { | |
| currentTime = $.now(); | |
| deltaTime = currentTime - THIS[ this.hash ].lastZoomTime; | |
| adjustedFactor = Math.pow( THIS[ this.hash ].zoomFactor, deltaTime / 1000 ); | |
| this.viewport.zoomBy( adjustedFactor ); | |
| this.viewport.applyConstraints(); | |
| THIS[ this.hash ].lastZoomTime = currentTime; | |
| scheduleZoom( this ); | |
| } | |
| } | |
| function lightUp() { | |
| if (this.buttonGroup) { | |
| this.buttonGroup.emulateEnter(); | |
| this.buttonGroup.emulateLeave(); | |
| } | |
| } | |
| function onHome() { | |
| if ( this.viewport ) { | |
| this.viewport.goHome(); | |
| } | |
| } | |
| function onFullScreen() { | |
| if ( this.isFullPage() && !$.isFullScreen() ) { | |
| // Is fullPage but not fullScreen | |
| this.setFullPage( false ); | |
| } else { | |
| this.setFullScreen( !this.isFullPage() ); | |
| } | |
| // correct for no mouseout event on change | |
| if ( this.buttonGroup ) { | |
| this.buttonGroup.emulateLeave(); | |
| } | |
| this.fullPageButton.element.focus(); | |
| if ( this.viewport ) { | |
| this.viewport.applyConstraints(); | |
| } | |
| } | |
| function onRotateLeft() { | |
| if ( this.viewport ) { | |
| var currRotation = this.viewport.getRotation(); | |
| if ( this.viewport.flipped ){ | |
| currRotation += this.rotationIncrement; | |
| } else { | |
| currRotation -= this.rotationIncrement; | |
| } | |
| this.viewport.setRotation(currRotation); | |
| } | |
| } | |
| function onRotateRight() { | |
| if ( this.viewport ) { | |
| var currRotation = this.viewport.getRotation(); | |
| if ( this.viewport.flipped ){ | |
| currRotation -= this.rotationIncrement; | |
| } else { | |
| currRotation += this.rotationIncrement; | |
| } | |
| this.viewport.setRotation(currRotation); | |
| } | |
| } | |
| /** | |
| * Note: When pressed flip control button | |
| */ | |
| function onFlip() { | |
| this.viewport.toggleFlip(); | |
| } | |
| /** | |
| * Find drawer | |
| */ | |
| $.determineDrawer = function( id ){ | |
| for (let property in OpenSeadragon) { | |
| const drawer = OpenSeadragon[ property ], | |
| proto = drawer.prototype; | |
| if( proto && | |
| proto instanceof OpenSeadragon.DrawerBase && | |
| $.isFunction( proto.getType ) && | |
| proto.getType.call( drawer ) === id | |
| ){ | |
| return drawer; | |
| } | |
| } | |
| return null; | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - Navigator | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class Navigator | |
| * @classdesc The Navigator provides a small view of the current image as fixed | |
| * while representing the viewport as a moving box serving as a frame | |
| * of reference in the larger viewport as to which portion of the image | |
| * is currently being examined. The navigator's viewport can be interacted | |
| * with using the keyboard or the mouse. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.Viewer | |
| * @extends OpenSeadragon.EventSource | |
| * @param {Object} options - Navigator options | |
| * @param {Element} [options.element] - An element to use for the navigator. | |
| * @param {String} [options.id] - Id of the element to use for the navigator. However, this is ignored if {@link options.element} is provided. | |
| */ | |
| $.Navigator = function( options ){ | |
| var viewer = options.viewer, | |
| _this = this, | |
| viewerSize, | |
| navigatorSize; | |
| //We may need to create a new element and id if they did not | |
| //provide the id for the existing element or the element itself | |
| if( options.element || options.id ){ | |
| if ( options.element ) { | |
| if ( options.id ){ | |
| $.console.warn("Given option.id for Navigator was ignored since option.element was provided and is being used instead."); | |
| } | |
| // Don't overwrite the element's id if it has one already | |
| if ( options.element.id ) { | |
| options.id = options.element.id; | |
| } else { | |
| options.id = 'navigator-' + $.now(); | |
| } | |
| this.element = options.element; | |
| } else { | |
| this.element = document.getElementById( options.id ); | |
| } | |
| options.controlOptions = { | |
| anchor: $.ControlAnchor.NONE, | |
| attachToViewer: false, | |
| autoFade: false | |
| }; | |
| } else { | |
| options.id = 'navigator-' + $.now(); | |
| this.element = $.makeNeutralElement( "div" ); | |
| options.controlOptions = { | |
| anchor: $.ControlAnchor.TOP_RIGHT, | |
| attachToViewer: true, | |
| autoFade: options.autoFade | |
| }; | |
| if( options.position ){ | |
| if( 'BOTTOM_RIGHT' === options.position ){ | |
| options.controlOptions.anchor = $.ControlAnchor.BOTTOM_RIGHT; | |
| } else if( 'BOTTOM_LEFT' === options.position ){ | |
| options.controlOptions.anchor = $.ControlAnchor.BOTTOM_LEFT; | |
| } else if( 'TOP_RIGHT' === options.position ){ | |
| options.controlOptions.anchor = $.ControlAnchor.TOP_RIGHT; | |
| } else if( 'TOP_LEFT' === options.position ){ | |
| options.controlOptions.anchor = $.ControlAnchor.TOP_LEFT; | |
| } else if( 'ABSOLUTE' === options.position ){ | |
| options.controlOptions.anchor = $.ControlAnchor.ABSOLUTE; | |
| options.controlOptions.top = options.top; | |
| options.controlOptions.left = options.left; | |
| options.controlOptions.height = options.height; | |
| options.controlOptions.width = options.width; | |
| } | |
| } | |
| } | |
| this.element.id = options.id; | |
| this.element.className += ' navigator'; | |
| options = $.extend( true, { | |
| sizeRatio: $.DEFAULT_SETTINGS.navigatorSizeRatio | |
| }, options, { | |
| element: this.element, | |
| tabIndex: -1, // No keyboard navigation, omit from tab order | |
| //These need to be overridden to prevent recursion since | |
| //the navigator is a viewer and a viewer has a navigator | |
| showNavigator: false, | |
| mouseNavEnabled: false, | |
| showNavigationControl: false, | |
| showSequenceControl: false, | |
| immediateRender: true, | |
| blendTime: 0, | |
| animationTime: options.animationTime, | |
| // disable autoResize since resize behavior is implemented differently by the navigator | |
| autoResize: false, | |
| // prevent resizing the navigator from adding unwanted space around the image | |
| minZoomImageRatio: 1.0, | |
| background: options.background, | |
| opacity: options.opacity, | |
| borderColor: options.borderColor, | |
| displayRegionColor: options.displayRegionColor | |
| }); | |
| options.minPixelRatio = this.minPixelRatio = viewer.minPixelRatio; | |
| $.setElementTouchActionNone( this.element ); | |
| this.borderWidth = 2; | |
| //At some browser magnification levels the display regions lines up correctly, but at some there appears to | |
| //be a one pixel gap. | |
| this.fudge = new $.Point(1, 1); | |
| this.totalBorderWidths = new $.Point(this.borderWidth * 2, this.borderWidth * 2).minus(this.fudge); | |
| if ( options.controlOptions.anchor !== $.ControlAnchor.NONE ) { | |
| (function( style, borderWidth ){ | |
| style.margin = '0px'; | |
| style.border = borderWidth + 'px solid ' + options.borderColor; | |
| style.padding = '0px'; | |
| style.background = options.background; | |
| style.opacity = options.opacity; | |
| style.overflow = 'hidden'; | |
| }( this.element.style, this.borderWidth)); | |
| } | |
| this.displayRegion = $.makeNeutralElement( "div" ); | |
| this.displayRegion.id = this.element.id + '-displayregion'; | |
| this.displayRegion.className = 'displayregion'; | |
| (function( style, borderWidth ){ | |
| style.position = 'relative'; | |
| style.top = '0px'; | |
| style.left = '0px'; | |
| style.fontSize = '0px'; | |
| style.overflow = 'hidden'; | |
| style.border = borderWidth + 'px solid ' + options.displayRegionColor; | |
| style.margin = '0px'; | |
| style.padding = '0px'; | |
| style.background = 'transparent'; | |
| // We use square bracket notation on the statement below, because float is a keyword. | |
| // This is important for the Google Closure compiler, if nothing else. | |
| /*jshint sub:true */ | |
| style['float'] = 'left'; //Webkit | |
| style.cssFloat = 'left'; //Firefox | |
| style.zIndex = 999999999; | |
| style.cursor = 'default'; | |
| style.boxSizing = 'content-box'; | |
| }( this.displayRegion.style, this.borderWidth )); | |
| $.setElementPointerEventsNone( this.displayRegion ); | |
| $.setElementTouchActionNone( this.displayRegion ); | |
| this.displayRegionContainer = $.makeNeutralElement("div"); | |
| this.displayRegionContainer.id = this.element.id + '-displayregioncontainer'; | |
| this.displayRegionContainer.className = "displayregioncontainer"; | |
| this.displayRegionContainer.style.width = "100%"; | |
| this.displayRegionContainer.style.height = "100%"; | |
| $.setElementPointerEventsNone( this.displayRegionContainer ); | |
| $.setElementTouchActionNone( this.displayRegionContainer ); | |
| viewer.addControl( | |
| this.element, | |
| options.controlOptions | |
| ); | |
| this._resizeWithViewer = options.controlOptions.anchor !== $.ControlAnchor.ABSOLUTE && | |
| options.controlOptions.anchor !== $.ControlAnchor.NONE; | |
| if (options.width && options.height) { | |
| this.setWidth(options.width); | |
| this.setHeight(options.height); | |
| } else if ( this._resizeWithViewer ) { | |
| viewerSize = $.getElementSize( viewer.element ); | |
| this.element.style.height = Math.round( viewerSize.y * options.sizeRatio ) + 'px'; | |
| this.element.style.width = Math.round( viewerSize.x * options.sizeRatio ) + 'px'; | |
| this.oldViewerSize = viewerSize; | |
| navigatorSize = $.getElementSize( this.element ); | |
| this.elementArea = navigatorSize.x * navigatorSize.y; | |
| } | |
| this.oldContainerSize = new $.Point( 0, 0 ); | |
| $.Viewer.apply( this, [ options ] ); | |
| this.displayRegionContainer.appendChild(this.displayRegion); | |
| this.element.getElementsByTagName('div')[0].appendChild(this.displayRegionContainer); | |
| function rotate(degrees, immediately) { | |
| _setTransformRotate(_this.displayRegionContainer, degrees); | |
| _setTransformRotate(_this.displayRegion, -degrees); | |
| _this.viewport.setRotation(degrees, immediately); | |
| } | |
| if (options.navigatorRotate) { | |
| var degrees = options.viewer.viewport ? | |
| options.viewer.viewport.getRotation() : | |
| options.viewer.degrees || 0; | |
| rotate(degrees, true); | |
| options.viewer.addHandler("rotate", function (args) { | |
| rotate(args.degrees, args.immediately); | |
| }); | |
| } | |
| // Remove the base class' (Viewer's) innerTracker and replace it with our own | |
| this.innerTracker.destroy(); | |
| this.innerTracker = new $.MouseTracker({ | |
| userData: 'Navigator.innerTracker', | |
| element: this.element, //this.canvas, | |
| dragHandler: $.delegate( this, onCanvasDrag ), | |
| clickHandler: $.delegate( this, onCanvasClick ), | |
| releaseHandler: $.delegate( this, onCanvasRelease ), | |
| scrollHandler: $.delegate( this, onCanvasScroll ), | |
| preProcessEventHandler: function (eventInfo) { | |
| if (eventInfo.eventType === 'wheel') { | |
| //don't scroll the page up and down if the user is scrolling | |
| //in the navigator | |
| eventInfo.preventDefault = true; | |
| } | |
| } | |
| }); | |
| this.outerTracker.userData = 'Navigator.outerTracker'; | |
| // this.innerTracker is attached to this.element...we need to allow pointer | |
| // events to pass through this Viewer's canvas/container elements so implicit | |
| // pointer capture works on touch devices | |
| //TODO an alternative is to attach the new MouseTracker to this.canvas...not | |
| // sure why it isn't already (see MouseTracker constructor call above) | |
| $.setElementPointerEventsNone( this.canvas ); | |
| $.setElementPointerEventsNone( this.container ); | |
| this.addHandler("reset-size", function() { | |
| if (_this.viewport) { | |
| _this.viewport.goHome(true); | |
| } | |
| }); | |
| viewer.world.addHandler("item-index-change", function(event) { | |
| window.setTimeout(function(){ | |
| var item = _this.world.getItemAt(event.previousIndex); | |
| _this.world.setItemIndex(item, event.newIndex); | |
| }, 1); | |
| }); | |
| viewer.world.addHandler("remove-item", function(event) { | |
| var theirItem = event.item; | |
| var myItem = _this._getMatchingItem(theirItem); | |
| if (myItem) { | |
| _this.world.removeItem(myItem); | |
| } | |
| }); | |
| this.update(viewer.viewport); | |
| }; | |
| $.extend( $.Navigator.prototype, $.EventSource.prototype, $.Viewer.prototype, /** @lends OpenSeadragon.Navigator.prototype */{ | |
| /** | |
| * Used to notify the navigator when its size has changed. | |
| * Especially useful when {@link OpenSeadragon.Options}.navigatorAutoResize is set to false and the navigator is resizable. | |
| * @function | |
| */ | |
| updateSize: function () { | |
| if ( this.viewport ) { | |
| var containerSize = new $.Point( | |
| (this.container.clientWidth === 0 ? 1 : this.container.clientWidth), | |
| (this.container.clientHeight === 0 ? 1 : this.container.clientHeight) | |
| ); | |
| if ( !containerSize.equals( this.oldContainerSize ) ) { | |
| this.viewport.resize( containerSize, true ); | |
| this.viewport.goHome(true); | |
| this.oldContainerSize = containerSize; | |
| this.world.update(); | |
| this.world.draw(); | |
| this.update(this.viewer.viewport); | |
| } | |
| } | |
| }, | |
| /** | |
| * Explicitly sets the width of the navigator, in web coordinates. Disables automatic resizing. | |
| * @param {Number|String} width - the new width, either a number of pixels or a CSS string, such as "100%" | |
| */ | |
| setWidth: function(width) { | |
| this.width = width; | |
| this.element.style.width = typeof (width) === "number" ? (width + 'px') : width; | |
| this._resizeWithViewer = false; | |
| this.updateSize(); | |
| }, | |
| /** | |
| * Explicitly sets the height of the navigator, in web coordinates. Disables automatic resizing. | |
| * @param {Number|String} height - the new height, either a number of pixels or a CSS string, such as "100%" | |
| */ | |
| setHeight: function(height) { | |
| this.height = height; | |
| this.element.style.height = typeof (height) === "number" ? (height + 'px') : height; | |
| this._resizeWithViewer = false; | |
| this.updateSize(); | |
| }, | |
| /** | |
| * Flip navigator element | |
| * @param {Boolean} state - Flip state to set. | |
| */ | |
| setFlip: function(state) { | |
| this.viewport.setFlip(state); | |
| this.setDisplayTransform(this.viewer.viewport.getFlip() ? "scale(-1,1)" : "scale(1,1)"); | |
| return this; | |
| }, | |
| setDisplayTransform: function(rule) { | |
| setElementTransform(this.canvas, rule); | |
| setElementTransform(this.element, rule); | |
| }, | |
| /** | |
| * Used to update the navigator minimap's viewport rectangle when a change in the viewer's viewport occurs. | |
| * @function | |
| * @param {OpenSeadragon.Viewport} [viewport] The viewport to display. Default: the viewport this navigator is tracking. | |
| */ | |
| update: function( viewport ) { | |
| var viewerSize, | |
| newWidth, | |
| newHeight, | |
| bounds, | |
| topleft, | |
| bottomright; | |
| if(!viewport){ | |
| viewport = this.viewer.viewport; | |
| } | |
| viewerSize = $.getElementSize( this.viewer.element ); | |
| if ( this._resizeWithViewer && viewerSize.x && viewerSize.y && !viewerSize.equals( this.oldViewerSize ) ) { | |
| this.oldViewerSize = viewerSize; | |
| if ( this.maintainSizeRatio || !this.elementArea) { | |
| newWidth = viewerSize.x * this.sizeRatio; | |
| newHeight = viewerSize.y * this.sizeRatio; | |
| } else { | |
| newWidth = Math.sqrt(this.elementArea * (viewerSize.x / viewerSize.y)); | |
| newHeight = this.elementArea / newWidth; | |
| } | |
| this.element.style.width = Math.round( newWidth ) + 'px'; | |
| this.element.style.height = Math.round( newHeight ) + 'px'; | |
| if (!this.elementArea) { | |
| this.elementArea = newWidth * newHeight; | |
| } | |
| this.updateSize(); | |
| } | |
| if (viewport && this.viewport) { | |
| bounds = viewport.getBoundsNoRotate(true); | |
| topleft = this.viewport.pixelFromPointNoRotate(bounds.getTopLeft(), false); | |
| bottomright = this.viewport.pixelFromPointNoRotate(bounds.getBottomRight(), false) | |
| .minus( this.totalBorderWidths ); | |
| if (!this.navigatorRotate) { | |
| var degrees = viewport.getRotation(true); | |
| _setTransformRotate(this.displayRegion, -degrees); | |
| } | |
| //update style for navigator-box | |
| var style = this.displayRegion.style; | |
| style.display = this.world.getItemCount() ? 'block' : 'none'; | |
| style.top = topleft.y.toFixed(2) + "px"; | |
| style.left = topleft.x.toFixed(2) + "px"; | |
| var width = bottomright.x - topleft.x; | |
| var height = bottomright.y - topleft.y; | |
| // make sure width and height are non-negative so IE doesn't throw | |
| style.width = Math.round( Math.max( width, 0 ) ) + 'px'; | |
| style.height = Math.round( Math.max( height, 0 ) ) + 'px'; | |
| } | |
| }, | |
| // overrides Viewer.addTiledImage | |
| addTiledImage: function(options) { | |
| var _this = this; | |
| var original = options.originalTiledImage; | |
| delete options.original; | |
| var optionsClone = $.extend({}, options, { | |
| success: function(event) { | |
| var myItem = event.item; | |
| myItem._originalForNavigator = original; | |
| _this._matchBounds(myItem, original, true); | |
| _this._matchOpacity(myItem, original); | |
| _this._matchCompositeOperation(myItem, original); | |
| function matchBounds() { | |
| _this._matchBounds(myItem, original); | |
| } | |
| function matchOpacity() { | |
| _this._matchOpacity(myItem, original); | |
| } | |
| function matchCompositeOperation() { | |
| _this._matchCompositeOperation(myItem, original); | |
| } | |
| original.addHandler('bounds-change', matchBounds); | |
| original.addHandler('clip-change', matchBounds); | |
| original.addHandler('opacity-change', matchOpacity); | |
| original.addHandler('composite-operation-change', matchCompositeOperation); | |
| } | |
| }); | |
| return $.Viewer.prototype.addTiledImage.apply(this, [optionsClone]); | |
| }, | |
| destroy: function() { | |
| return $.Viewer.prototype.destroy.apply(this); | |
| }, | |
| // private | |
| _getMatchingItem: function(theirItem) { | |
| var count = this.world.getItemCount(); | |
| var item; | |
| for (var i = 0; i < count; i++) { | |
| item = this.world.getItemAt(i); | |
| if (item._originalForNavigator === theirItem) { | |
| return item; | |
| } | |
| } | |
| return null; | |
| }, | |
| // private | |
| _matchBounds: function(myItem, theirItem, immediately) { | |
| var bounds = theirItem.getBoundsNoRotate(); | |
| myItem.setPosition(bounds.getTopLeft(), immediately); | |
| myItem.setWidth(bounds.width, immediately); | |
| myItem.setRotation(theirItem.getRotation(), immediately); | |
| myItem.setClip(theirItem.getClip()); | |
| myItem.setFlip(theirItem.getFlip()); | |
| }, | |
| // private | |
| _matchOpacity: function(myItem, theirItem) { | |
| myItem.setOpacity(theirItem.opacity); | |
| }, | |
| // private | |
| _matchCompositeOperation: function(myItem, theirItem) { | |
| myItem.setCompositeOperation(theirItem.compositeOperation); | |
| } | |
| }); | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onCanvasClick( event ) { | |
| var canvasClickEventArgs = { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| quick: event.quick, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when a click event occurs on the {@link OpenSeadragon.Viewer#navigator} element. | |
| * | |
| * @event navigator-click | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Boolean} quick - True only if the clickDistThreshold and clickTimeThreshold are both passed. Useful for differentiating between clicks and drags. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default click to zoom behaviour. Default: false. | |
| */ | |
| this.viewer.raiseEvent('navigator-click', canvasClickEventArgs); | |
| if ( !canvasClickEventArgs.preventDefaultAction && event.quick && this.viewer.viewport && (this.panVertical || this.panHorizontal)) { | |
| if(this.viewer.viewport.flipped) { | |
| event.position.x = this.viewport.getContainerSize().x - event.position.x; | |
| } | |
| var target = this.viewport.pointFromPixel(event.position); | |
| if (!this.panVertical) { | |
| // perform only horizonal pan | |
| target.y = this.viewer.viewport.getCenter(true).y; | |
| } else if (!this.panHorizontal) { | |
| // perform only vertical pan | |
| target.x = this.viewer.viewport.getCenter(true).x; | |
| } | |
| this.viewer.viewport.panTo(target); | |
| this.viewer.viewport.applyConstraints(); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onCanvasDrag( event ) { | |
| var canvasDragEventArgs = { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| delta: event.delta, | |
| speed: event.speed, | |
| direction: event.direction, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefaultAction: false | |
| }; | |
| /** | |
| * Raised when a drag event occurs on the {@link OpenSeadragon.Viewer#navigator} element. | |
| * | |
| * @event navigator-drag | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {OpenSeadragon.Point} delta - The x,y components of the difference between start drag and end drag. | |
| * @property {Number} speed - Current computed speed, in pixels per second. | |
| * @property {Number} direction - Current computed direction, expressed as an angle counterclockwise relative to the positive X axis (-pi to pi, in radians). Only valid if speed > 0. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| * @property {Boolean} preventDefaultAction - Set to true to prevent default drag to pan behaviour. Default: false. | |
| */ | |
| this.viewer.raiseEvent('navigator-drag', canvasDragEventArgs); | |
| if ( !canvasDragEventArgs.preventDefaultAction && this.viewer.viewport ) { | |
| if( !this.panHorizontal ){ | |
| event.delta.x = 0; | |
| } | |
| if( !this.panVertical ){ | |
| event.delta.y = 0; | |
| } | |
| if(this.viewer.viewport.flipped){ | |
| event.delta.x = -event.delta.x; | |
| } | |
| this.viewer.viewport.panBy( | |
| this.viewport.deltaPointsFromPixels( | |
| event.delta | |
| ) | |
| ); | |
| if( this.viewer.constrainDuringPan ){ | |
| this.viewer.viewport.applyConstraints(); | |
| } | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onCanvasRelease( event ) { | |
| if ( event.insideElementPressed && this.viewer.viewport ) { | |
| this.viewer.viewport.applyConstraints(); | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onCanvasScroll( event ) { | |
| var eventArgs = { | |
| tracker: event.eventSource, | |
| position: event.position, | |
| scroll: event.scroll, | |
| shift: event.shift, | |
| originalEvent: event.originalEvent, | |
| preventDefault: event.preventDefault | |
| }; | |
| /** | |
| * Raised when a scroll event occurs on the {@link OpenSeadragon.Viewer#navigator} element (mouse wheel, touch pinch, etc.). | |
| * | |
| * @event navigator-scroll | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised this event. | |
| * @property {OpenSeadragon.MouseTracker} tracker - A reference to the MouseTracker which originated this event. | |
| * @property {OpenSeadragon.Point} position - The position of the event relative to the tracked element. | |
| * @property {Number} scroll - The scroll delta for the event. | |
| * @property {Boolean} shift - True if the shift key was pressed during this event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {Boolean} preventDefault - Set to true to prevent the default user-agent's handling of the wheel event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.viewer.raiseEvent( 'navigator-scroll', eventArgs ); | |
| event.preventDefault = eventArgs.preventDefault; | |
| } | |
| /** | |
| * @function | |
| * @private | |
| * @param {Object} element | |
| * @param {Number} degrees | |
| */ | |
| function _setTransformRotate( element, degrees ) { | |
| setElementTransform(element, "rotate(" + degrees + "deg)"); | |
| } | |
| function setElementTransform( element, rule ) { | |
| element.style.webkitTransform = rule; | |
| element.style.mozTransform = rule; | |
| element.style.msTransform = rule; | |
| element.style.oTransform = rule; | |
| element.style.transform = rule; | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - getString/setString | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| //TODO: I guess this is where the i18n needs to be reimplemented. I'll look | |
| // into existing patterns for i18n in javascript but i think that mimicking | |
| // pythons gettext might be a reasonable approach. | |
| var I18N = { | |
| Errors: { | |
| Dzc: "Sorry, we don't support Deep Zoom Collections!", | |
| Dzi: "Hmm, this doesn't appear to be a valid Deep Zoom Image.", | |
| Xml: "Hmm, this doesn't appear to be a valid Deep Zoom Image.", | |
| ImageFormat: "Sorry, we don't support {0}-based Deep Zoom Images.", | |
| Security: "It looks like a security restriction stopped us from " + | |
| "loading this Deep Zoom Image.", | |
| Status: "This space unintentionally left blank ({0} {1}).", | |
| OpenFailed: "Unable to open {0}: {1}" | |
| }, | |
| Tooltips: { | |
| FullPage: "Toggle full page", | |
| Home: "Go home", | |
| ZoomIn: "Zoom in", | |
| ZoomOut: "Zoom out", | |
| NextPage: "Next page", | |
| PreviousPage: "Previous page", | |
| RotateLeft: "Rotate left", | |
| RotateRight: "Rotate right", | |
| Flip: "Flip Horizontally" | |
| } | |
| }; | |
| $.extend( $, /** @lends OpenSeadragon */{ | |
| /** | |
| * @function | |
| * @param {String} property | |
| */ | |
| getString: function( prop ) { | |
| var props = prop.split('.'), | |
| string = null, | |
| args = arguments, | |
| container = I18N, | |
| i; | |
| for (i = 0; i < props.length - 1; i++) { | |
| // in case not a subproperty | |
| container = container[ props[ i ] ] || {}; | |
| } | |
| string = container[ props[ i ] ]; | |
| if ( typeof ( string ) !== "string" ) { | |
| $.console.error( "Untranslated source string:", prop ); | |
| string = ""; // FIXME: this breaks gettext()-style convention, which would return source | |
| } | |
| return string.replace(/\{\d+\}/g, function(capture) { | |
| var i = parseInt( capture.match( /\d+/ ), 10 ) + 1; | |
| return i < args.length ? | |
| args[ i ] : | |
| ""; | |
| }); | |
| }, | |
| /** | |
| * @function | |
| * @param {String} property | |
| * @param {*} value | |
| */ | |
| setString: function( prop, value ) { | |
| var props = prop.split('.'), | |
| container = I18N, | |
| i; | |
| for ( i = 0; i < props.length - 1; i++ ) { | |
| if ( !container[ props[ i ] ] ) { | |
| container[ props[ i ] ] = {}; | |
| } | |
| container = container[ props[ i ] ]; | |
| } | |
| container[ props[ i ] ] = value; | |
| } | |
| }); | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - Point | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class Point | |
| * @classdesc A Point is really used as a 2-dimensional vector, equally useful for | |
| * representing a point on a plane, or the height and width of a plane | |
| * not requiring any other frame of reference. | |
| * | |
| * @memberof OpenSeadragon | |
| * @param {Number} [x] The vector component 'x'. Defaults to the origin at 0. | |
| * @param {Number} [y] The vector component 'y'. Defaults to the origin at 0. | |
| */ | |
| $.Point = function( x, y ) { | |
| /** | |
| * The vector component 'x'. | |
| * @member {Number} x | |
| * @memberof OpenSeadragon.Point# | |
| */ | |
| this.x = typeof ( x ) === "number" ? x : 0; | |
| /** | |
| * The vector component 'y'. | |
| * @member {Number} y | |
| * @memberof OpenSeadragon.Point# | |
| */ | |
| this.y = typeof ( y ) === "number" ? y : 0; | |
| }; | |
| /** @lends OpenSeadragon.Point.prototype */ | |
| $.Point.prototype = { | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.Point} a duplicate of this Point | |
| */ | |
| clone: function() { | |
| return new $.Point(this.x, this.y); | |
| }, | |
| /** | |
| * Add another Point to this point and return a new Point. | |
| * @function | |
| * @param {OpenSeadragon.Point} point The point to add vector components. | |
| * @returns {OpenSeadragon.Point} A new point representing the sum of the | |
| * vector components | |
| */ | |
| plus: function( point ) { | |
| return new $.Point( | |
| this.x + point.x, | |
| this.y + point.y | |
| ); | |
| }, | |
| /** | |
| * Subtract another Point to this point and return a new Point. | |
| * @function | |
| * @param {OpenSeadragon.Point} point The point to subtract vector components. | |
| * @returns {OpenSeadragon.Point} A new point representing the subtraction of the | |
| * vector components | |
| */ | |
| minus: function( point ) { | |
| return new $.Point( | |
| this.x - point.x, | |
| this.y - point.y | |
| ); | |
| }, | |
| /** | |
| * Multiply this point by a factor and return a new Point. | |
| * @function | |
| * @param {Number} factor The factor to multiply vector components. | |
| * @returns {OpenSeadragon.Point} A new point representing the multiplication | |
| * of the vector components by the factor | |
| */ | |
| times: function( factor ) { | |
| return new $.Point( | |
| this.x * factor, | |
| this.y * factor | |
| ); | |
| }, | |
| /** | |
| * Divide this point by a factor and return a new Point. | |
| * @function | |
| * @param {Number} factor The factor to divide vector components. | |
| * @returns {OpenSeadragon.Point} A new point representing the division of the | |
| * vector components by the factor | |
| */ | |
| divide: function( factor ) { | |
| return new $.Point( | |
| this.x / factor, | |
| this.y / factor | |
| ); | |
| }, | |
| /** | |
| * Compute the opposite of this point and return a new Point. | |
| * @function | |
| * @returns {OpenSeadragon.Point} A new point representing the opposite of the | |
| * vector components | |
| */ | |
| negate: function() { | |
| return new $.Point( -this.x, -this.y ); | |
| }, | |
| /** | |
| * Compute the distance between this point and another point. | |
| * @function | |
| * @param {OpenSeadragon.Point} point The point to compute the distance with. | |
| * @returns {Number} The distance between the 2 points | |
| */ | |
| distanceTo: function( point ) { | |
| return Math.sqrt( | |
| Math.pow( this.x - point.x, 2 ) + | |
| Math.pow( this.y - point.y, 2 ) | |
| ); | |
| }, | |
| /** | |
| * Compute the squared distance between this point and another point. | |
| * Useful for optimizing things like comparing distances. | |
| * @function | |
| * @param {OpenSeadragon.Point} point The point to compute the squared distance with. | |
| * @returns {Number} The squared distance between the 2 points | |
| */ | |
| squaredDistanceTo: function( point ) { | |
| return Math.pow( this.x - point.x, 2 ) + | |
| Math.pow( this.y - point.y, 2 ); | |
| }, | |
| /** | |
| * Apply a function to each coordinate of this point and return a new point. | |
| * @function | |
| * @param {function} func The function to apply to each coordinate. | |
| * @returns {OpenSeadragon.Point} A new point with the coordinates computed | |
| * by the specified function | |
| */ | |
| apply: function( func ) { | |
| return new $.Point( func( this.x ), func( this.y ) ); | |
| }, | |
| /** | |
| * Check if this point is equal to another one. | |
| * @function | |
| * @param {OpenSeadragon.Point} point The point to compare this point with. | |
| * @returns {Boolean} true if they are equal, false otherwise. | |
| */ | |
| equals: function( point ) { | |
| return ( | |
| point instanceof $.Point | |
| ) && ( | |
| this.x === point.x | |
| ) && ( | |
| this.y === point.y | |
| ); | |
| }, | |
| /** | |
| * Rotates the point around the specified pivot | |
| * From http://stackoverflow.com/questions/4465931/rotate-rectangle-around-a-point | |
| * @function | |
| * @param {Number} degress to rotate around the pivot. | |
| * @param {OpenSeadragon.Point} [pivot=(0,0)] Point around which to rotate. | |
| * Defaults to the origin. | |
| * @returns {OpenSeadragon.Point}. A new point representing the point rotated around the specified pivot | |
| */ | |
| rotate: function (degrees, pivot) { | |
| pivot = pivot || new $.Point(0, 0); | |
| var cos; | |
| var sin; | |
| // Avoid float computations when possible | |
| if (degrees % 90 === 0) { | |
| var d = $.positiveModulo(degrees, 360); | |
| switch (d) { | |
| case 0: | |
| cos = 1; | |
| sin = 0; | |
| break; | |
| case 90: | |
| cos = 0; | |
| sin = 1; | |
| break; | |
| case 180: | |
| cos = -1; | |
| sin = 0; | |
| break; | |
| case 270: | |
| cos = 0; | |
| sin = -1; | |
| break; | |
| } | |
| } else { | |
| var angle = degrees * Math.PI / 180.0; | |
| cos = Math.cos(angle); | |
| sin = Math.sin(angle); | |
| } | |
| var x = cos * (this.x - pivot.x) - sin * (this.y - pivot.y) + pivot.x; | |
| var y = sin * (this.x - pivot.x) + cos * (this.y - pivot.y) + pivot.y; | |
| return new $.Point(x, y); | |
| }, | |
| /** | |
| * Convert this point to a string in the format (x,y) where x and y are | |
| * rounded to the nearest integer. | |
| * @function | |
| * @returns {String} A string representation of this point. | |
| */ | |
| toString: function() { | |
| return "(" + (Math.round(this.x * 100) / 100) + "," + (Math.round(this.y * 100) / 100) + ")"; | |
| } | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - TileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class TileSource | |
| * @classdesc The TileSource contains the most basic implementation required to create a | |
| * smooth transition between layers in an image pyramid. It has only a single key | |
| * interface that must be implemented to complete its key functionality: | |
| * 'getTileUrl'. It also has several optional interfaces that can be | |
| * implemented if a new TileSource wishes to support configuration via a simple | |
| * object or array ('configure') and if the tile source supports or requires | |
| * configuration via retrieval of a document on the network ala AJAX or JSONP, | |
| * ('getImageInfo'). | |
| * <br/> | |
| * By default the image pyramid is split into N layers where the image's longest | |
| * side in M (in pixels), where N is the smallest integer which satisfies | |
| * <strong>2^(N+1) >= M</strong>. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.EventSource | |
| * @param {Object} options | |
| * You can either specify a URL, or literally define the TileSource (by specifying | |
| * width, height, tileSize, tileOverlap, minLevel, and maxLevel). For the former, | |
| * the extending class is expected to implement 'supports' and 'configure'. | |
| * Note that _in this case, the child class of getImageInfo() is ignored!_ | |
| * For the latter, the construction is assumed to occur through | |
| * the extending classes implementation of 'configure'. | |
| * @param {String} [options.url] | |
| * The URL for the data necessary for this TileSource. | |
| * @param {String} [options.referenceStripThumbnailUrl] | |
| * The URL for a thumbnail image to be used by the reference strip | |
| * @param {Function} [options.success] | |
| * A function to be called upon successful creation. | |
| * @param {Boolean} [options.ajaxWithCredentials] | |
| * If this TileSource needs to make an AJAX call, this specifies whether to set | |
| * the XHR's withCredentials (for accessing secure data). | |
| * @param {Object} [options.ajaxHeaders] | |
| * A set of headers to include in AJAX requests. | |
| * @param {Boolean} [options.splitHashDataForPost] | |
| * First occurrence of '#' in the options.url is used to split URL | |
| * and the latter part is treated as POST data (applies to getImageInfo(...)) | |
| * Does not work if getImageInfo() is overridden and used (see the options description) | |
| * @param {Number} [options.width] | |
| * Width of the source image at max resolution in pixels. | |
| * @param {Number} [options.height] | |
| * Height of the source image at max resolution in pixels. | |
| * @param {Number} [options.tileSize] | |
| * The size of the tiles to assumed to make up each pyramid layer in pixels. | |
| * Tile size determines the point at which the image pyramid must be | |
| * divided into a matrix of smaller images. | |
| * Use options.tileWidth and options.tileHeight to support non-square tiles. | |
| * @param {Number} [options.tileWidth] | |
| * The width of the tiles to assumed to make up each pyramid layer in pixels. | |
| * @param {Number} [options.tileHeight] | |
| * The height of the tiles to assumed to make up each pyramid layer in pixels. | |
| * @param {Number} [options.tileOverlap] | |
| * The number of pixels each tile is expected to overlap touching tiles. | |
| * @param {Number} [options.minLevel] | |
| * The minimum level to attempt to load. | |
| * @param {Number} [options.maxLevel] | |
| * The maximum level to attempt to load. | |
| */ | |
| $.TileSource = function( width, height, tileSize, tileOverlap, minLevel, maxLevel ) { | |
| var _this = this; | |
| var args = arguments, | |
| options, | |
| i; | |
| if( $.isPlainObject( width ) ){ | |
| options = width; | |
| }else{ | |
| options = { | |
| width: args[0], | |
| height: args[1], | |
| tileSize: args[2], | |
| tileOverlap: args[3], | |
| minLevel: args[4], | |
| maxLevel: args[5] | |
| }; | |
| } | |
| //Tile sources supply some events, namely 'ready' when they must be configured | |
| //by asynchronously fetching their configuration data. | |
| $.EventSource.call( this ); | |
| //we allow options to override anything we don't treat as | |
| //required via idiomatic options or which is functionally | |
| //set depending on the state of the readiness of this tile | |
| //source | |
| $.extend( true, this, options ); | |
| if (!this.success) { | |
| //Any functions that are passed as arguments are bound to the ready callback | |
| for ( i = 0; i < arguments.length; i++ ) { | |
| if ( $.isFunction( arguments[ i ] ) ) { | |
| this.success = arguments[ i ]; | |
| //only one callback per constructor | |
| break; | |
| } | |
| } | |
| } | |
| if (this.success) { | |
| this.addHandler( 'ready', function ( event ) { | |
| _this.success( event ); | |
| } ); | |
| } | |
| /** | |
| * Retrieve context2D of this tile source | |
| * @memberOf OpenSeadragon.TileSource | |
| * @function getContext2D | |
| */ | |
| /** | |
| * Ratio of width to height | |
| * @member {Number} aspectRatio | |
| * @memberof OpenSeadragon.TileSource# | |
| */ | |
| /** | |
| * Vector storing x and y dimensions ( width and height respectively ). | |
| * @member {OpenSeadragon.Point} dimensions | |
| * @memberof OpenSeadragon.TileSource# | |
| */ | |
| /** | |
| * The overlap in pixels each tile shares with its adjacent neighbors. | |
| * @member {Number} tileOverlap | |
| * @memberof OpenSeadragon.TileSource# | |
| */ | |
| /** | |
| * The minimum pyramid level this tile source supports or should attempt to load. | |
| * @member {Number} minLevel | |
| * @memberof OpenSeadragon.TileSource# | |
| */ | |
| /** | |
| * The maximum pyramid level this tile source supports or should attempt to load. | |
| * @member {Number} maxLevel | |
| * @memberof OpenSeadragon.TileSource# | |
| */ | |
| /** | |
| * | |
| * @member {Boolean} ready | |
| * @memberof OpenSeadragon.TileSource# | |
| */ | |
| // TODO potentially buggy behavior: what if .url is used by child class before it calls super constructor? | |
| // this can happen if old JS class definition is used | |
| if( 'string' === $.type( arguments[ 0 ] ) ){ | |
| this.url = arguments[0]; | |
| } | |
| if (this.url) { | |
| //in case the getImageInfo method is overridden and/or implies an | |
| //async mechanism set some safe defaults first | |
| this.aspectRatio = 1; | |
| this.dimensions = new $.Point( 10, 10 ); | |
| this._tileWidth = 0; | |
| this._tileHeight = 0; | |
| this.tileOverlap = 0; | |
| this.minLevel = 0; | |
| this.maxLevel = 0; | |
| this.ready = false; | |
| //configuration via url implies the extending class | |
| //implements and 'configure' | |
| this.getImageInfo( this.url ); | |
| } else { | |
| //explicit configuration via positional args in constructor | |
| //or the more idiomatic 'options' object | |
| this.ready = true; | |
| this.aspectRatio = (options.width && options.height) ? | |
| (options.width / options.height) : 1; | |
| this.dimensions = new $.Point( options.width, options.height ); | |
| if ( this.tileSize ){ | |
| this._tileWidth = this._tileHeight = this.tileSize; | |
| delete this.tileSize; | |
| } else { | |
| if( this.tileWidth ){ | |
| // We were passed tileWidth in options, but we want to rename it | |
| // with a leading underscore to make clear that it is not safe to directly modify it | |
| this._tileWidth = this.tileWidth; | |
| delete this.tileWidth; | |
| } else { | |
| this._tileWidth = 0; | |
| } | |
| if( this.tileHeight ){ | |
| // See note above about renaming this.tileWidth | |
| this._tileHeight = this.tileHeight; | |
| delete this.tileHeight; | |
| } else { | |
| this._tileHeight = 0; | |
| } | |
| } | |
| this.tileOverlap = options.tileOverlap ? options.tileOverlap : 0; | |
| this.minLevel = options.minLevel ? options.minLevel : 0; | |
| this.maxLevel = ( undefined !== options.maxLevel && null !== options.maxLevel ) ? | |
| options.maxLevel : ( | |
| ( options.width && options.height ) ? Math.ceil( | |
| Math.log( Math.max( options.width, options.height ) ) / | |
| Math.log( 2 ) | |
| ) : 0 | |
| ); | |
| if( this.success && $.isFunction( this.success ) ){ | |
| this.success( this ); | |
| } | |
| } | |
| }; | |
| /** @lends OpenSeadragon.TileSource.prototype */ | |
| $.TileSource.prototype = { | |
| getTileSize: function( level ) { | |
| $.console.error( | |
| "[TileSource.getTileSize] is deprecated. " + | |
| "Use TileSource.getTileWidth() and TileSource.getTileHeight() instead" | |
| ); | |
| return this._tileWidth; | |
| }, | |
| /** | |
| * Return the tileWidth for a given level. | |
| * Subclasses should override this if tileWidth can be different at different levels | |
| * such as in IIIFTileSource. Code should use this function rather than reading | |
| * from ._tileWidth directly. | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getTileWidth: function( level ) { | |
| if (!this._tileWidth) { | |
| return this.getTileSize(level); | |
| } | |
| return this._tileWidth; | |
| }, | |
| /** | |
| * Return the tileHeight for a given level. | |
| * Subclasses should override this if tileHeight can be different at different levels | |
| * such as in IIIFTileSource. Code should use this function rather than reading | |
| * from ._tileHeight directly. | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getTileHeight: function( level ) { | |
| if (!this._tileHeight) { | |
| return this.getTileSize(level); | |
| } | |
| return this._tileHeight; | |
| }, | |
| /** | |
| * Set the maxLevel to the given level, and perform the memoization of | |
| * getLevelScale with the new maxLevel. This function can be useful if the | |
| * memoization is required before the first call of getLevelScale, or both | |
| * memoized getLevelScale and maxLevel should be changed accordingly. | |
| * @function | |
| * @param {Number} level | |
| */ | |
| setMaxLevel: function( level ) { | |
| this.maxLevel = level; | |
| this._memoizeLevelScale(); | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getLevelScale: function( level ) { | |
| // if getLevelScale is not memoized, we generate the memoized version | |
| // at the first call and return the result | |
| this._memoizeLevelScale(); | |
| return this.getLevelScale( level ); | |
| }, | |
| // private | |
| _memoizeLevelScale: function() { | |
| // see https://github.com/openseadragon/openseadragon/issues/22 | |
| // we use the tilesources implementation of getLevelScale to generate | |
| // a memoized re-implementation | |
| var levelScaleCache = {}, | |
| i; | |
| for( i = 0; i <= this.maxLevel; i++ ){ | |
| levelScaleCache[ i ] = 1 / Math.pow(2, this.maxLevel - i); | |
| } | |
| this.getLevelScale = function( _level ){ | |
| return levelScaleCache[ _level ]; | |
| }; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getNumTiles: function( level ) { | |
| var scale = this.getLevelScale( level ), | |
| x = Math.ceil( scale * this.dimensions.x / this.getTileWidth(level) ), | |
| y = Math.ceil( scale * this.dimensions.y / this.getTileHeight(level) ); | |
| return new $.Point( x, y ); | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getPixelRatio: function( level ) { | |
| var imageSizeScaled = this.dimensions.times( this.getLevelScale( level ) ), | |
| rx = 1.0 / imageSizeScaled.x * $.pixelDensityRatio, | |
| ry = 1.0 / imageSizeScaled.y * $.pixelDensityRatio; | |
| return new $.Point(rx, ry); | |
| }, | |
| /** | |
| * @function | |
| * @returns {Number} The highest level in this tile source that can be contained in a single tile. | |
| */ | |
| getClosestLevel: function() { | |
| var i, | |
| tiles; | |
| for (i = this.minLevel + 1; i <= this.maxLevel; i++){ | |
| tiles = this.getNumTiles(i); | |
| if (tiles.x > 1 || tiles.y > 1) { | |
| break; | |
| } | |
| } | |
| return i - 1; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {OpenSeadragon.Point} point | |
| */ | |
| getTileAtPoint: function(level, point) { | |
| var validPoint = point.x >= 0 && point.x <= 1 && | |
| point.y >= 0 && point.y <= 1 / this.aspectRatio; | |
| $.console.assert(validPoint, "[TileSource.getTileAtPoint] must be called with a valid point."); | |
| var widthScaled = this.dimensions.x * this.getLevelScale(level); | |
| var pixelX = point.x * widthScaled; | |
| var pixelY = point.y * widthScaled; | |
| var x = Math.floor(pixelX / this.getTileWidth(level)); | |
| var y = Math.floor(pixelY / this.getTileHeight(level)); | |
| // When point.x == 1 or point.y == 1 / this.aspectRatio we want to | |
| // return the last tile of the row/column | |
| if (point.x >= 1) { | |
| x = this.getNumTiles(level).x - 1; | |
| } | |
| var EPSILON = 1e-15; | |
| if (point.y >= 1 / this.aspectRatio - EPSILON) { | |
| y = this.getNumTiles(level).y - 1; | |
| } | |
| return new $.Point(x, y); | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| * @param {Boolean} [isSource=false] Whether to return the source bounds of the tile. | |
| * @returns {OpenSeadragon.Rect} Either where this tile fits (in normalized coordinates) or the | |
| * portion of the tile to use as the source of the drawing operation (in pixels), depending on | |
| * the isSource parameter. | |
| */ | |
| getTileBounds: function( level, x, y, isSource ) { | |
| var dimensionsScaled = this.dimensions.times( this.getLevelScale( level ) ), | |
| tileWidth = this.getTileWidth(level), | |
| tileHeight = this.getTileHeight(level), | |
| px = ( x === 0 ) ? 0 : tileWidth * x - this.tileOverlap, | |
| py = ( y === 0 ) ? 0 : tileHeight * y - this.tileOverlap, | |
| sx = tileWidth + ( x === 0 ? 1 : 2 ) * this.tileOverlap, | |
| sy = tileHeight + ( y === 0 ? 1 : 2 ) * this.tileOverlap, | |
| scale = 1.0 / dimensionsScaled.x; | |
| sx = Math.min( sx, dimensionsScaled.x - px ); | |
| sy = Math.min( sy, dimensionsScaled.y - py ); | |
| if (isSource) { | |
| return new $.Rect(0, 0, sx, sy); | |
| } | |
| return new $.Rect( px * scale, py * scale, sx * scale, sy * scale ); | |
| }, | |
| /** | |
| * Responsible for retrieving, and caching the | |
| * image metadata pertinent to this TileSources implementation. | |
| * There are three scenarios of opening a tile source: providing a parseable string, plain object, or an URL. | |
| * This method is only called by OSD if the TileSource configuration is a non-parseable string (~url). | |
| * | |
| * The string can contain a hash `#` symbol, followed by | |
| * key=value arguments. If this is the case, this method sends this | |
| * data as a POST body. | |
| * | |
| * @function | |
| * @param {String} url | |
| * @throws {Error} | |
| */ | |
| getImageInfo: function( url ) { | |
| var _this = this, | |
| callbackName, | |
| callback, | |
| readySource, | |
| options, | |
| urlParts, | |
| filename, | |
| lastDot; | |
| if( url ) { | |
| urlParts = url.split( '/' ); | |
| filename = urlParts[ urlParts.length - 1 ]; | |
| lastDot = filename.lastIndexOf( '.' ); | |
| if ( lastDot > -1 ) { | |
| urlParts[ urlParts.length - 1 ] = filename.slice( 0, lastDot ); | |
| } | |
| } | |
| var postData = null; | |
| if (this.splitHashDataForPost) { | |
| var hashIdx = url.indexOf("#"); | |
| if (hashIdx !== -1) { | |
| postData = url.substring(hashIdx + 1); | |
| url = url.substr(0, hashIdx); | |
| } | |
| } | |
| callback = function( data ){ | |
| if( typeof (data) === "string" ) { | |
| data = $.parseXml( data ); | |
| } | |
| var $TileSource = $.TileSource.determineType( _this, data, url ); | |
| if ( !$TileSource ) { | |
| /** | |
| * Raised when an error occurs loading a TileSource. | |
| * | |
| * @event open-failed | |
| * @memberof OpenSeadragon.TileSource | |
| * @type {object} | |
| * @property {OpenSeadragon.TileSource} eventSource - A reference to the TileSource which raised the event. | |
| * @property {String} message | |
| * @property {String} source | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( 'open-failed', { message: "Unable to load TileSource", source: url } ); | |
| return; | |
| } | |
| options = $TileSource.prototype.configure.apply( _this, [ data, url, postData ]); | |
| if (options.ajaxWithCredentials === undefined) { | |
| options.ajaxWithCredentials = _this.ajaxWithCredentials; | |
| } | |
| readySource = new $TileSource( options ); | |
| _this.ready = true; | |
| /** | |
| * Raised when a TileSource is opened and initialized. | |
| * | |
| * @event ready | |
| * @memberof OpenSeadragon.TileSource | |
| * @type {object} | |
| * @property {OpenSeadragon.TileSource} eventSource - A reference to the TileSource which raised the event. | |
| * @property {Object} tileSource | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( 'ready', { tileSource: readySource } ); | |
| }; | |
| if( url.match(/\.js$/) ){ | |
| //TODO: Its not very flexible to require tile sources to end jsonp | |
| // request for info with a url that ends with '.js' but for | |
| // now it's the only way I see to distinguish uniformly. | |
| callbackName = url.split('/').pop().replace('.js', ''); | |
| $.jsonp({ | |
| url: url, | |
| async: false, | |
| callbackName: callbackName, | |
| callback: callback | |
| }); | |
| } else { | |
| // request info via xhr asynchronously. | |
| $.makeAjaxRequest( { | |
| url: url, | |
| postData: postData, | |
| withCredentials: this.ajaxWithCredentials, | |
| headers: this.ajaxHeaders, | |
| success: function( xhr ) { | |
| var data = processResponse( xhr ); | |
| callback( data ); | |
| }, | |
| error: function ( xhr, exc ) { | |
| var msg; | |
| /* | |
| IE < 10 will block XHR requests to different origins. Any property access on the request | |
| object will raise an exception which we'll attempt to handle by formatting the original | |
| exception rather than the second one raised when we try to access xhr.status | |
| */ | |
| try { | |
| msg = "HTTP " + xhr.status + " attempting to load TileSource: " + url; | |
| } catch ( e ) { | |
| var formattedExc; | |
| if ( typeof ( exc ) === "undefined" || !exc.toString ) { | |
| formattedExc = "Unknown error"; | |
| } else { | |
| formattedExc = exc.toString(); | |
| } | |
| msg = formattedExc + " attempting to load TileSource: " + url; | |
| } | |
| $.console.error(msg); | |
| /*** | |
| * Raised when an error occurs loading a TileSource. | |
| * | |
| * @event open-failed | |
| * @memberof OpenSeadragon.TileSource | |
| * @type {object} | |
| * @property {OpenSeadragon.TileSource} eventSource - A reference to the TileSource which raised the event. | |
| * @property {String} message | |
| * @property {String} source | |
| * @property {String} postData - HTTP POST data (usually but not necessarily in k=v&k2=v2... form, | |
| * see TileSource::getTilePostData) or null | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( 'open-failed', { | |
| message: msg, | |
| source: url, | |
| postData: postData | |
| }); | |
| } | |
| }); | |
| } | |
| }, | |
| /** | |
| * Responsible for determining if the particular TileSource supports the | |
| * data format ( and allowed to apply logic against the url the data was | |
| * loaded from, if any ). Overriding implementations are expected to do | |
| * something smart with data and / or url to determine support. Also | |
| * understand that iteration order of TileSources is not guaranteed so | |
| * please make sure your data or url is expressive enough to ensure a simple | |
| * and sufficient mechanism for clear determination. | |
| * @function | |
| * @param {String|Object|Array|Document} data | |
| * @param {String} url - the url the data was loaded | |
| * from if any. | |
| * @returns {Boolean} | |
| */ | |
| supports: function( data, url ) { | |
| return false; | |
| }, | |
| /** | |
| * Check whether two tileSources are equal. This is used for example | |
| * when replacing tile-sources, which turns on the zombie cache before | |
| * old item removal. | |
| * @param {OpenSeadragon.TileSource} otherSource | |
| * @returns {Boolean} | |
| */ | |
| equals: function (otherSource) { | |
| return false; | |
| }, | |
| /** | |
| * Responsible for parsing and configuring the | |
| * image metadata pertinent to this TileSources implementation. | |
| * This method is not implemented by this class other than to throw an Error | |
| * announcing you have to implement it. Because of the variety of tile | |
| * server technologies, and various specifications for building image | |
| * pyramids, this method is here to allow easy integration. | |
| * @function | |
| * @param {String|Object|Array|Document} data | |
| * @param {String} url - the url the data was loaded | |
| * from if any. | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null value obtained from | |
| * the protocol URL after '#' sign if flag splitHashDataForPost set to 'true' | |
| * @returns {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure the tile source constructor (include all values you want to | |
| * instantiate the TileSource subclass with - what _options_ object should contain). | |
| * @throws {Error} | |
| */ | |
| configure: function( data, url, postData ) { | |
| throw new Error( "Method not implemented." ); | |
| }, | |
| /** | |
| * Shall this source need to free some objects | |
| * upon unloading, it must be done here. For example, canvas | |
| * size must be set to 0 for safari to free. | |
| * @param {OpenSeadragon.Viewer} viewer | |
| */ | |
| destroy: function ( viewer ) { | |
| //no-op | |
| }, | |
| /** | |
| * Responsible for retrieving the url which will return an image for the | |
| * region specified by the given x, y, and level components. | |
| * This method is not implemented by this class other than to throw an Error | |
| * announcing you have to implement it. Because of the variety of tile | |
| * server technologies, and various specifications for building image | |
| * pyramids, this method is here to allow easy integration. | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| * @returns {String|Function} url - A string for the url or a function that returns a url string. | |
| * @throws {Error} | |
| */ | |
| getTileUrl: function( level, x, y ) { | |
| throw new Error( "Method not implemented." ); | |
| }, | |
| /** | |
| * Must use AJAX in order to work, i.e. loadTilesWithAjax = true is set. | |
| * If a value is returned, ajax issues POST request to the tile url. | |
| * If null is returned, ajax issues GET request. | |
| * The return value must comply to the header 'content type'. | |
| * | |
| * Examples (USED HEADER --> getTilePostData CODE): | |
| * 'Content-type': 'application/x-www-form-urlencoded' --> | |
| * return "key1=value=1&key2=value2"; | |
| * | |
| * 'Content-type': 'application/x-www-form-urlencoded' --> | |
| * return JSON.stringify({key: "value", number: 5}); | |
| * | |
| * 'Content-type': 'multipart/form-data' --> | |
| * let result = new FormData(); | |
| * result.append("data", myData); | |
| * return result; | |
| * | |
| * IMPORTANT: in case you move all the logic on image fetching | |
| * to post data, you must re-define 'getTileHashKey(...)' to | |
| * stay unique for different tile images. | |
| * | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| * @returns {*|null} post data to send with tile configuration request | |
| */ | |
| getTilePostData: function( level, x, y ) { | |
| return null; | |
| }, | |
| /** | |
| * Responsible for retrieving the headers which will be attached to the image request for the | |
| * region specified by the given x, y, and level components. | |
| * This option is only relevant if {@link OpenSeadragon.Options}.loadTilesWithAjax is set to true. | |
| * The headers returned here will override headers specified at the Viewer or TiledImage level. | |
| * Specifying a falsy value for a header will clear its existing value set at the Viewer or | |
| * TiledImage level (if any). | |
| * | |
| * Note that the headers of existing tiles don't automatically change when this function | |
| * returns updated headers. To do that, you need to call {@link OpenSeadragon.Viewer#setAjaxHeaders} | |
| * and propagate the changes. | |
| * | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| * @returns {Object} | |
| */ | |
| getTileAjaxHeaders: function( level, x, y ) { | |
| return {}; | |
| }, | |
| /** | |
| * The tile cache object is uniquely determined by this key and used to lookup | |
| * the image data in cache: keys should be different if images are different. | |
| * | |
| * You can return falsey tile cache key, in which case the tile will | |
| * be created without invoking ImageJob --- but with data=null. Then, | |
| * you are responsible for manually creating the cache data. This is useful | |
| * particularly if you want to use empty TiledImage with client-side derived data | |
| * only. The default tile-cache key is then called "" - an empty string. | |
| * | |
| * Note: default behaviour does not take into account post data. | |
| * @param {Number} level tile level it was fetched with | |
| * @param {Number} x x-coordinate in the pyramid level | |
| * @param {Number} y y-coordinate in the pyramid level | |
| * @param {String} url the tile was fetched with | |
| * @param {Object} ajaxHeaders the tile was fetched with | |
| * @param {*} postData data the tile was fetched with (type depends on getTilePostData(..) return type) | |
| * @return {?String} can return the cache key or null, in that case an empty cache is initialized | |
| * without downloading any data for internal use: user has to define the cache contents manually, via | |
| * the cache interface of this class. | |
| */ | |
| getTileHashKey: function(level, x, y, url, ajaxHeaders, postData) { | |
| function withHeaders(hash) { | |
| return ajaxHeaders ? hash + "+" + JSON.stringify(ajaxHeaders) : hash; | |
| } | |
| if (typeof url !== "string") { | |
| return withHeaders(level + "/" + x + "_" + y); | |
| } | |
| return withHeaders(url); | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| tileExists: function( level, x, y ) { | |
| var numTiles = this.getNumTiles( level ); | |
| return level >= this.minLevel && | |
| level <= this.maxLevel && | |
| x >= 0 && | |
| y >= 0 && | |
| x < numTiles.x && | |
| y < numTiles.y; | |
| }, | |
| /** | |
| * Decide whether tiles have transparency: this is crucial for correct images blending. | |
| * Overriden on a tile level by setting tile.hasTransparency = true; | |
| * @param context2D unused, deprecated argument | |
| * @param url tile.getUrl() value for given tile | |
| * @param ajaxHeaders tile.ajaxHeaders value for given tile | |
| * @param post tile.post value for given tile | |
| * @returns {boolean} true if the image has transparency | |
| */ | |
| hasTransparency: function(context2D, url, ajaxHeaders, post) { | |
| return url.match('.png'); | |
| }, | |
| /** | |
| * Download tile data. | |
| * Note that if you override this function, you should override also downloadTileAbort(). | |
| * @param {ImageJob} context job context that you have to call finish(...) on. | |
| * @param {String} [context.src] - URL of image to download. | |
| * @param {String} [context.loadWithAjax] - Whether to load this image with AJAX. | |
| * @param {String} [context.ajaxHeaders] - Headers to add to the image request if using AJAX. | |
| * @param {Boolean} [context.ajaxWithCredentials] - Whether to set withCredentials on AJAX requests. | |
| * @param {String} [context.crossOriginPolicy] - CORS policy to use for downloads | |
| * @param {?String|?Object} [context.postData] - HTTP POST data (usually but not necessarily | |
| * in k=v&k2=v2... form, see TileSource::getTilePostData) or null | |
| * @param {*} [context.userData] - Empty object to attach your own data and helper variables to. | |
| * @param {Function} [context.finish] - Should be called unless abort() was executed upon successful | |
| * data retrieval. | |
| * Usage: context.finish(data, request, dataType=undefined). Pass the downloaded data object | |
| * add also reference to an ajax request if used. Optionally, specify what data type the data is. | |
| * @param {Function} [context.fail] - Should be called unless abort() was executed upon unsuccessful request. | |
| * Usage: context.fail(errMessage, request). Provide error message in case of failure, | |
| * add also reference to an ajax request if used. | |
| * @param {Function} [context.abort] - Called automatically when the job times out. | |
| * Usage: if you decide to abort the request (no fail/finish will be called), call context.abort(). | |
| * @param {Function} [context.callback] Private parameter. Called automatically once image has been downloaded | |
| * (triggered by finish). | |
| * @param {Number} [context.timeout] Private parameter. The max number of milliseconds that | |
| * this image job may take to complete. | |
| * @param {string} [context.errorMsg] Private parameter. The final error message, default null (set by finish). | |
| */ | |
| downloadTileStart: function (context) { | |
| const dataStore = context.userData, | |
| image = new Image(); | |
| dataStore.image = image; | |
| dataStore.request = null; | |
| const finalize = function(error) { | |
| if (error || !image) { | |
| context.fail(error || "[downloadTileStart] Image load failed: undefined Image instance.", | |
| dataStore.request); | |
| return; | |
| } | |
| image.onload = image.onerror = image.onabort = null; | |
| context.finish(image, dataStore.request, "image"); | |
| }; | |
| image.onload = function () { | |
| finalize(); | |
| }; | |
| image.onabort = image.onerror = function() { | |
| finalize("[downloadTileStart] Image load aborted."); | |
| }; | |
| // Load the tile with an AJAX request if the loadWithAjax option is | |
| // set. Otherwise load the image by setting the source property of the image object. | |
| if (context.loadWithAjax) { | |
| dataStore.request = $.makeAjaxRequest({ | |
| url: context.src, | |
| withCredentials: context.ajaxWithCredentials, | |
| headers: context.ajaxHeaders, | |
| responseType: "arraybuffer", | |
| postData: context.postData, | |
| success: function(request) { | |
| var blb; | |
| // Make the raw data into a blob. | |
| // BlobBuilder fallback adapted from | |
| // http://stackoverflow.com/questions/15293694/blob-constructor-browser-compatibility | |
| try { | |
| blb = new window.Blob([request.response]); | |
| } catch (e) { | |
| const BlobBuilder = ( | |
| window.BlobBuilder || | |
| window.WebKitBlobBuilder || | |
| window.MozBlobBuilder || | |
| window.MSBlobBuilder | |
| ); | |
| if (e.name === 'TypeError' && BlobBuilder) { | |
| const bb = new BlobBuilder(); | |
| bb.append(request.response); | |
| blb = bb.getBlob(); | |
| } | |
| } | |
| // If the blob is empty for some reason consider the image load a failure. | |
| if (blb.size === 0) { | |
| finalize("[downloadTileStart] Empty image response."); | |
| } else { | |
| // Create a URL for the blob data and make it the source of the image object. | |
| // This will still trigger Image.onload to indicate a successful tile load. | |
| image.src = (window.URL || window.webkitURL).createObjectURL(blb); | |
| } | |
| }, | |
| error: function(request) { | |
| finalize("[downloadTileStart] Image load aborted - XHR error"); | |
| } | |
| }); | |
| } else { | |
| if (context.crossOriginPolicy !== false) { | |
| image.crossOrigin = context.crossOriginPolicy; | |
| } | |
| image.src = context.src; | |
| } | |
| }, | |
| /** | |
| * Provide means of aborting the execution. | |
| * Note that if you override this function, you should override also downloadTileStart(). | |
| * Note that calling job.abort() would create an infinite loop! | |
| * | |
| * @param {ImageJob} context job, the same object as with downloadTileStart(..) | |
| * @param {*} [context.userData] - Empty object to attach (and mainly read) your own data. | |
| */ | |
| downloadTileAbort: function (context) { | |
| if (context.userData.request) { | |
| context.userData.request.abort(); | |
| } | |
| var image = context.userData.image; | |
| if (context.userData.image) { | |
| image.onload = image.onerror = image.onabort = null; | |
| } | |
| }, | |
| /** | |
| * Create cache object from the result of the download process. The | |
| * cacheObject parameter should be used to attach the data to, there are no | |
| * conventions on how it should be stored - all the logic is implemented within *TileCache() functions. | |
| * | |
| * Note that | |
| * - data is cached automatically as cacheObject.data | |
| * - if you override any of *TileCache() functions, you should override all of them. | |
| * - these functions might be called over shared cache object managed by other TileSources simultaneously. | |
| * @param {OpenSeadragon.CacheRecord} cacheObject context cache object | |
| * @param {*} data image data, the data sent to ImageJob.prototype.finish(), by default an Image object | |
| * @param {OpenSeadragon.Tile} tile instance the cache was created with | |
| * @deprecated | |
| */ | |
| createTileCache: function(cacheObject, data, tile) { | |
| $.console.error("[TileSource.createTileCache] has been deprecated. Use cache API of a tile instead."); | |
| //no-op, we create the cache automatically | |
| }, | |
| /** | |
| * Cache object destructor, unset all properties you created to allow GC collection. | |
| * Note that if you override any of *TileCache() functions, you should override all of them. | |
| * Note that these functions might be called over shared cache object managed by other TileSources simultaneously. | |
| * Original cache data is cacheObject.data, but do not delete it manually! It is taken care for, | |
| * you might break things. | |
| * @param {OpenSeadragon.CacheRecord} cacheObject context cache object | |
| * @deprecated | |
| */ | |
| destroyTileCache: function (cacheObject) { | |
| $.console.error("[TileSource.destroyTileCache] has been deprecated. Use cache API of a tile instead."); | |
| //no-op, handled internally | |
| }, | |
| /** | |
| * Raw data getter, should return anything that is compatible with the system, or undefined | |
| * if the system can handle it. | |
| * @param {OpenSeadragon.CacheRecord} cacheObject context cache object | |
| * @returns {OpenSeadragon.Promise<?>} cache data | |
| * @deprecated | |
| */ | |
| getTileCacheData: function(cacheObject) { | |
| $.console.error("[TileSource.getTileCacheData] has been deprecated. Use cache API of a tile instead."); | |
| return cacheObject.getDataAs(undefined, false); | |
| }, | |
| /** | |
| * Compatibility image element getter | |
| * - plugins might need image representation of the data | |
| * - div HTML rendering relies on image element presence | |
| * Note that if you override any of *TileCache() functions, you should override all of them. | |
| * Note that these functions might be called over shared cache object managed by other TileSources simultaneously. | |
| * @param {OpenSeadragon.CacheRecord} cacheObject context cache object | |
| * @returns {Image} cache data as an Image | |
| * @deprecated | |
| */ | |
| getTileCacheDataAsImage: function(cacheObject) { | |
| $.console.error("[TileSource.getTileCacheDataAsImage] has been deprecated. Use cache API of a tile instead."); | |
| return cacheObject.getImage(); | |
| }, | |
| /** | |
| * Compatibility context 2D getter | |
| * - most heavily used rendering method is a canvas-based approach, | |
| * convert the data to a canvas and return it's 2D context | |
| * Note that if you override any of *TileCache() functions, you should override all of them. | |
| * @param {OpenSeadragon.CacheRecord} cacheObject context cache object | |
| * @returns {CanvasRenderingContext2D} context of the canvas representation of the cache data | |
| * @deprecated | |
| */ | |
| getTileCacheDataAsContext2D: function(cacheObject) { | |
| $.console.error("[TileSource.getTileCacheDataAsContext2D] has been deprecated. Use cache API of a tile instead."); | |
| return cacheObject.getRenderedContext(); | |
| } | |
| }; | |
| $.extend( true, $.TileSource.prototype, $.EventSource.prototype ); | |
| /** | |
| * Decides whether to try to process the response as xml, json, or hand back | |
| * the text | |
| * @private | |
| * @inner | |
| * @function | |
| * @param {XMLHttpRequest} xhr - the completed network request | |
| */ | |
| function processResponse( xhr ){ | |
| var responseText = xhr.responseText, | |
| status = xhr.status, | |
| statusText, | |
| data; | |
| if ( !xhr ) { | |
| throw new Error( $.getString( "Errors.Security" ) ); | |
| } else if ( xhr.status !== 200 && xhr.status !== 0 ) { | |
| status = xhr.status; | |
| statusText = ( status === 404 ) ? | |
| "Not Found" : | |
| xhr.statusText; | |
| throw new Error( $.getString( "Errors.Status", status, statusText ) ); | |
| } | |
| if( responseText.match(/^\s*<.*/) ){ | |
| try{ | |
| data = ( xhr.responseXML && xhr.responseXML.documentElement ) ? | |
| xhr.responseXML : | |
| $.parseXml( responseText ); | |
| } catch (e){ | |
| data = xhr.responseText; | |
| } | |
| }else if( responseText.match(/\s*[{[].*/) ){ | |
| try{ | |
| data = $.parseJSON(responseText); | |
| } catch(e){ | |
| data = responseText; | |
| } | |
| }else{ | |
| data = responseText; | |
| } | |
| return data; | |
| } | |
| /** | |
| * Determines the TileSource Implementation by introspection of OpenSeadragon | |
| * namespace, calling each TileSource implementation of 'isType' | |
| * @private | |
| * @inner | |
| * @function | |
| * @param {Object|Array|Document} data - the tile source configuration object | |
| * @param {String} url - the url where the tile source configuration object was | |
| * loaded from, if any. | |
| */ | |
| $.TileSource.determineType = function( tileSource, data, url ){ | |
| var property; | |
| for( property in OpenSeadragon ){ | |
| if( property.match(/.+TileSource$/) && | |
| $.isFunction( OpenSeadragon[ property ] ) && | |
| $.isFunction( OpenSeadragon[ property ].prototype.supports ) && | |
| OpenSeadragon[ property ].prototype.supports.call( tileSource, data, url ) | |
| ){ | |
| return OpenSeadragon[ property ]; | |
| } | |
| } | |
| $.console.error( "No TileSource was able to open %s %s", url, data ); | |
| return null; | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - DziTileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class DziTileSource | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @param {Number|Object} width - the pixel width of the image or the idiomatic | |
| * options object which is used instead of positional arguments. | |
| * @param {Number} height | |
| * @param {Number} tileSize | |
| * @param {Number} tileOverlap | |
| * @param {String} tilesUrl | |
| * @param {String} fileFormat | |
| * @param {OpenSeadragon.DisplayRect[]} displayRects | |
| * @property {String} tilesUrl | |
| * @property {String} fileFormat | |
| * @property {OpenSeadragon.DisplayRect[]} displayRects | |
| */ | |
| $.DziTileSource = function( width, height, tileSize, tileOverlap, tilesUrl, fileFormat, displayRects, minLevel, maxLevel ) { | |
| var i, | |
| rect, | |
| level, | |
| options; | |
| if( $.isPlainObject( width ) ){ | |
| options = width; | |
| }else{ | |
| options = { | |
| width: arguments[ 0 ], | |
| height: arguments[ 1 ], | |
| tileSize: arguments[ 2 ], | |
| tileOverlap: arguments[ 3 ], | |
| tilesUrl: arguments[ 4 ], | |
| fileFormat: arguments[ 5 ], | |
| displayRects: arguments[ 6 ], | |
| minLevel: arguments[ 7 ], | |
| maxLevel: arguments[ 8 ] | |
| }; | |
| } | |
| this._levelRects = {}; | |
| this.tilesUrl = options.tilesUrl; | |
| this.fileFormat = options.fileFormat; | |
| this.displayRects = options.displayRects; | |
| if ( this.displayRects ) { | |
| for ( i = this.displayRects.length - 1; i >= 0; i-- ) { | |
| rect = this.displayRects[ i ]; | |
| for ( level = rect.minLevel; level <= rect.maxLevel; level++ ) { | |
| if ( !this._levelRects[ level ] ) { | |
| this._levelRects[ level ] = []; | |
| } | |
| this._levelRects[ level ].push( rect ); | |
| } | |
| } | |
| } | |
| $.TileSource.apply( this, [ options ] ); | |
| }; | |
| $.extend( $.DziTileSource.prototype, $.TileSource.prototype, /** @lends OpenSeadragon.DziTileSource.prototype */{ | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} optional - url | |
| */ | |
| supports: function( data, url ){ | |
| var ns; | |
| if ( data.Image ) { | |
| ns = data.Image.xmlns; | |
| } else if ( data.documentElement) { | |
| if ("Image" === data.documentElement.localName || "Image" === data.documentElement.tagName) { | |
| ns = data.documentElement.namespaceURI; | |
| } | |
| } | |
| ns = (ns || '').toLowerCase(); | |
| return (ns.indexOf('schemas.microsoft.com/deepzoom/2008') !== -1 || | |
| ns.indexOf('schemas.microsoft.com/deepzoom/2009') !== -1); | |
| }, | |
| /** | |
| * | |
| * @function | |
| * @param {Object|XMLDocument} data - the raw configuration | |
| * @param {String} url - the url the data was retrieved from if any. | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null | |
| * @returns {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure this tile sources constructor. | |
| */ | |
| configure: function( data, url, postData ){ | |
| var options; | |
| if( !$.isPlainObject(data) ){ | |
| options = configureFromXML( this, data ); | |
| }else{ | |
| options = configureFromObject( this, data ); | |
| } | |
| if (url && !options.tilesUrl) { | |
| options.tilesUrl = url.replace( | |
| /([^/]+?)(\.(dzi|xml|js)?(\?[^/]*)?)?\/?$/, '$1_files/'); | |
| if (url.search(/\.(dzi|xml|js)\?/) !== -1) { | |
| options.queryParams = url.match(/\?.*/); | |
| }else{ | |
| options.queryParams = ''; | |
| } | |
| } | |
| return options; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| getTileUrl: function( level, x, y ) { | |
| return [ this.tilesUrl, level, '/', x, '_', y, '.', this.fileFormat, this.queryParams ].join( '' ); | |
| }, | |
| /** | |
| * Equality comparator | |
| */ | |
| equals: function(otherSource) { | |
| return this.tilesUrl === otherSource.tilesUrl; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| tileExists: function( level, x, y ) { | |
| var rects = this._levelRects[ level ], | |
| rect, | |
| scale, | |
| xMin, | |
| yMin, | |
| xMax, | |
| yMax, | |
| i; | |
| if ((this.minLevel && level < this.minLevel) || (this.maxLevel && level > this.maxLevel)) { | |
| return false; | |
| } | |
| if ( !rects || !rects.length ) { | |
| return true; | |
| } | |
| for ( i = rects.length - 1; i >= 0; i-- ) { | |
| rect = rects[ i ]; | |
| if ( level < rect.minLevel || level > rect.maxLevel ) { | |
| continue; | |
| } | |
| scale = this.getLevelScale( level ); | |
| xMin = rect.x * scale; | |
| yMin = rect.y * scale; | |
| xMax = xMin + rect.width * scale; | |
| yMax = yMin + rect.height * scale; | |
| xMin = Math.floor( xMin / this._tileWidth ); | |
| yMin = Math.floor( yMin / this._tileWidth ); // DZI tiles are square, so we just use _tileWidth | |
| xMax = Math.ceil( xMax / this._tileWidth ); | |
| yMax = Math.ceil( yMax / this._tileWidth ); | |
| if ( xMin <= x && x < xMax && yMin <= y && y < yMax ) { | |
| return true; | |
| } | |
| } | |
| return false; | |
| } | |
| }); | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function configureFromXML( tileSource, xmlDoc ){ | |
| if ( !xmlDoc || !xmlDoc.documentElement ) { | |
| throw new Error( $.getString( "Errors.Xml" ) ); | |
| } | |
| var root = xmlDoc.documentElement, | |
| rootName = root.localName || root.tagName, | |
| ns = xmlDoc.documentElement.namespaceURI, | |
| configuration = null, | |
| displayRects = [], | |
| dispRectNodes, | |
| dispRectNode, | |
| rectNode, | |
| sizeNode, | |
| i; | |
| if ( rootName === "Image" ) { | |
| try { | |
| sizeNode = root.getElementsByTagName("Size" )[ 0 ]; | |
| if (sizeNode === undefined) { | |
| sizeNode = root.getElementsByTagNameNS(ns, "Size" )[ 0 ]; | |
| } | |
| configuration = { | |
| Image: { | |
| xmlns: "http://schemas.microsoft.com/deepzoom/2008", | |
| Url: root.getAttribute( "Url" ), | |
| Format: root.getAttribute( "Format" ), | |
| DisplayRect: null, | |
| Overlap: parseInt( root.getAttribute( "Overlap" ), 10 ), | |
| TileSize: parseInt( root.getAttribute( "TileSize" ), 10 ), | |
| Size: { | |
| Height: parseInt( sizeNode.getAttribute( "Height" ), 10 ), | |
| Width: parseInt( sizeNode.getAttribute( "Width" ), 10 ) | |
| } | |
| } | |
| }; | |
| if ( !$.imageFormatSupported( configuration.Image.Format ) ) { | |
| throw new Error( | |
| $.getString( "Errors.ImageFormat", configuration.Image.Format.toUpperCase() ) | |
| ); | |
| } | |
| dispRectNodes = root.getElementsByTagName("DisplayRect" ); | |
| if (dispRectNodes === undefined) { | |
| dispRectNodes = root.getElementsByTagNameNS(ns, "DisplayRect" )[ 0 ]; | |
| } | |
| for ( i = 0; i < dispRectNodes.length; i++ ) { | |
| dispRectNode = dispRectNodes[ i ]; | |
| rectNode = dispRectNode.getElementsByTagName("Rect" )[ 0 ]; | |
| if (rectNode === undefined) { | |
| rectNode = dispRectNode.getElementsByTagNameNS(ns, "Rect" )[ 0 ]; | |
| } | |
| displayRects.push({ | |
| Rect: { | |
| X: parseInt( rectNode.getAttribute( "X" ), 10 ), | |
| Y: parseInt( rectNode.getAttribute( "Y" ), 10 ), | |
| Width: parseInt( rectNode.getAttribute( "Width" ), 10 ), | |
| Height: parseInt( rectNode.getAttribute( "Height" ), 10 ), | |
| MinLevel: parseInt( dispRectNode.getAttribute( "MinLevel" ), 10 ), | |
| MaxLevel: parseInt( dispRectNode.getAttribute( "MaxLevel" ), 10 ) | |
| } | |
| }); | |
| } | |
| if( displayRects.length ){ | |
| configuration.Image.DisplayRect = displayRects; | |
| } | |
| return configureFromObject( tileSource, configuration ); | |
| } catch ( e ) { | |
| throw (e instanceof Error) ? | |
| e : | |
| new Error( $.getString("Errors.Dzi") ); | |
| } | |
| } else if ( rootName === "Collection" ) { | |
| throw new Error( $.getString( "Errors.Dzc" ) ); | |
| } else if ( rootName === "Error" ) { | |
| var messageNode = root.getElementsByTagName("Message")[0]; | |
| var message = messageNode.firstChild.nodeValue; | |
| throw new Error(message); | |
| } | |
| throw new Error( $.getString( "Errors.Dzi" ) ); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function configureFromObject( tileSource, configuration ){ | |
| var imageData = configuration.Image, | |
| tilesUrl = imageData.Url, | |
| fileFormat = imageData.Format, | |
| sizeData = imageData.Size, | |
| dispRectData = imageData.DisplayRect || [], | |
| width = parseInt( sizeData.Width, 10 ), | |
| height = parseInt( sizeData.Height, 10 ), | |
| tileSize = parseInt( imageData.TileSize, 10 ), | |
| tileOverlap = parseInt( imageData.Overlap, 10 ), | |
| displayRects = [], | |
| rectData, | |
| i; | |
| //TODO: need to figure out out to better handle image format compatibility | |
| // which actually includes additional file formats like xml and pdf | |
| // and plain text for various tilesource implementations to avoid low | |
| // level errors. | |
| // | |
| // For now, just don't perform the check. | |
| // | |
| /*if ( !imageFormatSupported( fileFormat ) ) { | |
| throw new Error( | |
| $.getString( "Errors.ImageFormat", fileFormat.toUpperCase() ) | |
| ); | |
| }*/ | |
| for ( i = 0; i < dispRectData.length; i++ ) { | |
| rectData = dispRectData[ i ].Rect; | |
| displayRects.push( new $.DisplayRect( | |
| parseInt( rectData.X, 10 ), | |
| parseInt( rectData.Y, 10 ), | |
| parseInt( rectData.Width, 10 ), | |
| parseInt( rectData.Height, 10 ), | |
| parseInt( rectData.MinLevel, 10 ), | |
| parseInt( rectData.MaxLevel, 10 ) | |
| )); | |
| } | |
| return $.extend(true, { | |
| width: width, /* width *required */ | |
| height: height, /* height *required */ | |
| tileSize: tileSize, /* tileSize *required */ | |
| tileOverlap: tileOverlap, /* tileOverlap *required */ | |
| minLevel: null, /* minLevel */ | |
| maxLevel: null, /* maxLevel */ | |
| tilesUrl: tilesUrl, /* tilesUrl */ | |
| fileFormat: fileFormat, /* fileFormat */ | |
| displayRects: displayRects /* displayRects */ | |
| }, configuration ); | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - IIIFTileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2025 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class IIIFTileSource | |
| * @classdesc A client implementation of the International Image Interoperability Framework | |
| * Format: Image API 1.0 - 3.0 | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @see http://iiif.io/api/image/ | |
| * @param {String} [options.tileFormat='jpg'] | |
| * The extension that will be used when requiring tiles. | |
| */ | |
| $.IIIFTileSource = function( options ){ | |
| /* eslint-disable camelcase */ | |
| $.extend( true, this, options ); | |
| /* Normalizes v3-style 'id' keys to an "_id" internal property */ | |
| this._id = this["@id"] || this["id"] || this['identifier'] || null; | |
| if ( !( this.height && this.width && this._id) ) { | |
| throw new Error( 'IIIF required parameters (width, height, or id) not provided.' ); | |
| } | |
| options.tileSizePerScaleFactor = {}; | |
| this.tileFormat = this.tileFormat || 'jpg'; | |
| this.version = options.version; | |
| this.isLevel0 = checkLevel0( options ); | |
| // N.B. 2.0 renamed scale_factors to scaleFactors | |
| if ( this.tile_width && this.tile_height ) { | |
| options.tileWidth = this.tile_width; | |
| options.tileHeight = this.tile_height; | |
| } else if ( this.tile_width ) { | |
| options.tileSize = this.tile_width; | |
| } else if ( this.tile_height ) { | |
| options.tileSize = this.tile_height; | |
| } else if ( this.tiles ) { | |
| // Version 2.0 forwards | |
| if ( this.tiles.length === 1 ) { | |
| options.tileWidth = this.tiles[0].width; | |
| // Use height if provided, otherwise assume square tiles and use width. | |
| options.tileHeight = this.tiles[0].height || this.tiles[0].width; | |
| this.scale_factors = this.tiles[0].scaleFactors; | |
| } else { | |
| // Multiple tile sizes at different levels | |
| this.scale_factors = []; | |
| for (var t = 0; t < this.tiles.length; t++ ) { | |
| for (var sf = 0; sf < this.tiles[t].scaleFactors.length; sf++) { | |
| var scaleFactor = this.tiles[t].scaleFactors[sf]; | |
| this.scale_factors.push(scaleFactor); | |
| options.tileSizePerScaleFactor[scaleFactor] = { | |
| width: this.tiles[t].width, | |
| height: this.tiles[t].height || this.tiles[t].width | |
| }; | |
| } | |
| } | |
| } | |
| } else if ( canBeTiled(options) ) { | |
| // use the largest of tileOptions that is smaller than the short dimension | |
| var shortDim = Math.min( this.height, this.width ), | |
| tileOptions = [256, 512, 1024], | |
| smallerTiles = []; | |
| for ( var c = 0; c < tileOptions.length; c++ ) { | |
| if ( tileOptions[c] <= shortDim ) { | |
| smallerTiles.push( tileOptions[c] ); | |
| } | |
| } | |
| if ( smallerTiles.length > 0 ) { | |
| options.tileSize = Math.max.apply( null, smallerTiles ); | |
| } else { | |
| // If we're smaller than 256, just use the short side. | |
| options.tileSize = shortDim; | |
| } | |
| } else if (this.sizes && this.sizes.length > 0) { | |
| // This info.json can't be tiled, but we can still construct a legacy pyramid from the sizes array. | |
| // In this mode, IIIFTileSource will call functions from the abstract baseTileSource or the | |
| // LegacyTileSource instead of performing IIIF tiling. | |
| this.emulateLegacyImagePyramid = true; | |
| options.levels = constructLevels( this ); | |
| // use the largest available size to define tiles | |
| $.extend( true, options, { | |
| width: options.levels[ options.levels.length - 1 ].width, | |
| height: options.levels[ options.levels.length - 1 ].height, | |
| tileSize: Math.max( options.height, options.width ), | |
| tileOverlap: 0, | |
| minLevel: 0, | |
| maxLevel: options.levels.length - 1 | |
| }); | |
| this.levels = options.levels; | |
| } else { | |
| $.console.error("Nothing in the info.json to construct image pyramids from"); | |
| } | |
| if (!options.maxLevel && !this.emulateLegacyImagePyramid) { | |
| if (!this.scale_factors) { | |
| options.maxLevel = Number(Math.round(Math.log(Math.max(this.width, this.height), 2))); | |
| } else { | |
| var maxScaleFactor = Math.max.apply(null, this.scale_factors); | |
| options.maxLevel = Math.round(Math.log(maxScaleFactor) * Math.LOG2E); | |
| } | |
| } | |
| // Create an array with precise resolution sizes if these have been supplied through the 'sizes' object | |
| if( this.sizes ) { | |
| var sizeLength = this.sizes.length; | |
| // Create a copy of the sizes list and sort in ascending order | |
| var sortedSizes = this.sizes.slice().sort(( size1, size2 ) => size1.width - size2.width); | |
| // List may or may not include the full resolution size (should be last after sorting): add it if necessary | |
| if( sortedSizes[sizeLength - 1].width < this.width && sortedSizes[sizeLength - 1].height < this.height ) { | |
| sortedSizes.push( {width: this.width, height: this.height} ); | |
| sizeLength++; | |
| } | |
| // Only try to use 'sizes' if the number of dimensions within exactly matches the number of resolution levels (maxLevel+1) | |
| if ( sizeLength === options.maxLevel + 1 ) { | |
| // If we have a list of scaleFactors, make sure each of our sizes really corresponds to the listed scales | |
| var isResolutionList = 1; | |
| if ( this.scale_factors && this.scale_factors.length === sizeLength ) { | |
| for ( var i = 0; i < sizeLength; i++ ) { | |
| var factor = this.scale_factors[sizeLength - i - 1]; // Scale factor order is inverted | |
| if ( Math.round( this.width / sortedSizes[i].width ) !== factor || | |
| Math.round( this.height / sortedSizes[i].height ) !== factor ) { | |
| isResolutionList = 0; | |
| break; | |
| } | |
| } | |
| } | |
| // The 'sizes' array does indeed contain a list of resolution levels, so assign our sorted array | |
| if ( isResolutionList === 1 ) { | |
| this.levelSizes = sortedSizes; | |
| } | |
| } | |
| } | |
| $.TileSource.apply( this, [ options ] ); | |
| }; | |
| $.extend( $.IIIFTileSource.prototype, $.TileSource.prototype, /** @lends OpenSeadragon.IIIFTileSource.prototype */{ | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} [url] - url | |
| */ | |
| supports: function( data, url ) { | |
| // Version 2.0 and forwards | |
| if (data.protocol && data.protocol === 'http://iiif.io/api/image') { | |
| return true; | |
| // Version 1.1 | |
| } else if ( data['@context'] && ( | |
| data['@context'] === "http://library.stanford.edu/iiif/image-api/1.1/context.json" || | |
| data['@context'] === "http://iiif.io/api/image/1/context.json") ) { | |
| // N.B. the iiif.io context is wrong, but where the representation lives so likely to be used | |
| return true; | |
| // Version 1.0 | |
| } else if ( data.profile && | |
| data.profile.indexOf("http://library.stanford.edu/iiif/image-api/compliance.html") === 0) { | |
| return true; | |
| } else if ( data.identifier && data.width && data.height ) { | |
| return true; | |
| } else if ( data.documentElement && | |
| "info" === data.documentElement.tagName && | |
| "http://library.stanford.edu/iiif/image-api/ns/" === | |
| data.documentElement.namespaceURI) { | |
| return true; | |
| // Not IIIF | |
| } else { | |
| return false; | |
| } | |
| }, | |
| /** | |
| * A static function used to prepare an incoming IIIF Image API info.json | |
| * response for processing by the tile handler. Normalizes data for all | |
| * versions of IIIF (1.0, 1.1, 2.x, 3.x) and returns a data object that | |
| * may be passed to the IIIFTileSource. | |
| * | |
| * @function | |
| * @static | |
| * @param {Object} data - the raw configuration | |
| * @param {String} url - the url configuration was retrieved from | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null | |
| * @returns {Object} A normalized IIIF data object | |
| * @example <caption>IIIF 2.x Info Looks like this</caption> | |
| * { | |
| * "@context": "http://iiif.io/api/image/2/context.json", | |
| * "@id": "http://iiif.example.com/prefix/1E34750D-38DB-4825-A38A-B60A345E591C", | |
| * "protocol": "http://iiif.io/api/image", | |
| * "height": 1024, | |
| * "width": 775, | |
| * "tiles" : [{"width":256, "scaleFactors":[1,2,4,8]}], | |
| * "profile": ["http://iiif.io/api/image/2/level1.json", { | |
| * "qualities": [ "native", "bitonal", "grey", "color" ], | |
| * "formats": [ "jpg", "png", "gif" ] | |
| * }] | |
| * } | |
| */ | |
| configure: function( data, url, postData ){ | |
| // Try to deduce our version and fake it upwards if needed | |
| if ( !$.isPlainObject(data) ) { | |
| var options = configureFromXml10( data ); | |
| options['@context'] = "http://iiif.io/api/image/1.0/context.json"; | |
| options["@id"] = url.replace('/info.xml', ''); | |
| options.version = 1; | |
| return options; | |
| } else { | |
| if ( !data['@context'] ) { | |
| data['@context'] = 'http://iiif.io/api/image/1.0/context.json'; | |
| data["@id"] = url.replace('/info.json', ''); | |
| data.version = 1; | |
| } else { | |
| var context = data['@context']; | |
| if (Array.isArray(context)) { | |
| for (var i = 0; i < context.length; i++) { | |
| if (typeof context[i] === 'string' && | |
| ( /^http:\/\/iiif\.io\/api\/image\/[1-3]\/context\.json$/.test(context[i]) || | |
| context[i] === 'http://library.stanford.edu/iiif/image-api/1.1/context.json' ) ) { | |
| context = context[i]; | |
| break; | |
| } | |
| } | |
| } | |
| switch (context) { | |
| case 'http://iiif.io/api/image/1/context.json': | |
| case 'http://library.stanford.edu/iiif/image-api/1.1/context.json': | |
| data.version = 1; | |
| break; | |
| case 'http://iiif.io/api/image/2/context.json': | |
| data.version = 2; | |
| break; | |
| case 'http://iiif.io/api/image/3/context.json': | |
| data.version = 3; | |
| break; | |
| default: | |
| $.console.error('Data has a @context property which contains no known IIIF context URI.'); | |
| } | |
| } | |
| if (data.preferredFormats) { | |
| for (var f = 0; f < data.preferredFormats.length; f++ ) { | |
| if ( $.imageFormatSupported(data.preferredFormats[f]) ) { | |
| data.tileFormat = data.preferredFormats[f]; | |
| break; | |
| } | |
| } | |
| } | |
| return data; | |
| } | |
| }, | |
| /** | |
| * Return the tileWidth for the given level. | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getTileWidth: function( level ) { | |
| if(this.emulateLegacyImagePyramid) { | |
| return $.TileSource.prototype.getTileWidth.call(this, level); | |
| } | |
| var scaleFactor = Math.pow(2, this.maxLevel - level); | |
| if (this.tileSizePerScaleFactor && this.tileSizePerScaleFactor[scaleFactor]) { | |
| return this.tileSizePerScaleFactor[scaleFactor].width; | |
| } | |
| return this._tileWidth; | |
| }, | |
| /** | |
| * Return the tileHeight for the given level. | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getTileHeight: function( level ) { | |
| if(this.emulateLegacyImagePyramid) { | |
| return $.TileSource.prototype.getTileHeight.call(this, level); | |
| } | |
| var scaleFactor = Math.pow(2, this.maxLevel - level); | |
| if (this.tileSizePerScaleFactor && this.tileSizePerScaleFactor[scaleFactor]) { | |
| return this.tileSizePerScaleFactor[scaleFactor].height; | |
| } | |
| return this._tileHeight; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getLevelScale: function ( level ) { | |
| if(this.emulateLegacyImagePyramid) { | |
| var levelScale = NaN; | |
| if (this.levels.length > 0 && level >= this.minLevel && level <= this.maxLevel) { | |
| levelScale = | |
| this.levels[level].width / | |
| this.levels[this.maxLevel].width; | |
| } | |
| return levelScale; | |
| } | |
| return $.TileSource.prototype.getLevelScale.call(this, level); | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getNumTiles: function( level ) { | |
| if(this.emulateLegacyImagePyramid) { | |
| var scale = this.getLevelScale(level); | |
| if (scale) { | |
| return new $.Point(1, 1); | |
| } else { | |
| return new $.Point(0, 0); | |
| } | |
| } | |
| // Use supplied list of scaled resolution sizes if these exist | |
| if( this.levelSizes ) { | |
| var levelSize = this.levelSizes[level]; | |
| var x = Math.ceil( levelSize.width / this.getTileWidth(level) ), | |
| y = Math.ceil( levelSize.height / this.getTileHeight(level) ); | |
| return new $.Point( x, y ); | |
| } | |
| // Otherwise call default TileSource->getNumTiles() function | |
| else { | |
| return $.TileSource.prototype.getNumTiles.call(this, level); | |
| } | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {OpenSeadragon.Point} point | |
| */ | |
| getTileAtPoint: function( level, point ) { | |
| if(this.emulateLegacyImagePyramid) { | |
| return new $.Point(0, 0); | |
| } | |
| // Use supplied list of scaled resolution sizes if these exist | |
| if( this.levelSizes ) { | |
| var validPoint = point.x >= 0 && point.x <= 1 && | |
| point.y >= 0 && point.y <= 1 / this.aspectRatio; | |
| $.console.assert(validPoint, "[TileSource.getTileAtPoint] must be called with a valid point."); | |
| var widthScaled = this.levelSizes[level].width; | |
| var pixelX = point.x * widthScaled; | |
| var pixelY = point.y * widthScaled; | |
| var x = Math.floor(pixelX / this.getTileWidth(level)); | |
| var y = Math.floor(pixelY / this.getTileHeight(level)); | |
| // When point.x == 1 or point.y == 1 / this.aspectRatio we want to | |
| // return the last tile of the row/column | |
| if (point.x >= 1) { | |
| x = this.getNumTiles(level).x - 1; | |
| } | |
| var EPSILON = 1e-15; | |
| if (point.y >= 1 / this.aspectRatio - EPSILON) { | |
| y = this.getNumTiles(level).y - 1; | |
| } | |
| return new $.Point(x, y); | |
| } | |
| // Otherwise call default TileSource->getTileAtPoint() function | |
| return $.TileSource.prototype.getTileAtPoint.call(this, level, point); | |
| }, | |
| /** | |
| * Responsible for retrieving the url which will return an image for the | |
| * region specified by the given x, y, and level components. | |
| * @function | |
| * @param {Number} level - z index | |
| * @param {Number} x | |
| * @param {Number} y | |
| * @throws {Error} | |
| */ | |
| getTileUrl: function( level, x, y ){ | |
| if(this.emulateLegacyImagePyramid) { | |
| var url = null; | |
| if ( this.levels.length > 0 && level >= this.minLevel && level <= this.maxLevel ) { | |
| url = this.levels[ level ].url; | |
| } | |
| return url; | |
| } | |
| //# constants | |
| var IIIF_ROTATION = '0', | |
| //## get the scale (level as a decimal) | |
| scale = Math.pow( 0.5, this.maxLevel - level ), | |
| //# image dimensions at this level | |
| levelWidth, | |
| levelHeight, | |
| //## iiif region | |
| tileWidth, | |
| tileHeight, | |
| iiifTileSizeWidth, | |
| iiifTileSizeHeight, | |
| iiifRegion, | |
| iiifTileX, | |
| iiifTileY, | |
| iiifTileW, | |
| iiifTileH, | |
| iiifSize, | |
| iiifSizeW, | |
| iiifSizeH, | |
| iiifQuality, | |
| uri; | |
| // Use supplied list of scaled resolution sizes if these exist | |
| if( this.levelSizes ) { | |
| levelWidth = this.levelSizes[level].width; | |
| levelHeight = this.levelSizes[level].height; | |
| } | |
| // Otherwise calculate the sizes ourselves | |
| else { | |
| levelWidth = Math.ceil( this.width * scale ); | |
| levelHeight = Math.ceil( this.height * scale ); | |
| } | |
| tileWidth = this.getTileWidth(level); | |
| tileHeight = this.getTileHeight(level); | |
| iiifTileSizeWidth = Math.round( tileWidth / scale ); | |
| iiifTileSizeHeight = Math.round( tileHeight / scale ); | |
| if (this.version === 1) { | |
| iiifQuality = "native." + this.tileFormat; | |
| } else { | |
| iiifQuality = "default." + this.tileFormat; | |
| } | |
| if ( levelWidth < tileWidth && levelHeight < tileHeight ){ | |
| if ( this.version === 2 && levelWidth === this.width ) { | |
| iiifSize = "full"; | |
| } else if ( this.version === 3 && levelWidth === this.width && levelHeight === this.height ) { | |
| iiifSize = "max"; | |
| } else if ( this.version === 3 ) { | |
| iiifSize = levelWidth + "," + levelHeight; | |
| } else { | |
| iiifSize = levelWidth + ","; | |
| } | |
| iiifRegion = 'full'; | |
| } else { | |
| iiifTileX = x * iiifTileSizeWidth; | |
| iiifTileY = y * iiifTileSizeHeight; | |
| iiifTileW = Math.min( iiifTileSizeWidth, this.width - iiifTileX ); | |
| iiifTileH = Math.min( iiifTileSizeHeight, this.height - iiifTileY ); | |
| if ( x === 0 && y === 0 && iiifTileW === this.width && iiifTileH === this.height ) { | |
| iiifRegion = "full"; | |
| } else { | |
| iiifRegion = [ iiifTileX, iiifTileY, iiifTileW, iiifTileH ].join( ',' ); | |
| } | |
| iiifSizeW = Math.min( tileWidth, levelWidth - (x * tileWidth) ); | |
| iiifSizeH = Math.min( tileHeight, levelHeight - (y * tileHeight) ); | |
| if ( this.version === 2 && iiifSizeW === this.width ) { | |
| iiifSize = "full"; | |
| } else if ( this.version === 3 && iiifSizeW === this.width && iiifSizeH === this.height ) { | |
| iiifSize = "max"; | |
| } else if (this.isLevel0 && this.version < 3) { | |
| iiifSize = iiifSizeW + ","; | |
| } else { | |
| iiifSize = iiifSizeW + "," + iiifSizeH; | |
| } | |
| } | |
| uri = [ this._id, iiifRegion, iiifSize, IIIF_ROTATION, iiifQuality ].join( '/' ); | |
| return uri; | |
| }, | |
| /** | |
| * Equality comparator | |
| */ | |
| equals: function(otherSource) { | |
| return this._id === otherSource._id; | |
| }, | |
| __testonly__: { | |
| canBeTiled: canBeTiled, | |
| constructLevels: constructLevels | |
| } | |
| }); | |
| /** | |
| * Determine whether we have a level 0 compliance profile | |
| * @function | |
| * @param {Object} options | |
| * @param {Array|String} options.profile | |
| * @returns {Boolean} | |
| */ | |
| function checkLevel0 ( options ) { | |
| var level0Profiles = [ | |
| "http://library.stanford.edu/iiif/image-api/compliance.html#level0", | |
| "http://library.stanford.edu/iiif/image-api/1.1/compliance.html#level0", | |
| "http://iiif.io/api/image/2/level0.json", | |
| "level0", | |
| "https://iiif.io/api/image/3/level0.json" | |
| ]; | |
| var profileLevel = Array.isArray(options.profile) ? options.profile[0] : options.profile; | |
| var isLevel0 = (level0Profiles.indexOf(profileLevel) !== -1); | |
| return isLevel0; | |
| } | |
| /** | |
| * Determine whether arbitrary tile requests can be made against a service with the given profile | |
| * @function | |
| * @param {Object} options | |
| * @param {Array|String} options.profile | |
| * @param {Number} options.version | |
| * @param {String[]} options.extraFeatures | |
| * @returns {Boolean} | |
| */ | |
| function canBeTiled ( options ) { | |
| var isLevel0 = checkLevel0( options ); | |
| var hasCanonicalSizeFeature = false; | |
| if ( options.version === 2 && options.profile.length > 1 && options.profile[1].supports ) { | |
| hasCanonicalSizeFeature = options.profile[1].supports.indexOf( "sizeByW" ) !== -1; | |
| } | |
| if ( options.version === 3 && options.extraFeatures ) { | |
| hasCanonicalSizeFeature = options.extraFeatures.indexOf( "sizeByWh" ) !== -1; | |
| } | |
| return !isLevel0 || hasCanonicalSizeFeature; | |
| } | |
| /** | |
| * Build the legacy pyramid URLs (one tile per level) | |
| * @function | |
| * @param {object} options - infoJson | |
| * @throws {Error} | |
| */ | |
| function constructLevels(options) { | |
| var levels = []; | |
| for(var i = 0; i < options.sizes.length; i++) { | |
| levels.push({ | |
| url: options._id + '/full/' + options.sizes[i].width + ',' + | |
| (options.version === 3 ? options.sizes[i].height : '') + | |
| '/0/default.' + options.tileFormat, | |
| width: options.sizes[i].width, | |
| height: options.sizes[i].height | |
| }); | |
| } | |
| return levels.sort(function(a, b) { | |
| return a.width - b.width; | |
| }); | |
| } | |
| function configureFromXml10(xmlDoc) { | |
| //parse the xml | |
| if ( !xmlDoc || !xmlDoc.documentElement ) { | |
| throw new Error( $.getString( "Errors.Xml" ) ); | |
| } | |
| var root = xmlDoc.documentElement, | |
| rootName = root.tagName, | |
| configuration = null; | |
| if ( rootName === "info" ) { | |
| try { | |
| configuration = {}; | |
| parseXML10( root, configuration ); | |
| return configuration; | |
| } catch ( e ) { | |
| throw (e instanceof Error) ? | |
| e : | |
| new Error( $.getString("Errors.IIIF") ); | |
| } | |
| } | |
| throw new Error( $.getString( "Errors.IIIF" ) ); | |
| } | |
| function parseXML10( node, configuration, property ) { | |
| var i, | |
| value; | |
| if ( node.nodeType === 3 && property ) {//text node | |
| value = node.nodeValue.trim(); | |
| if( value.match(/^\d*$/)){ | |
| value = Number( value ); | |
| } | |
| if( !configuration[ property ] ){ | |
| configuration[ property ] = value; | |
| }else{ | |
| if( !$.isArray( configuration[ property ] ) ){ | |
| configuration[ property ] = [ configuration[ property ] ]; | |
| } | |
| configuration[ property ].push( value ); | |
| } | |
| } else if( node.nodeType === 1 ){ | |
| for( i = 0; i < node.childNodes.length; i++ ){ | |
| parseXML10( node.childNodes[ i ], configuration, node.nodeName ); | |
| } | |
| } | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - SziTileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2013 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class SziTileSource | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @param {Number|Object} width - the pixel width of the image or the idiomatic | |
| * options object which is used instead of positional arguments. | |
| * @param {Number} height | |
| * @param {Number} tileSize | |
| * @param {Number} tileOverlap | |
| * @param {String} tilesUrl | |
| * @param {String} fileFormat | |
| * @param {OpenSeadragon.DisplayRect[]} displayRects | |
| * @property {String} tilesUrl | |
| * @property {String} fileFormat | |
| * @property {OpenSeadragon.DisplayRect[]} displayRects | |
| */ | |
| $.SziTileSource = function( width, height, tileSize, tileOverlap, tilesUrl, fileFormat, displayRects, minLevel, maxLevel ) { | |
| var i, | |
| rect, | |
| level, | |
| options; | |
| if( $.isPlainObject( width ) ){ | |
| options = width; | |
| }else{ | |
| options = { | |
| width: arguments[ 0 ], | |
| height: arguments[ 1 ], | |
| tileSize: arguments[ 2 ], | |
| tileOverlap: arguments[ 3 ], | |
| tilesUrl: arguments[ 4 ], | |
| fileFormat: arguments[ 5 ], | |
| displayRects: arguments[ 6 ], | |
| minLevel: arguments[ 7 ], | |
| maxLevel: arguments[ 8 ] | |
| }; | |
| } | |
| this._levelRects = {}; | |
| this.tilesUrl = options.tilesUrl; | |
| this.fileFormat = options.fileFormat; | |
| this.displayRects = options.displayRects; | |
| if ( this.displayRects ) { | |
| for ( i = this.displayRects.length - 1; i >= 0; i-- ) { | |
| rect = this.displayRects[ i ]; | |
| for ( level = rect.minLevel; level <= rect.maxLevel; level++ ) { | |
| if ( !this._levelRects[ level ] ) { | |
| this._levelRects[ level ] = []; | |
| } | |
| this._levelRects[ level ].push( rect ); | |
| } | |
| } | |
| } | |
| // Ensure TileSource constructor will call getImageInfo | |
| if (options.tilesUrl) { | |
| options.url = options.tilesUrl; | |
| } | |
| $.TileSource.apply( this, [ options ] ); | |
| }; | |
| $.extend( $.SziTileSource.prototype, $.TileSource.prototype, /** @lends OpenSeadragon.SziTileSource.prototype */{ | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} optional - url | |
| */ | |
| supports: function( data, url ) { | |
| return data.type === "szi"; | |
| }, | |
| getImageInfo: function( url ) { | |
| console.log("GETIMAGEINFO"); | |
| var self = this; | |
| fetchZipTOC( url, function( tocResult ) { | |
| if ( tocResult.error ) { | |
| self.raiseEvent('open-failed', { message: tocResult.error, source: url }); | |
| return; | |
| } | |
| var fileMap = parseCentralDirectory( tocResult.centralDirectory ); | |
| self.ranges = fileMap; | |
| self.queryParams = url.includes('?') ? url.slice(url.indexOf('?')) : ''; | |
| var dziFile = null; | |
| for ( var name in fileMap ) { | |
| if ( name.match(/\.dzi$/i) ) { dziFile = name; break; } | |
| } | |
| if ( !dziFile ) { | |
| self.raiseEvent('open-failed', { message: 'No DZI file found in archive', source: url }); | |
| return; | |
| } | |
| self.zipPath = dziFile.replace(".dzi", "_files/"); | |
| var offsetData = fileMap[ dziFile ]; | |
| fetchZipFile( url, dziFile, offsetData.offset, offsetData.size, function( fileData ) { | |
| if ( fileData.error ) { | |
| self.raiseEvent('open-failed', { message: fileData.error, source: url }); | |
| return; | |
| } | |
| var decoder = new TextDecoder('utf-8'); | |
| var dziString = decoder.decode( new Uint8Array( fileData ) ); | |
| var meta = parseDZI( dziString ); | |
| var options = { | |
| width: meta.width, | |
| height: meta.height, | |
| tileSize: meta.tileSize, | |
| tileOverlap: meta.overlap, | |
| tilesUrl: url, | |
| fileFormat: meta.format, | |
| displayRects: [] | |
| }; | |
| // Apply parsed metadata | |
| $.extend(true, self, options); | |
| // Set tile dimensions | |
| self._tileWidth = options.tileSize; | |
| self._tileHeight = options.tileSize; | |
| // Configure levels and dimensions | |
| self.minLevel = 0; | |
| // Compute maxLevel from image size (DZI spec uses log2(maxDimension)) | |
| self.maxLevel = Math.ceil( | |
| Math.log2(Math.max(self.width, self.height)) | |
| ); | |
| // Set image dimensions and aspect | |
| self.dimensions = new $.Point(self.width, self.height); | |
| self.aspectRatio = self.width / self.height; | |
| // Memoize level scales | |
| if (self._memoizeLevelScale) { | |
| self._memoizeLevelScale(); | |
| } | |
| self.ready = true; | |
| self.raiseEvent('ready', { tileSource: self }); | |
| } ); | |
| } ); | |
| }, | |
| /** | |
| * | |
| * @function | |
| * @param {Object|XMLDocument} data - the raw configuration | |
| * @param {String} url - the url the data was retrieved from if any. | |
| * @return {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure this tile sources constructor. | |
| */ | |
| configure: function( data, url ){ | |
| var options = { | |
| zipFile: true, | |
| loadTilesWithAjax: true, | |
| width: data.width || 1000, | |
| height: data.height || 1000, | |
| tileSize: data.tileSize || 256, | |
| tileOverlap: data.tileOverlap || 0, | |
| tilesUrl: data.tilesUrl || url, | |
| fileFormat: data.fileFormat || data.format, | |
| displayRects:data.displayRects || [] | |
| }; | |
| // Propagate URL so base TileSource will call getImageInfo | |
| options.url = options.tilesUrl; | |
| return options; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| getTileUrl: function( level, x, y ) { | |
| return this.tilesUrl; | |
| return "CMU-1/CMU-1_files/"+level+"/"+x+"_"+y+"."+this.fileFormat; | |
| }, | |
| getTileAjaxHeaders: function( level, x, y ) { | |
| console.log("HEADERS"); | |
| if (this.zipFile) { | |
| var diff = 6; // hack need to figure out this | |
| var range = this.ranges[[ this.zipPath, level, '/', x, '_', y, '.', this.fileFormat, this.queryParams ].join( '' )]; | |
| try { | |
| range = "bytes=" + (parseInt(range.dataOffset) - diff) + "-" + (parseInt(range.dataOffset) + parseInt(range.size) - diff); | |
| console.log(range); | |
| return { Range: range }; | |
| } catch (error) { | |
| range = "bytes=" + (0) + "-" + (0); | |
| return { Range: range }; | |
| } | |
| } | |
| return {}; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| tileExists: function( level, x, y ) { | |
| // Constrain to actual tile grid at this level | |
| if (level < this.minLevel || level > this.maxLevel) { | |
| return false; | |
| } | |
| var scale = this.getLevelScale(level); | |
| var tilesX = Math.ceil((this.width * scale) / this._tileWidth); | |
| var tilesY = Math.ceil((this.height * scale) / this._tileHeight); | |
| return x >= 0 && x < tilesX && y >= 0 && y < tilesY; | |
| } | |
| }); | |
| function fetchZipFile(zipUrl, fileName, localHeaderOffset, compressedSize, callback) { | |
| // Step 1: Fetch the local file header (at least 30 bytes to get lengths) | |
| var xhrHeader = new XMLHttpRequest(); | |
| xhrHeader.open('GET', zipUrl, true); | |
| xhrHeader.setRequestHeader('Range', 'bytes=' + localHeaderOffset + '-' + (localHeaderOffset + 30 - 1)); | |
| xhrHeader.responseType = 'arraybuffer'; | |
| xhrHeader.onload = function() { | |
| if (xhrHeader.status === 206) { | |
| var headerBuffer = xhrHeader.response; | |
| var headerView = new DataView(headerBuffer); | |
| // Check signature | |
| if (headerView.getUint32(0, true) !== 0x04034b50) { | |
| callback({ error: 'Invalid local file header' }); | |
| return; | |
| } | |
| var filenameLength = headerView.getUint16(26, true); | |
| var extraFieldLength = headerView.getUint16(28, true); | |
| var fileDataOffset = localHeaderOffset + 30 + filenameLength + extraFieldLength; | |
| // Step 2: Fetch the file data | |
| var xhrFile = new XMLHttpRequest(); | |
| xhrFile.open('GET', zipUrl, true); | |
| xhrFile.setRequestHeader('Range', 'bytes=' + fileDataOffset + '-' + (fileDataOffset + compressedSize - 1)); | |
| xhrFile.responseType = 'arraybuffer'; | |
| xhrFile.onload = function() { | |
| if (xhrFile.status === 206) { | |
| callback(xhrFile.response); | |
| } else { | |
| callback({ error: 'Failed to fetch file data: ' + xhrFile.status }); | |
| } | |
| }; | |
| xhrFile.onerror = function() { | |
| callback({ error: 'Error fetching file data' }); | |
| }; | |
| xhrFile.send(); | |
| } else { | |
| callback({ error: 'Failed to fetch local file header: ' + xhrHeader.status }); | |
| } | |
| }; | |
| xhrHeader.onerror = function() { | |
| callback({ error: 'Error fetching local file header' }); | |
| }; | |
| xhrHeader.send(); | |
| } | |
| function fetchZipTOC(zipUrl, callback) { | |
| // Step 1: Get file size with HEAD | |
| var xhrHead = new XMLHttpRequest(); | |
| xhrHead.open('HEAD', zipUrl, true); | |
| xhrHead.onload = function() { | |
| if (xhrHead.status === 200) { | |
| var fileSize = parseInt(xhrHead.getResponseHeader('Content-Length'), 10); | |
| var rangeStart = Math.max(0, fileSize - 65536); | |
| var rangeEnd = fileSize - 1; | |
| // Step 2: Get the last 64KB for EOCD | |
| var xhrToc = new XMLHttpRequest(); | |
| xhrToc.open('GET', zipUrl, true); | |
| xhrToc.setRequestHeader('Range', 'bytes=' + rangeStart + '-' + rangeEnd); | |
| xhrToc.responseType = 'arraybuffer'; | |
| xhrToc.onload = function() { | |
| if (xhrToc.status === 206) { | |
| var buffer = xhrToc.response; | |
| var dataView = new DataView(buffer); | |
| var eocdOffset = -1; | |
| for (var i = buffer.byteLength - 22; i >= 0; i--) { | |
| if (dataView.getUint32(i, true) === 0x06054b50) { | |
| eocdOffset = i; | |
| break; | |
| } | |
| } | |
| if (eocdOffset === -1) { | |
| callback({ error: 'EOCD not found' }); | |
| return; | |
| } | |
| var cdSize = dataView.getUint32(eocdOffset + 12, true); | |
| var cdOffset = dataView.getUint32(eocdOffset + 16, true); | |
| // Step 3: Fetch the Central Directory | |
| var xhrCd = new XMLHttpRequest(); | |
| xhrCd.open('GET', zipUrl, true); | |
| xhrCd.setRequestHeader('Range', 'bytes=' + cdOffset + '-' + (cdOffset + cdSize - 1)); | |
| xhrCd.responseType = 'arraybuffer'; | |
| xhrCd.onload = function() { | |
| if (xhrCd.status === 206) { | |
| // Success! Central directory is in xhrCd.response | |
| callback({ | |
| fileSize: fileSize, | |
| cdSize: cdSize, | |
| cdOffset: cdOffset, | |
| centralDirectory: xhrCd.response | |
| }); | |
| } else { | |
| callback({ error: 'Failed to fetch central directory: ' + xhrCd.status }); | |
| } | |
| }; | |
| xhrCd.onerror = function() { | |
| callback({ error: 'Error fetching central directory' }); | |
| }; | |
| xhrCd.send(); | |
| } else { | |
| callback({ error: 'Failed to fetch EOCD: ' + xhrToc.status }); | |
| } | |
| }; | |
| xhrToc.onerror = function() { | |
| callback({ error: 'Error fetching EOCD' }); | |
| }; | |
| xhrToc.send(); | |
| } else { | |
| callback({ error: 'Failed to get file size: ' + xhrHead.status }); | |
| } | |
| }; | |
| xhrHead.onerror = function() { | |
| callback({ error: 'Error fetching file size' }); | |
| }; | |
| xhrHead.send(); | |
| } | |
| function parseCentralDirectory(buffer) { | |
| var dataView = new DataView(buffer); | |
| var offset = 0; | |
| var files = {}; | |
| while (offset + 46 < buffer.byteLength) { | |
| // Check for central directory file header signature | |
| if (dataView.getUint32(offset, true) !== 0x02014b50) { | |
| break; | |
| } | |
| var compressedSize = dataView.getUint32(offset + 20, true); | |
| // var uncompressedSize = dataView.getUint32(offset + 24, true); // optional | |
| var fileNameLength = dataView.getUint16(offset + 28, true); | |
| var extraFieldLength = dataView.getUint16(offset + 30, true); | |
| var commentLength = dataView.getUint16(offset + 32, true); | |
| var localHeaderOffset = dataView.getUint32(offset + 42, true); | |
| // Read the file name | |
| var nameBytes = []; | |
| for (var i = 0; i < fileNameLength; i++) { | |
| nameBytes.push(dataView.getUint8(offset + 46 + i)); | |
| } | |
| var fileName = String.fromCharCode.apply(null, nameBytes); | |
| // Store the info | |
| var dataOffset = localHeaderOffset + fileNameLength + extraFieldLength; | |
| files[fileName] = { size: compressedSize, offset: dataOffset }; | |
| files[fileName] = { | |
| size: compressedSize, | |
| offset: localHeaderOffset, | |
| dataOffset: dataOffset, | |
| }; | |
| // Move to the next entry | |
| offset += 46 + fileNameLength + extraFieldLength + commentLength; | |
| } | |
| return files; | |
| } | |
| function parseDZI(dziString) { | |
| var parser = new DOMParser(); | |
| var xmlDoc = parser.parseFromString(dziString, "application/xml"); | |
| var imageElem = xmlDoc.getElementsByTagName("Image")[0]; | |
| // Attributes on <Image> | |
| var format = imageElem.getAttribute("Format"); | |
| var overlap = parseInt(imageElem.getAttribute("Overlap"), 10); | |
| var tileSize = parseInt(imageElem.getAttribute("TileSize"), 10); | |
| // Attributes on <Size> | |
| var sizeElem = imageElem.getElementsByTagName("Size")[0]; | |
| var width = parseInt(sizeElem.getAttribute("Width"), 10); | |
| var height = parseInt(sizeElem.getAttribute("Height"), 10); | |
| return { | |
| format: format, | |
| overlap: overlap, | |
| tileSize: tileSize, | |
| width: width, | |
| height: height | |
| }; | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - OsmTileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| /* | |
| * Derived from the OSM tile source in Rainer Simon's seajax-utils project | |
| * <http://github.com/rsimon/seajax-utils>. Rainer Simon has contributed | |
| * the included code to the OpenSeadragon project under the New BSD license; | |
| * see <https://github.com/openseadragon/openseadragon/issues/58>. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class OsmTileSource | |
| * @classdesc A tilesource implementation for OpenStreetMap.<br><br> | |
| * | |
| * Note 1. Zoomlevels. Deep Zoom and OSM define zoom levels differently. In Deep | |
| * Zoom, level 0 equals an image of 1x1 pixels. In OSM, level 0 equals an image of | |
| * 256x256 levels (see http://gasi.ch/blog/inside-deep-zoom-2). I.e. there is a | |
| * difference of log2(256)=8 levels.<br><br> | |
| * | |
| * Note 2. Image dimension. According to the OSM Wiki | |
| * (http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Zoom_levels) | |
| * the highest Mapnik zoom level has 256.144x256.144 tiles, with a 256x256 | |
| * pixel size. I.e. the Deep Zoom image dimension is 65.572.864x65.572.864 | |
| * pixels. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @param {Number|Object} width - the pixel width of the image or the idiomatic | |
| * options object which is used instead of positional arguments. | |
| * @param {Number} height | |
| * @param {Number} tileSize | |
| * @param {Number} tileOverlap | |
| * @param {String} tilesUrl | |
| */ | |
| $.OsmTileSource = function( width, height, tileSize, tileOverlap, tilesUrl ) { | |
| var options; | |
| if( $.isPlainObject( width ) ){ | |
| options = width; | |
| }else{ | |
| options = { | |
| width: arguments[0], | |
| height: arguments[1], | |
| tileSize: arguments[2], | |
| tileOverlap: arguments[3], | |
| tilesUrl: arguments[4] | |
| }; | |
| } | |
| //apply default setting for standard public OpenStreatMaps service | |
| //but allow them to be specified so fliks can host there own instance | |
| //or apply against other services supportting the same standard | |
| if( !options.width || !options.height ){ | |
| options.width = 65572864; | |
| options.height = 65572864; | |
| } | |
| if( !options.tileSize ){ | |
| options.tileSize = 256; | |
| options.tileOverlap = 0; | |
| } | |
| if( !options.tilesUrl ){ | |
| options.tilesUrl = "http://tile.openstreetmap.org/"; | |
| } | |
| options.minLevel = 8; | |
| $.TileSource.apply( this, [ options ] ); | |
| }; | |
| $.extend( $.OsmTileSource.prototype, $.TileSource.prototype, /** @lends OpenSeadragon.OsmTileSource.prototype */{ | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} optional - url | |
| */ | |
| supports: function( data, url ){ | |
| return ( | |
| data.type && | |
| "openstreetmaps" === data.type | |
| ); | |
| }, | |
| /** | |
| * | |
| * @function | |
| * @param {Object} data - the raw configuration | |
| * @param {String} url - the url the data was retrieved from if any. | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null | |
| * @returns {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure this tile sources constructor. | |
| */ | |
| configure: function( data, url, postData ){ | |
| return data; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| getTileUrl: function( level, x, y ) { | |
| return this.tilesUrl + (level - 8) + "/" + x + "/" + y + ".png"; | |
| }, | |
| /** | |
| * Equality comparator | |
| */ | |
| equals: function(otherSource) { | |
| return this.tilesUrl === otherSource.tilesUrl; | |
| } | |
| }); | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - TmsTileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| /* | |
| * Derived from the TMS tile source in Rainer Simon's seajax-utils project | |
| * <http://github.com/rsimon/seajax-utils>. Rainer Simon has contributed | |
| * the included code to the OpenSeadragon project under the New BSD license; | |
| * see <https://github.com/openseadragon/openseadragon/issues/58>. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class TmsTileSource | |
| * @classdesc A tilesource implementation for Tiled Map Services (TMS). | |
| * TMS tile scheme ( [ as supported by OpenLayers ] is described here | |
| * ( http://openlayers.org/dev/examples/tms.html ). | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @param {Number|Object} width - the pixel width of the image or the idiomatic | |
| * options object which is used instead of positional arguments. | |
| * @param {Number} height | |
| * @param {Number} tileSize | |
| * @param {Number} tileOverlap | |
| * @param {String} tilesUrl | |
| */ | |
| $.TmsTileSource = function( width, height, tileSize, tileOverlap, tilesUrl ) { | |
| var options; | |
| if( $.isPlainObject( width ) ){ | |
| options = width; | |
| }else{ | |
| options = { | |
| width: arguments[0], | |
| height: arguments[1], | |
| tileSize: arguments[2], | |
| tileOverlap: arguments[3], | |
| tilesUrl: arguments[4] | |
| }; | |
| } | |
| // TMS has integer multiples of 256 for width/height and adds buffer | |
| // if necessary -> account for this! | |
| var bufferedWidth = Math.ceil(options.width / 256) * 256, | |
| bufferedHeight = Math.ceil(options.height / 256) * 256, | |
| max; | |
| // Compute number of zoomlevels in this tileset | |
| if (bufferedWidth > bufferedHeight) { | |
| max = bufferedWidth / 256; | |
| } else { | |
| max = bufferedHeight / 256; | |
| } | |
| options.maxLevel = Math.ceil(Math.log(max) / Math.log(2)) - 1; | |
| options.tileSize = 256; | |
| options.width = bufferedWidth; | |
| options.height = bufferedHeight; | |
| $.TileSource.apply( this, [ options ] ); | |
| }; | |
| $.extend( $.TmsTileSource.prototype, $.TileSource.prototype, /** @lends OpenSeadragon.TmsTileSource.prototype */{ | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} optional - url | |
| */ | |
| supports: function( data, url ){ | |
| return ( data.type && "tiledmapservice" === data.type ); | |
| }, | |
| /** | |
| * | |
| * @function | |
| * @param {Object} data - the raw configuration | |
| * @param {String} url - the url the data was retrieved from if any. | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null | |
| * @returns {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure this tile sources constructor. | |
| */ | |
| configure: function( data, url, postData ){ | |
| return data; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| getTileUrl: function( level, x, y ) { | |
| // Convert from Deep Zoom definition to TMS zoom definition | |
| var yTiles = this.getNumTiles( level ).y - 1; | |
| return this.tilesUrl + level + "/" + x + "/" + (yTiles - y) + ".png"; | |
| }, | |
| /** | |
| * Equality comparator | |
| */ | |
| equals: function (otherSource) { | |
| return this.tilesUrl === otherSource.tilesUrl; | |
| } | |
| }); | |
| }( OpenSeadragon )); | |
| (function($) { | |
| /** | |
| * @class ZoomifyTileSource | |
| * @classdesc A tilesource implementation for the zoomify format. | |
| * | |
| * A description of the format can be found here: | |
| * https://ecommons.cornell.edu/bitstream/handle/1813/5410/Introducing_Zoomify_Image.pdf | |
| * | |
| * There are two ways of creating a zoomify tilesource for openseadragon | |
| * | |
| * 1) Supplying all necessary information in the tilesource object. A minimal example object for this method looks like this: | |
| * | |
| * { | |
| * type: "zoomifytileservice", | |
| * width: 1000, | |
| * height: 1000, | |
| * tilesUrl: "/test/data/zoomify/" | |
| * } | |
| * | |
| * The tileSize is set to 256 (the usual Zoomify default) when it is not defined. The tileUrl must the path to the image _directory_. | |
| * | |
| * 2) Loading image metadata from xml file: (CURRENTLY NOT SUPPORTED) | |
| * | |
| * When creating zoomify formatted images one "xml" like file with name ImageProperties.xml | |
| * will be created as well. Here is an example of such a file: | |
| * | |
| * <IMAGE_PROPERTIES WIDTH="1000" HEIGHT="1000" NUMTILES="21" NUMIMAGES="1" VERSION="1.8" TILESIZE="256" /> | |
| * | |
| * To use this xml file as metadata source you must supply the path to the ImageProperties.xml file and leave out all other parameters: | |
| * As stated above, this method of loading a zoomify tilesource is currently not supported | |
| * | |
| * { | |
| * type: "zoomifytileservice", | |
| * tilesUrl: "/test/data/zoomify/ImageProperties.xml" | |
| * } | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @param {Number} width - the pixel width of the image. | |
| * @param {Number} height | |
| * @param {Number} tileSize | |
| * @param {String} tilesUrl | |
| */ | |
| $.ZoomifyTileSource = function(options) { | |
| if(typeof options.tileSize === 'undefined'){ | |
| options.tileSize = 256; | |
| } | |
| if(typeof options.fileFormat === 'undefined'){ | |
| options.fileFormat = 'jpg'; | |
| this.fileFormat = options.fileFormat; | |
| } | |
| var currentImageSize = { | |
| x: options.width, | |
| y: options.height | |
| }; | |
| options.imageSizes = [{ | |
| x: options.width, | |
| y: options.height | |
| }]; | |
| options.gridSize = [this._getGridSize(options.width, options.height, options.tileSize)]; | |
| while (parseInt(currentImageSize.x, 10) > options.tileSize || parseInt(currentImageSize.y, 10) > options.tileSize) { | |
| currentImageSize.x = Math.floor(currentImageSize.x / 2); | |
| currentImageSize.y = Math.floor(currentImageSize.y / 2); | |
| options.imageSizes.push({ | |
| x: currentImageSize.x, | |
| y: currentImageSize.y | |
| }); | |
| options.gridSize.push(this._getGridSize(currentImageSize.x, currentImageSize.y, options.tileSize)); | |
| } | |
| options.imageSizes.reverse(); | |
| options.gridSize.reverse(); | |
| options.minLevel = 0; | |
| options.maxLevel = options.gridSize.length - 1; | |
| $.TileSource.apply(this, [options]); | |
| }; | |
| $.extend($.ZoomifyTileSource.prototype, $.TileSource.prototype, /** @lends OpenSeadragon.ZoomifyTileSource.prototype */ { | |
| //private | |
| _getGridSize: function(width, height, tileSize) { | |
| return { | |
| x: Math.ceil(width / tileSize), | |
| y: Math.ceil(height / tileSize) | |
| }; | |
| }, | |
| //private | |
| _calculateAbsoluteTileNumber: function(level, x, y) { | |
| var num = 0; | |
| var size = {}; | |
| //Sum up all tiles below the level we want the number of tiles | |
| for (var z = 0; z < level; z++) { | |
| size = this.gridSize[z]; | |
| num += size.x * size.y; | |
| } | |
| //Add the tiles of the level | |
| size = this.gridSize[level]; | |
| num += size.x * y + x; | |
| return num; | |
| }, | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} optional - url | |
| */ | |
| supports: function(data, url) { | |
| return (data.type && "zoomifytileservice" === data.type); | |
| }, | |
| /** | |
| * | |
| * @function | |
| * @param {Object} data - the raw configuration | |
| * @param {String} url - the url the data was retrieved from if any. | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null | |
| * @returns {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure this tile sources constructor. | |
| */ | |
| configure: function(data, url, postData) { | |
| return data; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| */ | |
| getTileUrl: function(level, x, y) { | |
| //console.log(level); | |
| var result = 0; | |
| var num = this._calculateAbsoluteTileNumber(level, x, y); | |
| result = Math.floor(num / 256); | |
| return this.tilesUrl + 'TileGroup' + result + '/' + level + '-' + x + '-' + y + '.' + this.fileFormat; | |
| }, | |
| /** | |
| * Equality comparator | |
| */ | |
| equals: function (otherSource) { | |
| return this.tilesUrl === otherSource.tilesUrl; | |
| } | |
| }); | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - LegacyTileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class LegacyTileSource | |
| * @classdesc The LegacyTileSource allows simple, traditional image pyramids to be loaded | |
| * into an OpenSeadragon Viewer. Basically, this translates to the historically | |
| * common practice of starting with a 'master' image, maybe a tiff for example, | |
| * and generating a set of 'service' images like one or more thumbnails, a medium | |
| * resolution image and a high resolution image in standard web formats like | |
| * png or jpg. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @param {Array} levels An array of file descriptions, each is an object with | |
| * a 'url', a 'width', and a 'height'. Overriding classes can expect more | |
| * properties but these properties are sufficient for this implementation. | |
| * Additionally, the levels are required to be listed in order from | |
| * smallest to largest. | |
| * @property {Number} aspectRatio | |
| * @property {Number} dimensions | |
| * @property {Number} tileSize | |
| * @property {Number} tileOverlap | |
| * @property {Number} minLevel | |
| * @property {Number} maxLevel | |
| * @property {Array} levels | |
| */ | |
| $.LegacyTileSource = function( levels ) { | |
| var options, | |
| width, | |
| height; | |
| if( $.isArray( levels ) ){ | |
| options = { | |
| type: 'legacy-image-pyramid', | |
| levels: levels | |
| }; | |
| } | |
| //clean up the levels to make sure we support all formats | |
| options.levels = filterFiles( options.levels ); | |
| if ( options.levels.length > 0 ) { | |
| width = options.levels[ options.levels.length - 1 ].width; | |
| height = options.levels[ options.levels.length - 1 ].height; | |
| } | |
| else { | |
| width = 0; | |
| height = 0; | |
| $.console.error( "No supported image formats found" ); | |
| } | |
| $.extend( true, options, { | |
| width: width, | |
| height: height, | |
| tileSize: Math.max( height, width ), | |
| tileOverlap: 0, | |
| minLevel: 0, | |
| maxLevel: options.levels.length > 0 ? options.levels.length - 1 : 0 | |
| } ); | |
| $.TileSource.apply( this, [ options ] ); | |
| this.levels = options.levels; | |
| }; | |
| $.extend( $.LegacyTileSource.prototype, $.TileSource.prototype, /** @lends OpenSeadragon.LegacyTileSource.prototype */{ | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} optional - url | |
| */ | |
| supports: function( data, url ){ | |
| return ( | |
| data.type && | |
| "legacy-image-pyramid" === data.type | |
| ) || ( | |
| data.documentElement && | |
| "legacy-image-pyramid" === data.documentElement.getAttribute('type') | |
| ); | |
| }, | |
| /** | |
| * | |
| * @function | |
| * @param {Object|XMLDocument} configuration - the raw configuration | |
| * @param {String} dataUrl - the url the data was retrieved from if any. | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null | |
| * @returns {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure this tile sources constructor. | |
| */ | |
| configure: function( configuration, dataUrl, postData ){ | |
| var options; | |
| if( !$.isPlainObject(configuration) ){ | |
| options = configureFromXML( this, configuration ); | |
| }else{ | |
| options = configureFromObject( this, configuration ); | |
| } | |
| return options; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getLevelScale: function ( level ) { | |
| var levelScale = NaN; | |
| if ( this.levels.length > 0 && level >= this.minLevel && level <= this.maxLevel ) { | |
| levelScale = | |
| this.levels[ level ].width / | |
| this.levels[ this.maxLevel ].width; | |
| } | |
| return levelScale; | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getNumTiles: function( level ) { | |
| var scale = this.getLevelScale( level ); | |
| if ( scale ){ | |
| return new $.Point( 1, 1 ); | |
| } else { | |
| return new $.Point( 0, 0 ); | |
| } | |
| }, | |
| /** | |
| * This method is not implemented by this class other than to throw an Error | |
| * announcing you have to implement it. Because of the variety of tile | |
| * server technologies, and various specifications for building image | |
| * pyramids, this method is here to allow easy integration. | |
| * @function | |
| * @param {Number} level | |
| * @param {Number} x | |
| * @param {Number} y | |
| * @throws {Error} | |
| */ | |
| getTileUrl: function ( level, x, y ) { | |
| var url = null; | |
| if ( this.levels.length > 0 && level >= this.minLevel && level <= this.maxLevel ) { | |
| url = this.levels[ level ].url; | |
| } | |
| return url; | |
| }, | |
| /** | |
| * Equality comparator | |
| */ | |
| equals: function (otherSource) { | |
| if (!otherSource.levels || otherSource.levels.length !== this.levels.length) { | |
| return false; | |
| } | |
| for (let i = this.minLevel; i <= this.maxLevel; i++) { | |
| if (this.levels[i].url !== otherSource.levels[i].url) { | |
| return false; | |
| } | |
| } | |
| return true; | |
| } | |
| } ); | |
| /** | |
| * This method removes any files from the Array which don't conform to our | |
| * basic requirements for a 'level' in the LegacyTileSource. | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function filterFiles( files ){ | |
| var filtered = [], | |
| file, | |
| i; | |
| for( i = 0; i < files.length; i++ ){ | |
| file = files[ i ]; | |
| if( file.height && | |
| file.width && | |
| file.url ){ | |
| //This is sufficient to serve as a level | |
| filtered.push({ | |
| url: file.url, | |
| width: Number( file.width ), | |
| height: Number( file.height ) | |
| }); | |
| } | |
| else { | |
| $.console.error( 'Unsupported image format: %s', file.url ? file.url : '<no URL>' ); | |
| } | |
| } | |
| return filtered.sort(function(a, b) { | |
| return a.height - b.height; | |
| }); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function configureFromXML( tileSource, xmlDoc ){ | |
| if ( !xmlDoc || !xmlDoc.documentElement ) { | |
| throw new Error( $.getString( "Errors.Xml" ) ); | |
| } | |
| var root = xmlDoc.documentElement, | |
| rootName = root.tagName, | |
| conf = null, | |
| levels = [], | |
| level, | |
| i; | |
| if ( rootName === "image" ) { | |
| try { | |
| conf = { | |
| type: root.getAttribute( "type" ), | |
| levels: [] | |
| }; | |
| levels = root.getElementsByTagName( "level" ); | |
| for ( i = 0; i < levels.length; i++ ) { | |
| level = levels[ i ]; | |
| conf.levels.push({ | |
| url: level.getAttribute( "url" ), | |
| width: parseInt( level.getAttribute( "width" ), 10 ), | |
| height: parseInt( level.getAttribute( "height" ), 10 ) | |
| }); | |
| } | |
| return configureFromObject( tileSource, conf ); | |
| } catch ( e ) { | |
| throw (e instanceof Error) ? | |
| e : | |
| new Error( 'Unknown error parsing Legacy Image Pyramid XML.' ); | |
| } | |
| } else if ( rootName === "collection" ) { | |
| throw new Error( 'Legacy Image Pyramid Collections not yet supported.' ); | |
| } else if ( rootName === "error" ) { | |
| throw new Error( 'Error: ' + xmlDoc ); | |
| } | |
| throw new Error( 'Unknown element ' + rootName ); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function configureFromObject( tileSource, configuration ){ | |
| return configuration.levels; | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - ImageTileSource | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function ($) { | |
| /** | |
| * @class ImageTileSource | |
| * @classdesc The ImageTileSource allows a simple image to be loaded | |
| * into an OpenSeadragon Viewer. | |
| * There are 2 ways to open an ImageTileSource: | |
| * 1. viewer.open({type: 'image', url: fooUrl}); | |
| * 2. viewer.open(new OpenSeadragon.ImageTileSource({url: fooUrl})); | |
| * | |
| * With the first syntax, the crossOriginPolicy, ajaxWithCredentials and | |
| * useCanvas options are inherited from the viewer if they are not | |
| * specified directly in the options object. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.TileSource | |
| * @param {Object} options Options object. | |
| * @param {String} options.url URL of the image | |
| * @param {Boolean} [options.buildPyramid=true] If set to true (default), a | |
| * pyramid will be built internally to provide a better downsampling. | |
| * @param {String|Boolean} [options.crossOriginPolicy=false] Valid values are | |
| * 'Anonymous', 'use-credentials', and false. If false, image requests will | |
| * not use CORS preventing internal pyramid building for images from other | |
| * domains. | |
| * @param {String|Boolean} [options.ajaxWithCredentials=false] Whether to set | |
| * the withCredentials XHR flag for AJAX requests (when loading tile sources). | |
| * @param {Boolean} [options.useCanvas=true] Set to false to prevent any use | |
| * of the canvas API. | |
| */ | |
| $.ImageTileSource = class extends $.TileSource { | |
| constructor(props) { | |
| super($.extend({ | |
| buildPyramid: true, | |
| crossOriginPolicy: false, | |
| ajaxWithCredentials: false, | |
| }, props)); | |
| } | |
| /** | |
| * Determine if the data and/or url imply the image service is supported by | |
| * this tile source. | |
| * @function | |
| * @param {Object|Array} data | |
| * @param {String} url - optional | |
| */ | |
| supports(data, url) { | |
| return data.type && data.type === "image"; | |
| } | |
| /** | |
| * | |
| * @function | |
| * @param {Object} options - the options | |
| * @param {String} dataUrl - the url the image was retrieved from, if any. | |
| * @param {String} postData - HTTP POST data in k=v&k2=v2... form or null | |
| * @returns {Object} options - A dictionary of keyword arguments sufficient | |
| * to configure this tile sources constructor. | |
| */ | |
| configure(options, dataUrl, postData) { | |
| return options; | |
| } | |
| /** | |
| * Responsible for retrieving, and caching the | |
| * image metadata pertinent to this TileSources implementation. | |
| * @function | |
| * @param {String} url | |
| * @throws {Error} | |
| */ | |
| getImageInfo(url) { | |
| const image = new Image(), | |
| _this = this; | |
| if (this.crossOriginPolicy) { | |
| image.crossOrigin = this.crossOriginPolicy; | |
| } | |
| if (this.ajaxWithCredentials) { | |
| image.useCredentials = this.ajaxWithCredentials; | |
| } | |
| $.addEvent(image, 'load', function () { | |
| _this.width = image.naturalWidth; | |
| _this.height = image.naturalHeight; | |
| _this.aspectRatio = _this.width / _this.height; | |
| _this.dimensions = new $.Point(_this.width, _this.height); | |
| _this._tileWidth = _this.width; | |
| _this._tileHeight = _this.height; | |
| _this.tileOverlap = 0; | |
| _this.minLevel = 0; | |
| _this.image = image; | |
| _this.levels = _this._buildLevels(image); | |
| _this.maxLevel = _this.levels.length - 1; | |
| _this.ready = true; | |
| // Note: this event is documented elsewhere, in TileSource | |
| _this.raiseEvent('ready', {tileSource: _this}); | |
| }); | |
| $.addEvent(image, 'error', function () { | |
| _this.image = null; | |
| // Note: this event is documented elsewhere, in TileSource | |
| _this.raiseEvent('open-failed', { | |
| message: "Error loading image at " + url, | |
| source: url | |
| }); | |
| }); | |
| image.src = url; | |
| } | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getLevelScale(level) { | |
| let levelScale = NaN; | |
| if (level >= this.minLevel && level <= this.maxLevel) { | |
| levelScale = | |
| this.levels[level].width / | |
| this.levels[this.maxLevel].width; | |
| } | |
| return levelScale; | |
| } | |
| /** | |
| * @function | |
| * @param {Number} level | |
| */ | |
| getNumTiles(level) { | |
| if (this.getLevelScale(level)) { | |
| return new $.Point(1, 1); | |
| } | |
| return new $.Point(0, 0); | |
| } | |
| /** | |
| * Retrieves a tile url | |
| * @function | |
| * @param {Number} level Level of the tile | |
| * @param {Number} x x coordinate of the tile | |
| * @param {Number} y y coordinate of the tile | |
| */ | |
| getTileUrl(level, x, y) { | |
| if (level === this.maxLevel) { | |
| return this.url; //for original image, preserve url | |
| } | |
| //make up url by positional args | |
| return `${this.url}?l=${level}&x=${x}&y=${y}`; | |
| } | |
| /** | |
| * Equality comparator | |
| */ | |
| equals(otherSource) { | |
| return this.url === otherSource.url; | |
| } | |
| getTilePostData(level, x, y) { | |
| return {level: level, x: x, y: y}; | |
| } | |
| /** | |
| * Retrieves a tile context 2D | |
| * @deprecated | |
| */ | |
| getContext2D(level, x, y) { | |
| $.console.error('Using [TiledImage.getContext2D] (for plain images only) is deprecated. ' + | |
| 'Use overridden downloadTileStart (https://openseadragon.github.io/examples/advanced-data-model/) instead.'); | |
| return this._createContext2D(); | |
| } | |
| downloadTileStart(job) { | |
| const tileData = job.postData; | |
| if (tileData.level === this.maxLevel) { | |
| job.finish(this.image, null, "image"); | |
| return; | |
| } | |
| if (tileData.level >= this.minLevel && tileData.level <= this.maxLevel) { | |
| const levelData = this.levels[tileData.level]; | |
| const context = this._createContext2D(this.image, levelData.width, levelData.height); | |
| job.finish(context, null, "context2d"); | |
| return; | |
| } | |
| job.fail(`Invalid level ${tileData.level} for plain image source. Did you forget to set buildPyramid=true?`); | |
| } | |
| downloadTileAbort(job) { | |
| //no-op | |
| } | |
| // private | |
| // | |
| // Builds the different levels of the pyramid if possible | |
| // (i.e. if canvas API enabled and no canvas tainting issue). | |
| _buildLevels(image) { | |
| const levels = [{ | |
| url: image.src, | |
| width: image.naturalWidth, | |
| height: image.naturalHeight | |
| }]; | |
| if (!this.buildPyramid || !$.supportsCanvas || !this.useCanvas) { | |
| return levels; | |
| } | |
| let currentWidth = image.naturalWidth, | |
| currentHeight = image.naturalHeight; | |
| // We build smaller levels until either width or height becomes | |
| // 2 pixel wide. | |
| while (currentWidth >= 2 && currentHeight >= 2) { | |
| currentWidth = Math.floor(currentWidth / 2); | |
| currentHeight = Math.floor(currentHeight / 2); | |
| levels.push({ | |
| width: currentWidth, | |
| height: currentHeight, | |
| }); | |
| } | |
| return levels.reverse(); | |
| } | |
| _createContext2D(data, w, h) { | |
| const canvas = document.createElement("canvas"), | |
| context = canvas.getContext("2d"); | |
| canvas.width = w; | |
| canvas.height = h; | |
| context.drawImage(data, 0, 0, w, h); | |
| return context; | |
| } | |
| }; | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - TileSourceCollection | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function($) { | |
| // deprecated | |
| $.TileSourceCollection = function(tileSize, tileSources, rows, layout) { | |
| $.console.error('TileSourceCollection is deprecated; use World instead'); | |
| }; | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - Queue | |
| * | |
| * Copyright (C) 2024 OpenSeadragon contributors (modified) | |
| * Copyright (C) Google Inc., The Closure Library Authors. | |
| * https://github.com/google/closure-library | |
| * | |
| * SPDX-License-Identifier: Apache-2.0 | |
| */ | |
| (function($) { | |
| /** | |
| * @class PriorityQueue | |
| * @classdesc Fast priority queue. Implemented as a Heap. | |
| */ | |
| $.PriorityQueue = class { | |
| /** | |
| * @param {?OpenSeadragon.PriorityQueue} optHeap Optional Heap or | |
| * Object to initialize heap with. | |
| */ | |
| constructor(optHeap = undefined) { | |
| /** | |
| * The nodes of the heap. | |
| * | |
| * This is a densely packed array containing all nodes of the heap, using | |
| * the standard flat representation of a tree as an array (i.e. element [0] | |
| * at the top, with [1] and [2] as the second row, [3] through [6] as the | |
| * third, etc). Thus, the children of element `i` are `2i+1` and `2i+2`, and | |
| * the parent of element `i` is `⌊(i-1)/2⌋`. | |
| * | |
| * The only invariant is that children's keys must be greater than parents'. | |
| * | |
| * @private | |
| */ | |
| this.nodes_ = []; | |
| if (optHeap) { | |
| this.insertAll(optHeap); | |
| } | |
| } | |
| /** | |
| * Insert the given value into the heap with the given key. | |
| * @param {K} key The key. | |
| * @param {V} value The value. | |
| */ | |
| insert(key, value) { | |
| this.insertNode(new Node(key, value)); | |
| } | |
| /** | |
| * Insert node item. | |
| * @param node | |
| */ | |
| insertNode(node) { | |
| const nodes = this.nodes_; | |
| node.index = nodes.length; | |
| nodes.push(node); | |
| this.moveUp_(node.index); | |
| } | |
| /** | |
| * Adds multiple key-value pairs from another Heap or Object | |
| * @param {?OpenSeadragon.PriorityQueue} heap Object containing the data to add. | |
| */ | |
| insertAll(heap) { | |
| let keys, values; | |
| if (heap instanceof $.PriorityQueue) { | |
| keys = heap.getKeys(); | |
| values = heap.getValues(); | |
| // If it is a heap and the current heap is empty, I can rely on the fact | |
| // that the keys/values are in the correct order to put in the underlying | |
| // structure. | |
| if (this.getCount() <= 0) { | |
| const nodes = this.nodes_; | |
| for (let i = 0; i < keys.length; i++) { | |
| const node = new Node(keys[i], values[i]); | |
| node.index = nodes.length; | |
| nodes.push(node); | |
| } | |
| return; | |
| } | |
| } else { | |
| throw "insertAll supports only OpenSeadragon.PriorityQueue object!"; | |
| } | |
| for (let i = 0; i < keys.length; i++) { | |
| this.insert(keys[i], values[i]); | |
| } | |
| } | |
| /** | |
| * Retrieves and removes the root value of this heap. | |
| * @return {Node} The root node item removed from the root of the heap. Returns | |
| * undefined if the heap is empty. | |
| */ | |
| remove() { | |
| const nodes = this.nodes_; | |
| const count = nodes.length; | |
| const rootNode = nodes[0]; | |
| if (count <= 0) { | |
| return undefined; | |
| } else if (count == 1) { // eslint-disable-line | |
| nodes.length = 0; | |
| } else { | |
| nodes[0] = nodes.pop(); | |
| if (nodes[0]) { | |
| nodes[0].index = 0; | |
| } | |
| this.moveDown_(0); | |
| } | |
| if (rootNode) { | |
| delete rootNode.index; | |
| } | |
| return rootNode; | |
| } | |
| /** | |
| * Retrieves but does not remove the root value of this heap. | |
| * @return {V} The value at the root of the heap. Returns | |
| * undefined if the heap is empty. | |
| */ | |
| peek() { | |
| const nodes = this.nodes_; | |
| if (nodes.length == 0) { // eslint-disable-line | |
| return undefined; | |
| } | |
| return nodes[0].value; | |
| } | |
| /** | |
| * Retrieves but does not remove the key of the root node of this heap. | |
| * @return {string} The key at the root of the heap. Returns undefined if the | |
| * heap is empty. | |
| */ | |
| peekKey() { | |
| return this.nodes_[0] && this.nodes_[0].key; | |
| } | |
| /** | |
| * Move the node up in hierarchy | |
| * @param {Node} node the node | |
| * @param {K} key new ley, must be smaller than current key | |
| */ | |
| decreaseKey(node, key) { | |
| if (node.index === undefined) { | |
| node.key = key; | |
| this.insertNode(node); | |
| } else { | |
| node.key = key; | |
| this.moveUp_(node.index); | |
| } | |
| } | |
| /** | |
| * Moves the node at the given index down to its proper place in the heap. | |
| * @param {number} index The index of the node to move down. | |
| * @private | |
| */ | |
| moveDown_(index) { | |
| const nodes = this.nodes_; | |
| const count = nodes.length; | |
| // Save the node being moved down. | |
| const node = nodes[index]; | |
| // While the current node has a child. | |
| while (index < (count >> 1)) { | |
| const leftChildIndex = this.getLeftChildIndex_(index); | |
| const rightChildIndex = this.getRightChildIndex_(index); | |
| // Determine the index of the smaller child. | |
| const smallerChildIndex = rightChildIndex < count && | |
| nodes[rightChildIndex].key < nodes[leftChildIndex].key ? | |
| rightChildIndex : | |
| leftChildIndex; | |
| // If the node being moved down is smaller than its children, the node | |
| // has found the correct index it should be at. | |
| if (nodes[smallerChildIndex].key > node.key) { | |
| break; | |
| } | |
| // If not, then take the smaller child as the current node. | |
| nodes[index] = nodes[smallerChildIndex]; | |
| nodes[index].index = index; | |
| index = smallerChildIndex; | |
| } | |
| nodes[index] = node; | |
| if (node) { | |
| node.index = index; | |
| } | |
| } | |
| /** | |
| * Moves the node at the given index up to its proper place in the heap. | |
| * @param {number} index The index of the node to move up. | |
| * @private | |
| */ | |
| moveUp_(index) { | |
| const nodes = this.nodes_; | |
| const node = nodes[index]; | |
| // While the node being moved up is not at the root. | |
| while (index > 0) { | |
| // If the parent is greater than the node being moved up, move the parent | |
| // down. | |
| const parentIndex = this.getParentIndex_(index); | |
| if (nodes[parentIndex].key > node.key) { | |
| nodes[index] = nodes[parentIndex]; | |
| nodes[index].index = index; | |
| index = parentIndex; | |
| } else { | |
| break; | |
| } | |
| } | |
| nodes[index] = node; | |
| if (node) { | |
| node.index = index; | |
| } | |
| } | |
| /** | |
| * Gets the index of the left child of the node at the given index. | |
| * @param {number} index The index of the node to get the left child for. | |
| * @return {number} The index of the left child. | |
| * @private | |
| */ | |
| getLeftChildIndex_(index) { | |
| return index * 2 + 1; | |
| } | |
| /** | |
| * Gets the index of the right child of the node at the given index. | |
| * @param {number} index The index of the node to get the right child for. | |
| * @return {number} The index of the right child. | |
| * @private | |
| */ | |
| getRightChildIndex_(index) { | |
| return index * 2 + 2; | |
| } | |
| /** | |
| * Gets the index of the parent of the node at the given index. | |
| * @param {number} index The index of the node to get the parent for. | |
| * @return {number} The index of the parent. | |
| * @private | |
| */ | |
| getParentIndex_(index) { | |
| return (index - 1) >> 1; | |
| } | |
| /** | |
| * Gets the values of the heap. | |
| * @return {!Array<*>} The values in the heap. | |
| */ | |
| getValues() { | |
| const nodes = this.nodes_; | |
| const rv = []; | |
| const l = nodes.length; | |
| for (let i = 0; i < l; i++) { | |
| rv.push(nodes[i].value); | |
| } | |
| return rv; | |
| } | |
| /** | |
| * Gets the keys of the heap. | |
| * @return {!Array<string>} The keys in the heap. | |
| */ | |
| getKeys() { | |
| const nodes = this.nodes_; | |
| const rv = []; | |
| const l = nodes.length; | |
| for (let i = 0; i < l; i++) { | |
| rv.push(nodes[i].key); | |
| } | |
| return rv; | |
| } | |
| /** | |
| * Whether the heap contains the given value. | |
| * @param {V} val The value to check for. | |
| * @return {boolean} Whether the heap contains the value. | |
| */ | |
| containsValue(val) { | |
| return this.nodes_.some((node) => node.value == val); // eslint-disable-line | |
| } | |
| /** | |
| * Whether the heap contains the given key. | |
| * @param {string} key The key to check for. | |
| * @return {boolean} Whether the heap contains the key. | |
| */ | |
| containsKey(key) { | |
| return this.nodes_.some((node) => node.value == key); // eslint-disable-line | |
| } | |
| /** | |
| * Clones a heap and returns a new heap | |
| * @return {!OpenSeadragon.PriorityQueue} A new Heap with the same key-value pairs. | |
| */ | |
| clone() { | |
| return new $.PriorityQueue(this); | |
| } | |
| /** | |
| * The number of key-value pairs in the map | |
| * @return {number} The number of pairs. | |
| */ | |
| getCount() { | |
| return this.nodes_.length; | |
| } | |
| /** | |
| * Returns true if this heap contains no elements. | |
| * @return {boolean} Whether this heap contains no elements. | |
| */ | |
| isEmpty() { | |
| return this.nodes_.length === 0; | |
| } | |
| /** | |
| * Removes all elements from the heap. | |
| */ | |
| clear() { | |
| this.nodes_.length = 0; | |
| } | |
| }; | |
| $.PriorityQueue.Node = class { | |
| constructor(key, value) { | |
| /** | |
| * The key. | |
| * @type {K} | |
| * @private | |
| */ | |
| this.key = key; | |
| /** | |
| * The value. | |
| * @type {V} | |
| * @private | |
| */ | |
| this.value = value; | |
| /** | |
| * The node index value. Updated in the heap. | |
| * @type {number} | |
| * @private | |
| */ | |
| this.index = 0; | |
| } | |
| clone() { | |
| return new Node(this.key, this.value); | |
| } | |
| }; | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon.convertor (static property) | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function($){ | |
| /** | |
| * modified from https://gist.github.com/Prottoy2938/66849e04b0bac459606059f5f9f3aa1a | |
| * @private | |
| */ | |
| class WeightedGraph { | |
| constructor() { | |
| this.adjacencyList = {}; | |
| this.vertices = {}; | |
| } | |
| /** | |
| * Add vertex to graph | |
| * @param vertex unique vertex ID | |
| * @return {boolean} true if inserted, false if exists (no-op) | |
| */ | |
| addVertex(vertex) { | |
| if (!this.vertices[vertex]) { | |
| this.vertices[vertex] = new $.PriorityQueue.Node(0, vertex); | |
| this.adjacencyList[vertex] = []; | |
| return true; | |
| } | |
| return false; | |
| } | |
| /** | |
| * Add edge to graph | |
| * @param vertex1 id, must exist by calling addVertex() | |
| * @param vertex2 id, must exist by calling addVertex() | |
| * @param weight | |
| * @param transform function that transforms on path vertex1 -> vertex2 | |
| * @return {boolean} true if new edge, false if replaced existing | |
| */ | |
| addEdge(vertex1, vertex2, weight, transform) { | |
| if (weight < 0) { | |
| $.console.error("WeightedGraph: negative weights will make for invalid shortest path computation!"); | |
| } | |
| const outgoingPaths = this.adjacencyList[vertex1], | |
| replacedEdgeIndex = outgoingPaths.findIndex(edge => edge.target === this.vertices[vertex2]), | |
| newEdge = { target: this.vertices[vertex2], origin: this.vertices[vertex1], weight, transform }; | |
| if (replacedEdgeIndex < 0) { | |
| this.adjacencyList[vertex1].push(newEdge); | |
| return true; | |
| } | |
| this.adjacencyList[vertex1][replacedEdgeIndex] = newEdge; | |
| return false; | |
| } | |
| /** | |
| * @return {{path: ConversionStep[], cost: number}|undefined} cheapest path from start to finish | |
| */ | |
| dijkstra(start, finish) { | |
| let path = []; //to return at end | |
| if (start === finish) { | |
| return {path: path, cost: 0}; | |
| } | |
| const nodes = new OpenSeadragon.PriorityQueue(); | |
| let smallestNode; | |
| //build up initial state | |
| for (let vertex in this.vertices) { | |
| vertex = this.vertices[vertex]; | |
| if (vertex.value === start) { | |
| vertex.key = 0; //keys are known distances | |
| nodes.insertNode(vertex); | |
| } else { | |
| vertex.key = Infinity; | |
| delete vertex.index; | |
| } | |
| vertex._previous = null; | |
| } | |
| // as long as there is something to visit | |
| while (nodes.getCount() > 0) { | |
| smallestNode = nodes.remove(); | |
| if (smallestNode.value === finish) { | |
| break; | |
| } | |
| const neighbors = this.adjacencyList[smallestNode.value]; | |
| for (let neighborKey in neighbors) { | |
| let edge = neighbors[neighborKey]; | |
| //relax node | |
| let newCost = smallestNode.key + edge.weight; | |
| let nextNeighbor = edge.target; | |
| if (newCost < nextNeighbor.key) { | |
| nextNeighbor._previous = smallestNode; | |
| //key change | |
| nodes.decreaseKey(nextNeighbor, newCost); | |
| } | |
| } | |
| } | |
| if (!smallestNode || !smallestNode._previous || smallestNode.value !== finish) { | |
| return undefined; //no path | |
| } | |
| let finalCost = smallestNode.key; //final weight last node | |
| // done, build the shortest path | |
| while (smallestNode._previous) { | |
| //backtrack | |
| const to = smallestNode.value, | |
| parent = smallestNode._previous, | |
| from = parent.value; | |
| path.push(this.adjacencyList[from].find(x => x.target.value === to)); | |
| smallestNode = parent; | |
| } | |
| return { | |
| path: path.reverse(), | |
| cost: finalCost | |
| }; | |
| } | |
| } | |
| /** | |
| * Edge.transform function on the conversion path in OpenSeadragon.converter.getConversionPath(). | |
| * It can be also conversion to undefined if used as destructor implementation. | |
| * | |
| * @callback TypeConvertor | |
| * @memberof OpenSeadragon | |
| * @param {OpenSeadragon.Tile} tile reference tile that owns the data | |
| * @param {any} data data in the input format | |
| * @returns {any} data in the output format | |
| */ | |
| /** | |
| * Destructor called every time a data type is to be destroyed or converted to another type. | |
| * | |
| * @callback TypeDestructor | |
| * @memberof OpenSeadragon | |
| * @param {any} data data in the format the destructor is registered for | |
| * @returns {any} can return any value that is carried over to the caller if desirable. | |
| * Note: not used by the OSD cache system. | |
| */ | |
| /** | |
| * Node on the conversion path in OpenSeadragon.converter.getConversionPath(). | |
| * | |
| * @typedef {Object} ConversionStep | |
| * @memberof OpenSeadragon | |
| * @param {OpenSeadragon.PriorityQueue.Node} target - Target node of the conversion step. | |
| * Its value is the target format. | |
| * @param {OpenSeadragon.PriorityQueue.Node} origin - Origin node of the conversion step. | |
| * Its value is the origin format. | |
| * @param {number} weight cost of the conversion | |
| * @param {TypeConvertor} transform the conversion itself | |
| */ | |
| /** | |
| * Class that orchestrates automated data types conversion. Do not instantiate | |
| * this class, use OpenSeadragon.convertor - a global instance, instead. | |
| * @class DataTypeConvertor | |
| * @memberOf OpenSeadragon | |
| */ | |
| $.DataTypeConvertor = class { | |
| constructor() { | |
| this.graph = new WeightedGraph(); | |
| this.destructors = {}; | |
| this.copyings = {}; | |
| // Teaching OpenSeadragon built-in conversions: | |
| const imageCreator = (tile, url) => new $.Promise((resolve, reject) => { | |
| if (!$.supportsAsync) { | |
| throw "Not supported in sync mode!"; | |
| } | |
| const img = new Image(); | |
| img.onerror = img.onabort = reject; | |
| img.onload = () => resolve(img); | |
| img.src = url; | |
| }); | |
| const canvasContextCreator = (tile, imageData) => { | |
| const canvas = document.createElement( 'canvas' ); | |
| canvas.width = imageData.width; | |
| canvas.height = imageData.height; | |
| const context = canvas.getContext('2d', { willReadFrequently: true }); | |
| context.drawImage( imageData, 0, 0 ); | |
| return context; | |
| }; | |
| this.learn("context2d", "webImageUrl", (tile, ctx) => ctx.canvas.toDataURL(), 1, 2); | |
| this.learn("image", "webImageUrl", (tile, image) => image.url); | |
| this.learn("image", "context2d", canvasContextCreator, 1, 1); | |
| this.learn("url", "image", imageCreator, 1, 1); | |
| //Copies | |
| this.learn("image", "image", (tile, image) => imageCreator(tile, image.src), 1, 1); | |
| this.learn("url", "url", (tile, url) => url, 0, 1); //strings are immutable, no need to copy | |
| this.learn("context2d", "context2d", (tile, ctx) => canvasContextCreator(tile, ctx.canvas)); | |
| /** | |
| * Free up canvas memory | |
| * (iOS 12 or higher on 2GB RAM device has only 224MB canvas memory, | |
| * and Safari keeps canvas until its height and width will be set to 0). | |
| */ | |
| this.learnDestroy("context2d", ctx => { | |
| ctx.canvas.width = 0; | |
| ctx.canvas.height = 0; | |
| }); | |
| } | |
| /** | |
| * Unique identifier (unlike toString.call(x)) to be guessed | |
| * from the data value. This type guess is more strict than | |
| * OpenSeadragon.type() implementation, but for most type recognition | |
| * this test relies on the output of OpenSeadragon.type(). | |
| * | |
| * Note: although we try to implement the type guessing, do | |
| * not rely on this functionality! Prefer explicit type declaration. | |
| * | |
| * @function guessType | |
| * @param x object to get unique identifier for | |
| * - can be array, in that case, alphabetically-ordered list of inner unique types | |
| * is returned (null, undefined are ignored) | |
| * - if $.isPlainObject(x) is true, then the object can define | |
| * getType function to specify its type | |
| * - otherwise, toString.call(x) is applied to get the parameter description | |
| * @return {string} unique variable descriptor | |
| */ | |
| guessType( x ) { | |
| if (Array.isArray(x)) { | |
| const types = []; | |
| for (let item of x) { | |
| if (item === undefined || item === null) { | |
| continue; | |
| } | |
| const type = this.guessType(item); | |
| if (!types.includes(type)) { | |
| types.push(type); | |
| } | |
| } | |
| types.sort(); | |
| return `Array [${types.join(",")}]`; | |
| } | |
| const guessType = $.type(x); | |
| if (guessType === "dom-node") { | |
| //distinguish nodes | |
| return guessType.nodeName.toLowerCase(); | |
| } | |
| if (guessType === "object") { | |
| if ($.isFunction(x.getType)) { | |
| return x.getType(); | |
| } | |
| } | |
| return guessType; | |
| } | |
| /** | |
| * Teach the system to convert data type 'from' -> 'to' | |
| * @param {string} from unique ID of the data item 'from' | |
| * @param {string} to unique ID of the data item 'to' | |
| * @param {OpenSeadragon.TypeConvertor} callback convertor that takes two arguments: a tile reference, and | |
| * a data object of a type 'from'; and converts this data object to type 'to'. It can return also the value | |
| * wrapped in a Promise (returned in resolve) or it can be async function. | |
| * @param {Number} [costPower=0] positive cost class of the conversion, smaller or equal than 7. | |
| * Should reflect the actual cost of the conversion: | |
| * - if nothing must be done and only reference is retrieved (or a constant operation done), | |
| * return 0 (default) | |
| * - if a linear amount of work is necessary, | |
| * return 1 | |
| * ... and so on, basically the number in O() complexity power exponent (for simplification) | |
| * @param {Number} [costMultiplier=1] multiplier of the cost class, e.g. O(3n^2) would | |
| * use costPower=2, costMultiplier=3; can be between 1 and 10^5 | |
| */ | |
| learn(from, to, callback, costPower = 0, costMultiplier = 1) { | |
| $.console.assert(costPower >= 0 && costPower <= 7, "[DataTypeConvertor] Conversion costPower must be between <0, 7>."); | |
| $.console.assert($.isFunction(callback), "[DataTypeConvertor:learn] Callback must be a valid function!"); | |
| if (from === to) { | |
| this.copyings[to] = callback; | |
| } else { | |
| //we won't know if somebody added multiple edges, though it will choose some edge anyway | |
| costPower++; | |
| costMultiplier = Math.min(Math.max(costMultiplier, 1), 10 ^ 5); | |
| this.graph.addVertex(from); | |
| this.graph.addVertex(to); | |
| this.graph.addEdge(from, to, costPower * 10 ^ 5 + costMultiplier, callback); | |
| this._known = {}; //invalidate precomputed paths :/ | |
| } | |
| } | |
| /** | |
| * Teach the system to destroy data type 'type' | |
| * for example, textures loaded to GPU have to be also manually removed when not needed anymore. | |
| * Needs to be defined only when the created object has extra deletion process. | |
| * @param {string} type | |
| * @param {OpenSeadragon.TypeDestructor} callback destructor, receives the object created, | |
| * it is basically a type conversion to 'undefined' - thus the type. | |
| */ | |
| learnDestroy(type, callback) { | |
| this.destructors[type] = callback; | |
| } | |
| /** | |
| * Convert data item x of type 'from' to any of the 'to' types, chosen is the cheapest known conversion. | |
| * Data is destroyed upon conversion. For different behavior, implement your conversion using the | |
| * path rules obtained from getConversionPath(). | |
| * Note: conversion DOES NOT COPY data if [to] contains type 'from' (e.g., the cheapest conversion is no conversion). | |
| * It automatically calls destructor on immediate types, but NOT on the x and the result. You should call these | |
| * manually if these should be destroyed. | |
| * @param {OpenSeadragon.Tile} tile | |
| * @param {any} data data item to convert | |
| * @param {string} from data item type | |
| * @param {string} to desired type(s) | |
| * @return {OpenSeadragon.Promise<?>} promise resolution with type 'to' or undefined if the conversion failed | |
| */ | |
| convert(tile, data, from, ...to) { | |
| const conversionPath = this.getConversionPath(from, to); | |
| if (!conversionPath) { | |
| $.console.error(`[OpenSeadragon.convertor.convert] Conversion ${from} ---> ${to} cannot be done!`); | |
| return $.Promise.resolve(); | |
| } | |
| const stepCount = conversionPath.length, | |
| _this = this; | |
| const step = (x, i, destroy = true) => { | |
| if (i >= stepCount) { | |
| return $.Promise.resolve(x); | |
| } | |
| let edge = conversionPath[i]; | |
| let y = edge.transform(tile, x); | |
| if (y === undefined) { | |
| $.console.error(`[OpenSeadragon.convertor.convert] data mid result undefined value (while converting using %s)`, edge); | |
| return $.Promise.resolve(); | |
| } | |
| //node.value holds the type string | |
| if (destroy) { | |
| _this.destroy(x, edge.origin.value); | |
| } | |
| const result = $.type(y) === "promise" ? y : $.Promise.resolve(y); | |
| return result.then(res => step(res, i + 1)); | |
| }; | |
| //destroy only mid-results, but not the original value | |
| return step(data, 0, false); | |
| } | |
| /** | |
| * Copy the data item given. | |
| * @param {OpenSeadragon.Tile} tile | |
| * @param {any} data data item to convert | |
| * @param {string} type data type | |
| * @return {OpenSeadragon.Promise<?>|undefined} promise resolution with data passed from constructor | |
| */ | |
| copy(tile, data, type) { | |
| const copyTransform = this.copyings[type]; | |
| if (copyTransform) { | |
| const y = copyTransform(tile, data); | |
| return $.type(y) === "promise" ? y : $.Promise.resolve(y); | |
| } | |
| $.console.warn(`[OpenSeadragon.convertor.copy] is not supported with type %s`, type); | |
| return $.Promise.resolve(undefined); | |
| } | |
| /** | |
| * Destroy the data item given. | |
| * @param {string} type data type | |
| * @param {any} data | |
| * @return {OpenSeadragon.Promise<any>|undefined} promise resolution with data passed from constructor, or undefined | |
| * if not such conversion exists | |
| */ | |
| destroy(data, type) { | |
| const destructor = this.destructors[type]; | |
| if (destructor) { | |
| const y = destructor(data); | |
| return $.type(y) === "promise" ? y : $.Promise.resolve(y); | |
| } | |
| return undefined; | |
| } | |
| /** | |
| * Get possible system type conversions and cache result. | |
| * @param {string} from data item type | |
| * @param {string|string[]} to array of accepted types | |
| * @return {ConversionStep[]|undefined} array of required conversions (returns empty array | |
| * for from===to), or undefined if the system cannot convert between given types. | |
| * Each object has 'transform' function that converts between neighbouring types, such | |
| * that x = arr[i].transform(x) is valid input for convertor arr[i+1].transform(), e.g. | |
| * arr[i+1].transform(arr[i].transform( ... )) is a valid conversion procedure. | |
| * | |
| * Note: if a function is returned, it is a callback called once the data is ready. | |
| */ | |
| getConversionPath(from, to) { | |
| let bestConvertorPath, selectedType; | |
| let knownFrom = this._known[from]; | |
| if (!knownFrom) { | |
| this._known[from] = knownFrom = {}; | |
| } | |
| if (Array.isArray(to)) { | |
| $.console.assert(to.length > 0, "[getConversionPath] conversion 'to' type must be defined."); | |
| let bestCost = Infinity; | |
| //FIXME: pre-compute all paths in 'to' array? could be efficient for multiple | |
| // type system, but overhead for simple use cases... now we just use the first type if costs unknown | |
| selectedType = to[0]; | |
| for (const outType of to) { | |
| const conversion = knownFrom[outType]; | |
| if (conversion && bestCost > conversion.cost) { | |
| bestConvertorPath = conversion; | |
| bestCost = conversion.cost; | |
| selectedType = outType; | |
| } | |
| } | |
| } else { | |
| $.console.assert(typeof to === "string", "[getConversionPath] conversion 'to' type must be defined."); | |
| bestConvertorPath = knownFrom[to]; | |
| selectedType = to; | |
| } | |
| if (!bestConvertorPath) { | |
| bestConvertorPath = this.graph.dijkstra(from, selectedType); | |
| this._known[from][selectedType] = bestConvertorPath; | |
| } | |
| return bestConvertorPath ? bestConvertorPath.path : undefined; | |
| } | |
| /** | |
| * Return a list of known conversion types | |
| * @return {string[]} | |
| */ | |
| getKnownTypes() { | |
| return Object.keys(this.graph.vertices); | |
| } | |
| /** | |
| * Check whether given type is known to the convertor | |
| * @param {string} type type to test | |
| * @return {boolean} | |
| */ | |
| existsType(type) { | |
| return !!this.graph.vertices[type]; | |
| } | |
| }; | |
| /** | |
| * Static convertor available throughout OpenSeadragon. | |
| * | |
| * Built-in conversions include types: | |
| * - context2d canvas 2d context | |
| * - image HTMLImage element | |
| * - url url string carrying or pointing to 2D raster data | |
| * - canvas HTMLCanvas element | |
| * | |
| * @type OpenSeadragon.DataTypeConvertor | |
| * @memberOf OpenSeadragon | |
| */ | |
| $.convertor = new $.DataTypeConvertor(); | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - Button | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * An enumeration of button states | |
| * @member ButtonState | |
| * @memberof OpenSeadragon | |
| * @static | |
| * @type {Object} | |
| * @property {Number} REST | |
| * @property {Number} GROUP | |
| * @property {Number} HOVER | |
| * @property {Number} DOWN | |
| */ | |
| $.ButtonState = { | |
| REST: 0, | |
| GROUP: 1, | |
| HOVER: 2, | |
| DOWN: 3 | |
| }; | |
| /** | |
| * @class Button | |
| * @classdesc Manages events, hover states for individual buttons, tool-tips, as well | |
| * as fading the buttons out when the user has not interacted with them | |
| * for a specified period. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.EventSource | |
| * @param {Object} options | |
| * @param {Element} [options.element=null] Element to use as the button. If not specified, an HTML <div> element is created. | |
| * @param {String} [options.tooltip=null] Provides context help for the button when the | |
| * user hovers over it. | |
| * @param {String} [options.srcRest=null] URL of image to use in 'rest' state. | |
| * @param {String} [options.srcGroup=null] URL of image to use in 'up' state. | |
| * @param {String} [options.srcHover=null] URL of image to use in 'hover' state. | |
| * @param {String} [options.srcDown=null] URL of image to use in 'down' state. | |
| * @param {Number} [options.fadeDelay=0] How long to wait before fading. | |
| * @param {Number} [options.fadeLength=2000] How long should it take to fade the button. | |
| * @param {OpenSeadragon.EventHandler} [options.onPress=null] Event handler callback for {@link OpenSeadragon.Button.event:press}. | |
| * @param {OpenSeadragon.EventHandler} [options.onRelease=null] Event handler callback for {@link OpenSeadragon.Button.event:release}. | |
| * @param {OpenSeadragon.EventHandler} [options.onClick=null] Event handler callback for {@link OpenSeadragon.Button.event:click}. | |
| * @param {OpenSeadragon.EventHandler} [options.onEnter=null] Event handler callback for {@link OpenSeadragon.Button.event:enter}. | |
| * @param {OpenSeadragon.EventHandler} [options.onExit=null] Event handler callback for {@link OpenSeadragon.Button.event:exit}. | |
| * @param {OpenSeadragon.EventHandler} [options.onFocus=null] Event handler callback for {@link OpenSeadragon.Button.event:focus}. | |
| * @param {OpenSeadragon.EventHandler} [options.onBlur=null] Event handler callback for {@link OpenSeadragon.Button.event:blur}. | |
| * @param {Object} [options.userData=null] Arbitrary object to be passed unchanged to any attached handler methods. | |
| */ | |
| $.Button = function( options ) { | |
| var _this = this; | |
| $.EventSource.call( this ); | |
| $.extend( true, this, { | |
| tooltip: null, | |
| srcRest: null, | |
| srcGroup: null, | |
| srcHover: null, | |
| srcDown: null, | |
| clickTimeThreshold: $.DEFAULT_SETTINGS.clickTimeThreshold, | |
| clickDistThreshold: $.DEFAULT_SETTINGS.clickDistThreshold, | |
| /** | |
| * How long to wait before fading. | |
| * @member {Number} fadeDelay | |
| * @memberof OpenSeadragon.Button# | |
| */ | |
| fadeDelay: 0, | |
| /** | |
| * How long should it take to fade the button. | |
| * @member {Number} fadeLength | |
| * @memberof OpenSeadragon.Button# | |
| */ | |
| fadeLength: 2000, | |
| onPress: null, | |
| onRelease: null, | |
| onClick: null, | |
| onEnter: null, | |
| onExit: null, | |
| onFocus: null, | |
| onBlur: null, | |
| userData: null | |
| }, options ); | |
| /** | |
| * The button element. | |
| * @member {Element} element | |
| * @memberof OpenSeadragon.Button# | |
| */ | |
| this.element = options.element || $.makeNeutralElement("div"); | |
| //if the user has specified the element to bind the control to explicitly | |
| //then do not add the default control images | |
| if ( !options.element ) { | |
| this.imgRest = $.makeTransparentImage( this.srcRest ); | |
| this.imgGroup = $.makeTransparentImage( this.srcGroup ); | |
| this.imgHover = $.makeTransparentImage( this.srcHover ); | |
| this.imgDown = $.makeTransparentImage( this.srcDown ); | |
| this.imgRest.alt = | |
| this.imgGroup.alt = | |
| this.imgHover.alt = | |
| this.imgDown.alt = | |
| this.tooltip; | |
| // Allow pointer events to pass through the img elements so implicit | |
| // pointer capture works on touch devices | |
| $.setElementPointerEventsNone( this.imgRest ); | |
| $.setElementPointerEventsNone( this.imgGroup ); | |
| $.setElementPointerEventsNone( this.imgHover ); | |
| $.setElementPointerEventsNone( this.imgDown ); | |
| this.element.style.position = "relative"; | |
| $.setElementTouchActionNone( this.element ); | |
| this.imgGroup.style.position = | |
| this.imgHover.style.position = | |
| this.imgDown.style.position = | |
| "absolute"; | |
| this.imgGroup.style.top = | |
| this.imgHover.style.top = | |
| this.imgDown.style.top = | |
| "0px"; | |
| this.imgGroup.style.left = | |
| this.imgHover.style.left = | |
| this.imgDown.style.left = | |
| "0px"; | |
| this.imgHover.style.visibility = | |
| this.imgDown.style.visibility = | |
| "hidden"; | |
| this.element.appendChild( this.imgRest ); | |
| this.element.appendChild( this.imgGroup ); | |
| this.element.appendChild( this.imgHover ); | |
| this.element.appendChild( this.imgDown ); | |
| } | |
| this.addHandler("press", this.onPress); | |
| this.addHandler("release", this.onRelease); | |
| this.addHandler("click", this.onClick); | |
| this.addHandler("enter", this.onEnter); | |
| this.addHandler("exit", this.onExit); | |
| this.addHandler("focus", this.onFocus); | |
| this.addHandler("blur", this.onBlur); | |
| /** | |
| * The button's current state. | |
| * @member {OpenSeadragon.ButtonState} currentState | |
| * @memberof OpenSeadragon.Button# | |
| */ | |
| this.currentState = $.ButtonState.GROUP; | |
| // When the button last began to fade. | |
| this.fadeBeginTime = null; | |
| // Whether this button should fade after user stops interacting with the viewport. | |
| this.shouldFade = false; | |
| this.element.style.display = "inline-block"; | |
| this.element.style.position = "relative"; | |
| this.element.title = this.tooltip; | |
| /** | |
| * Tracks mouse/touch/key events on the button. | |
| * @member {OpenSeadragon.MouseTracker} tracker | |
| * @memberof OpenSeadragon.Button# | |
| */ | |
| this.tracker = new $.MouseTracker({ | |
| userData: 'Button.tracker', | |
| element: this.element, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| enterHandler: function( event ) { | |
| if ( event.insideElementPressed ) { | |
| inTo( _this, $.ButtonState.DOWN ); | |
| /** | |
| * Raised when the cursor enters the Button element. | |
| * | |
| * @event enter | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "enter", { originalEvent: event.originalEvent } ); | |
| } else if ( !event.buttonDownAny ) { | |
| inTo( _this, $.ButtonState.HOVER ); | |
| } | |
| }, | |
| focusHandler: function ( event ) { | |
| _this.tracker.enterHandler( event ); | |
| /** | |
| * Raised when the Button element receives focus. | |
| * | |
| * @event focus | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "focus", { originalEvent: event.originalEvent } ); | |
| }, | |
| leaveHandler: function( event ) { | |
| outTo( _this, $.ButtonState.GROUP ); | |
| if ( event.insideElementPressed ) { | |
| /** | |
| * Raised when the cursor leaves the Button element. | |
| * | |
| * @event exit | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "exit", { originalEvent: event.originalEvent } ); | |
| } | |
| }, | |
| blurHandler: function ( event ) { | |
| _this.tracker.leaveHandler( event ); | |
| /** | |
| * Raised when the Button element loses focus. | |
| * | |
| * @event blur | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "blur", { originalEvent: event.originalEvent } ); | |
| }, | |
| pressHandler: function ( event ) { | |
| inTo( _this, $.ButtonState.DOWN ); | |
| /** | |
| * Raised when a mouse button is pressed or touch occurs in the Button element. | |
| * | |
| * @event press | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "press", { originalEvent: event.originalEvent } ); | |
| }, | |
| releaseHandler: function( event ) { | |
| if ( event.insideElementPressed && event.insideElementReleased ) { | |
| outTo( _this, $.ButtonState.HOVER ); | |
| /** | |
| * Raised when the mouse button is released or touch ends in the Button element. | |
| * | |
| * @event release | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "release", { originalEvent: event.originalEvent } ); | |
| } else if ( event.insideElementPressed ) { | |
| outTo( _this, $.ButtonState.GROUP ); | |
| } else { | |
| inTo( _this, $.ButtonState.HOVER ); | |
| } | |
| }, | |
| clickHandler: function( event ) { | |
| if ( event.quick ) { | |
| /** | |
| * Raised when a mouse button is pressed and released or touch is initiated and ended in the Button element within the time and distance threshold. | |
| * | |
| * @event click | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent("click", { originalEvent: event.originalEvent }); | |
| } | |
| }, | |
| keyHandler: function( event ){ | |
| //console.log( "%s : handling key %s!", _this.tooltip, event.keyCode); | |
| if( 13 === event.keyCode ){ | |
| /*** | |
| * Raised when a mouse button is pressed and released or touch is initiated and ended in the Button element within the time and distance threshold. | |
| * | |
| * @event click | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "click", { originalEvent: event.originalEvent } ); | |
| /*** | |
| * Raised when the mouse button is released or touch ends in the Button element. | |
| * | |
| * @event release | |
| * @memberof OpenSeadragon.Button | |
| * @type {object} | |
| * @property {OpenSeadragon.Button} eventSource - A reference to the Button which raised the event. | |
| * @property {Object} originalEvent - The original DOM event. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| _this.raiseEvent( "release", { originalEvent: event.originalEvent } ); | |
| event.preventDefault = true; | |
| } else{ | |
| event.preventDefault = false; | |
| } | |
| } | |
| }); | |
| outTo( this, $.ButtonState.REST ); | |
| }; | |
| $.extend( $.Button.prototype, $.EventSource.prototype, /** @lends OpenSeadragon.Button.prototype */{ | |
| /** | |
| * Used by a button container element (e.g. a ButtonGroup) to transition the button state | |
| * to ButtonState.GROUP. | |
| * @function | |
| */ | |
| notifyGroupEnter: function() { | |
| inTo( this, $.ButtonState.GROUP ); | |
| }, | |
| /** | |
| * Used by a button container element (e.g. a ButtonGroup) to transition the button state | |
| * to ButtonState.REST. | |
| * @function | |
| */ | |
| notifyGroupExit: function() { | |
| outTo( this, $.ButtonState.REST ); | |
| }, | |
| /** | |
| * @function | |
| */ | |
| disable: function(){ | |
| this.notifyGroupExit(); | |
| this.element.disabled = true; | |
| this.tracker.setTracking(false); | |
| $.setElementOpacity( this.element, 0.2, true ); | |
| }, | |
| /** | |
| * @function | |
| */ | |
| enable: function(){ | |
| this.element.disabled = false; | |
| this.tracker.setTracking(true); | |
| $.setElementOpacity( this.element, 1.0, true ); | |
| this.notifyGroupEnter(); | |
| }, | |
| destroy: function() { | |
| if (this.imgRest) { | |
| this.element.removeChild(this.imgRest); | |
| this.imgRest = null; | |
| } | |
| if (this.imgGroup) { | |
| this.element.removeChild(this.imgGroup); | |
| this.imgGroup = null; | |
| } | |
| if (this.imgHover) { | |
| this.element.removeChild(this.imgHover); | |
| this.imgHover = null; | |
| } | |
| if (this.imgDown) { | |
| this.element.removeChild(this.imgDown); | |
| this.imgDown = null; | |
| } | |
| this.removeAllHandlers(); | |
| this.tracker.destroy(); | |
| this.element = null; | |
| } | |
| }); | |
| function scheduleFade( button ) { | |
| $.requestAnimationFrame(function(){ | |
| updateFade( button ); | |
| }); | |
| } | |
| function updateFade( button ) { | |
| var currentTime, | |
| deltaTime, | |
| opacity; | |
| if ( button.shouldFade ) { | |
| currentTime = $.now(); | |
| deltaTime = currentTime - button.fadeBeginTime; | |
| opacity = 1.0 - deltaTime / button.fadeLength; | |
| opacity = Math.min( 1.0, opacity ); | |
| opacity = Math.max( 0.0, opacity ); | |
| if( button.imgGroup ){ | |
| $.setElementOpacity( button.imgGroup, opacity, true ); | |
| } | |
| if ( opacity > 0 ) { | |
| // fade again | |
| scheduleFade( button ); | |
| } | |
| } | |
| } | |
| function beginFading( button ) { | |
| button.shouldFade = true; | |
| button.fadeBeginTime = $.now() + button.fadeDelay; | |
| window.setTimeout( function(){ | |
| scheduleFade( button ); | |
| }, button.fadeDelay ); | |
| } | |
| function stopFading( button ) { | |
| button.shouldFade = false; | |
| if( button.imgGroup ){ | |
| $.setElementOpacity( button.imgGroup, 1.0, true ); | |
| } | |
| } | |
| function inTo( button, newState ) { | |
| if( button.element.disabled ){ | |
| return; | |
| } | |
| if ( newState >= $.ButtonState.GROUP && | |
| button.currentState === $.ButtonState.REST ) { | |
| stopFading( button ); | |
| button.currentState = $.ButtonState.GROUP; | |
| } | |
| if ( newState >= $.ButtonState.HOVER && | |
| button.currentState === $.ButtonState.GROUP ) { | |
| if( button.imgHover ){ | |
| button.imgHover.style.visibility = ""; | |
| } | |
| button.currentState = $.ButtonState.HOVER; | |
| } | |
| if ( newState >= $.ButtonState.DOWN && | |
| button.currentState === $.ButtonState.HOVER ) { | |
| if( button.imgDown ){ | |
| button.imgDown.style.visibility = ""; | |
| } | |
| button.currentState = $.ButtonState.DOWN; | |
| } | |
| } | |
| function outTo( button, newState ) { | |
| if( button.element.disabled ){ | |
| return; | |
| } | |
| if ( newState <= $.ButtonState.HOVER && | |
| button.currentState === $.ButtonState.DOWN ) { | |
| if( button.imgDown ){ | |
| button.imgDown.style.visibility = "hidden"; | |
| } | |
| button.currentState = $.ButtonState.HOVER; | |
| } | |
| if ( newState <= $.ButtonState.GROUP && | |
| button.currentState === $.ButtonState.HOVER ) { | |
| if( button.imgHover ){ | |
| button.imgHover.style.visibility = "hidden"; | |
| } | |
| button.currentState = $.ButtonState.GROUP; | |
| } | |
| if ( newState <= $.ButtonState.REST && | |
| button.currentState === $.ButtonState.GROUP ) { | |
| beginFading( button ); | |
| button.currentState = $.ButtonState.REST; | |
| } | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - ButtonGroup | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class ButtonGroup | |
| * @classdesc Manages events on groups of buttons. | |
| * | |
| * @memberof OpenSeadragon | |
| * @param {Object} options - A dictionary of settings applied against the entire group of buttons. | |
| * @param {Array} options.buttons Array of buttons | |
| * @param {Element} [options.element] Element to use as the container | |
| **/ | |
| $.ButtonGroup = function( options ) { | |
| $.extend( true, this, { | |
| /** | |
| * An array containing the buttons themselves. | |
| * @member {Array} buttons | |
| * @memberof OpenSeadragon.ButtonGroup# | |
| */ | |
| buttons: [], | |
| clickTimeThreshold: $.DEFAULT_SETTINGS.clickTimeThreshold, | |
| clickDistThreshold: $.DEFAULT_SETTINGS.clickDistThreshold, | |
| labelText: "" | |
| }, options ); | |
| // copy the button elements TODO: Why? | |
| var buttons = this.buttons.concat([]), | |
| _this = this, | |
| i; | |
| /** | |
| * The shared container for the buttons. | |
| * @member {Element} element | |
| * @memberof OpenSeadragon.ButtonGroup# | |
| */ | |
| this.element = options.element || $.makeNeutralElement( "div" ); | |
| // TODO What if there IS an options.group specified? | |
| if( !options.group ){ | |
| this.element.style.display = "inline-block"; | |
| //this.label = $.makeNeutralElement( "label" ); | |
| //TODO: support labels for ButtonGroups | |
| //this.label.innerHTML = this.labelText; | |
| //this.element.appendChild( this.label ); | |
| for ( i = 0; i < buttons.length; i++ ) { | |
| this.element.appendChild( buttons[ i ].element ); | |
| } | |
| } | |
| $.setElementTouchActionNone( this.element ); | |
| /** | |
| * Tracks mouse/touch/key events across the group of buttons. | |
| * @member {OpenSeadragon.MouseTracker} tracker | |
| * @memberof OpenSeadragon.ButtonGroup# | |
| */ | |
| this.tracker = new $.MouseTracker({ | |
| userData: 'ButtonGroup.tracker', | |
| element: this.element, | |
| clickTimeThreshold: this.clickTimeThreshold, | |
| clickDistThreshold: this.clickDistThreshold, | |
| enterHandler: function ( event ) { | |
| var i; | |
| for ( i = 0; i < _this.buttons.length; i++ ) { | |
| _this.buttons[ i ].notifyGroupEnter(); | |
| } | |
| }, | |
| leaveHandler: function ( event ) { | |
| var i; | |
| if ( !event.insideElementPressed ) { | |
| for ( i = 0; i < _this.buttons.length; i++ ) { | |
| _this.buttons[ i ].notifyGroupExit(); | |
| } | |
| } | |
| }, | |
| }); | |
| }; | |
| /** @lends OpenSeadragon.ButtonGroup.prototype */ | |
| $.ButtonGroup.prototype = { | |
| /** | |
| * Adds the given button to this button group. | |
| * | |
| * @function | |
| * @param {OpenSeadragon.Button} button | |
| */ | |
| addButton: function( button ){ | |
| this.buttons.push(button); | |
| this.element.appendChild(button.element); | |
| }, | |
| /** | |
| * TODO: Figure out why this is used on the public API and if a more useful | |
| * api can be created. | |
| * @function | |
| * @private | |
| */ | |
| emulateEnter: function() { | |
| this.tracker.enterHandler( { eventSource: this.tracker } ); | |
| }, | |
| /** | |
| * TODO: Figure out why this is used on the public API and if a more useful | |
| * api can be created. | |
| * @function | |
| * @private | |
| */ | |
| emulateLeave: function() { | |
| this.tracker.leaveHandler( { eventSource: this.tracker } ); | |
| }, | |
| destroy: function() { | |
| while (this.buttons.length) { | |
| var button = this.buttons.pop(); | |
| this.element.removeChild(button.element); | |
| button.destroy(); | |
| } | |
| this.tracker.destroy(); | |
| this.element = null; | |
| } | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - Rect | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function($) { | |
| /** | |
| * @class Rect | |
| * @classdesc A Rectangle is described by it top left coordinates (x, y), width, | |
| * height and degrees of rotation around (x, y). | |
| * Note that the coordinate system used is the one commonly used with images: | |
| * x increases when going to the right | |
| * y increases when going to the bottom | |
| * degrees increases clockwise with 0 being the horizontal | |
| * | |
| * The constructor normalizes the rectangle to always have 0 <= degrees < 90 | |
| * | |
| * @memberof OpenSeadragon | |
| * @param {Number} [x=0] The vector component 'x'. | |
| * @param {Number} [y=0] The vector component 'y'. | |
| * @param {Number} [width=0] The vector component 'width'. | |
| * @param {Number} [height=0] The vector component 'height'. | |
| * @param {Number} [degrees=0] Rotation of the rectangle around (x,y) in degrees. | |
| */ | |
| $.Rect = function(x, y, width, height, degrees) { | |
| /** | |
| * The vector component 'x'. | |
| * @member {Number} x | |
| * @memberof OpenSeadragon.Rect# | |
| */ | |
| this.x = typeof (x) === "number" ? x : 0; | |
| /** | |
| * The vector component 'y'. | |
| * @member {Number} y | |
| * @memberof OpenSeadragon.Rect# | |
| */ | |
| this.y = typeof (y) === "number" ? y : 0; | |
| /** | |
| * The vector component 'width'. | |
| * @member {Number} width | |
| * @memberof OpenSeadragon.Rect# | |
| */ | |
| this.width = typeof (width) === "number" ? width : 0; | |
| /** | |
| * The vector component 'height'. | |
| * @member {Number} height | |
| * @memberof OpenSeadragon.Rect# | |
| */ | |
| this.height = typeof (height) === "number" ? height : 0; | |
| /** | |
| * The rotation of the rectangle, in degrees. | |
| * @member {Number} degrees | |
| * @memberof OpenSeadragon.Rect# | |
| */ | |
| this.degrees = typeof (degrees) === "number" ? degrees : 0; | |
| // Normalizes the rectangle. | |
| this.degrees = $.positiveModulo(this.degrees, 360); | |
| var newTopLeft, newWidth; | |
| if (this.degrees >= 270) { | |
| newTopLeft = this.getTopRight(); | |
| this.x = newTopLeft.x; | |
| this.y = newTopLeft.y; | |
| newWidth = this.height; | |
| this.height = this.width; | |
| this.width = newWidth; | |
| this.degrees -= 270; | |
| } else if (this.degrees >= 180) { | |
| newTopLeft = this.getBottomRight(); | |
| this.x = newTopLeft.x; | |
| this.y = newTopLeft.y; | |
| this.degrees -= 180; | |
| } else if (this.degrees >= 90) { | |
| newTopLeft = this.getBottomLeft(); | |
| this.x = newTopLeft.x; | |
| this.y = newTopLeft.y; | |
| newWidth = this.height; | |
| this.height = this.width; | |
| this.width = newWidth; | |
| this.degrees -= 90; | |
| } | |
| }; | |
| /** | |
| * Builds a rectangle having the 3 specified points as summits. | |
| * @static | |
| * @memberof OpenSeadragon.Rect | |
| * @param {OpenSeadragon.Point} topLeft | |
| * @param {OpenSeadragon.Point} topRight | |
| * @param {OpenSeadragon.Point} bottomLeft | |
| * @returns {OpenSeadragon.Rect} | |
| */ | |
| $.Rect.fromSummits = function(topLeft, topRight, bottomLeft) { | |
| var width = topLeft.distanceTo(topRight); | |
| var height = topLeft.distanceTo(bottomLeft); | |
| var diff = topRight.minus(topLeft); | |
| var radians = Math.atan(diff.y / diff.x); | |
| if (diff.x < 0) { | |
| radians += Math.PI; | |
| } else if (diff.y < 0) { | |
| radians += 2 * Math.PI; | |
| } | |
| return new $.Rect( | |
| topLeft.x, | |
| topLeft.y, | |
| width, | |
| height, | |
| radians / Math.PI * 180); | |
| }; | |
| /** @lends OpenSeadragon.Rect.prototype */ | |
| $.Rect.prototype = { | |
| /** | |
| * @function | |
| * @returns {OpenSeadragon.Rect} a duplicate of this Rect | |
| */ | |
| clone: function() { | |
| return new $.Rect( | |
| this.x, | |
| this.y, | |
| this.width, | |
| this.height, | |
| this.degrees); | |
| }, | |
| /** | |
| * The aspect ratio is simply the ratio of width to height. | |
| * @function | |
| * @returns {Number} The ratio of width to height. | |
| */ | |
| getAspectRatio: function() { | |
| return this.width / this.height; | |
| }, | |
| /** | |
| * Provides the coordinates of the upper-left corner of the rectangle as a | |
| * point. | |
| * @function | |
| * @returns {OpenSeadragon.Point} The coordinate of the upper-left corner of | |
| * the rectangle. | |
| */ | |
| getTopLeft: function() { | |
| return new $.Point( | |
| this.x, | |
| this.y | |
| ); | |
| }, | |
| /** | |
| * Provides the coordinates of the bottom-right corner of the rectangle as a | |
| * point. | |
| * @function | |
| * @returns {OpenSeadragon.Point} The coordinate of the bottom-right corner of | |
| * the rectangle. | |
| */ | |
| getBottomRight: function() { | |
| return new $.Point(this.x + this.width, this.y + this.height) | |
| .rotate(this.degrees, this.getTopLeft()); | |
| }, | |
| /** | |
| * Provides the coordinates of the top-right corner of the rectangle as a | |
| * point. | |
| * @function | |
| * @returns {OpenSeadragon.Point} The coordinate of the top-right corner of | |
| * the rectangle. | |
| */ | |
| getTopRight: function() { | |
| return new $.Point(this.x + this.width, this.y) | |
| .rotate(this.degrees, this.getTopLeft()); | |
| }, | |
| /** | |
| * Provides the coordinates of the bottom-left corner of the rectangle as a | |
| * point. | |
| * @function | |
| * @returns {OpenSeadragon.Point} The coordinate of the bottom-left corner of | |
| * the rectangle. | |
| */ | |
| getBottomLeft: function() { | |
| return new $.Point(this.x, this.y + this.height) | |
| .rotate(this.degrees, this.getTopLeft()); | |
| }, | |
| /** | |
| * Computes the center of the rectangle. | |
| * @function | |
| * @returns {OpenSeadragon.Point} The center of the rectangle as represented | |
| * as represented by a 2-dimensional vector (x,y) | |
| */ | |
| getCenter: function() { | |
| return new $.Point( | |
| this.x + this.width / 2.0, | |
| this.y + this.height / 2.0 | |
| ).rotate(this.degrees, this.getTopLeft()); | |
| }, | |
| /** | |
| * Returns the width and height component as a vector OpenSeadragon.Point | |
| * @function | |
| * @returns {OpenSeadragon.Point} The 2 dimensional vector representing the | |
| * width and height of the rectangle. | |
| */ | |
| getSize: function() { | |
| return new $.Point(this.width, this.height); | |
| }, | |
| /** | |
| * Determines if two Rectangles have equivalent components. | |
| * @function | |
| * @param {OpenSeadragon.Rect} rectangle The Rectangle to compare to. | |
| * @returns {Boolean} 'true' if all components are equal, otherwise 'false'. | |
| */ | |
| equals: function(other) { | |
| return (other instanceof $.Rect) && | |
| this.x === other.x && | |
| this.y === other.y && | |
| this.width === other.width && | |
| this.height === other.height && | |
| this.degrees === other.degrees; | |
| }, | |
| /** | |
| * Multiply all dimensions (except degrees) in this Rect by a factor and | |
| * return a new Rect. | |
| * @function | |
| * @param {Number} factor The factor to multiply vector components. | |
| * @returns {OpenSeadragon.Rect} A new rect representing the multiplication | |
| * of the vector components by the factor | |
| */ | |
| times: function(factor) { | |
| return new $.Rect( | |
| this.x * factor, | |
| this.y * factor, | |
| this.width * factor, | |
| this.height * factor, | |
| this.degrees); | |
| }, | |
| /** | |
| * Translate/move this Rect by a vector and return new Rect. | |
| * @function | |
| * @param {OpenSeadragon.Point} delta The translation vector. | |
| * @returns {OpenSeadragon.Rect} A new rect with altered position | |
| */ | |
| translate: function(delta) { | |
| return new $.Rect( | |
| this.x + delta.x, | |
| this.y + delta.y, | |
| this.width, | |
| this.height, | |
| this.degrees); | |
| }, | |
| /** | |
| * Returns the smallest rectangle that will contain this and the given | |
| * rectangle bounding boxes. | |
| * @param {OpenSeadragon.Rect} rect | |
| * @returns {OpenSeadragon.Rect} The new rectangle. | |
| */ | |
| union: function(rect) { | |
| var thisBoundingBox = this.getBoundingBox(); | |
| var otherBoundingBox = rect.getBoundingBox(); | |
| var left = Math.min(thisBoundingBox.x, otherBoundingBox.x); | |
| var top = Math.min(thisBoundingBox.y, otherBoundingBox.y); | |
| var right = Math.max( | |
| thisBoundingBox.x + thisBoundingBox.width, | |
| otherBoundingBox.x + otherBoundingBox.width); | |
| var bottom = Math.max( | |
| thisBoundingBox.y + thisBoundingBox.height, | |
| otherBoundingBox.y + otherBoundingBox.height); | |
| return new $.Rect( | |
| left, | |
| top, | |
| right - left, | |
| bottom - top); | |
| }, | |
| /** | |
| * Returns the bounding box of the intersection of this rectangle with the | |
| * given rectangle. | |
| * @param {OpenSeadragon.Rect} rect | |
| * @returns {OpenSeadragon.Rect} the bounding box of the intersection | |
| * or null if the rectangles don't intersect. | |
| */ | |
| intersection: function(rect) { | |
| // Simplified version of Weiler Atherton clipping algorithm | |
| // https://en.wikipedia.org/wiki/Weiler%E2%80%93Atherton_clipping_algorithm | |
| // Because we just want the bounding box of the intersection, | |
| // we can just compute the bounding box of: | |
| // 1. all the summits of this which are inside rect | |
| // 2. all the summits of rect which are inside this | |
| // 3. all the intersections of rect and this | |
| var EPSILON = 0.0000000001; | |
| var intersectionPoints = []; | |
| var thisTopLeft = this.getTopLeft(); | |
| if (rect.containsPoint(thisTopLeft, EPSILON)) { | |
| intersectionPoints.push(thisTopLeft); | |
| } | |
| var thisTopRight = this.getTopRight(); | |
| if (rect.containsPoint(thisTopRight, EPSILON)) { | |
| intersectionPoints.push(thisTopRight); | |
| } | |
| var thisBottomLeft = this.getBottomLeft(); | |
| if (rect.containsPoint(thisBottomLeft, EPSILON)) { | |
| intersectionPoints.push(thisBottomLeft); | |
| } | |
| var thisBottomRight = this.getBottomRight(); | |
| if (rect.containsPoint(thisBottomRight, EPSILON)) { | |
| intersectionPoints.push(thisBottomRight); | |
| } | |
| var rectTopLeft = rect.getTopLeft(); | |
| if (this.containsPoint(rectTopLeft, EPSILON)) { | |
| intersectionPoints.push(rectTopLeft); | |
| } | |
| var rectTopRight = rect.getTopRight(); | |
| if (this.containsPoint(rectTopRight, EPSILON)) { | |
| intersectionPoints.push(rectTopRight); | |
| } | |
| var rectBottomLeft = rect.getBottomLeft(); | |
| if (this.containsPoint(rectBottomLeft, EPSILON)) { | |
| intersectionPoints.push(rectBottomLeft); | |
| } | |
| var rectBottomRight = rect.getBottomRight(); | |
| if (this.containsPoint(rectBottomRight, EPSILON)) { | |
| intersectionPoints.push(rectBottomRight); | |
| } | |
| var thisSegments = this._getSegments(); | |
| var rectSegments = rect._getSegments(); | |
| for (var i = 0; i < thisSegments.length; i++) { | |
| var thisSegment = thisSegments[i]; | |
| for (var j = 0; j < rectSegments.length; j++) { | |
| var rectSegment = rectSegments[j]; | |
| var intersect = getIntersection(thisSegment[0], thisSegment[1], | |
| rectSegment[0], rectSegment[1]); | |
| if (intersect) { | |
| intersectionPoints.push(intersect); | |
| } | |
| } | |
| } | |
| // Get intersection point of segments [a,b] and [c,d] | |
| function getIntersection(a, b, c, d) { | |
| // http://stackoverflow.com/a/1968345/1440403 | |
| var abVector = b.minus(a); | |
| var cdVector = d.minus(c); | |
| var denom = -cdVector.x * abVector.y + abVector.x * cdVector.y; | |
| if (denom === 0) { | |
| return null; | |
| } | |
| var s = (abVector.x * (a.y - c.y) - abVector.y * (a.x - c.x)) / denom; | |
| var t = (cdVector.x * (a.y - c.y) - cdVector.y * (a.x - c.x)) / denom; | |
| if (-EPSILON <= s && s <= 1 - EPSILON && | |
| -EPSILON <= t && t <= 1 - EPSILON) { | |
| return new $.Point(a.x + t * abVector.x, a.y + t * abVector.y); | |
| } | |
| return null; | |
| } | |
| if (intersectionPoints.length === 0) { | |
| return null; | |
| } | |
| var minX = intersectionPoints[0].x; | |
| var maxX = intersectionPoints[0].x; | |
| var minY = intersectionPoints[0].y; | |
| var maxY = intersectionPoints[0].y; | |
| for (var k = 1; k < intersectionPoints.length; k++) { | |
| var point = intersectionPoints[k]; | |
| if (point.x < minX) { | |
| minX = point.x; | |
| } | |
| if (point.x > maxX) { | |
| maxX = point.x; | |
| } | |
| if (point.y < minY) { | |
| minY = point.y; | |
| } | |
| if (point.y > maxY) { | |
| maxY = point.y; | |
| } | |
| } | |
| return new $.Rect(minX, minY, maxX - minX, maxY - minY); | |
| }, | |
| // private | |
| _getSegments: function() { | |
| var topLeft = this.getTopLeft(); | |
| var topRight = this.getTopRight(); | |
| var bottomLeft = this.getBottomLeft(); | |
| var bottomRight = this.getBottomRight(); | |
| return [[topLeft, topRight], | |
| [topRight, bottomRight], | |
| [bottomRight, bottomLeft], | |
| [bottomLeft, topLeft]]; | |
| }, | |
| /** | |
| * Rotates a rectangle around a point. | |
| * @function | |
| * @param {Number} degrees The angle in degrees to rotate. | |
| * @param {OpenSeadragon.Point} [pivot] The point about which to rotate. | |
| * Defaults to the center of the rectangle. | |
| * @returns {OpenSeadragon.Rect} | |
| */ | |
| rotate: function(degrees, pivot) { | |
| degrees = $.positiveModulo(degrees, 360); | |
| if (degrees === 0) { | |
| return this.clone(); | |
| } | |
| pivot = pivot || this.getCenter(); | |
| var newTopLeft = this.getTopLeft().rotate(degrees, pivot); | |
| var newTopRight = this.getTopRight().rotate(degrees, pivot); | |
| var diff = newTopRight.minus(newTopLeft); | |
| // Handle floating point error | |
| diff = diff.apply(function(x) { | |
| var EPSILON = 1e-15; | |
| return Math.abs(x) < EPSILON ? 0 : x; | |
| }); | |
| var radians = Math.atan(diff.y / diff.x); | |
| if (diff.x < 0) { | |
| radians += Math.PI; | |
| } else if (diff.y < 0) { | |
| radians += 2 * Math.PI; | |
| } | |
| return new $.Rect( | |
| newTopLeft.x, | |
| newTopLeft.y, | |
| this.width, | |
| this.height, | |
| radians / Math.PI * 180); | |
| }, | |
| /** | |
| * Retrieves the smallest horizontal (degrees=0) rectangle which contains | |
| * this rectangle. | |
| * @returns {OpenSeadragon.Rect} | |
| */ | |
| getBoundingBox: function() { | |
| if (this.degrees === 0) { | |
| return this.clone(); | |
| } | |
| var topLeft = this.getTopLeft(); | |
| var topRight = this.getTopRight(); | |
| var bottomLeft = this.getBottomLeft(); | |
| var bottomRight = this.getBottomRight(); | |
| var minX = Math.min(topLeft.x, topRight.x, bottomLeft.x, bottomRight.x); | |
| var maxX = Math.max(topLeft.x, topRight.x, bottomLeft.x, bottomRight.x); | |
| var minY = Math.min(topLeft.y, topRight.y, bottomLeft.y, bottomRight.y); | |
| var maxY = Math.max(topLeft.y, topRight.y, bottomLeft.y, bottomRight.y); | |
| return new $.Rect( | |
| minX, | |
| minY, | |
| maxX - minX, | |
| maxY - minY); | |
| }, | |
| /** | |
| * Retrieves the smallest horizontal (degrees=0) rectangle which contains | |
| * this rectangle and has integers x, y, width and height | |
| * @returns {OpenSeadragon.Rect} | |
| */ | |
| getIntegerBoundingBox: function() { | |
| var boundingBox = this.getBoundingBox(); | |
| var x = Math.floor(boundingBox.x); | |
| var y = Math.floor(boundingBox.y); | |
| var width = Math.ceil(boundingBox.width + boundingBox.x - x); | |
| var height = Math.ceil(boundingBox.height + boundingBox.y - y); | |
| return new $.Rect(x, y, width, height); | |
| }, | |
| /** | |
| * Determines whether a point is inside this rectangle (edge included). | |
| * @function | |
| * @param {OpenSeadragon.Point} point | |
| * @param {Number} [epsilon=0] the margin of error allowed | |
| * @returns {Boolean} true if the point is inside this rectangle, false | |
| * otherwise. | |
| */ | |
| containsPoint: function(point, epsilon) { | |
| epsilon = epsilon || 0; | |
| // See http://stackoverflow.com/a/2752754/1440403 for explanation | |
| var topLeft = this.getTopLeft(); | |
| var topRight = this.getTopRight(); | |
| var bottomLeft = this.getBottomLeft(); | |
| var topDiff = topRight.minus(topLeft); | |
| var leftDiff = bottomLeft.minus(topLeft); | |
| return ((point.x - topLeft.x) * topDiff.x + | |
| (point.y - topLeft.y) * topDiff.y >= -epsilon) && | |
| ((point.x - topRight.x) * topDiff.x + | |
| (point.y - topRight.y) * topDiff.y <= epsilon) && | |
| ((point.x - topLeft.x) * leftDiff.x + | |
| (point.y - topLeft.y) * leftDiff.y >= -epsilon) && | |
| ((point.x - bottomLeft.x) * leftDiff.x + | |
| (point.y - bottomLeft.y) * leftDiff.y <= epsilon); | |
| }, | |
| /** | |
| * Provides a string representation of the rectangle which is useful for | |
| * debugging. | |
| * @function | |
| * @returns {String} A string representation of the rectangle. | |
| */ | |
| toString: function() { | |
| return "[" + | |
| (Math.round(this.x * 100) / 100) + ", " + | |
| (Math.round(this.y * 100) / 100) + ", " + | |
| (Math.round(this.width * 100) / 100) + "x" + | |
| (Math.round(this.height * 100) / 100) + ", " + | |
| (Math.round(this.degrees * 100) / 100) + "deg" + | |
| "]"; | |
| } | |
| }; | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - ReferenceStrip | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function ( $ ) { | |
| // dictionary from id to private properties | |
| var THIS = {}; | |
| /** | |
| * The CollectionDrawer is a reimplementation if the Drawer API that | |
| * focuses on allowing a viewport to be redefined as a collection | |
| * of smaller viewports, defined by a clear number of rows and / or | |
| * columns of which each item in the matrix of viewports has its own | |
| * source. | |
| * | |
| * This idea is a reexpression of the idea of dzi collections | |
| * which allows a clearer algorithm to reuse the tile sources already | |
| * supported by OpenSeadragon, in heterogeneous or homogeneous | |
| * sequences just like mixed groups already supported by the viewer | |
| * for the purpose of image sequnces. | |
| * | |
| * TODO: The difficult part of this feature is figuring out how to express | |
| * this functionality as a combination of the functionality already | |
| * provided by Drawer, Viewport, TileSource, and Navigator. It may | |
| * require better abstraction at those points in order to efficiently | |
| * reuse those paradigms. | |
| */ | |
| /** | |
| * @class ReferenceStrip | |
| * @memberof OpenSeadragon | |
| * @param {Object} options | |
| */ | |
| $.ReferenceStrip = function ( options ) { | |
| var _this = this, | |
| viewer = options.viewer, | |
| viewerSize = $.getElementSize( viewer.element ), | |
| element, | |
| style, | |
| i; | |
| //We may need to create a new element and id if they did not | |
| //provide the id for the existing element | |
| if ( !options.id ) { | |
| options.id = 'referencestrip-' + $.now(); | |
| this.element = $.makeNeutralElement( "div" ); | |
| this.element.id = options.id; | |
| this.element.className = 'referencestrip'; | |
| } | |
| options = $.extend( true, { | |
| sizeRatio: $.DEFAULT_SETTINGS.referenceStripSizeRatio, | |
| position: $.DEFAULT_SETTINGS.referenceStripPosition, | |
| scroll: $.DEFAULT_SETTINGS.referenceStripScroll, | |
| clickTimeThreshold: $.DEFAULT_SETTINGS.clickTimeThreshold | |
| }, options, { | |
| element: this.element | |
| } ); | |
| $.extend( this, options ); | |
| //Private state properties | |
| THIS[this.id] = { | |
| animating: false | |
| }; | |
| this.minPixelRatio = this.viewer.minPixelRatio; | |
| this.element.tabIndex = 0; | |
| style = this.element.style; | |
| style.marginTop = '0px'; | |
| style.marginRight = '0px'; | |
| style.marginBottom = '0px'; | |
| style.marginLeft = '0px'; | |
| style.left = '0px'; | |
| style.bottom = '0px'; | |
| style.border = '0px'; | |
| style.background = '#000'; | |
| style.position = 'relative'; | |
| $.setElementTouchActionNone( this.element ); | |
| $.setElementOpacity( this.element, 0.8 ); | |
| this.viewer = viewer; | |
| this.tracker = new $.MouseTracker( { | |
| userData: 'ReferenceStrip.tracker', | |
| element: this.element, | |
| clickHandler: $.delegate( this, onStripClick ), | |
| dragHandler: $.delegate( this, onStripDrag ), | |
| scrollHandler: $.delegate( this, onStripScroll ), | |
| enterHandler: $.delegate( this, onStripEnter ), | |
| leaveHandler: $.delegate( this, onStripLeave ), | |
| keyDownHandler: $.delegate( this, onKeyDown ), | |
| keyHandler: $.delegate( this, onKeyPress ), | |
| preProcessEventHandler: function (eventInfo) { | |
| if (eventInfo.eventType === 'wheel') { | |
| eventInfo.preventDefault = true; | |
| } | |
| } | |
| } ); | |
| //Controls the position and orientation of the reference strip and sets the | |
| //appropriate width and height | |
| if ( options.width && options.height ) { | |
| this.element.style.width = options.width + 'px'; | |
| this.element.style.height = options.height + 'px'; | |
| viewer.addControl( | |
| this.element, | |
| { anchor: $.ControlAnchor.BOTTOM_LEFT } | |
| ); | |
| } else { | |
| if ( "horizontal" === options.scroll ) { | |
| this.element.style.width = ( | |
| viewerSize.x * | |
| options.sizeRatio * | |
| viewer.tileSources.length | |
| ) + ( 12 * viewer.tileSources.length ) + 'px'; | |
| this.element.style.height = ( | |
| viewerSize.y * | |
| options.sizeRatio | |
| ) + 'px'; | |
| viewer.addControl( | |
| this.element, | |
| { anchor: $.ControlAnchor.BOTTOM_LEFT } | |
| ); | |
| } else { | |
| this.element.style.height = ( | |
| viewerSize.y * | |
| options.sizeRatio * | |
| viewer.tileSources.length | |
| ) + ( 12 * viewer.tileSources.length ) + 'px'; | |
| this.element.style.width = ( | |
| viewerSize.x * | |
| options.sizeRatio | |
| ) + 'px'; | |
| viewer.addControl( | |
| this.element, | |
| { anchor: $.ControlAnchor.TOP_LEFT } | |
| ); | |
| } | |
| } | |
| this.panelWidth = ( viewerSize.x * this.sizeRatio ) + 8; | |
| this.panelHeight = ( viewerSize.y * this.sizeRatio ) + 8; | |
| this.panels = []; | |
| this.miniViewers = {}; | |
| /*jshint loopfunc:true*/ | |
| for ( i = 0; i < viewer.tileSources.length; i++ ) { | |
| element = $.makeNeutralElement( 'div' ); | |
| element.id = this.element.id + "-" + i; | |
| element.style.width = _this.panelWidth + 'px'; | |
| element.style.height = _this.panelHeight + 'px'; | |
| element.style.display = 'inline'; | |
| element.style['float'] = 'left'; //Webkit | |
| element.style.cssFloat = 'left'; //Firefox | |
| element.style.padding = '2px'; | |
| $.setElementTouchActionNone( element ); | |
| $.setElementPointerEventsNone( element ); | |
| this.element.appendChild( element ); | |
| element.activePanel = false; | |
| this.panels.push( element ); | |
| } | |
| loadPanels( this, this.scroll === 'vertical' ? viewerSize.y : viewerSize.x, 0 ); | |
| this.setFocus( 0 ); | |
| }; | |
| /** @lends OpenSeadragon.ReferenceStrip.prototype */ | |
| $.ReferenceStrip.prototype = { | |
| /** | |
| * @function | |
| */ | |
| setFocus: function ( page ) { | |
| var element = this.element.querySelector('#' + this.element.id + '-' + page ), | |
| viewerSize = $.getElementSize( this.viewer.canvas ), | |
| scrollWidth = Number( this.element.style.width.replace( 'px', '' ) ), | |
| scrollHeight = Number( this.element.style.height.replace( 'px', '' ) ), | |
| offsetLeft = -Number( this.element.style.marginLeft.replace( 'px', '' ) ), | |
| offsetTop = -Number( this.element.style.marginTop.replace( 'px', '' ) ), | |
| offset; | |
| if ( this.currentSelected !== element ) { | |
| if ( this.currentSelected ) { | |
| this.currentSelected.style.background = '#000'; | |
| } | |
| this.currentSelected = element; | |
| this.currentSelected.style.background = '#999'; | |
| if ( 'horizontal' === this.scroll ) { | |
| //right left | |
| offset = ( Number( page ) ) * ( this.panelWidth + 3 ); | |
| if ( offset > offsetLeft + viewerSize.x - this.panelWidth ) { | |
| offset = Math.min( offset, ( scrollWidth - viewerSize.x ) ); | |
| this.element.style.marginLeft = -offset + 'px'; | |
| loadPanels( this, viewerSize.x, -offset ); | |
| } else if ( offset < offsetLeft ) { | |
| offset = Math.max( 0, offset - viewerSize.x / 2 ); | |
| this.element.style.marginLeft = -offset + 'px'; | |
| loadPanels( this, viewerSize.x, -offset ); | |
| } | |
| } else { | |
| offset = ( Number( page ) ) * ( this.panelHeight + 3 ); | |
| if ( offset > offsetTop + viewerSize.y - this.panelHeight ) { | |
| offset = Math.min( offset, ( scrollHeight - viewerSize.y ) ); | |
| this.element.style.marginTop = -offset + 'px'; | |
| loadPanels( this, viewerSize.y, -offset ); | |
| } else if ( offset < offsetTop ) { | |
| offset = Math.max( 0, offset - viewerSize.y / 2 ); | |
| this.element.style.marginTop = -offset + 'px'; | |
| loadPanels( this, viewerSize.y, -offset ); | |
| } | |
| } | |
| this.currentPage = page; | |
| onStripEnter.call( this, { eventSource: this.tracker } ); | |
| } | |
| }, | |
| /** | |
| * @function | |
| */ | |
| update: function () { | |
| if ( THIS[this.id].animating ) { | |
| // $.console.log( 'image reference strip update' ); | |
| return true; | |
| } | |
| return false; | |
| }, | |
| destroy: function() { | |
| if (this.miniViewers) { | |
| for (var key in this.miniViewers) { | |
| this.miniViewers[key].destroy(); | |
| } | |
| } | |
| this.tracker.destroy(); | |
| if (this.element) { | |
| this.viewer.removeControl( this.element ); | |
| } | |
| } | |
| }; | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onStripClick( event ) { | |
| if ( event.quick ) { | |
| var page; | |
| if ( 'horizontal' === this.scroll ) { | |
| // +4px fix to solve problem with precision on thumbnail selection if there is a lot of them | |
| page = Math.floor(event.position.x / (this.panelWidth + 4)); | |
| } else { | |
| page = Math.floor(event.position.y / this.panelHeight); | |
| } | |
| this.viewer.goToPage( page ); | |
| } | |
| this.element.focus(); | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onStripDrag( event ) { | |
| this.dragging = true; | |
| if ( this.element ) { | |
| var offsetLeft = Number( this.element.style.marginLeft.replace( 'px', '' ) ), | |
| offsetTop = Number( this.element.style.marginTop.replace( 'px', '' ) ), | |
| scrollWidth = Number( this.element.style.width.replace( 'px', '' ) ), | |
| scrollHeight = Number( this.element.style.height.replace( 'px', '' ) ), | |
| viewerSize = $.getElementSize( this.viewer.canvas ); | |
| if ( 'horizontal' === this.scroll ) { | |
| if ( -event.delta.x > 0 ) { | |
| //forward | |
| if ( offsetLeft > -( scrollWidth - viewerSize.x ) ) { | |
| this.element.style.marginLeft = ( offsetLeft + ( event.delta.x * 2 ) ) + 'px'; | |
| loadPanels( this, viewerSize.x, offsetLeft + ( event.delta.x * 2 ) ); | |
| } | |
| } else if ( -event.delta.x < 0 ) { | |
| //reverse | |
| if ( offsetLeft < 0 ) { | |
| this.element.style.marginLeft = ( offsetLeft + ( event.delta.x * 2 ) ) + 'px'; | |
| loadPanels( this, viewerSize.x, offsetLeft + ( event.delta.x * 2 ) ); | |
| } | |
| } | |
| } else { | |
| if ( -event.delta.y > 0 ) { | |
| //forward | |
| if ( offsetTop > -( scrollHeight - viewerSize.y ) ) { | |
| this.element.style.marginTop = ( offsetTop + ( event.delta.y * 2 ) ) + 'px'; | |
| loadPanels( this, viewerSize.y, offsetTop + ( event.delta.y * 2 ) ); | |
| } | |
| } else if ( -event.delta.y < 0 ) { | |
| //reverse | |
| if ( offsetTop < 0 ) { | |
| this.element.style.marginTop = ( offsetTop + ( event.delta.y * 2 ) ) + 'px'; | |
| loadPanels( this, viewerSize.y, offsetTop + ( event.delta.y * 2 ) ); | |
| } | |
| } | |
| } | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onStripScroll( event ) { | |
| if ( this.element ) { | |
| var offsetLeft = Number( this.element.style.marginLeft.replace( 'px', '' ) ), | |
| offsetTop = Number( this.element.style.marginTop.replace( 'px', '' ) ), | |
| scrollWidth = Number( this.element.style.width.replace( 'px', '' ) ), | |
| scrollHeight = Number( this.element.style.height.replace( 'px', '' ) ), | |
| viewerSize = $.getElementSize( this.viewer.canvas ); | |
| if ( 'horizontal' === this.scroll ) { | |
| if ( event.scroll > 0 ) { | |
| //forward | |
| if ( offsetLeft > -( scrollWidth - viewerSize.x ) ) { | |
| this.element.style.marginLeft = ( offsetLeft - ( event.scroll * 60 ) ) + 'px'; | |
| loadPanels( this, viewerSize.x, offsetLeft - ( event.scroll * 60 ) ); | |
| } | |
| } else if ( event.scroll < 0 ) { | |
| //reverse | |
| if ( offsetLeft < 0 ) { | |
| this.element.style.marginLeft = ( offsetLeft - ( event.scroll * 60 ) ) + 'px'; | |
| loadPanels( this, viewerSize.x, offsetLeft - ( event.scroll * 60 ) ); | |
| } | |
| } | |
| } else { | |
| if ( event.scroll < 0 ) { | |
| //scroll up | |
| if ( offsetTop > viewerSize.y - scrollHeight ) { | |
| this.element.style.marginTop = ( offsetTop + ( event.scroll * 60 ) ) + 'px'; | |
| loadPanels( this, viewerSize.y, offsetTop + ( event.scroll * 60 ) ); | |
| } | |
| } else if ( event.scroll > 0 ) { | |
| //scroll dowm | |
| if ( offsetTop < 0 ) { | |
| this.element.style.marginTop = ( offsetTop + ( event.scroll * 60 ) ) + 'px'; | |
| loadPanels( this, viewerSize.y, offsetTop + ( event.scroll * 60 ) ); | |
| } | |
| } | |
| } | |
| event.preventDefault = true; | |
| } | |
| } | |
| function loadPanels( strip, viewerSize, scroll ) { | |
| var panelSize, | |
| activePanelsStart, | |
| activePanelsEnd, | |
| miniViewer, | |
| i, | |
| element; | |
| if ( 'horizontal' === strip.scroll ) { | |
| panelSize = strip.panelWidth; | |
| } else { | |
| panelSize = strip.panelHeight; | |
| } | |
| activePanelsStart = Math.ceil( viewerSize / panelSize ) + 5; | |
| activePanelsEnd = Math.ceil( ( Math.abs( scroll ) + viewerSize ) / panelSize ) + 1; | |
| activePanelsStart = activePanelsEnd - activePanelsStart; | |
| activePanelsStart = activePanelsStart < 0 ? 0 : activePanelsStart; | |
| for ( i = activePanelsStart; i < activePanelsEnd && i < strip.panels.length; i++ ) { | |
| element = strip.panels[i]; | |
| if ( !element.activePanel ) { | |
| var miniTileSource; | |
| var originalTileSource = strip.viewer.tileSources[i]; | |
| if (originalTileSource.referenceStripThumbnailUrl) { | |
| miniTileSource = { | |
| type: 'image', | |
| url: originalTileSource.referenceStripThumbnailUrl | |
| }; | |
| } else { | |
| miniTileSource = originalTileSource; | |
| } | |
| miniViewer = new $.Viewer( { | |
| id: element.id, | |
| tileSources: [miniTileSource], | |
| element: element, | |
| navigatorSizeRatio: strip.sizeRatio, | |
| showNavigator: false, | |
| mouseNavEnabled: false, | |
| showNavigationControl: false, | |
| showSequenceControl: false, | |
| immediateRender: true, | |
| blendTime: 0, | |
| animationTime: 0, | |
| loadTilesWithAjax: strip.viewer.loadTilesWithAjax, | |
| ajaxHeaders: strip.viewer.ajaxHeaders, | |
| drawer: 'canvas', //always use canvas for the reference strip | |
| } ); | |
| // Allow pointer events to pass through miniViewer's canvas/container | |
| // elements so implicit pointer capture works on touch devices | |
| $.setElementPointerEventsNone( miniViewer.canvas ); | |
| $.setElementPointerEventsNone( miniViewer.container ); | |
| // We'll use event delegation from the reference strip element instead of | |
| // handling events on every miniViewer | |
| miniViewer.innerTracker.setTracking( false ); | |
| miniViewer.outerTracker.setTracking( false ); | |
| strip.miniViewers[element.id] = miniViewer; | |
| element.activePanel = true; | |
| } | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onStripEnter( event ) { | |
| var element = event.eventSource.element; | |
| //$.setElementOpacity(element, 0.8); | |
| //element.style.border = '1px solid #555'; | |
| //element.style.background = '#000'; | |
| if ( 'horizontal' === this.scroll ) { | |
| //element.style.paddingTop = "0px"; | |
| element.style.marginBottom = "0px"; | |
| } else { | |
| //element.style.paddingRight = "0px"; | |
| element.style.marginLeft = "0px"; | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onStripLeave( event ) { | |
| var element = event.eventSource.element; | |
| if ( 'horizontal' === this.scroll ) { | |
| //element.style.paddingTop = "10px"; | |
| element.style.marginBottom = "-" + ( $.getElementSize( element ).y / 2 ) + "px"; | |
| } else { | |
| //element.style.paddingRight = "10px"; | |
| element.style.marginLeft = "-" + ( $.getElementSize( element ).x / 2 ) + "px"; | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onKeyDown( event ) { | |
| //console.log( event.keyCode ); | |
| if ( !event.ctrl && !event.alt && !event.meta ) { | |
| switch ( event.keyCode ) { | |
| case 38: //up arrow | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: 1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 40: //down arrow | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: -1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 37: //left arrow | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: -1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 39: //right arrow | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: 1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| default: | |
| //console.log( 'navigator keycode %s', event.keyCode ); | |
| event.preventDefault = false; | |
| break; | |
| } | |
| } else { | |
| event.preventDefault = false; | |
| } | |
| } | |
| /** | |
| * @private | |
| * @inner | |
| * @function | |
| */ | |
| function onKeyPress( event ) { | |
| //console.log( event.keyCode ); | |
| if ( !event.ctrl && !event.alt && !event.meta ) { | |
| switch ( event.keyCode ) { | |
| case 61: //=|+ | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: 1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 45: //-|_ | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: -1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 48: //0|) | |
| case 119: //w | |
| case 87: //W | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: 1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 115: //s | |
| case 83: //S | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: -1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 97: //a | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: -1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| case 100: //d | |
| onStripScroll.call( this, { eventSource: this.tracker, position: null, scroll: 1, shift: null } ); | |
| event.preventDefault = true; | |
| break; | |
| default: | |
| //console.log( 'navigator keycode %s', event.keyCode ); | |
| event.preventDefault = false; | |
| break; | |
| } | |
| } else { | |
| event.preventDefault = false; | |
| } | |
| } | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - DisplayRect | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class DisplayRect | |
| * @classdesc A display rectangle is very similar to {@link OpenSeadragon.Rect} but adds two | |
| * fields, 'minLevel' and 'maxLevel' which denote the supported zoom levels | |
| * for this rectangle. | |
| * | |
| * @memberof OpenSeadragon | |
| * @extends OpenSeadragon.Rect | |
| * @param {Number} x The vector component 'x'. | |
| * @param {Number} y The vector component 'y'. | |
| * @param {Number} width The vector component 'height'. | |
| * @param {Number} height The vector component 'width'. | |
| * @param {Number} minLevel The lowest zoom level supported. | |
| * @param {Number} maxLevel The highest zoom level supported. | |
| */ | |
| $.DisplayRect = function( x, y, width, height, minLevel, maxLevel ) { | |
| $.Rect.apply( this, [ x, y, width, height ] ); | |
| /** | |
| * The lowest zoom level supported. | |
| * @member {Number} minLevel | |
| * @memberof OpenSeadragon.DisplayRect# | |
| */ | |
| this.minLevel = minLevel; | |
| /** | |
| * The highest zoom level supported. | |
| * @member {Number} maxLevel | |
| * @memberof OpenSeadragon.DisplayRect# | |
| */ | |
| this.maxLevel = maxLevel; | |
| }; | |
| $.extend( $.DisplayRect.prototype, $.Rect.prototype ); | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - Spring | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class Spring | |
| * @memberof OpenSeadragon | |
| * @param {Object} options - Spring configuration settings. | |
| * @param {Number} options.springStiffness - Spring stiffness. Must be greater than zero. | |
| * The closer to zero, the closer to linear animation. | |
| * @param {Number} options.animationTime - Animation duration per spring, in seconds. | |
| * Must be zero or greater. | |
| * @param {Number} [options.initial=0] - Initial value of spring. | |
| * @param {Boolean} [options.exponential=false] - Whether this spring represents | |
| * an exponential scale (such as zoom) and should be animated accordingly. Note that | |
| * exponential springs must have non-zero values. | |
| */ | |
| $.Spring = function( options ) { | |
| var args = arguments; | |
| if( typeof ( options ) !== 'object' ){ | |
| //allows backward compatible use of ( initialValue, config ) as | |
| //constructor parameters | |
| options = { | |
| initial: args.length && typeof ( args[ 0 ] ) === "number" ? | |
| args[ 0 ] : | |
| undefined, | |
| /** | |
| * Spring stiffness. | |
| * @member {Number} springStiffness | |
| * @memberof OpenSeadragon.Spring# | |
| */ | |
| springStiffness: args.length > 1 ? | |
| args[ 1 ].springStiffness : | |
| 5.0, | |
| /** | |
| * Animation duration per spring. | |
| * @member {Number} animationTime | |
| * @memberof OpenSeadragon.Spring# | |
| */ | |
| animationTime: args.length > 1 ? | |
| args[ 1 ].animationTime : | |
| 1.5 | |
| }; | |
| } | |
| $.console.assert(typeof options.springStiffness === "number" && options.springStiffness !== 0, | |
| "[OpenSeadragon.Spring] options.springStiffness must be a non-zero number"); | |
| $.console.assert(typeof options.animationTime === "number" && options.animationTime >= 0, | |
| "[OpenSeadragon.Spring] options.animationTime must be a number greater than or equal to 0"); | |
| if (options.exponential) { | |
| this._exponential = true; | |
| delete options.exponential; | |
| } | |
| $.extend( true, this, options); | |
| /** | |
| * @member {Object} current | |
| * @memberof OpenSeadragon.Spring# | |
| * @property {Number} value | |
| * @property {Number} time | |
| */ | |
| this.current = { | |
| value: typeof ( this.initial ) === "number" ? | |
| this.initial : | |
| (this._exponential ? 0 : 1), | |
| time: $.now() // always work in milliseconds | |
| }; | |
| $.console.assert(!this._exponential || this.current.value !== 0, | |
| "[OpenSeadragon.Spring] value must be non-zero for exponential springs"); | |
| /** | |
| * @member {Object} start | |
| * @memberof OpenSeadragon.Spring# | |
| * @property {Number} value | |
| * @property {Number} time | |
| */ | |
| this.start = { | |
| value: this.current.value, | |
| time: this.current.time | |
| }; | |
| /** | |
| * @member {Object} target | |
| * @memberof OpenSeadragon.Spring# | |
| * @property {Number} value | |
| * @property {Number} time | |
| */ | |
| this.target = { | |
| value: this.current.value, | |
| time: this.current.time | |
| }; | |
| if (this._exponential) { | |
| this.start._logValue = Math.log(this.start.value); | |
| this.target._logValue = Math.log(this.target.value); | |
| this.current._logValue = Math.log(this.current.value); | |
| } | |
| }; | |
| /** @lends OpenSeadragon.Spring.prototype */ | |
| $.Spring.prototype = { | |
| /** | |
| * @function | |
| * @param {Number} target | |
| */ | |
| resetTo: function( target ) { | |
| $.console.assert(!this._exponential || target !== 0, | |
| "[OpenSeadragon.Spring.resetTo] target must be non-zero for exponential springs"); | |
| this.start.value = this.target.value = this.current.value = target; | |
| this.start.time = this.target.time = this.current.time = $.now(); | |
| if (this._exponential) { | |
| this.start._logValue = Math.log(this.start.value); | |
| this.target._logValue = Math.log(this.target.value); | |
| this.current._logValue = Math.log(this.current.value); | |
| } | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} target | |
| */ | |
| springTo: function( target ) { | |
| $.console.assert(!this._exponential || target !== 0, | |
| "[OpenSeadragon.Spring.springTo] target must be non-zero for exponential springs"); | |
| this.start.value = this.current.value; | |
| this.start.time = this.current.time; | |
| this.target.value = target; | |
| this.target.time = this.start.time + 1000 * this.animationTime; | |
| if (this._exponential) { | |
| this.start._logValue = Math.log(this.start.value); | |
| this.target._logValue = Math.log(this.target.value); | |
| } | |
| }, | |
| /** | |
| * @function | |
| * @param {Number} delta | |
| */ | |
| shiftBy: function( delta ) { | |
| this.start.value += delta; | |
| this.target.value += delta; | |
| if (this._exponential) { | |
| $.console.assert(this.target.value !== 0 && this.start.value !== 0, | |
| "[OpenSeadragon.Spring.shiftBy] spring value must be non-zero for exponential springs"); | |
| this.start._logValue = Math.log(this.start.value); | |
| this.target._logValue = Math.log(this.target.value); | |
| } | |
| }, | |
| setExponential: function(value) { | |
| this._exponential = value; | |
| if (this._exponential) { | |
| $.console.assert(this.current.value !== 0 && this.target.value !== 0 && this.start.value !== 0, | |
| "[OpenSeadragon.Spring.setExponential] spring value must be non-zero for exponential springs"); | |
| this.start._logValue = Math.log(this.start.value); | |
| this.target._logValue = Math.log(this.target.value); | |
| this.current._logValue = Math.log(this.current.value); | |
| } | |
| }, | |
| /** | |
| * @function | |
| * @returns true if the spring is still updating its value, false if it is | |
| * already at the target value. | |
| */ | |
| update: function() { | |
| this.current.time = $.now(); | |
| let startValue, targetValue; | |
| if (this._exponential) { | |
| startValue = this.start._logValue; | |
| targetValue = this.target._logValue; | |
| } else { | |
| startValue = this.start.value; | |
| targetValue = this.target.value; | |
| } | |
| if(this.current.time >= this.target.time){ | |
| this.current.value = this.target.value; | |
| } else { | |
| let currentValue = startValue + | |
| ( targetValue - startValue ) * | |
| transform( | |
| this.springStiffness, | |
| ( this.current.time - this.start.time ) / | |
| ( this.target.time - this.start.time ) | |
| ); | |
| if (this._exponential) { | |
| this.current.value = Math.exp(currentValue); | |
| } else { | |
| this.current.value = currentValue; | |
| } | |
| } | |
| return this.current.value !== this.target.value; | |
| }, | |
| /** | |
| * Returns whether the spring is at the target value | |
| * @function | |
| * @returns {Boolean} True if at target value, false otherwise | |
| */ | |
| isAtTargetValue: function() { | |
| return this.current.value === this.target.value; | |
| } | |
| }; | |
| /** | |
| * @private | |
| */ | |
| function transform( stiffness, x ) { | |
| return ( 1.0 - Math.exp( stiffness * -x ) ) / | |
| ( 1.0 - Math.exp( -stiffness ) ); | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - ImageLoader | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function($){ | |
| /** | |
| * @class ImageJob | |
| * @classdesc Handles downloading of a single image. | |
| * | |
| * @memberof OpenSeadragon | |
| * @param {Object} options - Options for this ImageJob. | |
| * @param {String} [options.src] - URL of image to download. | |
| * @param {Tile} [options.tile] - Tile that belongs the data to. | |
| * @param {TileSource} [options.source] - Image loading strategy | |
| * @param {String} [options.loadWithAjax] - Whether to load this image with AJAX. | |
| * @param {String} [options.ajaxHeaders] - Headers to add to the image request if using AJAX. | |
| * @param {Boolean} [options.ajaxWithCredentials] - Whether to set withCredentials on AJAX requests. | |
| * @param {String} [options.crossOriginPolicy] - CORS policy to use for downloads | |
| * @param {String} [options.postData] - HTTP POST data (usually but not necessarily in k=v&k2=v2... form, | |
| * see TileSource::getTilePostData) or null | |
| * @param {Function} [options.callback] - Called once image has been downloaded. | |
| * @param {Function} [options.abort] - Called when this image job is aborted. | |
| * @param {Number} [options.timeout] - The max number of milliseconds that this image job may take to complete. | |
| * @param {Number} [options.tries] - Actual number of the current try. | |
| */ | |
| $.ImageJob = function(options) { | |
| $.extend(true, this, { | |
| timeout: $.DEFAULT_SETTINGS.timeout, | |
| jobId: null, | |
| tries: 0 | |
| }, options); | |
| /** | |
| * Data object which will contain downloaded image data. | |
| * @member {Image|*} data data object, by default an Image object (depends on TileSource) | |
| * @memberof OpenSeadragon.ImageJob# | |
| */ | |
| this.data = null; | |
| /** | |
| * User workspace to populate with helper variables | |
| * @member {*} userData to append custom data and avoid namespace collision | |
| * @memberof OpenSeadragon.ImageJob# | |
| */ | |
| this.userData = {}; | |
| /** | |
| * Error message holder | |
| * @member {string} error message | |
| * @memberof OpenSeadragon.ImageJob# | |
| * @private | |
| */ | |
| this.errorMsg = null; | |
| }; | |
| $.ImageJob.prototype = { | |
| /** | |
| * Starts the image job. | |
| * @method | |
| * @memberof OpenSeadragon.ImageJob# | |
| */ | |
| start: function() { | |
| this.tries++; | |
| var self = this; | |
| var selfAbort = this.abort; | |
| this.jobId = window.setTimeout(function () { | |
| self.fail("Image load exceeded timeout (" + self.timeout + " ms)", null); | |
| }, this.timeout); | |
| this.abort = function() { | |
| self.source.downloadTileAbort(self); | |
| if (typeof selfAbort === "function") { | |
| selfAbort(); | |
| } | |
| }; | |
| this.source.downloadTileStart(this); | |
| }, | |
| /** | |
| * Finish this job. | |
| * @param {*} data data that has been downloaded | |
| * @param {XMLHttpRequest} request reference to the request if used | |
| * @param {string} dataType data type identifier | |
| * fallback compatibility behavior: dataType treated as errorMessage if data is falsey value | |
| * @memberof OpenSeadragon.ImageJob# | |
| */ | |
| finish: function(data, request, dataType) { | |
| if (!this.jobId) { | |
| return; | |
| } | |
| // old behavior, no deprecation due to possible finish calls with invalid data item (e.g. different error) | |
| if (data === null || data === undefined || data === false) { | |
| this.fail(dataType || "[downloadTileStart->finish()] Retrieved data is invalid!", request); | |
| return; | |
| } | |
| this.data = data; | |
| this.request = request; | |
| this.errorMsg = null; | |
| this.dataType = dataType; | |
| if (this.jobId) { | |
| window.clearTimeout(this.jobId); | |
| } | |
| this.callback(this); | |
| }, | |
| /** | |
| * Finish this job as a failure. | |
| * @param {string} errorMessage description upon failure | |
| * @param {XMLHttpRequest} request reference to the request if used | |
| */ | |
| fail: function(errorMessage, request) { | |
| this.data = null; | |
| this.request = request; | |
| this.errorMsg = errorMessage; | |
| this.dataType = null; | |
| if (this.jobId) { | |
| window.clearTimeout(this.jobId); | |
| this.jobId = null; | |
| } | |
| this.callback(this); | |
| } | |
| }; | |
| /** | |
| * @class ImageLoader | |
| * @memberof OpenSeadragon | |
| * @classdesc Handles downloading of a set of images using asynchronous queue pattern. | |
| * You generally won't have to interact with the ImageLoader directly. | |
| * @param {Object} options - Options for this ImageLoader. | |
| * @param {Number} [options.jobLimit] - The number of concurrent image requests. See imageLoaderLimit in {@link OpenSeadragon.Options} for details. | |
| * @param {Number} [options.timeout] - The max number of milliseconds that an image job may take to complete. | |
| */ | |
| $.ImageLoader = function(options) { | |
| $.extend(true, this, { | |
| jobLimit: $.DEFAULT_SETTINGS.imageLoaderLimit, | |
| timeout: $.DEFAULT_SETTINGS.timeout, | |
| jobQueue: [], | |
| failedTiles: [], | |
| jobsInProgress: 0 | |
| }, options); | |
| }; | |
| /** @lends OpenSeadragon.ImageLoader.prototype */ | |
| $.ImageLoader.prototype = { | |
| /** | |
| * Add an unloaded image to the loader queue. | |
| * @method | |
| * @param {Object} options - Options for this job. | |
| * @param {String} [options.src] - URL of image to download. | |
| * @param {Tile} [options.tile] - Tile that belongs the data to. The tile instance | |
| * is not internally used and serves for custom TileSources implementations. | |
| * @param {TileSource} [options.source] - Image loading strategy | |
| * @param {String} [options.loadWithAjax] - Whether to load this image with AJAX. | |
| * @param {String} [options.ajaxHeaders] - Headers to add to the image request if using AJAX. | |
| * @param {String|Boolean} [options.crossOriginPolicy] - CORS policy to use for downloads | |
| * @param {String} [options.postData] - POST parameters (usually but not necessarily in k=v&k2=v2... form, | |
| * see TileSource::getTilePostData) or null | |
| * @param {Boolean} [options.ajaxWithCredentials] - Whether to set withCredentials on AJAX | |
| * requests. | |
| * @param {Function} [options.callback] - Called once image has been downloaded. | |
| * @param {Function} [options.abort] - Called when this image job is aborted. | |
| * @returns {boolean} true if job was immediatelly started, false if queued | |
| */ | |
| addJob: function(options) { | |
| if (!options.source) { | |
| $.console.error('ImageLoader.prototype.addJob() requires [options.source]. ' + | |
| 'TileSource since new API defines how images are fetched. Creating a dummy TileSource.'); | |
| var implementation = $.TileSource.prototype; | |
| options.source = { | |
| downloadTileStart: implementation.downloadTileStart, | |
| downloadTileAbort: implementation.downloadTileAbort | |
| }; | |
| } | |
| const _this = this, | |
| jobOptions = { | |
| src: options.src, | |
| tile: options.tile || {}, | |
| source: options.source, | |
| loadWithAjax: options.loadWithAjax, | |
| ajaxHeaders: options.loadWithAjax ? options.ajaxHeaders : null, | |
| crossOriginPolicy: options.crossOriginPolicy, | |
| ajaxWithCredentials: options.ajaxWithCredentials, | |
| postData: options.postData, | |
| callback: (job) => completeJob(_this, job, options.callback), | |
| abort: options.abort, | |
| timeout: this.timeout | |
| }, | |
| newJob = new $.ImageJob(jobOptions); | |
| if ( !this.jobLimit || this.jobsInProgress < this.jobLimit ) { | |
| newJob.start(); | |
| this.jobsInProgress++; | |
| return true; | |
| } | |
| this.jobQueue.push( newJob ); | |
| return false; | |
| }, | |
| /** | |
| * @returns {boolean} true if a job can be submitted | |
| */ | |
| canAcceptNewJob() { | |
| return !this.jobLimit || this.jobsInProgress < this.jobLimit; | |
| }, | |
| /** | |
| * Clear any unstarted image loading jobs from the queue. | |
| * @method | |
| */ | |
| clear: function() { | |
| for( var i = 0; i < this.jobQueue.length; i++ ) { | |
| var job = this.jobQueue[i]; | |
| if ( typeof job.abort === "function" ) { | |
| job.abort(); | |
| } | |
| } | |
| this.jobQueue = []; | |
| } | |
| }; | |
| /** | |
| * Cleans up ImageJob once completed. Restarts job after tileRetryDelay seconds if failed | |
| * but max tileRetryMax times | |
| * @method | |
| * @private | |
| * @param loader - ImageLoader used to start job. | |
| * @param job - The ImageJob that has completed. | |
| * @param callback - Called once cleanup is finished. | |
| */ | |
| function completeJob(loader, job, callback) { | |
| if (job.errorMsg && job.data === null && job.tries < 1 + loader.tileRetryMax) { | |
| loader.failedTiles.push(job); | |
| } | |
| let nextJob; | |
| loader.jobsInProgress--; | |
| if (loader.canAcceptNewJob() && loader.jobQueue.length > 0) { | |
| nextJob = loader.jobQueue.shift(); | |
| nextJob.start(); | |
| loader.jobsInProgress++; | |
| } | |
| if (loader.tileRetryMax > 0 && loader.jobQueue.length === 0) { | |
| if (loader.canAcceptNewJob() && loader.failedTiles.length > 0) { | |
| nextJob = loader.failedTiles.shift(); | |
| setTimeout(function () { | |
| nextJob.start(); | |
| }, loader.tileRetryDelay); | |
| loader.jobsInProgress++; | |
| } | |
| } | |
| callback(job.data, job.errorMsg, job.request, job.dataType); | |
| } | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - Tile | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @class Tile | |
| * @memberof OpenSeadragon | |
| * @param {Number} level The zoom level this tile belongs to. | |
| * @param {Number} x The vector component 'x'. | |
| * @param {Number} y The vector component 'y'. | |
| * @param {OpenSeadragon.Rect} bounds Where this tile fits, in normalized | |
| * coordinates. | |
| * @param {Boolean} exists Is this tile a part of a sparse image? ( Also has | |
| * this tile failed to load? ) | |
| * @param {String|Function} url The URL of this tile's image or a function that returns a url. | |
| * @param {CanvasRenderingContext2D} [context2D=undefined] The context2D of this tile if it | |
| * * is provided directly by the tile source. Deprecated: use Tile::addCache(...) instead. | |
| * @param {Boolean} loadWithAjax Whether this tile image should be loaded with an AJAX request . | |
| * @param {Object} ajaxHeaders The headers to send with this tile's AJAX request (if applicable). | |
| * @param {OpenSeadragon.Rect} sourceBounds The portion of the tile to use as the source of the | |
| * drawing operation, in pixels. Note that this only works when drawing with canvas; when drawing | |
| * with HTML the entire tile is always used. | |
| * @param {String} postData HTTP POST data (usually but not necessarily in k=v&k2=v2... form, | |
| * see TileSource::getTilePostData) or null | |
| * @param {String} cacheKey key to act as a tile cache, must be unique for tiles with unique image data | |
| */ | |
| $.Tile = function(level, x, y, bounds, exists, url, context2D, loadWithAjax, ajaxHeaders, sourceBounds, postData, cacheKey) { | |
| /** | |
| * The zoom level this tile belongs to. | |
| * @member {Number} level | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.level = level; | |
| /** | |
| * The vector component 'x'. | |
| * @member {Number} x | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.x = x; | |
| /** | |
| * The vector component 'y'. | |
| * @member {Number} y | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.y = y; | |
| /** | |
| * Where this tile fits, in normalized coordinates | |
| * @member {OpenSeadragon.Rect} bounds | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.bounds = bounds; | |
| /** | |
| * Where this tile fits, in normalized coordinates, after positioning | |
| * @member {OpenSeadragon.Rect} positionedBounds | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.positionedBounds = new OpenSeadragon.Rect(bounds.x, bounds.y, bounds.width, bounds.height); | |
| /** | |
| * The portion of the tile to use as the source of the drawing operation, in pixels. Note that | |
| * this only works when drawing with canvas; when drawing with HTML the entire tile is always used. | |
| * @member {OpenSeadragon.Rect} sourceBounds | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.sourceBounds = sourceBounds; | |
| /** | |
| * Is this tile a part of a sparse image? Also has this tile failed to load? | |
| * @member {Boolean} exists | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.exists = exists; | |
| /** | |
| * Private property to hold string url or url retriever function. | |
| * Consumers should access via Tile.getUrl() | |
| * @member {String|Function} url | |
| * @memberof OpenSeadragon.Tile# | |
| * @private | |
| */ | |
| this._url = url; | |
| /** | |
| * Post parameters for this tile. For example, it can be an URL-encoded string | |
| * in k1=v1&k2=v2... format, or a JSON, or a FormData instance... or null if no POST request used | |
| * @member {String} postData HTTP POST data (usually but not necessarily in k=v&k2=v2... form, | |
| * see TileSource::getTilePostData) or null | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.postData = postData; | |
| /** | |
| * The context2D of this tile if it is provided directly by the tile source. | |
| * @member {CanvasRenderingContext2D} context2D | |
| * @memberOf OpenSeadragon.Tile# | |
| */ | |
| if (context2D) { | |
| this.context2D = context2D; | |
| } | |
| /** | |
| * Whether to load this tile's image with an AJAX request. | |
| * @member {Boolean} loadWithAjax | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.loadWithAjax = loadWithAjax; | |
| /** | |
| * The headers to be used in requesting this tile's image. | |
| * Only used if loadWithAjax is set to true. | |
| * @member {Object} ajaxHeaders | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.ajaxHeaders = ajaxHeaders; | |
| if (cacheKey === undefined) { | |
| $.console.warn("Tile constructor needs 'cacheKey' variable: creation tile cache" + | |
| " in Tile class is deprecated. TileSource.prototype.getTileHashKey will be used."); | |
| cacheKey = $.TileSource.prototype.getTileHashKey(level, x, y, url, ajaxHeaders, postData); | |
| } | |
| this._cKey = cacheKey || ""; | |
| this._ocKey = cacheKey || ""; | |
| /** | |
| * Is this tile loaded? | |
| * @member {Boolean} loaded | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.loaded = false; | |
| /** | |
| * Is this tile loading? | |
| * @member {Boolean} loading | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.loading = false; | |
| /** | |
| * This tile's position on screen, in pixels. | |
| * @member {OpenSeadragon.Point} position | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.position = null; | |
| /** | |
| * This tile's size on screen, in pixels. | |
| * @member {OpenSeadragon.Point} size | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.size = null; | |
| /** | |
| * Whether to flip the tile when rendering. | |
| * @member {Boolean} flipped | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.flipped = false; | |
| /** | |
| * The start time of this tile's blending. | |
| * @member {Number} blendStart | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.blendStart = null; | |
| /** | |
| * The current opacity this tile should be. | |
| * @member {Number} opacity | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.opacity = null; | |
| /** | |
| * The squared distance of this tile to the viewport center. | |
| * Use for comparing tiles. | |
| * @member {Number} squaredDistance | |
| * @memberof OpenSeadragon.Tile# | |
| * @private | |
| */ | |
| this.squaredDistance = null; | |
| /** | |
| * The visibility score of this tile. | |
| * @member {Number} visibility | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.visibility = null; | |
| /** | |
| * The transparency indicator of this tile. | |
| * @member {Boolean} hasTransparency true if tile contains transparency for correct rendering | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.hasTransparency = false; | |
| /** | |
| * Whether this tile is currently being drawn. | |
| * @member {Boolean} beingDrawn | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.beingDrawn = false; | |
| /** | |
| * Timestamp the tile was last touched. | |
| * @member {Number} lastTouchTime | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.lastTouchTime = 0; | |
| /** | |
| * Whether this tile is in the right-most column for its level. | |
| * @member {Boolean} isRightMost | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.isRightMost = false; | |
| /** | |
| * Whether this tile is in the bottom-most row for its level. | |
| * @member {Boolean} isBottomMost | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.isBottomMost = false; | |
| /** | |
| * Owner of this tile. Do not change this property manually. | |
| * @member {OpenSeadragon.TiledImage} | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| this.tiledImage = null; | |
| /** | |
| * Array of cached tile data associated with the tile. | |
| * @member {Object} | |
| * @private | |
| */ | |
| this._caches = {}; | |
| /** | |
| * Processing flag, exempt the tile from removal when there are ongoing updates | |
| * @member {Boolean|Number} | |
| * @private | |
| */ | |
| this.processing = false; | |
| /** | |
| * Processing promise, resolves when the tile exits processing, or | |
| * resolves immediatelly if not in the processing state. | |
| * @member {OpenSeadragon.Promise} | |
| * @private | |
| */ | |
| this.processingPromise = $.Promise.resolve(); | |
| }; | |
| /** @lends OpenSeadragon.Tile.prototype */ | |
| $.Tile.prototype = { | |
| /** | |
| * Provides a string representation of this tiles level and (x,y) | |
| * components. | |
| * @function | |
| * @returns {String} | |
| */ | |
| toString: function() { | |
| return this.level + "/" + this.x + "_" + this.y; | |
| }, | |
| /** | |
| * The unique main cache key for this tile. Created automatically | |
| * from the given tiledImage.source.getTileHashKey(...) implementation. | |
| * @member {String} cacheKey | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| get cacheKey() { | |
| return this._cKey; | |
| }, | |
| set cacheKey(value) { | |
| if (value === this.cacheKey) { | |
| return; | |
| } | |
| const cache = this.getCache(value); | |
| if (!cache) { | |
| // It's better to first set cache, then change the key to existing one. Warn if otherwise. | |
| $.console.warn("[Tile.cacheKey] should not be set manually. Use addCache() with setAsMain=true."); | |
| } | |
| this._updateMainCacheKey(value); | |
| }, | |
| /** | |
| * By default equal to tile.cacheKey, marks a cache associated with this tile | |
| * that holds the cache original data (it was loaded with). In case you | |
| * change the tile data, the tile original data should be left with the cache | |
| * 'originalCacheKey' and the new, modified data should be stored in cache 'cacheKey'. | |
| * This key is used in cache resolution: in case new tile data is requested, if | |
| * this cache key exists in the cache it is loaded. | |
| * @member {String} originalCacheKey | |
| * @memberof OpenSeadragon.Tile# | |
| */ | |
| set originalCacheKey(value) { | |
| throw "Original Cache Key cannot be managed manually!"; | |
| }, | |
| get originalCacheKey() { | |
| return this._ocKey; | |
| }, | |
| /** | |
| * The Image object for this tile. | |
| * @member {Object} image | |
| * @memberof OpenSeadragon.Tile# | |
| * @deprecated | |
| * @returns {Image} | |
| */ | |
| get image() { | |
| $.console.error("[Tile.image] property has been deprecated. Use [Tile.getData] instead."); | |
| return this.getImage(); | |
| }, | |
| /** | |
| * The URL of this tile's image. | |
| * @member {String} url | |
| * @memberof OpenSeadragon.Tile# | |
| * @deprecated | |
| * @returns {String} | |
| */ | |
| get url() { | |
| $.console.error("[Tile.url] property has been deprecated. Use [Tile.getUrl] instead."); | |
| return this.getUrl(); | |
| }, | |
| /** | |
| * The HTML div element for this tile | |
| * @member {Element} element | |
| * @memberof OpenSeadragon.Tile# | |
| * @deprecated | |
| */ | |
| get element() { | |
| $.console.error("Tile::element property is deprecated. Use cache API instead. Moreover, this property might be unstable."); | |
| const cache = this.getCache(); | |
| if (!cache || !cache.loaded) { | |
| return null; | |
| } | |
| if (cache.type !== OpenSeadragon.HTMLDrawer.canvasCacheType || cache.type !== OpenSeadragon.HTMLDrawer.imageCacheType) { | |
| $.console.error("Access to HtmlDrawer property via Tile instance: HTMLDrawer must be used!"); | |
| return null; | |
| } | |
| return cache.data.element; | |
| }, | |
| /** | |
| * The HTML img element for this tile. | |
| * @member {Element} imgElement | |
| * @memberof OpenSeadragon.Tile# | |
| * @deprecated | |
| */ | |
| get imgElement() { | |
| $.console.error("Tile::imgElement property is deprecated. Use cache API instead. Moreover, this property might be unstable."); | |
| const cache = this.getCache(); | |
| if (!cache || !cache.loaded) { | |
| return null; | |
| } | |
| if (cache.type !== OpenSeadragon.HTMLDrawer.canvasCacheType || cache.type !== OpenSeadragon.HTMLDrawer.imageCacheType) { | |
| $.console.error("Access to HtmlDrawer property via Tile instance: HTMLDrawer must be used!"); | |
| return null; | |
| } | |
| return cache.data.imgElement; | |
| }, | |
| /** | |
| * The alias of this.element.style. | |
| * @member {String} style | |
| * @memberof OpenSeadragon.Tile# | |
| * @deprecated | |
| */ | |
| get style() { | |
| $.console.error("Tile::style property is deprecated. Use cache API instead. Moreover, this property might be unstable."); | |
| const cache = this.getCache(); | |
| if (!cache || !cache.loaded) { | |
| return null; | |
| } | |
| if (cache.type !== OpenSeadragon.HTMLDrawer.canvasCacheType || cache.type !== OpenSeadragon.HTMLDrawer.imageCacheType) { | |
| $.console.error("Access to HtmlDrawer property via Tile instance: HTMLDrawer must be used!"); | |
| return null; | |
| } | |
| return cache.data.style; | |
| }, | |
| /** | |
| * Get the Image object for this tile. | |
| * @returns {?Image} | |
| */ | |
| getImage: function() { | |
| $.console.error("[Tile.getImage] property has been deprecated. Use 'tile-invalidated' routine event instead."); | |
| //this method used to ensure the underlying data model conformed to given type - convert instead of getData() | |
| const cache = this.getCache(this.cacheKey); | |
| if (!cache) { | |
| return undefined; | |
| } | |
| cache.transformTo("image"); | |
| return cache.data; | |
| }, | |
| /** | |
| * Get the url string for this tile. | |
| * @returns {String} | |
| */ | |
| getUrl: function() { | |
| if (typeof this._url === 'function') { | |
| return this._url(); | |
| } | |
| return this._url; | |
| }, | |
| /** | |
| * Get the CanvasRenderingContext2D instance for tile image data drawn | |
| * onto Canvas if enabled and available | |
| * @returns {CanvasRenderingContext2D|undefined} | |
| */ | |
| getCanvasContext: function() { | |
| $.console.error("[Tile.getCanvasContext] property has been deprecated. Use 'tile-invalidated' routine event instead."); | |
| //this method used to ensure the underlying data model conformed to given type - convert instead of getData() | |
| const cache = this.getCache(this.cacheKey); | |
| if (!cache) { | |
| return undefined; | |
| } | |
| cache.transformTo("context2d"); | |
| return cache.data; | |
| }, | |
| /** | |
| * The context2D of this tile if it is provided directly by the tile source. | |
| * @deprecated | |
| * @type {CanvasRenderingContext2D} | |
| */ | |
| get context2D() { | |
| $.console.error("[Tile.context2D] property has been deprecated. Use 'tile-invalidated' routine event instead."); | |
| return this.getCanvasContext(); | |
| }, | |
| /** | |
| * The context2D of this tile if it is provided directly by the tile source. | |
| * @deprecated | |
| */ | |
| set context2D(value) { | |
| $.console.error("[Tile.context2D] property has been deprecated. Use 'tile-invalidated' routine event instead."); | |
| const cache = this._caches[this.cacheKey]; | |
| if (cache) { | |
| this.removeCache(this.cacheKey); | |
| } | |
| this.addCache(this.cacheKey, value, 'context2d', true, false); | |
| }, | |
| /** | |
| * The default cache for this tile. | |
| * @deprecated | |
| * @type OpenSeadragon.CacheRecord | |
| */ | |
| get cacheImageRecord() { | |
| $.console.error("[Tile.cacheImageRecord] property has been deprecated. Use Tile::getCache."); | |
| return this.getCache(this.cacheKey); | |
| }, | |
| /** | |
| * The default cache for this tile. | |
| * @deprecated | |
| */ | |
| set cacheImageRecord(value) { | |
| $.console.error("[Tile.cacheImageRecord] property has been deprecated. Use Tile::addCache."); | |
| const cache = this._caches[this.cacheKey]; | |
| if (cache) { | |
| this.removeCache(this.cacheKey); | |
| } | |
| if (value) { | |
| if (value.loaded) { | |
| this.addCache(this.cacheKey, value.data, value.type, true, false); | |
| } else { | |
| value.await().then(x => this.addCache(this.cacheKey, x, value.type, true, false)); | |
| } | |
| } | |
| }, | |
| /** | |
| * Cache key for main cache that is 'cache-equal', but different from original cache key | |
| * @return {string} | |
| * @private | |
| */ | |
| buildDistinctMainCacheKey: function () { | |
| return this.cacheKey === this.originalCacheKey ? "mod://" + this.originalCacheKey : this.cacheKey; | |
| }, | |
| /** | |
| * Read tile cache data object (CacheRecord) | |
| * @param {string} [key=this.cacheKey] cache key to read that belongs to this tile | |
| * @return {OpenSeadragon.CacheRecord} | |
| */ | |
| getCache: function(key = this._cKey) { | |
| const cache = this._caches[key]; | |
| if (cache) { | |
| cache.withTileReference(this); | |
| } | |
| return cache; | |
| }, | |
| /** | |
| * Create tile cache for given data object. | |
| * | |
| * Using `setAsMain` updates also main tile cache key - the main cache key used to draw this tile. | |
| * In that case, the cache should be ready to be rendered immediatelly (converted to one of the supported formats | |
| * of the currently employed drawer). | |
| * | |
| * NOTE: if the existing cache already exists, | |
| * data parameter is ignored and inherited from the existing cache object. | |
| * WARNING: if you override main tile cache key to point to a different cache, the invalidation routine | |
| * will no longer work. If you need to modify tile main data, prefer to use invalidation routine instead. | |
| * | |
| * @param {string} key cache key, if unique, new cache object is created, else existing cache attached | |
| * @param {*} data this data will be IGNORED if cache already exists; therefore if | |
| * `typeof data === 'function'` holds (both async and normal functions), the data is called to obtain | |
| * the data item: this is an optimization to load data only when necessary. | |
| * @param {string} [type=undefined] data type, will be guessed if not provided (not recommended), | |
| * if data is a callback the type is a mandatory field, not setting it results in undefined behaviour | |
| * @param {boolean} [setAsMain=false] if true, the key will be set as the tile.cacheKey, | |
| * no effect if key === this.cacheKey | |
| * @param [_safely=true] private | |
| * @returns {OpenSeadragon.CacheRecord|null} - The cache record the tile was attached to. | |
| */ | |
| addCache: function(key, data, type = undefined, setAsMain = false, _safely = true) { | |
| const tiledImage = this.tiledImage; | |
| if (!tiledImage) { | |
| return null; //async can access outside its lifetime | |
| } | |
| if (!type) { | |
| if (!this.__typeWarningReported) { | |
| $.console.warn(this, "[Tile.addCache] called without type specification. " + | |
| "Automated deduction is potentially unsafe: prefer specification of data type explicitly."); | |
| this.__typeWarningReported = true; | |
| } | |
| if (typeof data === 'function') { | |
| $.console.error("[TileCache.cacheTile] options.data as a callback requires type argument! Current is " + type); | |
| } | |
| type = $.convertor.guessType(data); | |
| } | |
| const overwritesMainCache = key === this.cacheKey; | |
| if (_safely && (overwritesMainCache || setAsMain)) { | |
| // Need to get the supported type for rendering out of the active drawer. | |
| const supportedTypes = tiledImage.viewer.drawer.getSupportedDataFormats(); | |
| const conversion = $.convertor.getConversionPath(type, supportedTypes); | |
| $.console.assert(conversion, "[Tile.addCache] data was set for the default tile cache we are unable" + | |
| `to render. Make sure OpenSeadragon.convertor was taught to convert ${type} to (one of): ${conversion.toString()}`); | |
| } | |
| const cachedItem = tiledImage._tileCache.cacheTile({ | |
| data: data, | |
| dataType: type, | |
| tile: this, | |
| cacheKey: key, | |
| cutoff: tiledImage.source.getClosestLevel(), | |
| }); | |
| const havingRecord = this._caches[key]; | |
| if (havingRecord !== cachedItem) { | |
| this._caches[key] = cachedItem; | |
| if (havingRecord) { | |
| havingRecord.removeTile(this); | |
| tiledImage._tileCache.safeUnloadCache(havingRecord); | |
| } | |
| } | |
| // Update cache key if differs and main requested | |
| if (!overwritesMainCache && setAsMain) { | |
| this._updateMainCacheKey(key); | |
| } | |
| return cachedItem; | |
| }, | |
| /** | |
| * Add cache object to the tile | |
| * | |
| * @param {string} key cache key, if unique, new cache object is created, else existing cache attached | |
| * @param {OpenSeadragon.CacheRecord} cache the cache object to attach to this tile | |
| * @param {boolean} [setAsMain=false] if true, the key will be set as the tile.cacheKey, | |
| * no effect if key === this.cacheKey | |
| * @param [_safely=true] private | |
| * @returns {OpenSeadragon.CacheRecord|null} - Returns cache parameter reference if attached. | |
| */ | |
| setCache(key, cache, setAsMain = false, _safely = true) { | |
| const tiledImage = this.tiledImage; | |
| if (!tiledImage) { | |
| return null; //async can access outside its lifetime | |
| } | |
| const overwritesMainCache = key === this.cacheKey; | |
| if (_safely) { | |
| $.console.assert(cache instanceof $.CacheRecord, "[Tile.setCache] cache must be a CacheRecord object!"); | |
| if (overwritesMainCache || setAsMain) { | |
| // Need to get the supported type for rendering out of the active drawer. | |
| const supportedTypes = tiledImage.viewer.drawer.getSupportedDataFormats(); | |
| const conversion = $.convertor.getConversionPath(cache.type, supportedTypes); | |
| $.console.assert(conversion, "[Tile.setCache] data was set for the default tile cache we are unable" + | |
| `to render. Make sure OpenSeadragon.convertor was taught to convert ${cache.type} to (one of): ${conversion.toString()}`); | |
| } | |
| } | |
| const havingRecord = this._caches[key]; | |
| if (havingRecord !== cache) { | |
| this._caches[key] = cache; | |
| cache.addTile(this); // keep reference bidirectional | |
| if (havingRecord) { | |
| havingRecord.removeTile(this); | |
| tiledImage._tileCache.safeUnloadCache(havingRecord); | |
| } | |
| } | |
| // Update cache key if differs and main requested | |
| if (!overwritesMainCache && setAsMain) { | |
| this._updateMainCacheKey(key); | |
| } | |
| return cache; | |
| }, | |
| /** | |
| * Sets the main cache key for this tile and | |
| * performs necessary updates | |
| * @param value | |
| * @private | |
| */ | |
| _updateMainCacheKey: function(value) { | |
| let ref = this._caches[this._cKey]; | |
| if (ref) { | |
| // make sure we free drawer internal cache if people change cache key externally | |
| ref.destroyInternalCache(); | |
| } | |
| this._cKey = value; | |
| }, | |
| /** | |
| * Get the number of caches available to this tile | |
| * @returns {number} number of caches | |
| */ | |
| getCacheSize: function() { | |
| return Object.values(this._caches).length; | |
| }, | |
| /** | |
| * Free tile cache. Removes by default the cache record if no other tile uses it. | |
| * @param {string} key cache key, required | |
| * @param {boolean} [freeIfUnused=true] set to false if zombie should be created | |
| * @return {OpenSeadragon.CacheRecord|undefined} reference to the cache record if it was removed, | |
| * undefined if removal was refused to perform (e.g. does not exist, it is an original data target etc.) | |
| */ | |
| removeCache: function(key, freeIfUnused = true) { | |
| const deleteTarget = this._caches[key]; | |
| if (!deleteTarget) { | |
| // try to erase anyway in case the cache got stuck in memory | |
| this.tiledImage._tileCache.unloadCacheForTile(this, key, freeIfUnused, true); | |
| return undefined; | |
| } | |
| const currentMainKey = this.cacheKey, | |
| originalDataKey = this.originalCacheKey, | |
| sameBuiltinKeys = currentMainKey === originalDataKey; | |
| if (!sameBuiltinKeys && originalDataKey === key) { | |
| $.console.warn("[Tile.removeCache] original data must not be manually deleted: other parts of the code might rely on it!", | |
| "If you want the tile not to preserve the original data, toggle of data perseverance in tile.setData()."); | |
| return undefined; | |
| } | |
| if (currentMainKey === key) { | |
| if (!sameBuiltinKeys && this._caches[originalDataKey]) { | |
| // if we have original data let's revert back | |
| this._updateMainCacheKey(originalDataKey); | |
| } else { | |
| $.console.warn("[Tile.removeCache] trying to remove the only cache that can be used to draw the tile!", | |
| "If you want to remove the main cache, first set different cache as main with tile.addCache()"); | |
| return undefined; | |
| } | |
| } | |
| if (this.tiledImage._tileCache.unloadCacheForTile(this, key, freeIfUnused, false)) { | |
| //if we managed to free tile from record, we are sure we decreased cache count | |
| delete this._caches[key]; | |
| } | |
| return deleteTarget; | |
| }, | |
| /** | |
| * Get the ratio between current and original size. | |
| * @function | |
| * @deprecated | |
| * @returns {number} | |
| */ | |
| getScaleForEdgeSmoothing: function() { | |
| // getCanvasContext is deprecated and so should be this method. | |
| $.console.warn("[Tile.getScaleForEdgeSmoothing] is deprecated, the following error is the consequence:"); | |
| const context = this.getCanvasContext(); | |
| if (!context) { | |
| $.console.warn( | |
| '[Tile.drawCanvas] attempting to get tile scale %s when tile\'s not cached', | |
| this.toString()); | |
| return 1; | |
| } | |
| return context.canvas.width / (this.size.x * $.pixelDensityRatio); | |
| }, | |
| /** | |
| * Get a translation vector that when applied to the tile position produces integer coordinates. | |
| * Needed to avoid swimming and twitching. | |
| * @function | |
| * @param {Number} [scale=1] - Scale to be applied to position. | |
| * @returns {OpenSeadragon.Point} | |
| */ | |
| getTranslationForEdgeSmoothing: function(scale, canvasSize, sketchCanvasSize) { | |
| // The translation vector must have positive values, otherwise the image goes a bit off | |
| // the sketch canvas to the top and left and we must use negative coordinates to repaint it | |
| // to the main canvas. In that case, some browsers throw: | |
| // INDEX_SIZE_ERR: DOM Exception 1: Index or size was negative, or greater than the allowed value. | |
| const x = Math.max(1, Math.ceil((sketchCanvasSize.x - canvasSize.x) / 2)); | |
| const y = Math.max(1, Math.ceil((sketchCanvasSize.y - canvasSize.y) / 2)); | |
| return new $.Point(x, y).minus( | |
| this.position | |
| .times($.pixelDensityRatio) | |
| .times(scale || 1) | |
| .apply(function(x) { | |
| return x % 1; | |
| }) | |
| ); | |
| }, | |
| /** | |
| * Reflect that a cache object was renamed. Called internally from TileCache. | |
| * Do NOT call manually. | |
| * @function | |
| * @private | |
| */ | |
| reflectCacheRenamed: function (oldKey, newKey) { | |
| let cache = this._caches[oldKey]; | |
| if (!cache) { | |
| return; // nothing to fix | |
| } | |
| // Do update via private refs, old key no longer exists in cache | |
| if (oldKey === this._ocKey) { | |
| this._ocKey = newKey; | |
| } | |
| if (oldKey === this._cKey) { | |
| this._cKey = newKey; | |
| } | |
| // Working key is never updated, it will be invalidated (but do not dereference cache, just fix the pointers) | |
| this._caches[newKey] = cache; | |
| delete this._caches[oldKey]; | |
| }, | |
| /** | |
| * Check if two tiles are data-equal | |
| * @param {OpenSeadragon.Tile} tile | |
| */ | |
| equals(tile) { | |
| return this._ocKey === tile._ocKey; | |
| }, | |
| /** | |
| * Removes tile from the system: it will still be present in the | |
| * OSD memory, but marked as loaded=false, and its data will be erased. | |
| * @param {boolean} [erase=false] | |
| */ | |
| unload: function(erase = false) { | |
| if (!this.loaded) { | |
| return; | |
| } | |
| this.tiledImage._tileCache.unloadTile(this, erase); | |
| }, | |
| /** | |
| * this method shall be called only by cache system when the tile is already empty of data | |
| * @private | |
| */ | |
| _unload: function () { | |
| this.tiledImage = null; | |
| this._caches = {}; | |
| this._cacheSize = 0; | |
| this.loaded = false; | |
| this.loading = false; | |
| this._cKey = this._ocKey; | |
| } | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - Overlay | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function($) { | |
| /** | |
| * An enumeration of positions that an overlay may be assigned relative to | |
| * the viewport. | |
| * It is identical to OpenSeadragon.Placement but is kept for backward | |
| * compatibility. | |
| * @member OverlayPlacement | |
| * @memberof OpenSeadragon | |
| * @see OpenSeadragon.Placement | |
| * @static | |
| * @readonly | |
| * @type {Object} | |
| * @property {Number} CENTER | |
| * @property {Number} TOP_LEFT | |
| * @property {Number} TOP | |
| * @property {Number} TOP_RIGHT | |
| * @property {Number} RIGHT | |
| * @property {Number} BOTTOM_RIGHT | |
| * @property {Number} BOTTOM | |
| * @property {Number} BOTTOM_LEFT | |
| * @property {Number} LEFT | |
| */ | |
| $.OverlayPlacement = $.Placement; | |
| /** | |
| * An enumeration of possible ways to handle overlays rotation | |
| * @member OverlayRotationMode | |
| * @memberOf OpenSeadragon | |
| * @static | |
| * @readonly | |
| * @property {Number} NO_ROTATION The overlay ignore the viewport rotation. | |
| * @property {Number} EXACT The overlay use CSS 3 transforms to rotate with | |
| * the viewport. If the overlay contains text, it will get rotated as well. | |
| * @property {Number} BOUNDING_BOX The overlay adjusts for rotation by | |
| * taking the size of the bounding box of the rotated bounds. | |
| * Only valid for overlays with Rect location and scalable in both directions. | |
| */ | |
| $.OverlayRotationMode = $.freezeObject({ | |
| NO_ROTATION: 1, | |
| EXACT: 2, | |
| BOUNDING_BOX: 3 | |
| }); | |
| /** | |
| * @class Overlay | |
| * @classdesc Provides a way to float an HTML element on top of the viewer element. | |
| * | |
| * @memberof OpenSeadragon | |
| * @param {Object} options | |
| * @param {Element} options.element | |
| * @param {OpenSeadragon.Point|OpenSeadragon.Rect} options.location - The | |
| * location of the overlay on the image. If a {@link OpenSeadragon.Point} | |
| * is specified, the overlay will be located at this location with respect | |
| * to the placement option. If a {@link OpenSeadragon.Rect} is specified, | |
| * the overlay will be placed at this location with the corresponding width | |
| * and height and placement TOP_LEFT. | |
| * @param {OpenSeadragon.Placement} [options.placement=OpenSeadragon.Placement.TOP_LEFT] | |
| * Defines what part of the overlay should be at the specified options.location | |
| * @param {OpenSeadragon.Overlay.OnDrawCallback} [options.onDraw] | |
| * @param {Boolean} [options.checkResize=true] Set to false to avoid to | |
| * check the size of the overlay every time it is drawn in the directions | |
| * which are not scaled. It will improve performances but will cause a | |
| * misalignment if the overlay size changes. | |
| * @param {Number} [options.width] The width of the overlay in viewport | |
| * coordinates. If specified, the width of the overlay will be adjusted when | |
| * the zoom changes. | |
| * @param {Number} [options.height] The height of the overlay in viewport | |
| * coordinates. If specified, the height of the overlay will be adjusted when | |
| * the zoom changes. | |
| * @param {Boolean} [options.rotationMode=OpenSeadragon.OverlayRotationMode.EXACT] | |
| * How to handle the rotation of the viewport. | |
| */ | |
| $.Overlay = function(element, location, placement) { | |
| /** | |
| * onDraw callback signature used by {@link OpenSeadragon.Overlay}. | |
| * | |
| * @callback OnDrawCallback | |
| * @memberof OpenSeadragon.Overlay | |
| * @param {OpenSeadragon.Point} position | |
| * @param {OpenSeadragon.Point} size | |
| * @param {Element} element | |
| */ | |
| var options; | |
| if ($.isPlainObject(element)) { | |
| options = element; | |
| } else { | |
| options = { | |
| element: element, | |
| location: location, | |
| placement: placement | |
| }; | |
| } | |
| this.elementWrapper = document.createElement('div'); | |
| this.element = options.element; | |
| this.elementWrapper.appendChild(this.element); | |
| if (this.element.id) { | |
| this.elementWrapper.id = "overlay-wrapper-" + this.element.id; // Unique ID if element has one | |
| } | |
| // Always add a class for styling & selection | |
| this.elementWrapper.classList.add("openseadragon-overlay-wrapper"); | |
| this.style = this.elementWrapper.style; | |
| this._init(options); | |
| }; | |
| /** @lends OpenSeadragon.Overlay.prototype */ | |
| $.Overlay.prototype = { | |
| // private | |
| _init: function(options) { | |
| this.location = options.location; | |
| this.placement = options.placement === undefined ? | |
| $.Placement.TOP_LEFT : options.placement; | |
| this.onDraw = options.onDraw; | |
| this.checkResize = options.checkResize === undefined ? | |
| true : options.checkResize; | |
| // When this.width is not null, the overlay get scaled horizontally | |
| this.width = options.width === undefined ? null : options.width; | |
| // When this.height is not null, the overlay get scaled vertically | |
| this.height = options.height === undefined ? null : options.height; | |
| this.rotationMode = options.rotationMode || $.OverlayRotationMode.EXACT; | |
| // Having a rect as location is a syntactic sugar | |
| if (this.location instanceof $.Rect) { | |
| this.width = this.location.width; | |
| this.height = this.location.height; | |
| this.location = this.location.getTopLeft(); | |
| this.placement = $.Placement.TOP_LEFT; | |
| } | |
| // Deprecated properties kept for backward compatibility. | |
| this.scales = this.width !== null && this.height !== null; | |
| this.bounds = new $.Rect( | |
| this.location.x, this.location.y, this.width, this.height); | |
| this.position = this.location; | |
| }, | |
| /** | |
| * Internal function to adjust the position of an overlay | |
| * depending on it size and placement. | |
| * @function | |
| * @param {OpenSeadragon.Point} position | |
| * @param {OpenSeadragon.Point} size | |
| */ | |
| adjust: function(position, size) { | |
| var properties = $.Placement.properties[this.placement]; | |
| if (!properties) { | |
| return; | |
| } | |
| if (properties.isHorizontallyCentered) { | |
| position.x -= size.x / 2; | |
| } else if (properties.isRight) { | |
| position.x -= size.x; | |
| } | |
| if (properties.isVerticallyCentered) { | |
| position.y -= size.y / 2; | |
| } else if (properties.isBottom) { | |
| position.y -= size.y; | |
| } | |
| }, | |
| /** | |
| * @function | |
| */ | |
| destroy: function() { | |
| var element = this.elementWrapper; | |
| var style = this.style; | |
| if (element.parentNode) { | |
| element.parentNode.removeChild(element); | |
| //this should allow us to preserve overlays when required between | |
| //pages | |
| if (element.prevElementParent) { | |
| style.display = 'none'; | |
| //element.prevElementParent.insertBefore( | |
| // element, | |
| // element.prevNextSibling | |
| //); | |
| document.body.appendChild(element); | |
| } | |
| } | |
| // clear the onDraw callback | |
| this.onDraw = null; | |
| style.top = ""; | |
| style.left = ""; | |
| style.position = ""; | |
| if (this.width !== null) { | |
| style.width = ""; | |
| } | |
| if (this.height !== null) { | |
| style.height = ""; | |
| } | |
| var transformOriginProp = $.getCssPropertyWithVendorPrefix( | |
| 'transformOrigin'); | |
| var transformProp = $.getCssPropertyWithVendorPrefix( | |
| 'transform'); | |
| if (transformOriginProp && transformProp) { | |
| style[transformOriginProp] = ""; | |
| style[transformProp] = ""; | |
| } | |
| }, | |
| /** | |
| * @function | |
| * @param {Element} container | |
| */ | |
| drawHTML: function(container, viewport) { | |
| var element = this.elementWrapper; | |
| if (element.parentNode !== container) { | |
| //save the source parent for later if we need it | |
| element.prevElementParent = element.parentNode; | |
| element.prevNextSibling = element.nextSibling; | |
| container.appendChild(element); | |
| // have to set position before calculating size, fix #1116 | |
| this.style.position = "absolute"; | |
| // this.size is used by overlays which don't get scaled in at | |
| // least one direction when this.checkResize is set to false. | |
| this.size = $.getElementSize(this.elementWrapper); | |
| } | |
| var positionAndSize = this._getOverlayPositionAndSize(viewport); | |
| var position = positionAndSize.position; | |
| var size = this.size = positionAndSize.size; | |
| var outerScale = ""; | |
| if (viewport.overlayPreserveContentDirection) { | |
| outerScale = viewport.flipped ? " scaleX(-1)" : " scaleX(1)"; | |
| } | |
| var rotate = viewport.flipped ? -positionAndSize.rotate : positionAndSize.rotate; | |
| var scale = viewport.flipped ? " scaleX(-1)" : ""; | |
| // call the onDraw callback if it exists to allow one to overwrite | |
| // the drawing/positioning/sizing of the overlay | |
| if (this.onDraw) { | |
| this.onDraw(position, size, this.element); | |
| } else { | |
| var style = this.style; | |
| var innerStyle = this.element.style; | |
| innerStyle.display = "block"; | |
| style.left = position.x + "px"; | |
| style.top = position.y + "px"; | |
| if (this.width !== null) { | |
| innerStyle.width = size.x + "px"; | |
| } | |
| if (this.height !== null) { | |
| innerStyle.height = size.y + "px"; | |
| } | |
| var transformOriginProp = $.getCssPropertyWithVendorPrefix( | |
| 'transformOrigin'); | |
| var transformProp = $.getCssPropertyWithVendorPrefix( | |
| 'transform'); | |
| if (transformOriginProp && transformProp) { | |
| if (rotate && !viewport.flipped) { | |
| innerStyle[transformProp] = ""; | |
| style[transformOriginProp] = this._getTransformOrigin(); | |
| style[transformProp] = "rotate(" + rotate + "deg)"; | |
| } else if (!rotate && viewport.flipped) { | |
| innerStyle[transformProp] = outerScale; | |
| style[transformOriginProp] = this._getTransformOrigin(); | |
| style[transformProp] = scale; | |
| } else if (rotate && viewport.flipped){ | |
| innerStyle[transformProp] = outerScale; | |
| style[transformOriginProp] = this._getTransformOrigin(); | |
| style[transformProp] = "rotate(" + rotate + "deg)" + scale; | |
| } else { | |
| innerStyle[transformProp] = ""; | |
| style[transformOriginProp] = ""; | |
| style[transformProp] = ""; | |
| } | |
| } | |
| style.display = 'flex'; | |
| } | |
| }, | |
| // private | |
| _getOverlayPositionAndSize: function(viewport) { | |
| var position = viewport.pixelFromPoint(this.location, true); | |
| var size = this._getSizeInPixels(viewport); | |
| this.adjust(position, size); | |
| var rotate = 0; | |
| if (viewport.getRotation(true) && | |
| this.rotationMode !== $.OverlayRotationMode.NO_ROTATION) { | |
| // BOUNDING_BOX is only valid if both directions get scaled. | |
| // Get replaced by EXACT otherwise. | |
| if (this.rotationMode === $.OverlayRotationMode.BOUNDING_BOX && | |
| this.width !== null && this.height !== null) { | |
| var rect = new $.Rect(position.x, position.y, size.x, size.y); | |
| var boundingBox = this._getBoundingBox(rect, viewport.getRotation(true)); | |
| position = boundingBox.getTopLeft(); | |
| size = boundingBox.getSize(); | |
| } else { | |
| rotate = viewport.getRotation(true); | |
| } | |
| } | |
| if (viewport.flipped) { | |
| position.x = (viewport.getContainerSize().x - position.x); | |
| } | |
| return { | |
| position: position, | |
| size: size, | |
| rotate: rotate | |
| }; | |
| }, | |
| // private | |
| _getSizeInPixels: function(viewport) { | |
| var width = this.size.x; | |
| var height = this.size.y; | |
| if (this.width !== null || this.height !== null) { | |
| var scaledSize = viewport.deltaPixelsFromPointsNoRotate( | |
| new $.Point(this.width || 0, this.height || 0), true); | |
| if (this.width !== null) { | |
| width = scaledSize.x; | |
| } | |
| if (this.height !== null) { | |
| height = scaledSize.y; | |
| } | |
| } | |
| if (this.checkResize && | |
| (this.width === null || this.height === null)) { | |
| var eltSize = this.size = $.getElementSize(this.elementWrapper); | |
| if (this.width === null) { | |
| width = eltSize.x; | |
| } | |
| if (this.height === null) { | |
| height = eltSize.y; | |
| } | |
| } | |
| return new $.Point(width, height); | |
| }, | |
| // private | |
| _getBoundingBox: function(rect, degrees) { | |
| var refPoint = this._getPlacementPoint(rect); | |
| return rect.rotate(degrees, refPoint).getBoundingBox(); | |
| }, | |
| // private | |
| _getPlacementPoint: function(rect) { | |
| var result = new $.Point(rect.x, rect.y); | |
| var properties = $.Placement.properties[this.placement]; | |
| if (properties) { | |
| if (properties.isHorizontallyCentered) { | |
| result.x += rect.width / 2; | |
| } else if (properties.isRight) { | |
| result.x += rect.width; | |
| } | |
| if (properties.isVerticallyCentered) { | |
| result.y += rect.height / 2; | |
| } else if (properties.isBottom) { | |
| result.y += rect.height; | |
| } | |
| } | |
| return result; | |
| }, | |
| // private | |
| _getTransformOrigin: function() { | |
| var result = ""; | |
| var properties = $.Placement.properties[this.placement]; | |
| if (!properties) { | |
| return result; | |
| } | |
| if (properties.isLeft) { | |
| result = "left"; | |
| } else if (properties.isRight) { | |
| result = "right"; | |
| } | |
| if (properties.isTop) { | |
| result += " top"; | |
| } else if (properties.isBottom) { | |
| result += " bottom"; | |
| } | |
| return result; | |
| }, | |
| /** | |
| * Changes the overlay settings. | |
| * @function | |
| * @param {OpenSeadragon.Point|OpenSeadragon.Rect|Object} location | |
| * If an object is specified, the options are the same than the constructor | |
| * except for the element which can not be changed. | |
| * @param {OpenSeadragon.Placement} placement | |
| */ | |
| update: function(location, placement) { | |
| var options = $.isPlainObject(location) ? location : { | |
| location: location, | |
| placement: placement | |
| }; | |
| this._init({ | |
| location: options.location || this.location, | |
| placement: options.placement !== undefined ? | |
| options.placement : this.placement, | |
| onDraw: options.onDraw || this.onDraw, | |
| checkResize: options.checkResize || this.checkResize, | |
| width: options.width !== undefined ? options.width : this.width, | |
| height: options.height !== undefined ? options.height : this.height, | |
| rotationMode: options.rotationMode || this.rotationMode | |
| }); | |
| }, | |
| /** | |
| * Returns the current bounds of the overlay in viewport coordinates | |
| * @function | |
| * @param {OpenSeadragon.Viewport} viewport the viewport | |
| * @returns {OpenSeadragon.Rect} overlay bounds | |
| */ | |
| getBounds: function(viewport) { | |
| $.console.assert(viewport, | |
| 'A viewport must now be passed to Overlay.getBounds.'); | |
| var width = this.width; | |
| var height = this.height; | |
| if (width === null || height === null) { | |
| var size = viewport.deltaPointsFromPixelsNoRotate(this.size, true); | |
| if (width === null) { | |
| width = size.x; | |
| } | |
| if (height === null) { | |
| height = size.y; | |
| } | |
| } | |
| var location = this.location.clone(); | |
| this.adjust(location, new $.Point(width, height)); | |
| return this._adjustBoundsForRotation( | |
| viewport, new $.Rect(location.x, location.y, width, height)); | |
| }, | |
| // private | |
| _adjustBoundsForRotation: function(viewport, bounds) { | |
| if (!viewport || | |
| viewport.getRotation(true) === 0 || | |
| this.rotationMode === $.OverlayRotationMode.EXACT) { | |
| return bounds; | |
| } | |
| if (this.rotationMode === $.OverlayRotationMode.BOUNDING_BOX) { | |
| // If overlay not fully scalable, BOUNDING_BOX falls back to EXACT | |
| if (this.width === null || this.height === null) { | |
| return bounds; | |
| } | |
| // It is easier to just compute the position and size and | |
| // convert to viewport coordinates. | |
| var positionAndSize = this._getOverlayPositionAndSize(viewport); | |
| return viewport.viewerElementToViewportRectangle(new $.Rect( | |
| positionAndSize.position.x, | |
| positionAndSize.position.y, | |
| positionAndSize.size.x, | |
| positionAndSize.size.y)); | |
| } | |
| // NO_ROTATION case | |
| return bounds.rotate(-viewport.getRotation(true), | |
| this._getPlacementPoint(bounds)); | |
| } | |
| }; | |
| }(OpenSeadragon)); | |
| /* | |
| * OpenSeadragon - DrawerBase | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| /** | |
| * @typedef BaseDrawerOptions | |
| * @memberOf OpenSeadragon | |
| * @property {boolean} [usePrivateCache=false] specify whether the drawer should use | |
| * detached (=internal) cache object in case it has to perform custom type conversion atop | |
| * what cache performs. In that case, drawer must implement internalCacheCreate() which gets data in one | |
| * of formats the drawer declares as supported. This method must return object to be used during drawing. | |
| * You should probably implement also internalCacheFree() to provide cleanup logics. | |
| * | |
| * @property {boolean} [preloadCache=true] | |
| * When internalCacheCreate is used, it can be applied offline (asynchronously) during data processing = preloading, | |
| * or just in time before rendering (if necessary). Preloading supports | |
| */ | |
| const OpenSeadragon = $; // (re)alias back to OpenSeadragon for JSDoc | |
| /** | |
| * @class OpenSeadragon.DrawerBase | |
| * @classdesc Base class for Drawers that handle rendering of tiles for an {@link OpenSeadragon.Viewer}. | |
| * @param {Object} options - Options for this Drawer. | |
| * @param {OpenSeadragon.Viewer} options.viewer - The Viewer that owns this Drawer. | |
| * @param {OpenSeadragon.Viewport} options.viewport - Reference to Viewer viewport. | |
| * @param {HTMLElement} options.element - Parent element. | |
| * @abstract | |
| */ | |
| OpenSeadragon.DrawerBase = class DrawerBase{ | |
| constructor(options){ | |
| $.console.assert( options.viewer, "[Drawer] options.viewer is required" ); | |
| $.console.assert( options.viewport, "[Drawer] options.viewport is required" ); | |
| $.console.assert( options.element, "[Drawer] options.element is required" ); | |
| this._id = this.getType() + $.now(); | |
| this.viewer = options.viewer; | |
| this.viewport = options.viewport; | |
| this.debugGridColor = typeof options.debugGridColor === 'string' ? [options.debugGridColor] : options.debugGridColor || $.DEFAULT_SETTINGS.debugGridColor; | |
| this.options = $.extend({}, this.defaultOptions, options.options); | |
| this.container = $.getElement( options.element ); | |
| this._renderingTarget = this._createDrawingElement(); | |
| this.canvas.style.width = "100%"; | |
| this.canvas.style.height = "100%"; | |
| this.canvas.style.position = "absolute"; | |
| // set canvas.style.left = 0 so the canvas is positioned properly in ltr and rtl html | |
| this.canvas.style.left = "0"; | |
| $.setElementOpacity( this.canvas, this.viewer.opacity, true ); | |
| // Allow pointer events to pass through the canvas element so implicit | |
| // pointer capture works on touch devices | |
| $.setElementPointerEventsNone( this.canvas ); | |
| $.setElementTouchActionNone( this.canvas ); | |
| // explicit left-align | |
| this.container.style.textAlign = "left"; | |
| this.container.appendChild( this.canvas ); | |
| this._checkInterfaceImplementation(); | |
| this.setInternalCacheNeedsRefresh(); // initializes stamp | |
| } | |
| /** | |
| * Retrieve default options for the current drawer. | |
| * The base implementation provides default shared options. | |
| * Overrides should enumerate all defaults or extend from this implementation. | |
| * return $.extend({}, super.options, { ... custom drawer instance options ... }); | |
| * @returns {BaseDrawerOptions} common options | |
| */ | |
| get defaultOptions() { | |
| return { | |
| usePrivateCache: false, | |
| preloadCache: true, | |
| }; | |
| } | |
| // protect the canvas member with a getter | |
| get canvas(){ | |
| return this._renderingTarget; | |
| } | |
| get element(){ | |
| $.console.error('Drawer.element is deprecated. Use Drawer.container instead.'); | |
| return this.container; | |
| } | |
| /** | |
| * Get unique drawer ID | |
| * @return {string} | |
| */ | |
| getId() { | |
| return this._id; | |
| } | |
| /** | |
| * @abstract | |
| * @returns {String | undefined} What type of drawer this is. Must be overridden by extending classes. | |
| */ | |
| getType(){ | |
| $.console.error('Drawer.getType must be implemented by child class'); | |
| return undefined; | |
| } | |
| /** | |
| * Retrieve required data formats the data must be converted to. | |
| * This list MUST BE A VALID SUBSET OF getSupportedDataFormats() | |
| * @abstract | |
| * @return {string[]} | |
| */ | |
| getRequiredDataFormats() { | |
| return this.getSupportedDataFormats(); | |
| } | |
| /** | |
| * Retrieve data types | |
| * @abstract | |
| * @return {string[]} | |
| */ | |
| getSupportedDataFormats() { | |
| throw "Drawer.getSupportedDataFormats must define its supported rendering data types!"; | |
| } | |
| /** | |
| * Check a particular cache record is compatible. | |
| * This function _MUST_ be called: if it returns a falsey | |
| * value, the rendering _MUST NOT_ proceed. It should | |
| * await next animation frames and check again for availability. | |
| * @param {OpenSeadragon.Tile} tile | |
| * @return {any|undefined} undefined if cache not available, compatible data otherwise. | |
| */ | |
| getDataToDraw(tile) { | |
| const cache = tile.getCache(tile.cacheKey); | |
| if (!cache) { | |
| $.console.warn("Attempt to draw tile %s when not cached!", tile); | |
| return undefined; | |
| } | |
| const dataCache = cache.getDataForRendering(this, tile); | |
| return dataCache && dataCache.data; | |
| } | |
| /** | |
| * @abstract | |
| * @returns {Boolean} Whether the drawer implementation is supported by the browser. Must be overridden by extending classes. | |
| */ | |
| static isSupported() { | |
| $.console.error('Drawer.isSupported must be implemented by child class'); | |
| } | |
| /** | |
| * @abstract | |
| * @returns {Element} the element to draw into | |
| * @private | |
| */ | |
| _createDrawingElement() { | |
| $.console.error('Drawer._createDrawingElement must be implemented by child class'); | |
| return null; | |
| } | |
| /** | |
| * @abstract | |
| * @param {Array} tiledImages - An array of TiledImages that are ready to be drawn. | |
| * @private | |
| */ | |
| draw(tiledImages) { | |
| $.console.error('Drawer.draw must be implemented by child class'); | |
| } | |
| /** | |
| * @abstract | |
| * @returns {Boolean} True if rotation is supported. | |
| */ | |
| canRotate() { | |
| $.console.error('Drawer.canRotate must be implemented by child class'); | |
| } | |
| /** | |
| * @abstract | |
| */ | |
| destroy() { | |
| $.console.error('Drawer.destroy must be implemented by child class'); | |
| } | |
| /** | |
| * Destroy internal cache. Should be called within destroy() when | |
| * usePrivateCache is set to true. Ensures cleanup of anything created | |
| * by internalCacheCreate(...). | |
| */ | |
| destroyInternalCache() { | |
| this.viewer.tileCache.clearDrawerInternalCache(this); | |
| } | |
| /** | |
| * @param {TiledImage} tiledImage the tiled image that is calling the function | |
| * @returns {Boolean} Whether this drawer requires enforcing minimum tile overlap to avoid showing seams. | |
| * @private | |
| */ | |
| minimumOverlapRequired(tiledImage) { | |
| return false; | |
| } | |
| /** | |
| * @abstract | |
| * @param {Boolean} [imageSmoothingEnabled] - Whether or not the image is | |
| * drawn smoothly on the canvas; see imageSmoothingEnabled in | |
| * {@link OpenSeadragon.Options} for more explanation. | |
| */ | |
| setImageSmoothingEnabled(imageSmoothingEnabled){ | |
| $.console.error('Drawer.setImageSmoothingEnabled must be implemented by child class'); | |
| } | |
| /** | |
| * Optional public API to draw a rectangle (e.g. for debugging purposes) | |
| * Child classes can override this method if they wish to support this | |
| * @param {OpenSeadragon.Rect} rect | |
| */ | |
| drawDebuggingRect(rect) { | |
| $.console.warn('[drawer].drawDebuggingRect is not implemented by this drawer'); | |
| } | |
| // Deprecated functions | |
| clear(){ | |
| $.console.warn('[drawer].clear() is deprecated. The drawer is responsible for clearing itself as needed before drawing tiles.'); | |
| } | |
| /** | |
| * If options.usePrivateCache is true, this method MUST RETURN the private cache content | |
| * @param {OpenSeadragon.CacheRecord} cache | |
| * @param {OpenSeadragon.Tile} tile | |
| * @return any | |
| */ | |
| internalCacheCreate(cache, tile) {} | |
| /** | |
| * It is possible to perform any necessary cleanup on internal cache, necessary if you | |
| * need to clean up some memory (e.g. destroy canvas by setting with & height to 0). | |
| * @param {*} data object returned by internalCacheCreate(...) | |
| */ | |
| internalCacheFree(data) {} | |
| /** | |
| * Call to invalidate internal cache. It will be rebuilt. With synchronous converions, | |
| * it will be rebuilt immediatelly. With asynchronous, it will be rebuilt once invalidation | |
| * routine happens, e.g. you should call also requestInvalidate() if you need to happen | |
| * it as soon as possible. | |
| */ | |
| setInternalCacheNeedsRefresh() { | |
| this._dataNeedsRefresh = $.now(); | |
| } | |
| // Private functions | |
| /** | |
| * Ensures that child classes have provided implementations for public API methods | |
| * draw, canRotate, destroy, and setImageSmoothinEnabled. Throws an exception if the original | |
| * placeholder methods are still in place. | |
| * @private | |
| * | |
| */ | |
| _checkInterfaceImplementation(){ | |
| if (this._createDrawingElement === $.DrawerBase.prototype._createDrawingElement) { | |
| throw(new Error("[drawer]._createDrawingElement must be implemented by child class")); | |
| } | |
| if (this.draw === $.DrawerBase.prototype.draw) { | |
| throw(new Error("[drawer].draw must be implemented by child class")); | |
| } | |
| if (this.canRotate === $.DrawerBase.prototype.canRotate) { | |
| throw(new Error("[drawer].canRotate must be implemented by child class")); | |
| } | |
| if (this.destroy === $.DrawerBase.prototype.destroy) { | |
| throw(new Error("[drawer].destroy must be implemented by child class")); | |
| } | |
| if (this.setImageSmoothingEnabled === $.DrawerBase.prototype.setImageSmoothingEnabled) { | |
| throw(new Error("[drawer].setImageSmoothingEnabled must be implemented by child class")); | |
| } | |
| } | |
| // Utility functions | |
| /** | |
| * Scale from OpenSeadragon viewer rectangle to drawer rectangle | |
| * (ignoring rotation) | |
| * @param {OpenSeadragon.Rect} rectangle - The rectangle in viewport coordinate system. | |
| * @returns {OpenSeadragon.Rect} Rectangle in drawer coordinate system. | |
| */ | |
| viewportToDrawerRectangle(rectangle) { | |
| var topLeft = this.viewport.pixelFromPointNoRotate(rectangle.getTopLeft(), true); | |
| var size = this.viewport.deltaPixelsFromPointsNoRotate(rectangle.getSize(), true); | |
| return new $.Rect( | |
| topLeft.x * $.pixelDensityRatio, | |
| topLeft.y * $.pixelDensityRatio, | |
| size.x * $.pixelDensityRatio, | |
| size.y * $.pixelDensityRatio | |
| ); | |
| } | |
| /** | |
| * This function converts the given point from to the drawer coordinate by | |
| * multiplying it with the pixel density. | |
| * This function does not take rotation into account, thus assuming provided | |
| * point is at 0 degree. | |
| * @param {OpenSeadragon.Point} point - the pixel point to convert | |
| * @returns {OpenSeadragon.Point} Point in drawer coordinate system. | |
| */ | |
| viewportCoordToDrawerCoord(point) { | |
| var vpPoint = this.viewport.pixelFromPointNoRotate(point, true); | |
| return new $.Point( | |
| vpPoint.x * $.pixelDensityRatio, | |
| vpPoint.y * $.pixelDensityRatio | |
| ); | |
| } | |
| // Internal utility functions | |
| /** | |
| * Calculate width and height of the canvas based on viewport dimensions | |
| * and pixelDensityRatio | |
| * @private | |
| * @returns {OpenSeadragon.Point} {x, y} size of the canvas | |
| */ | |
| _calculateCanvasSize() { | |
| var pixelDensityRatio = $.pixelDensityRatio; | |
| var viewportSize = this.viewport.getContainerSize(); | |
| return new OpenSeadragon.Point( Math.round(viewportSize.x * pixelDensityRatio), Math.round(viewportSize.y * pixelDensityRatio)); | |
| } | |
| /** | |
| * Called by implementations to fire the tiled-image-drawn event (used by tests) | |
| * @private | |
| */ | |
| _raiseTiledImageDrawnEvent(tiledImage, tiles){ | |
| if(!this.viewer) { | |
| return; | |
| } | |
| /** | |
| * Raised when a tiled image is drawn to the canvas. Used internally for testing. | |
| * The update-viewport event is preferred if you want to know when a frame has been drawn. | |
| * | |
| * @event tiled-image-drawn | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {OpenSeadragon.TiledImage} tiledImage - Which TiledImage is being drawn. | |
| * @property {Array} tiles - An array of Tile objects that were drawn. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| * @private | |
| */ | |
| this.viewer.raiseEvent( 'tiled-image-drawn', { | |
| tiledImage: tiledImage, | |
| tiles: tiles, | |
| }); | |
| } | |
| /** | |
| * Called by implementations to fire the drawer-error event | |
| * @private | |
| */ | |
| _raiseDrawerErrorEvent(tiledImage, errorMessage){ | |
| if(!this.viewer) { | |
| return; | |
| } | |
| /** | |
| * Raised when a tiled image is drawn to the canvas. Used internally for testing. | |
| * The update-viewport event is preferred if you want to know when a frame has been drawn. | |
| * | |
| * @event drawer-error | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {OpenSeadragon.TiledImage} tiledImage - Which TiledImage is being drawn. | |
| * @property {OpenSeadragon.DrawerBase} drawer - The drawer that raised the error. | |
| * @property {String} error - A message describing the error. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| * @protected | |
| */ | |
| this.viewer.raiseEvent( 'drawer-error', { | |
| tiledImage: tiledImage, | |
| drawer: this, | |
| error: errorMessage, | |
| }); | |
| } | |
| }; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - HTMLDrawer | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| const OpenSeadragon = $; // alias back for JSDoc | |
| /** | |
| * @class OpenSeadragon.HTMLDrawer | |
| * @extends OpenSeadragon.DrawerBase | |
| * @classdesc HTML-based implementation of DrawerBase for an {@link OpenSeadragon.Viewer}. | |
| * @param {Object} options - Options for this Drawer. | |
| * @param {OpenSeadragon.Viewer} options.viewer - The Viewer that owns this Drawer. | |
| * @param {OpenSeadragon.Viewport} options.viewport - Reference to Viewer viewport. | |
| * @param {Element} options.element - Parent element. | |
| * @param {Number} [options.debugGridColor] - See debugGridColor in {@link OpenSeadragon.Options} for details. | |
| */ | |
| class HTMLDrawer extends OpenSeadragon.DrawerBase{ | |
| constructor(options){ | |
| super(options); | |
| /** | |
| * The HTML element (div) that this drawer uses for drawing | |
| * @member {Element} canvas | |
| * @memberof OpenSeadragon.HTMLDrawer# | |
| */ | |
| /** | |
| * The parent element of this Drawer instance, passed in when the Drawer was created. | |
| * The parent of {@link OpenSeadragon.WebGLDrawer#canvas}. | |
| * @member {Element} container | |
| * @memberof OpenSeadragon.HTMLDrawer# | |
| */ | |
| // Reject listening for the tile-drawing event, which this drawer does not fire | |
| this.viewer.rejectEventHandler("tile-drawing", "The HTMLDrawer does not raise the tile-drawing event"); | |
| // Since the tile-drawn event is fired by this drawer, make sure handlers can be added for it | |
| this.viewer.allowEventHandler("tile-drawn"); | |
| // works with canvas & image objects | |
| function _prepareTile(tile, data) { | |
| const element = $.makeNeutralElement( "div" ); | |
| const imgElement = data.cloneNode(); | |
| imgElement.style.msInterpolationMode = "nearest-neighbor"; | |
| imgElement.style.width = "100%"; | |
| imgElement.style.height = "100%"; | |
| const style = element.style; | |
| style.position = "absolute"; | |
| return { | |
| element, imgElement, style, data | |
| }; | |
| } | |
| // The actual placing logics will not happen at draw event, but when the cache is created: | |
| $.convertor.learn("context2d", HTMLDrawer.canvasCacheType, (t, d) => _prepareTile(t, d.canvas), 1, 1); | |
| $.convertor.learn("image", HTMLDrawer.imageCacheType, _prepareTile, 1, 1); | |
| // Also learn how to move back, since these elements can be just used as-is | |
| $.convertor.learn(HTMLDrawer.canvasCacheType, "context2d", (t, d) => d.data.getContext('2d'), 1, 3); | |
| $.convertor.learn(HTMLDrawer.imageCacheType, "image", (t, d) => d.data, 1, 3); | |
| function _freeTile(data) { | |
| if ( data.imgElement && data.imgElement.parentNode ) { | |
| data.imgElement.parentNode.removeChild( data.imgElement ); | |
| } | |
| if ( data.element && data.element.parentNode ) { | |
| data.element.parentNode.removeChild( data.element ); | |
| } | |
| } | |
| $.convertor.learnDestroy(HTMLDrawer.canvasCacheType, _freeTile); | |
| $.convertor.learnDestroy(HTMLDrawer.imageCacheType, _freeTile); | |
| } | |
| static get imageCacheType() { | |
| return 'htmlDrawer[image]'; | |
| } | |
| static get canvasCacheType() { | |
| return 'htmlDrawer[canvas]'; | |
| } | |
| /** | |
| * @returns {Boolean} always true | |
| */ | |
| static isSupported() { | |
| return true; | |
| } | |
| /** | |
| * | |
| * @returns 'html' | |
| */ | |
| getType(){ | |
| return 'html'; | |
| } | |
| getSupportedDataFormats() { | |
| return [HTMLDrawer.imageCacheType, HTMLDrawer.canvasCacheType]; | |
| } | |
| /** | |
| * @param {TiledImage} tiledImage the tiled image that is calling the function | |
| * @returns {Boolean} Whether this drawer requires enforcing minimum tile overlap to avoid showing seams. | |
| * @private | |
| */ | |
| minimumOverlapRequired(tiledImage) { | |
| return true; | |
| } | |
| /** | |
| * create the HTML element (e.g. canvas, div) that the image will be drawn into | |
| * @returns {Element} the div to draw into | |
| */ | |
| _createDrawingElement(){ | |
| return $.makeNeutralElement("div"); | |
| } | |
| /** | |
| * Draws the TiledImages | |
| */ | |
| draw(tiledImages) { | |
| var _this = this; | |
| this._prepareNewFrame(); // prepare to draw a new frame | |
| tiledImages.forEach(function(tiledImage){ | |
| if (tiledImage.opacity !== 0) { | |
| _this._drawTiles(tiledImage); | |
| } | |
| }); | |
| } | |
| /** | |
| * @returns {Boolean} False - rotation is not supported. | |
| */ | |
| canRotate() { | |
| return false; | |
| } | |
| /** | |
| * Destroy the drawer (unload current loaded tiles) | |
| */ | |
| destroy() { | |
| this.container.removeChild(this.canvas); | |
| } | |
| /** | |
| * This function is ignored by the HTML Drawer. Implementing it is required by DrawerBase. | |
| * @param {Boolean} [imageSmoothingEnabled] - Whether or not the image is | |
| * drawn smoothly on the canvas; see imageSmoothingEnabled in | |
| * {@link OpenSeadragon.Options} for more explanation. | |
| */ | |
| setImageSmoothingEnabled(){ | |
| // noop - HTML Drawer does not deal with this property | |
| } | |
| /** | |
| * Clears the Drawer so it's ready to draw another frame. | |
| * @private | |
| * | |
| */ | |
| _prepareNewFrame() { | |
| this.canvas.innerHTML = ""; | |
| } | |
| /** | |
| * Draws a TiledImage. | |
| * @private | |
| * | |
| */ | |
| _drawTiles( tiledImage ) { | |
| var lastDrawn = tiledImage.getTilesToDraw().map(info => info.tile); | |
| if (tiledImage.opacity === 0 || (lastDrawn.length === 0 && !tiledImage.placeholderFillStyle)) { | |
| return; | |
| } | |
| // Iterate over the tiles to draw, and draw them | |
| for (var i = lastDrawn.length - 1; i >= 0; i--) { | |
| var tile = lastDrawn[ i ]; | |
| this._drawTile( tile ); | |
| if( this.viewer ){ | |
| /** | |
| * Raised when a tile is drawn to the canvas. Only valid for | |
| * context2d and html drawers. | |
| * | |
| * @event tile-drawn | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {OpenSeadragon.TiledImage} tiledImage - Which TiledImage is being drawn. | |
| * @property {OpenSeadragon.Tile} tile | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.viewer.raiseEvent( 'tile-drawn', { | |
| tiledImage: tiledImage, | |
| tile: tile | |
| }); | |
| } | |
| } | |
| } | |
| /** | |
| * Draws the given tile. | |
| * @private | |
| * @param {OpenSeadragon.Tile} tile - The tile to draw. | |
| * @param {Function} drawingHandler - Method for firing the drawing event if using canvas. | |
| * drawingHandler({context, tile, rendered}) | |
| */ | |
| _drawTile( tile ) { | |
| $.console.assert(tile, '[Drawer._drawTile] tile is required'); | |
| let container = this.canvas; | |
| if ( !tile.loaded ) { | |
| $.console.warn( | |
| "Attempting to draw tile %s when it's not yet loaded.", | |
| tile.toString() | |
| ); | |
| return; | |
| } | |
| //EXPERIMENTAL - trying to figure out how to scale the container | |
| // content during animation of the container size. | |
| const dataObject = this.getDataToDraw(tile); | |
| if (!dataObject) { | |
| return; | |
| } | |
| if ( dataObject.element.parentNode !== container ) { | |
| container.appendChild( dataObject.element ); | |
| } | |
| if ( dataObject.imgElement.parentNode !== dataObject.element ) { | |
| dataObject.element.appendChild( dataObject.imgElement ); | |
| } | |
| dataObject.style.top = tile.position.y + "px"; | |
| dataObject.style.left = tile.position.x + "px"; | |
| dataObject.style.height = tile.size.y + "px"; | |
| dataObject.style.width = tile.size.x + "px"; | |
| if (tile.flipped) { | |
| dataObject.style.transform = "scaleX(-1)"; | |
| } | |
| $.setElementOpacity( dataObject.element, tile.opacity ); | |
| } | |
| } | |
| $.HTMLDrawer = HTMLDrawer; | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - CanvasDrawer | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| const OpenSeadragon = $; // (re)alias back to OpenSeadragon for JSDoc | |
| /** | |
| * @class OpenSeadragon.CanvasDrawer | |
| * @extends OpenSeadragon.DrawerBase | |
| * @classdesc Default implementation of CanvasDrawer for an {@link OpenSeadragon.Viewer}. | |
| * @param {Object} options - Options for this Drawer. | |
| * @param {OpenSeadragon.Viewer} options.viewer - The Viewer that owns this Drawer. | |
| * @param {OpenSeadragon.Viewport} options.viewport - Reference to Viewer viewport. | |
| * @param {Element} options.element - Parent element. | |
| * @param {Number} [options.debugGridColor] - See debugGridColor in {@link OpenSeadragon.Options} for details. | |
| */ | |
| class CanvasDrawer extends OpenSeadragon.DrawerBase{ | |
| constructor(options) { | |
| super(options); | |
| /** | |
| * The HTML element (canvas) that this drawer uses for drawing | |
| * @member {Element} canvas | |
| * @memberof OpenSeadragon.CanvasDrawer# | |
| */ | |
| /** | |
| * The parent element of this Drawer instance, passed in when the Drawer was created. | |
| * The parent of {@link OpenSeadragon.WebGLDrawer#canvas}. | |
| * @member {Element} container | |
| * @memberof OpenSeadragon.CanvasDrawer# | |
| */ | |
| /** | |
| * 2d drawing context for {@link OpenSeadragon.CanvasDrawer#canvas}. | |
| * @member {Object} context | |
| * @memberof OpenSeadragon.CanvasDrawer# | |
| * @private | |
| */ | |
| this.context = this.canvas.getContext('2d'); | |
| // Sketch canvas used to temporarily draw tiles which cannot be drawn directly | |
| // to the main canvas due to opacity. Lazily initialized. | |
| this.sketchCanvas = null; | |
| this.sketchContext = null; | |
| // Image smoothing for canvas rendering (only if canvas is used). | |
| // Canvas default is "true", so this will only be changed if user specifies "false" in the options or via setImageSmoothinEnabled. | |
| this._imageSmoothingEnabled = true; | |
| // Since the tile-drawn and tile-drawing events are fired by this drawer, make sure handlers can be added for them | |
| this.viewer.allowEventHandler("tile-drawn"); | |
| this.viewer.allowEventHandler("tile-drawing"); | |
| } | |
| /** | |
| * @returns {Boolean} true if canvas is supported by the browser, otherwise false | |
| */ | |
| static isSupported(){ | |
| return $.supportsCanvas; | |
| } | |
| getType(){ | |
| return 'canvas'; | |
| } | |
| getSupportedDataFormats() { | |
| return ["context2d"]; | |
| } | |
| /** | |
| * create the HTML element (e.g. canvas, div) that the image will be drawn into | |
| * @returns {Element} the canvas to draw into | |
| */ | |
| _createDrawingElement(){ | |
| let canvas = $.makeNeutralElement("canvas"); | |
| let viewportSize = this._calculateCanvasSize(); | |
| canvas.width = viewportSize.x; | |
| canvas.height = viewportSize.y; | |
| return canvas; | |
| } | |
| /** | |
| * Draws the TiledImages | |
| */ | |
| draw(tiledImages) { | |
| this._prepareNewFrame(); // prepare to draw a new frame | |
| if(this.viewer.viewport.getFlip() !== this._viewportFlipped){ | |
| this._flip(); | |
| } | |
| for(const tiledImage of tiledImages){ | |
| if (tiledImage.opacity !== 0) { | |
| this._drawTiles(tiledImage); | |
| } | |
| } | |
| } | |
| /** | |
| * @returns {Boolean} True - rotation is supported. | |
| */ | |
| canRotate() { | |
| return true; | |
| } | |
| /** | |
| * Destroy the drawer (unload current loaded tiles) | |
| */ | |
| destroy() { | |
| //force unloading of current canvas (1x1 will be gc later, trick not necessarily needed) | |
| this.canvas.width = 1; | |
| this.canvas.height = 1; | |
| this.sketchCanvas = null; | |
| this.sketchContext = null; | |
| this.container.removeChild(this.canvas); | |
| } | |
| /** | |
| * @param {TiledImage} tiledImage the tiled image that is calling the function | |
| * @returns {Boolean} Whether this drawer requires enforcing minimum tile overlap to avoid showing seams. | |
| * @private | |
| */ | |
| minimumOverlapRequired(tiledImage) { | |
| return true; | |
| } | |
| /** | |
| * Turns image smoothing on or off for this viewer. Note: Ignored in some (especially older) browsers that do not support this property. | |
| * | |
| * @function | |
| * @param {Boolean} [imageSmoothingEnabled] - Whether or not the image is | |
| * drawn smoothly on the canvas; see imageSmoothingEnabled in | |
| * {@link OpenSeadragon.Options} for more explanation. | |
| */ | |
| setImageSmoothingEnabled(imageSmoothingEnabled){ | |
| this._imageSmoothingEnabled = !!imageSmoothingEnabled; | |
| this._updateImageSmoothingEnabled(this.context); | |
| this.viewer.forceRedraw(); | |
| } | |
| /** | |
| * Draw a rectangle onto the canvas | |
| * @param {OpenSeadragon.Rect} rect | |
| */ | |
| drawDebuggingRect(rect) { | |
| var context = this.context; | |
| context.save(); | |
| context.lineWidth = 2 * $.pixelDensityRatio; | |
| context.strokeStyle = this.debugGridColor[0]; | |
| context.fillStyle = this.debugGridColor[0]; | |
| context.strokeRect( | |
| rect.x * $.pixelDensityRatio, | |
| rect.y * $.pixelDensityRatio, | |
| rect.width * $.pixelDensityRatio, | |
| rect.height * $.pixelDensityRatio | |
| ); | |
| context.restore(); | |
| } | |
| /** | |
| * Test whether the current context is flipped or not | |
| * @private | |
| */ | |
| get _viewportFlipped(){ | |
| return this.context.getTransform().a < 0; | |
| } | |
| /** | |
| * Fires the tile-drawing event. | |
| * @private | |
| */ | |
| _raiseTileDrawingEvent(tiledImage, context, tile, rendered){ | |
| /** | |
| * This event is fired just before the tile is drawn giving the application a chance to alter the image. | |
| * | |
| * NOTE: This event is only fired when the 'canvas' drawer is being used | |
| * | |
| * @event tile-drawing | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {OpenSeadragon.Tile} tile - The Tile being drawn. | |
| * @property {OpenSeadragon.TiledImage} tiledImage - Which TiledImage is being drawn. | |
| * @property {CanvasRenderingContext2D} context - The HTML canvas context being drawn into. | |
| * @property {CanvasRenderingContext2D} rendered - The HTML canvas context containing the tile imagery. | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.viewer.raiseEvent('tile-drawing', { | |
| tiledImage: tiledImage, | |
| context: context, | |
| tile: tile, | |
| rendered: rendered | |
| }); | |
| } | |
| /** | |
| * Clears the Drawer so it's ready to draw another frame. | |
| * @private | |
| * | |
| */ | |
| _prepareNewFrame() { | |
| var viewportSize = this._calculateCanvasSize(); | |
| if( this.canvas.width !== viewportSize.x || | |
| this.canvas.height !== viewportSize.y ) { | |
| this.canvas.width = viewportSize.x; | |
| this.canvas.height = viewportSize.y; | |
| this._updateImageSmoothingEnabled(this.context); | |
| if ( this.sketchCanvas !== null ) { | |
| var sketchCanvasSize = this._calculateSketchCanvasSize(); | |
| this.sketchCanvas.width = sketchCanvasSize.x; | |
| this.sketchCanvas.height = sketchCanvasSize.y; | |
| this._updateImageSmoothingEnabled(this.sketchContext); | |
| } | |
| } | |
| this._clear(); | |
| } | |
| /** | |
| * @private | |
| * @param {Boolean} useSketch Whether to clear sketch canvas or main canvas | |
| * @param {OpenSeadragon.Rect} [bounds] The rectangle to clear | |
| */ | |
| _clear(useSketch, bounds){ | |
| var context = this._getContext(useSketch); | |
| if (bounds) { | |
| context.clearRect(bounds.x, bounds.y, bounds.width, bounds.height); | |
| } else { | |
| var canvas = context.canvas; | |
| context.clearRect(0, 0, canvas.width, canvas.height); | |
| } | |
| } | |
| /** | |
| * Draws a TiledImage. | |
| * @private | |
| * | |
| */ | |
| _drawTiles( tiledImage ) { | |
| const lastDrawn = tiledImage.getTilesToDraw().map(info => info.tile); | |
| if (tiledImage.opacity === 0 || (lastDrawn.length === 0 && !tiledImage.placeholderFillStyle)) { | |
| return; | |
| } | |
| let tile = lastDrawn[0]; | |
| let useSketch; | |
| if (tile) { | |
| useSketch = tiledImage.opacity < 1 || | |
| (tiledImage.compositeOperation && tiledImage.compositeOperation !== 'source-over') || | |
| (!tiledImage._isBottomItem() && | |
| tiledImage.source.hasTransparency(null, tile.getUrl(), tile.ajaxHeaders, tile.postData)); | |
| } | |
| let sketchScale; | |
| let sketchTranslate; | |
| const zoom = this.viewport.getZoom(true); | |
| const imageZoom = tiledImage.viewportToImageZoom(zoom); | |
| if (lastDrawn.length > 1 && | |
| imageZoom > tiledImage.smoothTileEdgesMinZoom && | |
| !tiledImage.iOSDevice && | |
| tiledImage.getRotation(true) % 360 === 0 ){ // TODO: support tile edge smoothing with tiled image rotation. | |
| // When zoomed in a lot (>100%) the tile edges are visible. | |
| // So we have to composite them at ~100% and scale them up together. | |
| // Note: Disabled on iOS devices per default as it causes a native crash | |
| useSketch = true; | |
| const context = tile.length && this.getDataToDraw(tile); | |
| if (context) { | |
| sketchScale = context.canvas.width / (tile.size.x * $.pixelDensityRatio); | |
| } else { | |
| sketchScale = 1; | |
| } | |
| sketchTranslate = tile.getTranslationForEdgeSmoothing(sketchScale, | |
| this._getCanvasSize(false), | |
| this._getCanvasSize(true)); | |
| } | |
| let bounds; | |
| if (useSketch) { | |
| if (!sketchScale) { | |
| // Except when edge smoothing, we only clean the part of the | |
| // sketch canvas we are going to use for performance reasons. | |
| bounds = this.viewport.viewportToViewerElementRectangle( | |
| tiledImage.getClippedBounds(true)) | |
| .getIntegerBoundingBox(); | |
| bounds = bounds.times($.pixelDensityRatio); | |
| } | |
| this._clear(true, bounds); | |
| } | |
| // When scaling, we must rotate only when blending the sketch canvas to | |
| // avoid interpolation | |
| if (!sketchScale) { | |
| this._setRotations(tiledImage, useSketch); | |
| } | |
| let usedClip = false; | |
| if ( tiledImage._clip ) { | |
| this._saveContext(useSketch); | |
| let box = tiledImage.imageToViewportRectangle(tiledImage._clip, true); | |
| box = box.rotate(-tiledImage.getRotation(true), tiledImage._getRotationPoint(true)); | |
| let clipRect = this.viewportToDrawerRectangle(box); | |
| if (sketchScale) { | |
| clipRect = clipRect.times(sketchScale); | |
| } | |
| if (sketchTranslate) { | |
| clipRect = clipRect.translate(sketchTranslate); | |
| } | |
| this._setClip(clipRect, useSketch); | |
| usedClip = true; | |
| } | |
| if (tiledImage._croppingPolygons) { | |
| const self = this; | |
| if(!usedClip){ | |
| this._saveContext(useSketch); | |
| } | |
| try { | |
| const polygons = tiledImage._croppingPolygons.map(function (polygon) { | |
| return polygon.map(function (coord) { | |
| const point = tiledImage | |
| .imageToViewportCoordinates(coord.x, coord.y, true) | |
| .rotate(-tiledImage.getRotation(true), tiledImage._getRotationPoint(true)); | |
| let clipPoint = self.viewportCoordToDrawerCoord(point); | |
| if (sketchScale) { | |
| clipPoint = clipPoint.times(sketchScale); | |
| } | |
| if (sketchTranslate) { // mostly fixes #2312 | |
| clipPoint = clipPoint.plus(sketchTranslate); | |
| } | |
| return clipPoint; | |
| }); | |
| }); | |
| this._clipWithPolygons(polygons, useSketch); | |
| } catch (e) { | |
| $.console.error(e); | |
| } | |
| usedClip = true; | |
| } | |
| tiledImage._hasOpaqueTile = false; | |
| if ( tiledImage.placeholderFillStyle && tiledImage._hasOpaqueTile === false ) { | |
| let placeholderRect = this.viewportToDrawerRectangle(tiledImage.getBoundsNoRotate(true)); | |
| if (sketchScale) { | |
| placeholderRect = placeholderRect.times(sketchScale); | |
| } | |
| if (sketchTranslate) { | |
| placeholderRect = placeholderRect.translate(sketchTranslate); | |
| } | |
| let fillStyle = null; | |
| if ( typeof tiledImage.placeholderFillStyle === "function" ) { | |
| fillStyle = tiledImage.placeholderFillStyle(tiledImage, this.context); | |
| } | |
| else { | |
| fillStyle = tiledImage.placeholderFillStyle; | |
| } | |
| this._drawRectangle(placeholderRect, fillStyle, useSketch); | |
| } | |
| const subPixelRoundingRule = determineSubPixelRoundingRule(tiledImage.subPixelRoundingForTransparency); | |
| let shouldRoundPositionAndSize = false; | |
| if (subPixelRoundingRule === $.SUBPIXEL_ROUNDING_OCCURRENCES.ALWAYS) { | |
| shouldRoundPositionAndSize = true; | |
| } else if (subPixelRoundingRule === $.SUBPIXEL_ROUNDING_OCCURRENCES.ONLY_AT_REST) { | |
| shouldRoundPositionAndSize = !(this.viewer && this.viewer.isAnimating()); | |
| } | |
| // Iterate over the tiles to draw, and draw them | |
| for (let i = 0; i < lastDrawn.length; i++) { | |
| tile = lastDrawn[ i ]; | |
| this._drawTile( tile, tiledImage, useSketch, sketchScale, | |
| sketchTranslate, shouldRoundPositionAndSize, tiledImage.source ); | |
| if( this.viewer ){ | |
| /** | |
| * Raised when a tile is drawn to the canvas. Only valid for | |
| * context2d and html drawers. | |
| * | |
| * @event tile-drawn | |
| * @memberof OpenSeadragon.Viewer | |
| * @type {object} | |
| * @property {OpenSeadragon.Viewer} eventSource - A reference to the Viewer which raised the event. | |
| * @property {OpenSeadragon.TiledImage} tiledImage - Which TiledImage is being drawn. | |
| * @property {OpenSeadragon.Tile} tile | |
| * @property {?Object} userData - Arbitrary subscriber-defined object. | |
| */ | |
| this.viewer.raiseEvent( 'tile-drawn', { | |
| tiledImage: tiledImage, | |
| tile: tile | |
| }); | |
| } | |
| } | |
| if ( usedClip ) { | |
| this._restoreContext( useSketch ); | |
| } | |
| if (!sketchScale) { | |
| if (tiledImage.getRotation(true) % 360 !== 0) { | |
| this._restoreRotationChanges(useSketch); | |
| } | |
| if (this.viewport.getRotation(true) % 360 !== 0) { | |
| this._restoreRotationChanges(useSketch); | |
| } | |
| } | |
| if (useSketch) { | |
| if (sketchScale) { | |
| this._setRotations(tiledImage); | |
| } | |
| this.blendSketch({ | |
| opacity: tiledImage.opacity, | |
| scale: sketchScale, | |
| translate: sketchTranslate, | |
| compositeOperation: tiledImage.compositeOperation, | |
| bounds: bounds | |
| }); | |
| if (sketchScale) { | |
| if (tiledImage.getRotation(true) % 360 !== 0) { | |
| this._restoreRotationChanges(false); | |
| } | |
| if (this.viewport.getRotation(true) % 360 !== 0) { | |
| this._restoreRotationChanges(false); | |
| } | |
| } | |
| } | |
| this._drawDebugInfo( tiledImage, lastDrawn ); | |
| // Fire tiled-image-drawn event. | |
| this._raiseTiledImageDrawnEvent(tiledImage, lastDrawn); | |
| } | |
| /** | |
| * Draws special debug information for a TiledImage if in debug mode. | |
| * @private | |
| * @param {OpenSeadragon.Tile[]} lastDrawn - An unordered list of Tiles drawn last frame. | |
| */ | |
| _drawDebugInfo( tiledImage, lastDrawn ) { | |
| if( tiledImage.debugMode ) { | |
| for ( var i = lastDrawn.length - 1; i >= 0; i-- ) { | |
| var tile = lastDrawn[ i ]; | |
| try { | |
| this._drawDebugInfoOnTile(tile, lastDrawn.length, i, tiledImage); | |
| } catch(e) { | |
| $.console.error(e); | |
| } | |
| } | |
| } | |
| } | |
| /** | |
| * This function will create multiple polygon paths on the drawing context by provided polygons, | |
| * then clip the context to the paths. | |
| * @private | |
| * @param {OpenSeadragon.Point[][]} polygons - an array of polygons. A polygon is an array of OpenSeadragon.Point | |
| * @param {Boolean} useSketch - Whether to use the sketch canvas or not. | |
| */ | |
| _clipWithPolygons (polygons, useSketch) { | |
| var context = this._getContext(useSketch); | |
| context.beginPath(); | |
| for(const polygon of polygons){ | |
| for(const [i, coord] of polygon.entries() ){ | |
| context[i === 0 ? 'moveTo' : 'lineTo'](coord.x, coord.y); | |
| } | |
| } | |
| context.clip(); | |
| } | |
| /** | |
| * Draws the given tile. | |
| * @private | |
| * @param {OpenSeadragon.Tile} tile - The tile to draw. | |
| * @param {OpenSeadragon.TiledImage} tiledImage - The tiled image being drawn. | |
| * @param {Boolean} useSketch - Whether to use the sketch canvas or not. | |
| * where <code>rendered</code> is the context with the pre-drawn image. | |
| * @param {Float} [scale=1] - Apply a scale to tile position and size. Defaults to 1. | |
| * @param {OpenSeadragon.Point} [translate] A translation vector to offset tile position | |
| * @param {Boolean} [shouldRoundPositionAndSize] - Tells whether to round | |
| * position and size of tiles supporting alpha channel in non-transparency | |
| * context. | |
| * @param {OpenSeadragon.TileSource} source - The source specification of the tile. | |
| */ | |
| _drawTile( tile, tiledImage, useSketch, scale, translate, shouldRoundPositionAndSize, source) { | |
| $.console.assert(tile, '[Drawer._drawTile] tile is required'); | |
| $.console.assert(tiledImage, '[Drawer._drawTile] drawingHandler is required'); | |
| if ( !tile.loaded ){ | |
| $.console.warn( | |
| "Attempting to draw tile %s when it's not yet loaded.", | |
| tile.toString() | |
| ); | |
| return; | |
| } | |
| const rendered = this.getDataToDraw(tile); | |
| if (!rendered) { | |
| return; | |
| } | |
| const context = this._getContext(useSketch); | |
| scale = scale || 1; | |
| let position = tile.position.times($.pixelDensityRatio), | |
| size = tile.size.times($.pixelDensityRatio); | |
| context.save(); | |
| if (typeof scale === 'number' && scale !== 1) { | |
| // draw tile at a different scale | |
| position = position.times(scale); | |
| size = size.times(scale); | |
| } | |
| if (translate instanceof $.Point) { | |
| // shift tile position slightly | |
| position = position.plus(translate); | |
| } | |
| //if we are supposed to be rendering fully opaque rectangle, | |
| //ie its done fading or fading is turned off, and if we are drawing | |
| //an image with an alpha channel, then the only way | |
| //to avoid seeing the tile underneath is to clear the rectangle | |
| if (context.globalAlpha === 1 && tile.hasTransparency) { | |
| if (shouldRoundPositionAndSize) { | |
| // Round to the nearest whole pixel so we don't get seams from overlap. | |
| position.x = Math.round(position.x); | |
| position.y = Math.round(position.y); | |
| size.x = Math.round(size.x); | |
| size.y = Math.round(size.y); | |
| } | |
| //clearing only the inside of the rectangle occupied | |
| //by the png prevents edge flikering | |
| context.clearRect( | |
| position.x, | |
| position.y, | |
| size.x, | |
| size.y | |
| ); | |
| } | |
| this._raiseTileDrawingEvent(tiledImage, context, tile, rendered); | |
| let sourceWidth, sourceHeight; | |
| if (tile.sourceBounds) { | |
| sourceWidth = Math.min(tile.sourceBounds.width, rendered.canvas.width); | |
| sourceHeight = Math.min(tile.sourceBounds.height, rendered.canvas.height); | |
| } else { | |
| sourceWidth = rendered.canvas.width; | |
| sourceHeight = rendered.canvas.height; | |
| } | |
| context.translate(position.x + size.x / 2, 0); | |
| if (tile.flipped) { | |
| context.scale(-1, 1); | |
| } | |
| context.drawImage( | |
| rendered.canvas, | |
| 0, | |
| 0, | |
| sourceWidth, | |
| sourceHeight, | |
| -size.x / 2, | |
| position.y, | |
| size.x, | |
| size.y | |
| ); | |
| context.restore(); | |
| } | |
| /** | |
| * Get the context of the main or sketch canvas | |
| * @private | |
| * @param {Boolean} useSketch | |
| * @returns {CanvasRenderingContext2D} | |
| */ | |
| _getContext( useSketch ) { | |
| var context = this.context; | |
| if ( useSketch ) { | |
| if (this.sketchCanvas === null) { | |
| this.sketchCanvas = document.createElement( "canvas" ); | |
| var sketchCanvasSize = this._calculateSketchCanvasSize(); | |
| this.sketchCanvas.width = sketchCanvasSize.x; | |
| this.sketchCanvas.height = sketchCanvasSize.y; | |
| this.sketchContext = this.sketchCanvas.getContext( "2d" ); | |
| // If the viewport is not currently rotated, the sketchCanvas | |
| // will have the same size as the main canvas. However, if | |
| // the viewport get rotated later on, we will need to resize it. | |
| if (this.viewport.getRotation() === 0) { | |
| var self = this; | |
| this.viewer.addHandler('rotate', function resizeSketchCanvas() { | |
| if (self.viewport.getRotation() === 0) { | |
| return; | |
| } | |
| self.viewer.removeHandler('rotate', resizeSketchCanvas); | |
| var sketchCanvasSize = self._calculateSketchCanvasSize(); | |
| self.sketchCanvas.width = sketchCanvasSize.x; | |
| self.sketchCanvas.height = sketchCanvasSize.y; | |
| }); | |
| } | |
| this._updateImageSmoothingEnabled(this.sketchContext); | |
| } | |
| context = this.sketchContext; | |
| } | |
| return context; | |
| } | |
| /** | |
| * Save the context of the main or sketch canvas | |
| * @private | |
| * @param {Boolean} useSketch | |
| */ | |
| _saveContext( useSketch ) { | |
| this._getContext( useSketch ).save(); | |
| } | |
| /** | |
| * Restore the context of the main or sketch canvas | |
| * @private | |
| * @param {Boolean} useSketch | |
| */ | |
| _restoreContext( useSketch ) { | |
| this._getContext( useSketch ).restore(); | |
| } | |
| // private | |
| _setClip(rect, useSketch) { | |
| var context = this._getContext( useSketch ); | |
| context.beginPath(); | |
| context.rect(rect.x, rect.y, rect.width, rect.height); | |
| context.clip(); | |
| } | |
| // private | |
| // used to draw a placeholder rectangle | |
| _drawRectangle(rect, fillStyle, useSketch) { | |
| var context = this._getContext( useSketch ); | |
| context.save(); | |
| context.fillStyle = fillStyle; | |
| context.fillRect(rect.x, rect.y, rect.width, rect.height); | |
| context.restore(); | |
| } | |
| /** | |
| * Blends the sketch canvas in the main canvas. | |
| * @param {Object} options The options | |
| * @param {Float} options.opacity The opacity of the blending. | |
| * @param {Float} [options.scale=1] The scale at which tiles were drawn on | |
| * the sketch. Default is 1. | |
| * Use scale to draw at a lower scale and then enlarge onto the main canvas. | |
| * @param {OpenSeadragon.Point} [options.translate] A translation vector | |
| * that was used to draw the tiles | |
| * @param {String} [options.compositeOperation] - How the image is | |
| * composited onto other images; see compositeOperation in | |
| * {@link OpenSeadragon.Options} for possible values. | |
| * @param {OpenSeadragon.Rect} [options.bounds] The part of the sketch | |
| * canvas to blend in the main canvas. If specified, options.scale and | |
| * options.translate get ignored. | |
| */ | |
| blendSketch(opacity, scale, translate, compositeOperation) { | |
| var options = opacity; | |
| if (!$.isPlainObject(options)) { | |
| options = { | |
| opacity: opacity, | |
| scale: scale, | |
| translate: translate, | |
| compositeOperation: compositeOperation | |
| }; | |
| } | |
| opacity = options.opacity; | |
| compositeOperation = options.compositeOperation; | |
| var bounds = options.bounds; | |
| this.context.save(); | |
| this.context.globalAlpha = opacity; | |
| if (compositeOperation) { | |
| this.context.globalCompositeOperation = compositeOperation; | |
| } | |
| if (bounds) { | |
| // Internet Explorer, Microsoft Edge, and Safari have problems | |
| // when you call context.drawImage with negative x or y | |
| // or x + width or y + height greater than the canvas width or height respectively. | |
| if (bounds.x < 0) { | |
| bounds.width += bounds.x; | |
| bounds.x = 0; | |
| } | |
| if (bounds.x + bounds.width > this.canvas.width) { | |
| bounds.width = this.canvas.width - bounds.x; | |
| } | |
| if (bounds.y < 0) { | |
| bounds.height += bounds.y; | |
| bounds.y = 0; | |
| } | |
| if (bounds.y + bounds.height > this.canvas.height) { | |
| bounds.height = this.canvas.height - bounds.y; | |
| } | |
| this.context.drawImage( | |
| this.sketchCanvas, | |
| bounds.x, | |
| bounds.y, | |
| bounds.width, | |
| bounds.height, | |
| bounds.x, | |
| bounds.y, | |
| bounds.width, | |
| bounds.height | |
| ); | |
| } else { | |
| scale = options.scale || 1; | |
| translate = options.translate; | |
| var position = translate instanceof $.Point ? | |
| translate : new $.Point(0, 0); | |
| var widthExt = 0; | |
| var heightExt = 0; | |
| if (translate) { | |
| var widthDiff = this.sketchCanvas.width - this.canvas.width; | |
| var heightDiff = this.sketchCanvas.height - this.canvas.height; | |
| widthExt = Math.round(widthDiff / 2); | |
| heightExt = Math.round(heightDiff / 2); | |
| } | |
| this.context.drawImage( | |
| this.sketchCanvas, | |
| position.x - widthExt * scale, | |
| position.y - heightExt * scale, | |
| (this.canvas.width + 2 * widthExt) * scale, | |
| (this.canvas.height + 2 * heightExt) * scale, | |
| -widthExt, | |
| -heightExt, | |
| this.canvas.width + 2 * widthExt, | |
| this.canvas.height + 2 * heightExt | |
| ); | |
| } | |
| this.context.restore(); | |
| } | |
| // private | |
| _drawDebugInfoOnTile(tile, count, i, tiledImage) { | |
| var colorIndex = this.viewer.world.getIndexOfItem(tiledImage) % this.debugGridColor.length; | |
| var context = this.context; | |
| context.save(); | |
| context.lineWidth = 2 * $.pixelDensityRatio; | |
| context.font = 'small-caps bold ' + (13 * $.pixelDensityRatio) + 'px arial'; | |
| context.strokeStyle = this.debugGridColor[colorIndex]; | |
| context.fillStyle = this.debugGridColor[colorIndex]; | |
| this._setRotations(tiledImage); | |
| if(this._viewportFlipped){ | |
| this._flip({point: tile.position.plus(tile.size.divide(2))}); | |
| } | |
| context.strokeRect( | |
| tile.position.x * $.pixelDensityRatio, | |
| tile.position.y * $.pixelDensityRatio, | |
| tile.size.x * $.pixelDensityRatio, | |
| tile.size.y * $.pixelDensityRatio | |
| ); | |
| var tileCenterX = (tile.position.x + (tile.size.x / 2)) * $.pixelDensityRatio; | |
| var tileCenterY = (tile.position.y + (tile.size.y / 2)) * $.pixelDensityRatio; | |
| // Rotate the text the right way around. | |
| context.translate( tileCenterX, tileCenterY ); | |
| const angleInDegrees = this.viewport.getRotation(true); | |
| context.rotate( Math.PI / 180 * -angleInDegrees ); | |
| context.translate( -tileCenterX, -tileCenterY ); | |
| if( tile.x === 0 && tile.y === 0 ){ | |
| context.fillText( | |
| "Zoom: " + this.viewport.getZoom(), | |
| tile.position.x * $.pixelDensityRatio, | |
| (tile.position.y - 30) * $.pixelDensityRatio | |
| ); | |
| context.fillText( | |
| "Pan: " + this.viewport.getBounds().toString(), | |
| tile.position.x * $.pixelDensityRatio, | |
| (tile.position.y - 20) * $.pixelDensityRatio | |
| ); | |
| } | |
| context.fillText( | |
| "Level: " + tile.level, | |
| (tile.position.x + 10) * $.pixelDensityRatio, | |
| (tile.position.y + 20) * $.pixelDensityRatio | |
| ); | |
| context.fillText( | |
| "Column: " + tile.x, | |
| (tile.position.x + 10) * $.pixelDensityRatio, | |
| (tile.position.y + 30) * $.pixelDensityRatio | |
| ); | |
| context.fillText( | |
| "Row: " + tile.y, | |
| (tile.position.x + 10) * $.pixelDensityRatio, | |
| (tile.position.y + 40) * $.pixelDensityRatio | |
| ); | |
| context.fillText( | |
| "Order: " + i + " of " + count, | |
| (tile.position.x + 10) * $.pixelDensityRatio, | |
| (tile.position.y + 50) * $.pixelDensityRatio | |
| ); | |
| context.fillText( | |
| "Size: " + tile.size.toString(), | |
| (tile.position.x + 10) * $.pixelDensityRatio, | |
| (tile.position.y + 60) * $.pixelDensityRatio | |
| ); | |
| context.fillText( | |
| "Position: " + tile.position.toString(), | |
| (tile.position.x + 10) * $.pixelDensityRatio, | |
| (tile.position.y + 70) * $.pixelDensityRatio | |
| ); | |
| if (this.viewport.getRotation(true) % 360 !== 0 ) { | |
| this._restoreRotationChanges(); | |
| } | |
| if (tiledImage.getRotation(true) % 360 !== 0) { | |
| this._restoreRotationChanges(); | |
| } | |
| context.restore(); | |
| } | |
| // private | |
| _updateImageSmoothingEnabled(context){ | |
| context.msImageSmoothingEnabled = this._imageSmoothingEnabled; | |
| context.imageSmoothingEnabled = this._imageSmoothingEnabled; | |
| } | |
| /** | |
| * Get the canvas size | |
| * @private | |
| * @param {Boolean} sketch If set to true return the size of the sketch canvas | |
| * @returns {OpenSeadragon.Point} The size of the canvas | |
| */ | |
| _getCanvasSize(sketch) { | |
| var canvas = this._getContext(sketch).canvas; | |
| return new $.Point(canvas.width, canvas.height); | |
| } | |
| /** | |
| * Get the canvas center | |
| * @private | |
| * @param {Boolean} sketch If set to true return the center point of the sketch canvas | |
| * @returns {OpenSeadragon.Point} The center point of the canvas | |
| */ | |
| _getCanvasCenter() { | |
| return new $.Point(this.canvas.width / 2, this.canvas.height / 2); | |
| } | |
| /** | |
| * Set rotations for viewport & tiledImage | |
| * @private | |
| * @param {OpenSeadragon.TiledImage} tiledImage | |
| * @param {Boolean} [useSketch=false] | |
| */ | |
| _setRotations(tiledImage, useSketch = false) { | |
| var saveContext = false; | |
| if (this.viewport.getRotation(true) % 360 !== 0) { | |
| this._offsetForRotation({ | |
| degrees: this.viewport.getRotation(true), | |
| useSketch: useSketch, | |
| saveContext: saveContext | |
| }); | |
| saveContext = false; | |
| } | |
| if (tiledImage.getRotation(true) % 360 !== 0) { | |
| this._offsetForRotation({ | |
| degrees: tiledImage.getRotation(true), | |
| point: this.viewport.pixelFromPointNoRotate( | |
| tiledImage._getRotationPoint(true), true), | |
| useSketch: useSketch, | |
| saveContext: saveContext | |
| }); | |
| } | |
| } | |
| // private | |
| _offsetForRotation(options) { | |
| var point = options.point ? | |
| options.point.times($.pixelDensityRatio) : | |
| this._getCanvasCenter(); | |
| var context = this._getContext(options.useSketch); | |
| context.save(); | |
| context.translate(point.x, point.y); | |
| context.rotate(Math.PI / 180 * options.degrees); | |
| context.translate(-point.x, -point.y); | |
| } | |
| // private | |
| _flip(options) { | |
| options = options || {}; | |
| var point = options.point ? | |
| options.point.times($.pixelDensityRatio) : | |
| this._getCanvasCenter(); | |
| var context = this._getContext(options.useSketch); | |
| context.translate(point.x, 0); | |
| context.scale(-1, 1); | |
| context.translate(-point.x, 0); | |
| } | |
| // private | |
| _restoreRotationChanges(useSketch) { | |
| var context = this._getContext(useSketch); | |
| context.restore(); | |
| } | |
| // private | |
| _calculateCanvasSize() { | |
| var pixelDensityRatio = $.pixelDensityRatio; | |
| var viewportSize = this.viewport.getContainerSize(); | |
| return { | |
| // canvas width and height are integers | |
| x: Math.round(viewportSize.x * pixelDensityRatio), | |
| y: Math.round(viewportSize.y * pixelDensityRatio) | |
| }; | |
| } | |
| // private | |
| _calculateSketchCanvasSize() { | |
| var canvasSize = this._calculateCanvasSize(); | |
| if (this.viewport.getRotation() === 0) { | |
| return canvasSize; | |
| } | |
| // If the viewport is rotated, we need a larger sketch canvas in order | |
| // to support edge smoothing. | |
| var sketchCanvasSize = Math.ceil(Math.sqrt( | |
| canvasSize.x * canvasSize.x + | |
| canvasSize.y * canvasSize.y)); | |
| return { | |
| x: sketchCanvasSize, | |
| y: sketchCanvasSize | |
| }; | |
| } | |
| } | |
| $.CanvasDrawer = CanvasDrawer; | |
| /** | |
| * Defines the value for subpixel rounding to fallback to in case of missing or | |
| * invalid value. | |
| * @private | |
| */ | |
| var DEFAULT_SUBPIXEL_ROUNDING_RULE = $.SUBPIXEL_ROUNDING_OCCURRENCES.NEVER; | |
| /** | |
| * Checks whether the input value is an invalid subpixel rounding enum value. | |
| * @private | |
| * | |
| * @param {SUBPIXEL_ROUNDING_OCCURRENCES} value - The subpixel rounding enum value to check. | |
| * @returns {Boolean} Returns true if the input value is none of the expected | |
| * {@link SUBPIXEL_ROUNDING_OCCURRENCES.ALWAYS}, {@link SUBPIXEL_ROUNDING_OCCURRENCES.ONLY_AT_REST} or {@link SUBPIXEL_ROUNDING_OCCURRENCES.NEVER} value. | |
| */ | |
| function isSubPixelRoundingRuleUnknown(value) { | |
| return value !== $.SUBPIXEL_ROUNDING_OCCURRENCES.ALWAYS && | |
| value !== $.SUBPIXEL_ROUNDING_OCCURRENCES.ONLY_AT_REST && | |
| value !== $.SUBPIXEL_ROUNDING_OCCURRENCES.NEVER; | |
| } | |
| /** | |
| * Ensures the returned value is always a valid subpixel rounding enum value, | |
| * defaulting to {@link SUBPIXEL_ROUNDING_OCCURRENCES.NEVER} if input is missing or invalid. | |
| * @private | |
| * @param {SUBPIXEL_ROUNDING_OCCURRENCES} value - The subpixel rounding enum value to normalize. | |
| * @returns {SUBPIXEL_ROUNDING_OCCURRENCES} Returns a valid subpixel rounding enum value. | |
| */ | |
| function normalizeSubPixelRoundingRule(value) { | |
| if (isSubPixelRoundingRuleUnknown(value)) { | |
| return DEFAULT_SUBPIXEL_ROUNDING_RULE; | |
| } | |
| return value; | |
| } | |
| /** | |
| * Ensures the returned value is always a valid subpixel rounding enum value, | |
| * defaulting to 'NEVER' if input is missing or invalid. | |
| * @private | |
| * | |
| * @param {Object} subPixelRoundingRules - A subpixel rounding enum values dictionary [{@link BROWSERS}] --> {@link SUBPIXEL_ROUNDING_OCCURRENCES}. | |
| * @returns {SUBPIXEL_ROUNDING_OCCURRENCES} Returns the determined subpixel rounding enum value for the | |
| * current browser. | |
| */ | |
| function determineSubPixelRoundingRule(subPixelRoundingRules) { | |
| if (typeof subPixelRoundingRules === 'number') { | |
| return normalizeSubPixelRoundingRule(subPixelRoundingRules); | |
| } | |
| if (!subPixelRoundingRules || !$.Browser) { | |
| return DEFAULT_SUBPIXEL_ROUNDING_RULE; | |
| } | |
| var subPixelRoundingRule = subPixelRoundingRules[$.Browser.vendor]; | |
| if (isSubPixelRoundingRuleUnknown(subPixelRoundingRule)) { | |
| subPixelRoundingRule = subPixelRoundingRules['*']; | |
| } | |
| return normalizeSubPixelRoundingRule(subPixelRoundingRule); | |
| } | |
| }( OpenSeadragon )); | |
| /* | |
| * OpenSeadragon - WebGLDrawer | |
| * | |
| * Copyright (C) 2009 CodePlex Foundation | |
| * Copyright (C) 2010-2024 OpenSeadragon contributors | |
| * | |
| * Redistribution and use in source and binary forms, with or without | |
| * modification, are permitted provided that the following conditions are | |
| * met: | |
| * | |
| * - Redistributions of source code must retain the above copyright notice, | |
| * this list of conditions and the following disclaimer. | |
| * | |
| * - Redistributions in binary form must reproduce the above copyright | |
| * notice, this list of conditions and the following disclaimer in the | |
| * documentation and/or other materials provided with the distribution. | |
| * | |
| * - Neither the name of CodePlex Foundation nor the names of its | |
| * contributors may be used to endorse or promote products derived from | |
| * this software without specific prior written permission. | |
| * | |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | |
| * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| */ | |
| (function( $ ){ | |
| const OpenSeadragon = $; // alias for JSDoc | |
| /** | |
| * @class OpenSeadragon.WebGLDrawer | |
| * @classdesc Default implementation of WebGLDrawer for an {@link OpenSeadragon.Viewer}. The WebGLDrawer | |
| * defines its own data type that ensures textures are correctly loaded to and deleted from the GPU memory. | |
| * The drawer utilizes a context-dependent two pass drawing pipeline. For the first pass, tile composition | |
| * for a given TiledImage is always done using a canvas with a WebGL context. This allows tiles to be stitched | |
| * together without seams or artifacts, without requiring a tile source with overlap. If overlap is present, | |
| * overlapping pixels are discarded. The second pass copies all pixel data from the WebGL context onto an output | |
| * canvas with a Context2d context. This allows applications to have access to pixel data and other functionality | |
| * provided by Context2d, regardless of whether the CanvasDrawer or the WebGLDrawer is used. Certain options, | |
| * including compositeOperation, clip, croppingPolygons, and debugMode are implemented using Context2d operations; | |
| * in these scenarios, each TiledImage is drawn onto the output canvas immediately after the tile composition step | |
| * (pass 1). Otherwise, for efficiency, all TiledImages are copied over to the output canvas at once, after all | |
| * tiles have been composited for all images. | |
| * @param {Object} options - Options for this Drawer. | |
| * @param {OpenSeadragon.Viewer} options.viewer - The Viewer that owns this Drawer. | |
| * @param {OpenSeadragon.Viewport} options.viewport - Reference to Viewer viewport. | |
| * @param {Element} options.element - Parent element. | |
| * @param {Number} [options.debugGridColor] - See debugGridColor in {@link OpenSeadragon.Options} for details. | |
| */ | |
| OpenSeadragon.WebGLDrawer = class WebGLDrawer extends OpenSeadragon.DrawerBase{ | |
| constructor(options){ | |
| super(options); | |
| /** | |
| * The HTML element (canvas) that this drawer uses for drawing | |
| * @member {Element} canvas | |
| * @memberof OpenSeadragon.WebGLDrawer# | |
| */ | |
| /** | |
| * The parent element of this Drawer instance, passed in when the Drawer was created. | |
| * The parent of {@link OpenSeadragon.WebGLDrawer#canvas}. | |
| * @member {Element} container | |
| * @memberof OpenSeadragon.WebGLDrawer# | |
| */ | |
| // private members | |
| this._destroyed = false; | |
| this._gl = null; | |
| this._firstPass = null; | |
| this._secondPass = null; | |
| this._glFrameBuffer = null; | |
| this._renderToTexture = null; | |
| this._outputCanvas = null; | |
| this._outputContext = null; | |
| this._clippingCanvas = null; | |
| this._clippingContext = null; | |
| this._renderingCanvas = null; | |
| this._backupCanvasDrawer = null; | |
| this._imageSmoothingEnabled = true; // will be updated by setImageSmoothingEnabled | |
| // Reject listening for the tile-drawing and tile-drawn events, which this drawer does not fire | |
| this.viewer.rejectEventHandler("tile-drawn", "The WebGLDrawer does not raise the tile-drawn event"); | |
| this.viewer.rejectEventHandler("tile-drawing", "The WebGLDrawer does not raise the tile-drawing event"); | |
| // this.viewer and this.canvas are part of the public DrawerBase API | |
| // and are defined by the parent DrawerBase class. Additional setup is done by | |
| // the private _setupCanvases and _setupRenderer functions. | |
| this._setupCanvases(); | |
| this._setupRenderer(); | |
| this._supportedFormats = ["context2d", "image"]; | |
| this.context = this._outputContext; // API required by tests | |
| } | |
| get defaultOptions() { | |
| return { | |
| // use detached cache: our type conversion will not collide (and does not have to preserve CPU data ref) | |
| usePrivateCache: true, | |
| preloadCache: false, | |
| }; | |
| } | |
| getSupportedDataFormats() { | |
| return this._supportedFormats; | |
| } | |
| // Public API required by all Drawer implementations | |
| /** | |
| * Clean up the renderer, removing all resources | |
| */ | |
| destroy(){ | |
| if(this._destroyed){ | |
| return; | |
| } | |
| // clear all resources used by the renderer, geometries, textures etc | |
| let gl = this._gl; | |
| // adapted from https://stackoverflow.com/a/23606581/1214731 | |
| var numTextureUnits = gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS); | |
| for (let unit = 0; unit < numTextureUnits; ++unit) { | |
| gl.activeTexture(gl.TEXTURE0 + unit); | |
| gl.bindTexture(gl.TEXTURE_2D, null); | |
| gl.bindTexture(gl.TEXTURE_CUBE_MAP, null); | |
| } | |
| gl.bindBuffer(gl.ARRAY_BUFFER, null); | |
| gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, null); | |
| gl.bindRenderbuffer(gl.RENDERBUFFER, null); | |
| gl.bindFramebuffer(gl.FRAMEBUFFER, null); | |
| // Delete all our created resources | |
| gl.deleteBuffer(this._secondPass.bufferOutputPosition); | |
| gl.deleteFramebuffer(this._glFrameBuffer); | |
| // make canvases 1 x 1 px and delete references | |
| this._renderingCanvas.width = this._renderingCanvas.height = 1; | |
| this._clippingCanvas.width = this._clippingCanvas.height = 1; | |
| this._outputCanvas.width = this._outputCanvas.height = 1; | |
| this._renderingCanvas = null; | |
| this._clippingCanvas = this._clippingContext = null; | |
| this._outputCanvas = this._outputContext = null; | |
| let ext = gl.getExtension('WEBGL_lose_context'); | |
| if(ext){ | |
| ext.loseContext(); | |
| } | |
| // set our webgl context reference to null to enable garbage collection | |
| this._gl = null; | |
| if(this._backupCanvasDrawer){ | |
| this._backupCanvasDrawer.destroy(); | |
| this._backupCanvasDrawer = null; | |
| } | |
| this.container.removeChild(this.canvas); | |
| if(this.viewer.drawer === this){ | |
| this.viewer.drawer = null; | |
| } | |
| this.destroyInternalCache(); | |
| // set our destroyed flag to true | |
| this._destroyed = true; | |
| } | |
| // Public API required by all Drawer implementations | |
| /** | |
| * | |
| * @returns {Boolean} true | |
| */ | |
| canRotate(){ | |
| return true; | |
| } | |
| // Public API required by all Drawer implementations | |
| /** | |
| * @returns {Boolean} true if canvas and webgl are supported | |
| */ | |
| static isSupported(){ | |
| let canvasElement = document.createElement( 'canvas' ); | |
| let webglContext = $.isFunction( canvasElement.getContext ) && | |
| canvasElement.getContext( 'webgl' ); | |
| let ext = webglContext && webglContext.getExtension('WEBGL_lose_context'); | |
| if(ext){ | |
| ext.loseContext(); | |
| } | |
| return !!( webglContext ); | |
| } | |
| /** | |
| * | |
| * @returns {string} 'webgl' | |
| */ | |
| getType(){ | |
| return 'webgl'; | |
| } | |
| /** | |
| * @param {TiledImage} tiledImage the tiled image that is calling the function | |
| * @returns {Boolean} Whether this drawer requires enforcing minimum tile overlap to avoid showing seams. | |
| * @private | |
| */ | |
| minimumOverlapRequired(tiledImage) { | |
| // return true if the tiled image is tainted, since the backup canvas drawer will be used. | |
| return tiledImage.isTainted(); | |
| } | |
| /** | |
| * create the HTML element (canvas in this case) that the image will be drawn into | |
| * @private | |
| * @returns {Element} the canvas to draw into | |
| */ | |
| _createDrawingElement(){ | |
| let canvas = $.makeNeutralElement("canvas"); | |
| let viewportSize = this._calculateCanvasSize(); | |
| canvas.width = viewportSize.x; | |
| canvas.height = viewportSize.y; | |
| return canvas; | |
| } | |
| /** | |
| * Get the backup renderer (CanvasDrawer) to use if data cannot be used by webgl | |
| * Lazy loaded | |
| * @private | |
| * @returns {CanvasDrawer} | |
| */ | |
| _getBackupCanvasDrawer(){ | |
| if(!this._backupCanvasDrawer){ | |
| this._backupCanvasDrawer = this.viewer.requestDrawer('canvas', {mainDrawer: false}); | |
| this._backupCanvasDrawer.canvas.style.setProperty('visibility', 'hidden'); | |
| this._backupCanvasDrawer.getSupportedDataFormats = () => this._supportedFormats; | |
| this._backupCanvasDrawer.getDataToDraw = this.getDataToDraw.bind(this); | |
| } | |
| return this._backupCanvasDrawer; | |
| } | |
| /** | |
| * | |
| * @param {Array} tiledImages Array of TiledImage objects to draw | |
| */ | |
| draw(tiledImages){ | |
| let gl = this._gl; | |
| const bounds = this.viewport.getBoundsNoRotateWithMargins(true); | |
| let view = { | |
| bounds: bounds, | |
| center: new OpenSeadragon.Point(bounds.x + bounds.width / 2, bounds.y + bounds.height / 2), | |
| rotation: this.viewport.getRotation(true) * Math.PI / 180 | |
| }; | |
| let flipMultiplier = this.viewport.flipped ? -1 : 1; | |
| // calculate view matrix for viewer | |
| let posMatrix = $.Mat3.makeTranslation(-view.center.x, -view.center.y); | |
| let scaleMatrix = $.Mat3.makeScaling(2 / view.bounds.width * flipMultiplier, -2 / view.bounds.height); | |
| let rotMatrix = $.Mat3.makeRotation(-view.rotation); | |
| let viewMatrix = scaleMatrix.multiply(rotMatrix).multiply(posMatrix); | |
| gl.bindFramebuffer(gl.FRAMEBUFFER, null); | |
| gl.clear(gl.COLOR_BUFFER_BIT); // clear the back buffer | |
| // clear the output canvas | |
| this._outputContext.clearRect(0, 0, this._outputCanvas.width, this._outputCanvas.height); | |
| let renderingBufferHasImageData = false; | |
| //iterate over tiled images and draw each one using a two-pass rendering pipeline if needed | |
| tiledImages.forEach( (tiledImage, tiledImageIndex) => { | |
| if(tiledImage.isTainted()){ | |
| // first, draw any data left in the rendering buffer onto the output canvas | |
| if(renderingBufferHasImageData){ | |
| this._outputContext.drawImage(this._renderingCanvas, 0, 0); | |
| // clear the buffer | |
| gl.bindFramebuffer(gl.FRAMEBUFFER, null); | |
| gl.clear(gl.COLOR_BUFFER_BIT); // clear the back buffer | |
| renderingBufferHasImageData = false; | |
| } | |
| // next, use the backup canvas drawer to draw this tainted image | |
| const canvasDrawer = this._getBackupCanvasDrawer(); | |
| canvasDrawer.draw([tiledImage]); | |
| this._outputContext.drawImage(canvasDrawer.canvas, 0, 0); | |
| } else { | |
| let tilesToDraw = tiledImage.getTilesToDraw(); | |
View raw
(Sorry about that, but we can’t show files that are this big right now.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment