gridviz 2.1.9 → 2.1.10

package/src/Dataset.js

@@ -1,76 +1,76 @@
-//@ts-check
-'use strict'
-
-/**
- * A grid cell.
- * @typedef {{x: number, y: number}} Cell */
-/**
- * An envelope.
- * @typedef { {xMin: number, xMax: number, yMin: number, yMax: number} } Envelope */
-
-/**
- * A multi resolution dataset of grid cells.
- * It consists of different {@link DatasetComponent}s for each resolution.
- *
- * @abstract
- *
- * @author Joseph Davies, Julien Gaffuri
- */
-export class Dataset {
-    /**
-     * @param {Array.<import("./DatasetComponent").DatasetComponent>} datasetComponents The dataset components
-     * @param {Array.<number>} resolutions The resolutions of the dataset components, in CRS geographical unit
-     * @param { {preprocess?:function(Cell):boolean} } opts Options. preprocess: A function to apply on each dataset cell to prepare its values. Can be used also to select cells to keep.
-     */
-    constructor(datasetComponents, resolutions, opts = {}) {
-        opts = opts || {}
-
-        /** The dataset components.
-         * @type {Array.<import("./DatasetComponent").DatasetComponent>} */
-        this.datasetComponents = datasetComponents
-
-        /** The resolutions of the dataset components, in CRS geographical unit.
-         * @type {Array.<number>} */
-        this.resolutions = resolutions
-
-        //there must be as many dataset components as resolutions
-        if (this.datasetComponents.length > 1 && this.datasetComponents.length != this.resolutions.length)
-            throw new Error(
-                'Uncompatible number of datasets and resolutions: ' +
-                    this.datasetComponents.length +
-                    ' ' +
-                    this.resolutions.length
-            )
-
-        //set dataset preprocesses if specified
-        if (opts.preprocess) this.setPrepocesses(opts.preprocess)
-    }
-
-    /**
-     * Set a preprocess function for all dataset components.
-     * This is a function applied on each cell after it has been loaded.
-     *
-     * @param {function(Cell):boolean} preprocess
-     * @returns {this}
-     */
-    setPrepocesses(preprocess) {
-        for (let ds of this.datasetComponents) ds.preprocess = preprocess
-        return this
-    }
-
-    /**
-     * A function to ease the creation of datasets from their components.
-     *
-     * @param {Array.<number>} resolutions The resolutions of the dataset components, in CRS geographical unit
-     * @param {function(number):import("./DatasetComponent").DatasetComponent} resToDatasetComponent Function returning a dataset component from a resolution
-     * @param { {preprocess?:function(Cell):boolean} } opts Options. preprocess: A function to apply on each dataset cell to prepare its values
-     * @returns {Dataset}
-     */
-    static make(resolutions, resToDatasetComponent, opts) {
-        //make dataset components
-        const dsc = []
-        for (const res of resolutions) dsc.push(resToDatasetComponent(res))
-        //make dataset
-        return new Dataset(dsc, resolutions, opts)
-    }
-}
+//@ts-check
+'use strict'
+
+/**
+ * A grid cell.
+ * @typedef {{x: number, y: number}} Cell */
+/**
+ * An envelope.
+ * @typedef { {xMin: number, xMax: number, yMin: number, yMax: number} } Envelope */
+
+/**
+ * A multi resolution dataset of grid cells.
+ * It consists of different {@link DatasetComponent}s for each resolution.
+ *
+ * @abstract
+ *
+ * @author Joseph Davies, Julien Gaffuri
+ */
+export class Dataset {
+    /**
+     * @param {Array.<import("./DatasetComponent").DatasetComponent>} datasetComponents The dataset components
+     * @param {Array.<number>} resolutions The resolutions of the dataset components, in CRS geographical unit
+     * @param { {preprocess?:function(Cell):boolean} } opts Options. preprocess: A function to apply on each dataset cell to prepare its values. Can be used also to select cells to keep.
+     */
+    constructor(datasetComponents, resolutions, opts = {}) {
+        opts = opts || {}
+
+        /** The dataset components.
+         * @type {Array.<import("./DatasetComponent").DatasetComponent>} */
+        this.datasetComponents = datasetComponents
+
+        /** The resolutions of the dataset components, in CRS geographical unit.
+         * @type {Array.<number>} */
+        this.resolutions = resolutions
+
+        //there must be as many dataset components as resolutions
+        if (this.datasetComponents.length > 1 && this.datasetComponents.length != this.resolutions.length)
+            throw new Error(
+                'Uncompatible number of datasets and resolutions: ' +
+                    this.datasetComponents.length +
+                    ' ' +
+                    this.resolutions.length
+            )
+
+        //set dataset preprocesses if specified
+        if (opts.preprocess) this.setPrepocesses(opts.preprocess)
+    }
+
+    /**
+     * Set a preprocess function for all dataset components.
+     * This is a function applied on each cell after it has been loaded.
+     *
+     * @param {function(Cell):boolean} preprocess
+     * @returns {this}
+     */
+    setPrepocesses(preprocess) {
+        for (let ds of this.datasetComponents) ds.preprocess = preprocess
+        return this
+    }
+
+    /**
+     * A function to ease the creation of datasets from their components.
+     *
+     * @param {Array.<number>} resolutions The resolutions of the dataset components, in CRS geographical unit
+     * @param {function(number):import("./DatasetComponent").DatasetComponent} resToDatasetComponent Function returning a dataset component from a resolution
+     * @param { {preprocess?:function(Cell):boolean} } opts Options. preprocess: A function to apply on each dataset cell to prepare its values
+     * @returns {Dataset}
+     */
+    static make(resolutions, resToDatasetComponent, opts) {
+        //make dataset components
+        const dsc = []
+        for (const res of resolutions) dsc.push(resToDatasetComponent(res))
+        //make dataset
+        return new Dataset(dsc, resolutions, opts)
+    }
+}

package/src/DatasetComponent.js

@@ -1,101 +1,113 @@
-//@ts-check
-'use strict'
-
-/**
- * A dataset component, of grid cells.
- * @abstract
- *
- * @author Joseph Davies, Julien Gaffuri
- */
-export class DatasetComponent {
-    /**
-     * @param {string} url The URL of the dataset.
-     * @param {number} resolution The dataset resolution, in the CRS geographical unit.
-     * @param {{preprocess?:function(import("./Dataset").Cell):boolean}} opts
-     * @abstract
-     */
-    constructor(url, resolution, opts = {}) {
-        opts = opts || {}
-
-        /**
-         * The url of the dataset.
-         * @protected
-         * @type {string} */
-        this.url = url
-
-        /**
-         * The dataset resolution in geographical unit.
-         * @protected
-         * @type {number} */
-        this.resolution = resolution
-
-        /**
-         * 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(import("./Dataset").Cell):boolean )| undefined } */
-        this.preprocess = opts.preprocess || undefined
-
-        /** The cells within the view
-         * @protected
-         * @type {Array.<import("./Dataset").Cell>} */
-        this.cellsViewCache = []
-    }
-
-    /**
-     * Request data within a geographic envelope.
-     *
-     * @abstract
-     * @param {import("./Dataset").Envelope|undefined} extGeo
-     * @param {function():void} callback
-     * @returns {this}
-     */
-    getData(extGeo, callback) {
-        throw new Error('Method getData not implemented.')
-    }
-
-    /**
-     * Fill the view cache with all cells which are within a geographical envelope.
-     * @abstract
-     * @param {import("./Dataset").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.<import("./Dataset").Cell>} cells Some cells from the dataset (a subset if necessary, usually the view cache).
-     * @returns {import("./Dataset").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
-    }
-
-    //getters and setters
-
-    /** @returns {number} */
-    getResolution() {
-        return this.resolution
-    }
-
-    /** @returns {Array.<import("./Dataset").Cell>} */
-    getViewCache() {
-        return this.cellsViewCache
-    }
-}
+//@ts-check
+'use strict'
+
+/**
+ * A dataset component, of grid cells.
+ * @abstract
+ *
+ * @author Joseph Davies, Julien Gaffuri
+ */
+export class DatasetComponent {
+    /**
+     * @param {string} url The URL of the dataset.
+     * @param {number} resolution The dataset resolution, in the CRS geographical unit.
+     * @param {{preprocess?:function(import("./Dataset").Cell):boolean}} opts
+     * @abstract
+     */
+    constructor(url, resolution, opts = {}) {
+        opts = opts || {}
+
+        /**
+         * The url of the dataset.
+         * @protected
+         * @type {string} */
+        this.url = url
+
+        /**
+         * The dataset resolution in geographical unit.
+         * @protected
+         * @type {number} */
+        this.resolution = resolution
+
+        /**
+         * 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(import("./Dataset").Cell):boolean )| undefined } */
+        this.preprocess = opts.preprocess || undefined
+
+        /** The cells within the view
+         * @protected
+         * @type {Array.<import("./Dataset").Cell>} */
+        this.cellsViewCache = []
+    }
+
+    /**
+     * Request data within a geographic envelope.
+     *
+     * @abstract
+     * @param {import("./Dataset").Envelope|undefined} extGeo
+     * @param {function():void} callback
+     * @returns {this}
+     */
+    getData(extGeo, callback) {
+        throw new Error('Method getData not implemented.')
+    }
+
+    /**
+     * Fill the view cache with all cells which are within a geographical envelope.
+     * @abstract
+     * @param {import("./Dataset").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.<import("./Dataset").Cell>} cells Some cells from the dataset (a subset if necessary, usually the view cache).
+     * @returns {import("./Dataset").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*/
+
+        /** @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.<import("./Dataset").Cell>} */
+    getViewCache() {
+        return this.cellsViewCache
+    }
+}