show/hide all labels convenience functions

Issue #808
3dmol · Sep 10, 2024 · b54feaf · b54feaf
1 parent 13d8fc5
commit b54feaf
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 3 deletions.
diff --git a/src/GLShape.ts b/src/GLShape.ts
@@ -1675,6 +1675,8 @@ export interface CylinderSpec extends ShapeSpec {
     dashLength?: number;
     /** Length of gaps (default 0.25) */
     gapLength?: number;
+    /** hidden */
+    hidden?: boolean;    
 };
 
 /**

diff --git a/src/GLViewer.ts b/src/GLViewer.ts
@@ -2581,6 +2581,55 @@ export class GLViewer {
         return this;
     };
 
+    /**
+     * Hide all labels in viewer
+     *
+     *         @example
+    $3Dmol.download("pdb:1ubq",viewer,{},function(){
+
+           viewer.addResLabels();
+           viewer.setStyle({},{stick:{}});
+           viewer.render( ); //show labels
+
+           viewer.hideAllLabels();
+           viewer.render(); //hide labels
+    });
+     */
+    public hideAllLabels() {
+        for (var i = 0; i < this.labels.length; i++) {
+            if (this.labels[i]) {
+                this.labels[i].hide();
+            }
+        }
+        this.show();
+        return this;
+    };    
+
+    /**
+     * Show all labels in viewer
+     *
+     *         @example
+    $3Dmol.download("pdb:1ubq",viewer,{},function(){
+
+           viewer.addResLabels();
+           viewer.setStyle({},{stick:{}});
+           viewer.render( ); //show labels
+
+           viewer.hideAllLabels();
+           viewer.showAllLabels();
+           viewer.render(); //hide labels
+    });
+     */
+    public showAllLabels() {
+        for (var i = 0; i < this.labels.length; i++) {
+            if (this.labels[i]) {
+                this.labels[i].show();
+            }
+        }
+        this.show();
+        return this;
+    };        
+
     // Modify label style
     /**
      * Modify existing label's style

diff --git a/src/Label.ts b/src/Label.ts
@@ -125,13 +125,16 @@ export class Label {
 
   /** Hide this label. */
   public hide() {
-    this.sprite.visible = false;
+    if(this.sprite) {
+      this.sprite.visible = false;
+    }
   }
 
   /** Show a hidden label. */
   public show() {
-
-    this.sprite.visible = true;
+    if(this.sprite) {
+      this.sprite.visible = true;
+    }
   }
 
   setContext() {

diff --git a/.../reference-images/tests-glcheck-render-tests-GLViewer_ts_hideAllLabels.html.png b/.../reference-images/tests-glcheck-render-tests-GLViewer_ts_hideAllLabels.html.png
diff --git a/.../reference-images/tests-glcheck-render-tests-GLViewer_ts_showAllLabels.html.png b/.../reference-images/tests-glcheck-render-tests-GLViewer_ts_showAllLabels.html.png