Selectively disable annotations

src/lib/annotations/BoxAnnotations.js

@@ -36,17 +36,49 @@ class BoxAnnotations {
         return Array.isArray(this.annotators) ? this.annotators : [];
     }
 
+    /**
+     * Get all annotators for a given viewer.
+     *
+     * @param {string} viewerName - Name of the viewer to get annotators for
+     * @return {Object} Annotator for the viewer
+     */
+    getAnnotatorsForViewer(viewerName, disabledAnnotators = []) {
+        const annotators = this.getAnnotators();
+
+        return annotators.find(
+            (annotator) => !disabledAnnotators.includes(annotator.NAME) && annotator.VIEWER.includes(viewerName)
+        );
+    }
+
     /**
      * Chooses a annotator based on viewer.
      *
-     * @param {Object} viewer - Current preview viewer
+     * @param {Object} viewerName - Current preview viewer name
      * @param {Array} [disabledAnnotators] - List of disabled annotators
-     * @return {Object} The annotator to use
+     * @param {Array} [viewerConfig] - Annotation configuration for a specific viewer
+     * @return {Object|null} A copy of the annotator to use, if available
      */
-    determineAnnotator(viewer, disabledAnnotators = []) {
-        return this.annotators.find(
-            (annotator) => !disabledAnnotators.includes(annotator.NAME) && annotator.VIEWER.includes(viewer)
-        );
+    determineAnnotator(viewerName, disabledAnnotators = [], viewerConfig = {}) {
+        const originalAnnotator = this.getAnnotatorsForViewer(viewerName, disabledAnnotators);
+
+        if (originalAnnotator) {
+            const annotator = Object.assign({}, originalAnnotator);
+            // If explicitly disabled via config, do nothing
+            if (viewerConfig.enabled === false) {
+                return null;
+            }
+
+            // Filter out disabled annotation types
+            if (Array.isArray(viewerConfig.disabledTypes)) {
+                annotator.TYPE = annotator.TYPE.filter((type) => {
+                    return !viewerConfig.disabledTypes.includes(type);
+                });
+            }
+
+            return annotator;
+        }
+
+        return null;
     }
 }
 

src/lib/viewers/BaseViewer.js

@@ -622,28 +622,52 @@ class BaseViewer extends EventEmitter {
     // Annotations
     //--------------------------------------------------------------------------
 
+    /**
+     * Get the configuration for viewer annotations and transform if legacy format.
+     *
+     * @return {Object} An object containing configuration properties.
+     */
+    getViewerAnnotationsConfig() {
+        const config = this.getViewerOption('annotations') || {};
+
+        // Backwards compatability for old boolean flag usage
+        if (typeof config === 'boolean') {
+            return {
+                enabled: config
+            };
+        }
+
+        return config;
+    }
+
     /**
      * Loads the appropriate annotator and loads the file's annotations
      *
      * @protected
      * @return {void}
      */
     loadAnnotator() {
+        // Do nothing if annotations are disabled for the viewer
+        if (!this.areAnnotationsEnabled()) {
+            return;
+        }
+
         /* global BoxAnnotations */
         const boxAnnotations = new BoxAnnotations();
+        // #TODO(@spramod|@jholdstock): remove this after we have annotation instancing
+        const viewerName = this.options.viewer.NAME;
+        const annotationsConfig = this.getViewerAnnotationsConfig();
 
-        this.annotatorConf = boxAnnotations.determineAnnotator(this.options.viewer.NAME);
+        this.annotatorConf = boxAnnotations.determineAnnotator(viewerName, undefined, annotationsConfig);
         if (!this.annotatorConf) {
             return;
         }
 
-        if (this.areAnnotationsEnabled()) {
-            const { file } = this.options;
-            this.canAnnotate = checkPermission(file, PERMISSION_ANNOTATE);
+        const { file } = this.options;
+        this.canAnnotate = checkPermission(file, PERMISSION_ANNOTATE);
 
-            if (this.canAnnotate) {
-                this.initAnnotations();
-            }
+        if (this.canAnnotate) {
+            this.initAnnotations();
         }
     }
 
@@ -696,9 +720,10 @@ class BaseViewer extends EventEmitter {
      */
     areAnnotationsEnabled() {
         // Respect viewer-specific annotation option if it is set
-        const viewerAnnotations = this.getViewerOption('annotations');
-        if (typeof viewerAnnotations === 'boolean') {
-            return viewerAnnotations;
+        const viewerAnnotations = this.getViewerAnnotationsConfig();
+
+        if (viewerAnnotations && viewerAnnotations.enabled !== undefined) {
+            return viewerAnnotations.enabled;
         }
 
         // Otherwise, use global preview annotation option