gridviz 3.0.15 → 3.0.17

package/src/core/Dataset.js

@@ -1,157 +1,154 @@
-//@ts-check
-'use strict'
-
-/**
- * A grid cell.
- * @typedef {{x: number, y: number}} Cell */
-
-/**
- * A dataset component, of grid cells.
- * @abstract
- *
- * @module core
- * @author Joseph Davies, Julien Gaffuri
- */
-export class Dataset {
-    /**
-     * @param {import("./Map.js").Map} map The map.
-     * @param {string} url The URL of the dataset.
-     * @param {number} resolution The dataset resolution, in the CRS geographical unit.
-     * @param {{preprocess?:function(Cell):boolean, mixedResolution?:function(Cell):number}} opts
-     * @abstract
-     */
-    constructor(map, url, resolution, opts = {}) {
-
-        /**
-         * The map.
-         * @protected
-         * @type {import("./Map.js").Map} */
-        this.map = map
-
-        /**
-         * The url of the dataset.
-         * @protected
-         * @type {string} */
-        this.url = url
-
-        /**
-         * The dataset resolution in geographical unit.
-         * @protected
-         * @type {number} */
-        this.resolution = resolution
-
-        /**
-        * In case the dataset is a dataset with cells having different resolution,
-        * this is the function returning the resolution of each cell.
-        * @protected
-        * @type {(function(Cell):number )| undefined } */
-        this.mixedResolution = opts.mixedResolution
-
-        /**
-         * A preprocess to run on each cell after loading. It can be used to apply some specific treatment before or compute a new column. And also to determine which cells to keep after loading.
-         * @type {(function(Cell):boolean )| undefined } */
-        this.preprocess = opts.preprocess || undefined
-
-        /** The cells within the view
-         * @protected
-         * @type {Array.<Cell>} */
-        this.cellsViewCache = []
-    }
-
-    /**
-     * Request data within a geographic envelope.
-     *
-     * @abstract
-     * @param {import("./GeoCanvas").Envelope|undefined} extGeo
-     * @returns {this}
-     */
-    getData(extGeo = undefined) {
-        throw new Error('Method getData not implemented.')
-    }
-
-    /**
-     * Fill the view cache with all cells which are within a geographical envelope.
-     * @abstract
-     * @param {import("./GeoCanvas").Envelope} extGeo The view geographical envelope.
-     * @returns {void}
-     */
-    updateViewCache(extGeo) {
-        throw new Error('Method updateViewCache not implemented.')
-    }
-
-    /**
-     * Get a cell under a given position, if any.
-     *
-     * @param {{x:number,y:number}} posGeo
-     * @param {Array.<Cell>} cells Some cells from the dataset (a subset if necessary, usually the view cache).
-     * @returns {Cell|undefined}
-     */
-    getCellFromPosition(posGeo, cells) {
-        //compute candidate cell position
-        /** @type {number} */
-        //const r = this.getResolution()
-        /** @type {number} */
-        //const cellX = r * Math.floor(posGeo.x / r)
-        /** @type {number} */
-        //const cellY = r * Math.floor(posGeo.y / r)
-
-        /*/get cell
-        for (const cell of cells) {
-            if (cell.x != cellX) continue
-            if (cell.y != cellY) continue
-            return cell
-        }
-        return undefined*/
-
-        //rare case of mixed resolution dataset
-        if (this.mixedResolution) {
-            for (const c of cells) {
-                /** @type {number} */
-                const r = +this.mixedResolution(c)
-                if (posGeo.x < c.x) continue
-                else if (c.x + r < posGeo.x) continue
-                else if (posGeo.y < c.y) continue
-                else if (c.y + r < posGeo.y) continue
-                else return c
-            }
-            return undefined
-        }
-
-        //common case
-
-        /** @type {number} */
-        const r = this.getResolution()
-        for (const cell of cells) {
-            if (posGeo.x < cell.x) continue
-            else if (cell.x + r < posGeo.x) continue
-            else if (posGeo.y < cell.y) continue
-            else if (cell.y + r < posGeo.y) continue
-            else return cell
-        }
-        return undefined
-
-    }
-
-    //getters and setters
-
-    /** @returns {number} */
-    getResolution() {
-        return this.resolution
-    }
-
-    /** @returns {Array.<Cell>} */
-    getViewCache() {
-        return this.cellsViewCache
-    }
-
-    /**
-     * Return the relevant dataset for a specified zoom.
-     * @param {number} z
-     * @param {number} minPixelsPerCell
-     * @returns {Dataset|undefined}
-     * */
-    getDataset(z, minPixelsPerCell) {
-        return this
-    }
-
-}
+//@ts-check
+'use strict'
+
+/**
+ * A grid cell.
+ * @typedef {{x: number, y: number}} Cell */
+
+/**
+ * A dataset component, of grid cells.
+ * @abstract
+ *
+ * @module core
+ * @author Joseph Davies, Julien Gaffuri
+ */
+export class Dataset {
+    /**
+     * @param {import("./Map.js").Map} map The map.
+     * @param {string} url The URL of the dataset.
+     * @param {number} resolution The dataset resolution, in the CRS geographical unit.
+     * @param {{preprocess?:function(Cell):boolean, mixedResolution?:function(Cell):number}} opts
+     * @abstract
+     */
+    constructor(map, url, resolution, opts = {}) {
+        /**
+         * The map.
+         * @protected
+         * @type {import("./Map.js").Map} */
+        this.map = map
+
+        /**
+         * The url of the dataset.
+         * @protected
+         * @type {string} */
+        this.url = url
+
+        /**
+         * The dataset resolution in geographical unit.
+         * @protected
+         * @type {number} */
+        this.resolution = resolution
+
+        /**
+         * In case the dataset is a dataset with cells having different resolution,
+         * this is the function returning the resolution of each cell.
+         * @protected
+         * @type {(function(Cell):number )| undefined } */
+        this.mixedResolution = opts.mixedResolution
+
+        /**
+         * A preprocess to run on each cell after loading. It can be used to apply some specific treatment before or compute a new column. And also to determine which cells to keep after loading.
+         * @type {(function(Cell):boolean )| undefined } */
+        this.preprocess = opts.preprocess || undefined
+
+        /** The cells within the view
+         * @protected
+         * @type {Array.<Cell>} */
+        this.cellsViewCache = []
+    }
+
+    /**
+     * Request data within a geographic envelope.
+     *
+     * @abstract
+     * @param {import("./GeoCanvas").Envelope|undefined} extGeo
+     * @returns {this}
+     */
+    getData(extGeo = undefined) {
+        throw new Error('Method getData not implemented.')
+    }
+
+    /**
+     * Fill the view cache with all cells which are within a geographical envelope.
+     * @abstract
+     * @param {import("./GeoCanvas").Envelope} extGeo The view geographical envelope.
+     * @returns {void}
+     */
+    updateViewCache(extGeo) {
+        throw new Error('Method updateViewCache not implemented.')
+    }
+
+    /**
+     * Get a cell under a given position, if any.
+     *
+     * @param {{x:number,y:number}} posGeo
+     * @param {Array.<Cell>} cells Some cells from the dataset (a subset if necessary, usually the view cache).
+     * @returns {Cell|undefined}
+     */
+    getCellFromPosition(posGeo, cells) {
+        //compute candidate cell position
+        /** @type {number} */
+        //const r = this.getResolution()
+        /** @type {number} */
+        //const cellX = r * Math.floor(posGeo.x / r)
+        /** @type {number} */
+        //const cellY = r * Math.floor(posGeo.y / r)
+
+        /*/get cell
+        for (const cell of cells) {
+            if (cell.x != cellX) continue
+            if (cell.y != cellY) continue
+            return cell
+        }
+        return undefined*/
+
+        //rare case of mixed resolution dataset
+        if (this.mixedResolution) {
+            for (const c of cells) {
+                /** @type {number} */
+                const r = +this.mixedResolution(c)
+                if (posGeo.x < c.x) continue
+                else if (c.x + r < posGeo.x) continue
+                else if (posGeo.y < c.y) continue
+                else if (c.y + r < posGeo.y) continue
+                else return c
+            }
+            return undefined
+        }
+
+        //common case
+
+        /** @type {number} */
+        const r = this.getResolution()
+        for (const cell of cells) {
+            if (posGeo.x < cell.x) continue
+            else if (cell.x + r < posGeo.x) continue
+            else if (posGeo.y < cell.y) continue
+            else if (cell.y + r < posGeo.y) continue
+            else return cell
+        }
+        return undefined
+    }
+
+    //getters and setters
+
+    /** @returns {number} */
+    getResolution() {
+        return this.resolution
+    }
+
+    /** @returns {Array.<Cell>} */
+    getViewCache() {
+        return this.cellsViewCache
+    }
+
+    /**
+     * Return the relevant dataset for a specified zoom.
+     * @param {number} z
+     * @param {number} minPixelsPerCell
+     * @returns {Dataset|undefined}
+     * */
+    getDataset(z, minPixelsPerCell) {
+        return this
+    }
+}

package/src/core/Drawable.js

@@ -1,61 +1,60 @@
-//@ts-check
-'use strict'
-
-/**
- * This is an abstract class used to group elements shared between Layer and Style classes.
- * 
- * @abstract
- * @module core
- * @author Joseph Davies, Julien Gaffuri
- */
-export class Drawable {
-    /**
-     * @param {object} opts
-     */
-    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} */
-        this.visible = opts.visible
-
-        /** A function returning the alpha (transparency/opacity), between 0.0 (fully transparent) and 1.0 (fully opaque).
-         *  The function parameter is the zoom level.
-         * (see CanvasRenderingContext2D: globalAlpha property)
-         * @type {(function(number):number)|undefined} */
-        this.alpha = opts.alpha
-
-        /** A function returning the blend operation.
-         * The function parameter is the zoom level.
-         * (see CanvasRenderingContext2D: globalCompositeOperation property)
-         * @type {function(number):GlobalCompositeOperation} */
-        this.blendOperation = opts.blendOperation || (z => "source-over")
-
-        /** @type {(function(number):string)|undefined} */
-        this.filterColor = opts.filterColor // (z) => "#eee7"
-    }
-
-    /**
-     * Draw layer filter.
-     * 
-     * @param {import("./GeoCanvas.js").GeoCanvas} geoCanvas The canvas where to draw the layer.
-     * @returns {void}
-     * @abstract
-     */
-    drawFilter(geoCanvas) {
-        //no filter: return
-        if (!this.filterColor) return
-
-        //get filter
-        const fc = this.filterColor(geoCanvas.view.z)
-
-        //no filter: return
-        if (!fc || fc == 'none') return
-
-        //draw filter
-        geoCanvas.ctx.fillStyle = fc
-        geoCanvas.ctx.fillRect(0, 0, geoCanvas.w, geoCanvas.h)
-    }
-
-}
+//@ts-check
+'use strict'
+
+/**
+ * This is an abstract class used to group elements shared between Layer and Style classes.
+ *
+ * @abstract
+ * @module core
+ * @author Joseph Davies, Julien Gaffuri
+ */
+export class Drawable {
+    /**
+     * @param {object} opts
+     */
+    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} */
+        this.visible = opts.visible
+
+        /** A function returning the alpha (transparency/opacity), between 0.0 (fully transparent) and 1.0 (fully opaque).
+         *  The function parameter is the zoom level.
+         * (see CanvasRenderingContext2D: globalAlpha property)
+         * @type {(function(number):number)|undefined} */
+        this.alpha = opts.alpha
+
+        /** A function returning the blend operation.
+         * The function parameter is the zoom level.
+         * (see CanvasRenderingContext2D: globalCompositeOperation property)
+         * @type {function(number):GlobalCompositeOperation} */
+        this.blendOperation = opts.blendOperation || ((z) => 'source-over')
+
+        /** @type {(function(number):string)|undefined} */
+        this.filterColor = opts.filterColor // (z) => "#eee7"
+    }
+
+    /**
+     * Draw layer filter.
+     *
+     * @param {import("./GeoCanvas.js").GeoCanvas} geoCanvas The canvas where to draw the layer.
+     * @returns {void}
+     * @abstract
+     */
+    drawFilter(geoCanvas) {
+        //no filter: return
+        if (!this.filterColor) return
+
+        //get filter
+        const fc = this.filterColor(geoCanvas.view.z)
+
+        //no filter: return
+        if (!fc || fc == 'none') return
+
+        //draw filter
+        geoCanvas.offscreenCtx.fillStyle = fc
+        geoCanvas.offscreenCtx.fillRect(0, 0, geoCanvas.w, geoCanvas.h)
+    }
+}