This static class defines configuration values that can be tweaked to customize Seadragon behavior. Unless otherwise noted, a change to any value will result in immediately visible changes to all viewers.
| Name | Type | Description |
|---|---|---|
| debugMode | Boolean | Whether messages should be logged and fail-fast behavior should be provided. Default is false. |
| animationTime | Number | The amount of time in seconds that animations should last. Default is 1.5. |
| blendTime | Number | The amount of time in seconds that new tiles take to blend from transparent to opaque. Default is 0.5. |
| alwaysBlend | Boolean | Whether tiles should always blend in and out, not just when they're first loaded. Default is false. |
| autoHideControls | Boolean | Whether controls should get automatically hidden when the user's mouse is off the viewer and the image has stopped animating. Default is true. |
| constrainDuringPan | Boolean | Whether the viewport should be constrained during panning (i.e. while the mouse is being is dragged), not just afterwards (i.e. after the mouse has been released). Default is true. |
| immediateRender | Boolean | Whether the most appropriate tiles should always be rendered first, before any lower-res tiles are rendered. This loses the "sharpening" effect and instead creates a very visible "tiling" effect. Default is false. |
| logarithmicZoom | Boolean | Whether the viewport should animate zoom logarithmically instead of linearly. This results in zooming in at the same rate as zooming out. Default is true. |
| wrapHorizontal | Boolean | Whether tiles should be "wrapped" horizontally, so that there are no left or right edges. Default is false. NOTE: this is an experimental API and is not guaranteed to work. The API is also very likely to change in the future. Use at your own risk! |
| wrapVertical | Boolean | Whether tiles should be "wrapped" vertically, so that there are no top or bottom edges. Default is false. NOTE: this is an experimental API and is not guaranteed to work. The API is also very likely to change in the future. Use at your own risk! |
| wrapOverlays | Boolean | Whether overlays should be continually re-positioned to match any horizontal or vertical wrapping. This has no effect if neither wrapHorizontal nor wrapVertical are set. Default is false. NOTE: this is an experimental API and is not guaranteed to work. The API is also very likely to change in the future. Use at your own risk! |
| transformOverlays | Boolean | Whether overlays should be scaled using CSS transforms rather than regular block sizing, in browsers that support it. This smoothly scales overlays and their content, including text, but the results may not appear the same in other browsers. Default is false. NOTE: this is an experimental API and is not guaranteed to work. The API is also very likely to change in the future. Use at your own risk! |
| minZoomDimension | Number | [Deprecated] The minimum size (in screen pixels) of either dimension that can result from zooming out. Default is null. This has been deprecated in favor of minZoomImageRatio, but this will still be respected if it's explicitly set. |
| minZoomImageRatio | Number | The minimum image ratio (image size to viewer size) in both dimensions that can result from zooming out. Default is 0.8. |
| maxZoomPixelRatio | Number | The maximum pixel ratio (screen pixel to content pixel) that can result from zooming in. Default is 2. |
| visibilityRatio | Number | The minimum portion of the viewport that must show visible content in both dimensions. Default is 0.8. |
| springStiffness | Number | Determines how sharply the springs used for animations move. Default is 5.0. |
| imageLoaderLimit | Number | The maximum number of concurrent image downloads that can be performed by each viewer. Default is 2. |
| clickTimeThreshold | Number | The maximum number of milliseconds that can pass between a mousedown and a mouseup for the action to still be considered a "quick" click. Default is 200. |
| clickDistThreshold | Number | The maximum number of pixels the mouse can move between a mousedown and a mouseup for the action to still be considered a "quick" click. Default is 5. |
| zoomPerClick | Number | The factor by which images should zoom when clicked on. Default is 2. |
| zoomPerScroll | Number | The factor by which images should zoom when scrolled over. Default is cube root of 2. |
| zoomPerSecond | Number | The factor by which images should zoom over each second when the zoom buttons are held down. Default is 2. |
| proxyUrl | String | The URL to prefix before any AJAX requests to overcome browser cross-site restrictions. The URL should be of the form "some/proxy.aspx?site=", so that the target site URL is passed as a GET parameter to the proxy. This URL can be absolute or relative, but must be on the same domain as the HTML page. If relative, it must be relative to the HTML page. Default is null. |
| imagePath | String | The path for all UI images. This can be absolute or relative. If relative, it must be relative to the HTML page. A change to this value will only affect new viewers. Default is "img/" for the distributed version of this library, and "http://seadragon.com/ajax/0.8/img/" for the version hosted on seadragon.com. |