gridviz 3.0.41 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gridviz",
-    "version": "3.0.41",
+    "version": "3.1.0",
     "description": "Visualization tool for gridded statistics",
     "keywords": [
         "statistics",
@@ -41,7 +41,7 @@
         "server": "webpack serve -c webpack.config.dev.cjs",
         "doc": "jsdoc -c docs/jsdoc/jsdoc.conf.json",
         "build-prod": "webpack --config webpack.config.prod.cjs",
-        "test": "jest",
+        "test": "node --test \"test/*.test.js\"",
         "format": "prettier --write ."
     },
     "files": [

package/src/core/Drawable.js

@@ -1,6 +1,19 @@
 //@ts-check
 'use strict'
 
+/**
+ * Tells if an element (a layer or a style) is visible at a zoom level: its visible property is a function of the zoom
+ * level, or a boolean; it is visible when not specified. Works for any object, whether it is a Drawable or not.
+ *
+ * @param {{visible?: (function(number):boolean)|boolean}} element
+ * @param {number} z The zoom level.
+ * @returns {boolean}
+ */
+export function isVisibleAt(element, z) {
+    const v = element.visible
+    return typeof v === 'function' ? !!v(z) : v !== false
+}
+
 /**
  * This is an abstract class used to group elements shared between Layer and Style classes.
  *
@@ -15,9 +28,9 @@ export class Drawable {
     constructor(opts) {
         opts = opts || {}
 
-        /** A function specifying if the element should be visible or not.
-         * The function parameter is the zoom level.
-         * @type {function(number):boolean} */
+        /** Specifies if the element should be visible or not: a function of the zoom level, or a boolean
+         * (to show or hide the element, then call map.redraw()). Visible when not specified.
+         * @type {(function(number):boolean)|boolean|undefined} */
         this.visible = opts.visible
 
         /** A function returning the alpha (transparency/opacity), between 0.0 (fully transparent) and 1.0 (fully opaque).
@@ -38,6 +51,15 @@ export class Drawable {
         this.filterBlendOperation = opts.filterBlendOperation // (z) => "multiply"
     }
 
+    /**
+     * Tells if the element is visible at a zoom level.
+     * @param {number} z The zoom level.
+     * @returns {boolean}
+     */
+    isVisible(z) {
+        return isVisibleAt(this, z)
+    }
+
     /**
      * Draw filter.
      *