gridviz 3.0.15 → 3.0.17

package/src/core/MultiResolutionDataset.js

@@ -1,97 +1,93 @@
-//@ts-check
-'use strict'
-
-/**
- * A multi resolution dataset of grid cells.
- * It consists of different {@link Dataset}s for each resolution.
- *
- * @abstract
- *
- * @module core
- * @author Joseph Davies, Julien Gaffuri
- */
-export class MultiResolutionDataset {
-    /**
-     * @param {Array.<number>} resolutions The resolutions of the datasets, in CRS geographical unit.
-     * @param {Array.<import("./Dataset").Dataset>|function(number):import("./Dataset").Dataset} datasets The datasets list, one per resolution. Or a function that returns a dataset from a resolution value.
-     * @param { {preprocess?:function(import("./Dataset").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(resolutions, datasets, opts = {}) {
-        opts = opts || {}
-
-        /** The resolutions of the datasets, in CRS geographical unit.
-         * @type {Array.<number>} */
-        this.resolutions = resolutions
-
-        /** The datasets. If the list is not explictely defined, build it from the resolution list with the function
-         * @type {Array.<import("./Dataset").Dataset>} */
-        this.datasets = (typeof datasets === 'function') ? this.resolutions.map(datasets) : datasets
-
-        //there must be as many datasets as resolutions
-        if (this.datasets.length > 1 && this.datasets.length != this.resolutions.length)
-            throw new Error(
-                'Uncompatible number of datasets and resolutions: ' +
-                this.datasets.length +
-                ' ' +
-                this.resolutions.length
-            )
-
-        //set dataset preprocesses if specified
-        if (opts.preprocess) this.setPrepocesses(opts.preprocess)
-    }
-
-
-    /**
-     * Return the relevant dataset for a specified zoom.
-     * @param {number} z
-     * @param {number} minPixelsPerCell
-     * @returns {import("./Dataset").Dataset|undefined}
-     * */
-    getDataset(z, minPixelsPerCell) {
-
-        //special case whith single dataset
-        if (this.datasets.length == 1) return this.datasets[0]
-
-        const rs = this.resolutions
-        let i = 0
-        let z_ = rs[i] / minPixelsPerCell
-        while (z_ < z && i < rs.length) {
-            i++
-            z_ = rs[i] / minPixelsPerCell
-        }
-        //if (i == 0) return this.dataset.datasets[0];
-        //return this.dataset.datasets[i - 1];
-        if (i == rs.length) return this.datasets[rs.length - 1]
-        return this.datasets[i]
-    }
-
-
-
-    /**
-     * Set a preprocess function for all datasets.
-     * This is a function applied on each cell after it has been loaded.
-     *
-     * @param {function(import("./Dataset").Cell):boolean} preprocess
-     * @returns {this}
-     */
-    setPrepocesses(preprocess) {
-        for (let ds of this.datasets) ds.preprocess = preprocess
-        return this
-    }
-
-    /**
-     * A function to ease the creation of multi resolution datasets.
-     *
-     * @param {Array.<number>} resolutions The resolutions of the datasets, in CRS geographical unit
-     * @param {function(number):import("./Dataset").Dataset} resToDataset Function returning a dataset from a resolution
-     * @param { {preprocess?:function(import("./Dataset").Cell):boolean} } opts Options. preprocess: A function to apply on each dataset cell to prepare its values
-     * @returns {MultiResolutionDataset}
-     */
-    /*static make(resolutions, resToDataset, opts) {
-        //make datasets
-        const dsc = []
-        for (const res of resolutions) dsc.push(resToDataset(res))
-        //make multi resolution dataset
-        return new MultiResolutionDataset(dsc, resolutions, opts)
-    }*/
-}
+//@ts-check
+'use strict'
+
+/**
+ * A multi resolution dataset of grid cells.
+ * It consists of different {@link Dataset}s for each resolution.
+ *
+ * @abstract
+ *
+ * @module core
+ * @author Joseph Davies, Julien Gaffuri
+ */
+export class MultiResolutionDataset {
+    /**
+     * @param {Array.<number>} resolutions The resolutions of the datasets, in CRS geographical unit.
+     * @param {Array.<import("./Dataset").Dataset>|function(number):import("./Dataset").Dataset} datasets The datasets list, one per resolution. Or a function that returns a dataset from a resolution value.
+     * @param { {preprocess?:function(import("./Dataset").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(resolutions, datasets, opts = {}) {
+        opts = opts || {}
+
+        /** The resolutions of the datasets, in CRS geographical unit.
+         * @type {Array.<number>} */
+        this.resolutions = resolutions
+
+        /** The datasets. If the list is not explictely defined, build it from the resolution list with the function
+         * @type {Array.<import("./Dataset").Dataset>} */
+        this.datasets = typeof datasets === 'function' ? this.resolutions.map(datasets) : datasets
+
+        //there must be as many datasets as resolutions
+        if (this.datasets.length > 1 && this.datasets.length != this.resolutions.length)
+            throw new Error(
+                'Uncompatible number of datasets and resolutions: ' +
+                    this.datasets.length +
+                    ' ' +
+                    this.resolutions.length
+            )
+
+        //set dataset preprocesses if specified
+        if (opts.preprocess) this.setPrepocesses(opts.preprocess)
+    }
+
+    /**
+     * Return the relevant dataset for a specified zoom.
+     * @param {number} z
+     * @param {number} minPixelsPerCell
+     * @returns {import("./Dataset").Dataset|undefined}
+     * */
+    getDataset(z, minPixelsPerCell) {
+        //special case whith single dataset
+        if (this.datasets.length == 1) return this.datasets[0]
+
+        const rs = this.resolutions
+        let i = 0
+        let z_ = rs[i] / minPixelsPerCell
+        while (z_ < z && i < rs.length) {
+            i++
+            z_ = rs[i] / minPixelsPerCell
+        }
+        //if (i == 0) return this.dataset.datasets[0];
+        //return this.dataset.datasets[i - 1];
+        if (i == rs.length) return this.datasets[rs.length - 1]
+        return this.datasets[i]
+    }
+
+    /**
+     * Set a preprocess function for all datasets.
+     * This is a function applied on each cell after it has been loaded.
+     *
+     * @param {function(import("./Dataset").Cell):boolean} preprocess
+     * @returns {this}
+     */
+    setPrepocesses(preprocess) {
+        for (let ds of this.datasets) ds.preprocess = preprocess
+        return this
+    }
+
+    /**
+     * A function to ease the creation of multi resolution datasets.
+     *
+     * @param {Array.<number>} resolutions The resolutions of the datasets, in CRS geographical unit
+     * @param {function(number):import("./Dataset").Dataset} resToDataset Function returning a dataset from a resolution
+     * @param { {preprocess?:function(import("./Dataset").Cell):boolean} } opts Options. preprocess: A function to apply on each dataset cell to prepare its values
+     * @returns {MultiResolutionDataset}
+     */
+    /*static make(resolutions, resToDataset, opts) {
+        //make datasets
+        const dsc = []
+        for (const res of resolutions) dsc.push(resToDataset(res))
+        //make multi resolution dataset
+        return new MultiResolutionDataset(dsc, resolutions, opts)
+    }*/
+}

package/src/core/Style.js

@@ -1,99 +1,98 @@
-//@ts-check
-'use strict'
-
-import { Drawable } from "./Drawable.js"
-
-/** @typedef {"square"|"circle"|"diamond"|"donut"|"triangle_up"|"triangle_down"|"triangle_left"|"triangle_right"|"none"} Shape */
-
-/**
- * viewScale type
- * Returns an object from a list of cells, 
- * @typedef {function(Array.<import('./Dataset.js').Cell>,number, number):*} ViewScale */
-
-/**
- * A style, to show a grid dataset.
- *
- * @module core
- * @author Joseph Davies, Julien Gaffuri
- */
-export class Style extends Drawable {
-    /**
-     * @abstract
-     * @param {{filter?:function(import('./Dataset').Cell):boolean, offset?:function(import('./Dataset').Cell, number, number):{dx:number,dy:number}, visible?:function(number):boolean,alpha?:function(number):number,blendOperation?:function(number):GlobalCompositeOperation,drawFun?:function,viewScale?:ViewScale}} opts
-     */
-    constructor(opts) {
-        super(opts)
-        opts = opts || {}
-
-        /**
-        * @type {ViewScale|undefined} */
-        this.viewScale = opts.viewScale
-
-        /** A filter function to apply to the cell list, to filter out some cells not to be drawn (such as for example the cells with value=0).
-        * @protected
-        * @type {function(import('./Dataset').Cell):boolean} */
-        this.filter = opts.filter || (() => true)
-
-        /** An offset. This is to alter the position of all symbols in a given direction. In geographical unit.
-         * @protected
-         * @type {function(import('./Dataset').Cell,number,number):{dx:number,dy:number}} */
-        this.offset = opts.offset || ((c, r, z) => ({ dx: 0, dy: 0 }))
-
-        /** A draw function for the style.
-         * @type {function|undefined} */
-        this.drawFun = opts.drawFun
-
-        /**
-         * @public
-         * @type {Array.<import("./Legend").Legend>} */
-        this.legends = []
-    }
-
-    /**
-     * Draw cells.
-     *
-     * @param {Array.<import('./Dataset').Cell>} cells The cells to draw.
-     * @param {import("./GeoCanvas").GeoCanvas} geoCanvas The canvas where to draw them.
-     * @param {number} resolution Their resolution (in geographic unit)
-     * @abstract
-     */
-    draw(cells, geoCanvas, resolution) {
-        if (this.drawFun) this.drawFun(cells, geoCanvas, resolution)
-        else throw new Error('Method draw not implemented.')
-    }
-
-    //getters and setters
-
-    /** @returns {function(import('./Dataset').Cell,number,number):{dx:number,dy:number}} */
-    getOffset() {
-        return this.offset
-    }
-    /** @param {function(import('./Dataset').Cell,number,number):{dx:number,dy:number}} val @returns {this} */
-    setOffset(val) {
-        this.offset = val
-        return this
-    }
-
-    /** Update legends of the style, if any
-     * @param {object} opts
-     * @returns {this} */
-    updateLegends(opts) {
-        Style.updateLegendsRecursive(this.legends, opts)
-        return this
-    }
-
-    /** @private */
-    static updateLegendsRecursive(lg, opts) {
-        if (Array.isArray(lg)) for (const lg_ of lg) this.updateLegendsRecursive(lg_, opts)
-        else lg.update(opts)
-    }
-
-    /**
-     * @param {Array.<import("./Legend").Legend>} legends
-     * @returns {this} */
-    addLegends(legends) {
-        for (let legend of legends)
-            this.legends.push(legend)
-        return this
-    }
-}
+//@ts-check
+'use strict'
+
+import { Drawable } from './Drawable.js'
+
+/** @typedef {"square"|"circle"|"diamond"|"donut"|"triangle_up"|"triangle_down"|"triangle_left"|"triangle_right"|"none"} Shape */
+
+/**
+ * viewScale type
+ * Returns an object from a list of cells,
+ * @typedef {function(Array.<import('./Dataset.js').Cell>,number, number):*} ViewScale */
+
+/**
+ * A style, to show a grid dataset.
+ *
+ * @module core
+ * @author Joseph Davies, Julien Gaffuri
+ */
+export class Style extends Drawable {
+    /**
+     * @abstract
+     * @param {{filter?:function(import('./Dataset').Cell):boolean, offset?:function(import('./Dataset').Cell, number, number):{dx:number,dy:number}, visible?:function(number):boolean,alpha?:function(number):number,blendOperation?:function(number):GlobalCompositeOperation,drawFun?:function,viewScale?:ViewScale}} opts
+     */
+    constructor(opts) {
+        super(opts)
+        opts = opts || {}
+
+        /**
+         * @type {ViewScale|undefined} */
+        this.viewScale = opts.viewScale
+
+        /** A filter function to apply to the cell list, to filter out some cells not to be drawn (such as for example the cells with value=0).
+         * @protected
+         * @type {(function(import('./Dataset').Cell):boolean) | undefined} */
+        this.filter = opts.filter || undefined
+
+        /** An offset. This is to alter the position of all symbols in a given direction. In geographical unit.
+         * @protected
+         * @type {function(import('./Dataset').Cell,number,number):{dx:number,dy:number}} */
+        this.offset = opts.offset || ((c, r, z) => ({ dx: 0, dy: 0 }))
+
+        /** A draw function for the style.
+         * @type {function|undefined} */
+        this.drawFun = opts.drawFun
+
+        /**
+         * @public
+         * @type {Array.<import("./Legend").Legend>} */
+        this.legends = []
+    }
+
+    /**
+     * Draw cells.
+     *
+     * @param {Array.<import('./Dataset').Cell>} cells The cells to draw.
+     * @param {import("./GeoCanvas").GeoCanvas} geoCanvas The canvas where to draw them.
+     * @param {number} resolution Their resolution (in geographic unit)
+     * @abstract
+     */
+    draw(cells, geoCanvas, resolution) {
+        if (this.drawFun) this.drawFun(cells, geoCanvas, resolution)
+        else throw new Error('Method draw not implemented.')
+    }
+
+    //getters and setters
+
+    /** @returns {function(import('./Dataset').Cell,number,number):{dx:number,dy:number}} */
+    getOffset() {
+        return this.offset
+    }
+    /** @param {function(import('./Dataset').Cell,number,number):{dx:number,dy:number}} val @returns {this} */
+    setOffset(val) {
+        this.offset = val
+        return this
+    }
+
+    /** Update legends of the style, if any
+     * @param {object} opts
+     * @returns {this} */
+    updateLegends(opts) {
+        Style.updateLegendsRecursive(this.legends, opts)
+        return this
+    }
+
+    /** @private */
+    static updateLegendsRecursive(lg, opts) {
+        if (Array.isArray(lg)) for (const lg_ of lg) this.updateLegendsRecursive(lg_, opts)
+        else lg.update(opts)
+    }
+
+    /**
+     * @param {Array.<import("./Legend").Legend>} legends
+     * @returns {this} */
+    addLegends(legends) {
+        for (let legend of legends) this.legends.push(legend)
+        return this
+    }
+}

package/src/dataset/CSVGrid.js

@@ -1,112 +1,112 @@
-//@ts-check
-'use strict'
-
-/** @typedef {{ dims: object, crs: string, tileSizeCell: number, originPoint: {x:number,y:number}, resolutionGeo: number, tilingBounds:import("../core/GeoCanvas.js").Envelope }} GridInfo */
-
-import { dsv } from 'd3-fetch'
-import { Dataset } from '../core/Dataset.js'
-
-/**
- * A dataset composed of a single CSV file (not tiled).
- *
- * @module dataset
- * @author Joseph Davies, Julien Gaffuri
- */
-export class CSVGrid extends Dataset {
-    /**
-     * @param {import("../core/Map.js").Map} map The map.
-     * @param {string} url The URL of the dataset.
-     * @param {number} resolution The dataset resolution in geographical unit.
-     * @param {{preprocess?:(function(import("../core/Dataset.js").Cell):boolean),delimiter?:string}} opts
-     */
-    constructor(map, url, resolution, opts = {}) {
-        super(map, url, resolution, opts)
-
-        /**
-         * @private
-         * @type {Array.<import("../core/Dataset.js").Cell>} */
-        this.cells = []
-
-        /**
-         * @private
-         * @type {string} */
-         this.delimiter = opts.delimiter || ","
-
-        /**
-         * @type {string}
-         * @private  */
-        this.infoLoadingStatus = 'notLoaded'
-
-        //get data
-        this.getData(undefined)
-    }
-
-    /**
-     * Request data within a geographic envelope.
-     * @param {import("../core/GeoCanvas.js").Envelope|undefined} e
-     */
-    getData(e) {
-        //check if data already loaded
-        if (this.infoLoadingStatus != 'notLoaded') return this
-
-        //load data
-        this.infoLoadingStatus = 'loading'
-            ; (async () => {
-                try {
-                    const data = await dsv(this.delimiter, this.url)
-
-                    //convert coordinates in numbers
-                    for (const c of data) {
-                        c.x = +c.x
-                        c.y = +c.y
-                    }
-
-                    //preprocess/filter
-                    if (this.preprocess) {
-                        this.cells = []
-                        for (const c of data) {
-                            const b = this.preprocess(c)
-                            if (b == false) continue
-                            this.cells.push(c)
-                        }
-                    } else {
-                        this.cells = data
-                    }
-
-                    //TODO check if redraw is necessary
-                    //that is if the dataset belongs to a layer which is visible at the current zoom level
-
-                    //redraw map
-                    if (this.map) this.map.redraw()
-
-                    this.infoLoadingStatus = 'loaded'
-                } catch (error) {
-                    //mark as failed
-                    this.infoLoadingStatus = 'failed'
-                    this.cells = []
-                }
-            })()
-
-        return this
-    }
-
-    /**
-     * Fill the view cache with all cells which are within a geographical envelope.
-     *
-     * @param {import("../core/GeoCanvas.js").Envelope} extGeo
-     * @returns {void}
-     */
-    updateViewCache(extGeo) {
-        //data not loaded yet
-        if (!this.cells) return
-
-        this.cellsViewCache = []
-        for (const cell of this.cells) {
-            if (+cell.x + this.resolution < extGeo.xMin) continue
-            if (+cell.x - this.resolution > extGeo.xMax) continue
-            if (+cell.y + this.resolution < extGeo.yMin) continue
-            if (+cell.y - this.resolution > extGeo.yMax) continue
-            this.cellsViewCache.push(cell)
-        }
-    }
-}
+//@ts-check
+'use strict'
+
+/** @typedef {{ dims: object, crs: string, tileSizeCell: number, originPoint: {x:number,y:number}, resolutionGeo: number, tilingBounds:import("../core/GeoCanvas.js").Envelope }} GridInfo */
+
+import { dsv } from 'd3-fetch'
+import { Dataset } from '../core/Dataset.js'
+
+/**
+ * A dataset composed of a single CSV file (not tiled).
+ *
+ * @module dataset
+ * @author Joseph Davies, Julien Gaffuri
+ */
+export class CSVGrid extends Dataset {
+    /**
+     * @param {import("../core/Map.js").Map} map The map.
+     * @param {string} url The URL of the dataset.
+     * @param {number} resolution The dataset resolution in geographical unit.
+     * @param {{preprocess?:(function(import("../core/Dataset.js").Cell):boolean),delimiter?:string}} opts
+     */
+    constructor(map, url, resolution, opts = {}) {
+        super(map, url, resolution, opts)
+
+        /**
+         * @private
+         * @type {Array.<import("../core/Dataset.js").Cell>} */
+        this.cells = []
+
+        /**
+         * @private
+         * @type {string} */
+        this.delimiter = opts.delimiter || ','
+
+        /**
+         * @type {string}
+         * @private  */
+        this.infoLoadingStatus = 'notLoaded'
+
+        //get data
+        this.getData(undefined)
+    }
+
+    /**
+     * Request data within a geographic envelope.
+     * @param {import("../core/GeoCanvas.js").Envelope|undefined} e
+     */
+    getData(e) {
+        //check if data already loaded
+        if (this.infoLoadingStatus != 'notLoaded') return this
+
+        //load data
+        this.infoLoadingStatus = 'loading'
+        ;(async () => {
+            try {
+                const data = await dsv(this.delimiter, this.url)
+
+                //convert coordinates in numbers
+                for (const c of data) {
+                    c.x = +c.x
+                    c.y = +c.y
+                }
+
+                //preprocess/filter
+                if (this.preprocess) {
+                    this.cells = []
+                    for (const c of data) {
+                        const b = this.preprocess(c)
+                        if (b == false) continue
+                        this.cells.push(c)
+                    }
+                } else {
+                    this.cells = data
+                }
+
+                //TODO check if redraw is necessary
+                //that is if the dataset belongs to a layer which is visible at the current zoom level
+
+                //redraw map
+                if (this.map) this.map.redraw()
+
+                this.infoLoadingStatus = 'loaded'
+            } catch (error) {
+                //mark as failed
+                this.infoLoadingStatus = 'failed'
+                this.cells = []
+            }
+        })()
+
+        return this
+    }
+
+    /**
+     * Fill the view cache with all cells which are within a geographical envelope.
+     *
+     * @param {import("../core/GeoCanvas.js").Envelope} extGeo
+     * @returns {void}
+     */
+    updateViewCache(extGeo) {
+        //data not loaded yet
+        if (!this.cells) return
+
+        this.cellsViewCache = []
+        for (const cell of this.cells) {
+            if (+cell.x + this.resolution < extGeo.xMin) continue
+            if (+cell.x - this.resolution > extGeo.xMax) continue
+            if (+cell.y + this.resolution < extGeo.yMin) continue
+            if (+cell.y - this.resolution > extGeo.yMax) continue
+            this.cellsViewCache.push(cell)
+        }
+    }
+}