Merge pull request #935 from leesei/master

feat(navigator): add option autoFade
This commit is contained in:
Ian Gilman 2016-05-16 09:40:23 -07:00
commit ea32e1b090
3 changed files with 11 additions and 5 deletions

View File

@ -62,7 +62,7 @@ $.Navigator = function( options ){
options.controlOptions = { options.controlOptions = {
anchor: $.ControlAnchor.TOP_RIGHT, anchor: $.ControlAnchor.TOP_RIGHT,
attachToViewer: true, attachToViewer: true,
autoFade: true autoFade: options.autoFade
}; };
if( options.position ){ if( options.position ){

View File

@ -354,16 +354,16 @@
* *
* @property {String} [navigatorId=navigator-GENERATED DATE] * @property {String} [navigatorId=navigator-GENERATED DATE]
* The ID of a div to hold the navigator minimap. * The ID of a div to hold the navigator minimap.
* If an ID is specified, the navigatorPosition, navigatorSizeRatio, navigatorMaintainSizeRatio, and navigatorTop|Left|Height|Width options will be ignored. * 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. * 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'] * @property {String} [navigatorPosition='TOP_RIGHT']
* Valid values are 'TOP_LEFT', 'TOP_RIGHT', 'BOTTOM_LEFT', 'BOTTOM_RIGHT', or 'ABSOLUTE'.<br> * Valid values are 'TOP_LEFT', 'TOP_RIGHT', 'BOTTOM_LEFT', 'BOTTOM_RIGHT', or 'ABSOLUTE'.<br>
* If 'ABSOLUTE' is specified, then navigatorTop|Left|Height|Width determines the size and position of the navigator minimap in the viewer, and navigatorSizeRatio and navigatorMaintainSizeRatio are ignored.<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 navigatorHeight|Width values determine the size of the navigator minimap. * 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] * @property {Number} [navigatorSizeRatio=0.2]
* Ratio of navigator size to viewer size. Ignored if navigatorHeight|Width are specified. * Ratio of navigator size to viewer size. Ignored if navigator[Height|Width] are specified.
* *
* @property {Boolean} [navigatorMaintainSizeRatio=false] * @property {Boolean} [navigatorMaintainSizeRatio=false]
* If true, the navigator minimap is resized (using navigatorSizeRatio) when the viewer size changes. * If true, the navigator minimap is resized (using navigatorSizeRatio) when the viewer size changes.
@ -386,6 +386,10 @@
* Set to false to prevent polling for navigator size changes. Useful for providing custom resize behavior. * 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. * 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] * @property {Boolean} [navigatorRotate=true]
* If true, the navigator will be rotated together with the viewer. * If true, the navigator will be rotated together with the viewer.
* *
@ -1059,6 +1063,7 @@ if (typeof define === 'function' && define.amd) {
navigatorHeight: null, navigatorHeight: null,
navigatorWidth: null, navigatorWidth: null,
navigatorAutoResize: true, navigatorAutoResize: true,
navigatorAutoFade: true,
navigatorRotate: true, navigatorRotate: true,
// INITIAL ROTATION // INITIAL ROTATION

View File

@ -417,6 +417,7 @@ $.Viewer = function( options ) {
width: this.navigatorWidth, width: this.navigatorWidth,
height: this.navigatorHeight, height: this.navigatorHeight,
autoResize: this.navigatorAutoResize, autoResize: this.navigatorAutoResize,
autoFade: this.navigatorAutoFade,
prefixUrl: this.prefixUrl, prefixUrl: this.prefixUrl,
viewer: this, viewer: this,
navigatorRotate: this.navigatorRotate, navigatorRotate: this.navigatorRotate,