gridviz 3.0.15 → 3.0.16

package/src/style/SquareColorWebGLStyle.js

@@ -1,126 +1,126 @@
-//@ts-check
-'use strict'
-
-import { Style } from '../core/Style.js'
-import { makeWebGLCanvas } from '../utils/webGLUtils.js'
-import { WebGLSquareColoringAdvanced } from '../utils/WebGLSquareColoringAdvanced.js'
-
-/**
- * Style based on webGL
- * To show cells as colored squares, with computation of the colors on GPU side (faster than JavaScript side).
- * Alls squares with the same size
- *
- * @module style
- * @author Julien Gaffuri
- */
-export class SquareColorWebGLStyle extends Style {
-    /** @param {object} opts */
-    constructor(opts) {
-        super(opts)
-        opts = opts || {}
-
-        /**
-         * A function returning a t value (within [0,1]) for a cell.
-         * @type {function(import('../core/Dataset.js').Cell,number,number,object):number} */
-        this.tFun = opts.tFun //(c,r,z,vs) => {}
-
-        /**
-         * Distribution stretching method.
-         * The stretching is performed on GPU side (fragment shader).
-         * @type {{ fun:string, alpha:number }} */
-        this.stretching = opts.stretching
-
-        /**
-         * The sample of the color ramp.
-         * The color is computed on GPU side (fragment shader) based on those values (linear interpolation).
-         * @type {Array.<string>} */
-        this.colors =
-            opts.colors ||
-            [
-                'rgb(158, 1, 66)',
-                'rgb(248, 142, 83)',
-                'rgb(251, 248, 176)',
-                'rgb(137, 207, 165)',
-                'rgb(94, 79, 162)',
-            ].reverse()
-        if (opts.color)
-            this.colors = [
-                opts.color(0),
-                opts.color(0.2),
-                opts.color(0.4),
-                opts.color(0.6),
-                opts.color(0.8),
-                opts.color(1),
-            ]
-
-        /**
-         * Define the opacity of the style, within [0,1].
-         * If this opacity is defined, the individual color opacity will be ignored.
-         * @type {function(number,number):number} */
-        this.opacity = opts.opacity // (r,z) => ...
-
-        /**
-         * A function returning the size of the cells, in geographical unit. All cells have the same size.
-         * @type {function(number,number):number} */
-        this.size = opts.size // (resolution, z) => ...
-    }
-
-    /**
-     * @param {Array.<import("../core/Dataset.js").Cell>} cells
-     * @param {import("../core/GeoCanvas.js").GeoCanvas} geoCanvas
-     * @param {number} resolution
-     */
-    draw(cells, geoCanvas, resolution) {
-
-        //filter
-        if (this.filter) cells = cells.filter(this.filter)
-
-        //
-        const z = geoCanvas.view.z
-
-        //get view scale
-        const viewScale = this.viewScale ? this.viewScale(cells, resolution, z) : undefined
-
-        //create canvas and webgl renderer
-        //for opacity control, see: https://webglfundamentals.org/webgl/lessons/webgl-and-alpha.html
-        const cvWGL = makeWebGLCanvas(
-            geoCanvas.w + '',
-            geoCanvas.h + '',
-            this.opacity != undefined ? { premultipliedAlpha: false } : undefined
-        )
-        if (!cvWGL) {
-            console.error('No webGL')
-            return
-        }
-
-        //add vertice and fragment data
-        const r2 = resolution / 2
-        const verticesBuffer = []
-        const tBuffer = []
-        for (let cell of cells) {
-            const t = this.tFun(cell, resolution, z, viewScale)
-            if (t == null || t == undefined) continue
-            verticesBuffer.push(cell.x + r2, cell.y + r2)
-            tBuffer.push(t > 1 ? 1 : t < 0 ? 0 : t)
-        }
-
-        //compute pixel size
-        const sizeGeo = this.size ? this.size(resolution, z) : resolution + 0.2 * z
-
-        //compute opacity
-        const op = this.opacity ? this.opacity(resolution, z) : undefined
-
-        //
-        const wgp = new WebGLSquareColoringAdvanced(cvWGL.gl, this.colors, this.stretching, sizeGeo / z, op)
-
-        //draw
-        wgp.draw(verticesBuffer, tBuffer, geoCanvas.getWebGLTransform())
-
-        //draw in canvas geo
-        geoCanvas.initCanvasTransform()
-        geoCanvas.ctx.drawImage(cvWGL.canvas, 0, 0)
-
-        //update legends
-        this.updateLegends({ style: this, resolution: resolution, z: z, viewScale: viewScale })
-    }
-}
+//@ts-check
+'use strict'
+
+import { Style } from '../core/Style.js'
+import { makeWebGLCanvas } from '../utils/webGLUtils.js'
+import { WebGLSquareColoringAdvanced } from '../utils/WebGLSquareColoringAdvanced.js'
+
+/**
+ * Style based on webGL
+ * To show cells as colored squares, with computation of the colors on GPU side (faster than JavaScript side).
+ * Alls squares with the same size
+ *
+ * @module style
+ * @author Julien Gaffuri
+ */
+export class SquareColorWebGLStyle extends Style {
+    /** @param {object} opts */
+    constructor(opts) {
+        super(opts)
+        opts = opts || {}
+
+        /**
+         * A function returning a t value (within [0,1]) for a cell.
+         * @type {function(import('../core/Dataset.js').Cell,number,number,object):number} */
+        this.tFun = opts.tFun //(c,r,z,vs) => {}
+
+        /**
+         * Distribution stretching method.
+         * The stretching is performed on GPU side (fragment shader).
+         * @type {{ fun:string, alpha:number }} */
+        this.stretching = opts.stretching
+
+        /**
+         * The sample of the color ramp.
+         * The color is computed on GPU side (fragment shader) based on those values (linear interpolation).
+         * @type {Array.<string>} */
+        this.colors =
+            opts.colors ||
+            [
+                'rgb(158, 1, 66)',
+                'rgb(248, 142, 83)',
+                'rgb(251, 248, 176)',
+                'rgb(137, 207, 165)',
+                'rgb(94, 79, 162)',
+            ].reverse()
+        if (opts.color)
+            this.colors = [
+                opts.color(0),
+                opts.color(0.2),
+                opts.color(0.4),
+                opts.color(0.6),
+                opts.color(0.8),
+                opts.color(1),
+            ]
+
+        /**
+         * Define the opacity of the style, within [0,1].
+         * If this opacity is defined, the individual color opacity will be ignored.
+         * @type {function(number,number):number} */
+        this.opacity = opts.opacity // (r,z) => ...
+
+        /**
+         * A function returning the size of the cells, in geographical unit. All cells have the same size.
+         * @type {function(number,number):number} */
+        this.size = opts.size // (resolution, z) => ...
+    }
+
+    /**
+     * @param {Array.<import("../core/Dataset.js").Cell>} cells
+     * @param {import("../core/GeoCanvas.js").GeoCanvas} geoCanvas
+     * @param {number} resolution
+     */
+    draw(cells, geoCanvas, resolution) {
+        //filter
+        if (this.filter) cells = cells.filter(this.filter)
+
+        //
+        const z = geoCanvas.view.z
+
+        //get view scale
+        const viewScale = this.viewScale ? this.viewScale(cells, resolution, z) : undefined
+
+        //create canvas and webgl renderer
+        //for opacity control, see: https://webglfundamentals.org/webgl/lessons/webgl-and-alpha.html
+        const cvWGL = makeWebGLCanvas(
+            geoCanvas.w + '',
+            geoCanvas.h + '',
+            this.opacity != undefined ? { premultipliedAlpha: false } : undefined
+        )
+        if (!cvWGL) {
+            console.error('No webGL')
+            return
+        }
+
+        //add vertice and fragment data
+        const r2 = resolution / 2
+        const verticesBuffer = []
+        const tBuffer = []
+        for (let cell of cells) {
+            const t = this.tFun(cell, resolution, z, viewScale)
+            if (t == null || t == undefined) continue
+            verticesBuffer.push(cell.x + r2, cell.y + r2)
+            tBuffer.push(t > 1 ? 1 : t < 0 ? 0 : t)
+        }
+
+        //compute pixel size
+        const sizeGeo = this.size ? this.size(resolution, z) : resolution + 0.2 * z
+
+        //compute opacity
+        const op = this.opacity ? this.opacity(resolution, z) : undefined
+
+        //
+        const wgp = new WebGLSquareColoringAdvanced(cvWGL.gl, this.colors, this.stretching, sizeGeo / z, op)
+
+        //draw
+        wgp.draw(verticesBuffer, tBuffer, geoCanvas.getWebGLTransform())
+
+        // draw in canvas geo
+        // NOTE: drawing each tile this way is very inefficient. WebGL is best used with fewer, heavier/larger draw calls.
+        geoCanvas.initCanvasTransform()
+        geoCanvas.offscreenCtx.drawImage(cvWGL.canvas, 0, 0)
+
+        //update legends
+        this.updateLegends({ style: this, resolution: resolution, z: z, viewScale: viewScale })
+    }
+}

package/src/style/StrokeStyle.js

@@ -1,136 +1,135 @@
-//@ts-check
-'use strict'
-
-import { Style } from '../core/Style.js'
-
-/**
- * @module style
- * @author Julien Gaffuri
- */
-export class StrokeStyle extends Style {
-    /** @param {object} opts */
-    constructor(opts) {
-        super(opts)
-        opts = opts || {}
-
-        /** A function returning the color of the cell.
-         * @type {function(import('../core/Dataset.js').Cell,number,number,object):string} */
-        this.strokeColor = opts.strokeColor || (() => "#666") //(c,r,z,vs) => {}
-
-        /** A function returning the size of a cell in geographical unit.
-         * @type {function(import('../core/Dataset.js').Cell,number,number,object):number} */
-        this.size = opts.size || ((cell, resolution) => resolution) //(c,r,z,vs) => {}
-
-        /** The stroke line width in geographical unit.
-         * @type {function(import('../core/Dataset.js').Cell,number,number,object):number} */
-        this.strokeWidth = opts.strokeWidth || ((cell, resolution, z) => z * 1.5) //(c,r,z,vs) => {}
-
-        /** A function returning the shape of a cell.
-        * @type {function(import("../core/Dataset.js").Cell,number,number,object):import("../core/Style.js").Shape} */
-        this.shape = opts.shape || (() => "square") //(c,r,z,vs) => {}
-    }
-
-    /**
-     * Draw cells as squares, with various colors and size.
-     *
-     * @param {Array.<import("../core/Dataset").Cell>} cells
-     * @param {import("../core/GeoCanvas").GeoCanvas} geoCanvas
-     * @param {number} resolution
-     */
-    draw(cells, geoCanvas, resolution) {
-
-        //filter
-        if (this.filter) cells = cells.filter(this.filter)
-
-        //
-        const z = geoCanvas.view.z
-
-        //get view scale
-        const viewScale = this.viewScale ? this.viewScale(cells, resolution, z) : undefined
-
-        const r2 = resolution * 0.5
-        for (let c of cells) {
-
-            //color
-            const col = this.strokeColor ? this.strokeColor(c, resolution, z, viewScale) : undefined
-            if (!col || col === 'none') continue
-            geoCanvas.ctx.strokeStyle = col
-
-            //size - in geo unit
-            const size = this.size ? this.size(c, resolution, z, viewScale) : resolution
-
-            //width
-            const wi = this.strokeWidth ? this.strokeWidth(c, resolution, z, viewScale) : 1 * z
-            if (!wi || wi <= 0) continue
-            geoCanvas.ctx.lineWidth = wi
-
-            //shape
-            const shape = this.shape ? this.shape(c, resolution, z, viewScale) : 'square'
-            if (shape === 'none') continue
-
-            //get offset
-            const offset = this.offset(c, resolution, z)
-
-            if (shape === 'square') {
-                //draw square
-                const d = resolution * (1 - size / resolution) * 0.5
-                geoCanvas.ctx.beginPath()
-                geoCanvas.ctx.rect(c.x + d + offset.dx, c.y + d + offset.dy, size, size)
-                geoCanvas.ctx.stroke()
-            } else if (shape === 'circle') {
-                //draw circle
-                geoCanvas.ctx.beginPath()
-                geoCanvas.ctx.arc(c.x + r2 + offset.dx, c.y + r2 + offset.dy, size * 0.5, 0, 2 * Math.PI, false)
-                geoCanvas.ctx.stroke()
-            } else if (shape === 'diamond') {
-                const s2 = size * 0.5
-                geoCanvas.ctx.beginPath()
-                geoCanvas.ctx.moveTo(c.x + r2 - s2, c.y + r2)
-                geoCanvas.ctx.lineTo(c.x + r2, c.y + r2 + s2)
-                geoCanvas.ctx.lineTo(c.x + r2 + s2, c.y + r2)
-                geoCanvas.ctx.lineTo(c.x + r2, c.y + r2 - s2)
-                geoCanvas.ctx.lineTo(c.x + r2 - s2, c.y + r2)
-                geoCanvas.ctx.stroke()
-            } else if (shape === 'donut') {
-                console.error('Not implemented')
-            } else if (shape === 'triangle_up') {
-                const dr2 = (size - resolution) / 2
-                geoCanvas.ctx.beginPath()
-                geoCanvas.ctx.moveTo(c.x - dr2, c.y - dr2)
-                geoCanvas.ctx.lineTo(c.x + r2, c.y + resolution + dr2)
-                geoCanvas.ctx.lineTo(c.x + resolution + dr2, c.y - dr2)
-                geoCanvas.ctx.closePath()
-                geoCanvas.ctx.stroke()
-            } else if (shape === 'triangle_down') {
-                const dr2 = (size - resolution) / 2
-                geoCanvas.ctx.beginPath()
-                geoCanvas.ctx.moveTo(c.x - dr2, c.y + resolution + dr2)
-                geoCanvas.ctx.lineTo(c.x + r2, c.y - dr2)
-                geoCanvas.ctx.lineTo(c.x + resolution + dr2, c.y + resolution + dr2)
-                geoCanvas.ctx.closePath()
-                geoCanvas.ctx.stroke()
-            } else if (shape === 'triangle_left') {
-                const dr2 = (size - resolution) / 2
-                geoCanvas.ctx.beginPath()
-                geoCanvas.ctx.moveTo(c.x + resolution + dr2, c.y + resolution + dr2)
-                geoCanvas.ctx.lineTo(c.x - dr2, c.y + r2)
-                geoCanvas.ctx.lineTo(c.x + resolution + dr2, c.y - dr2)
-                geoCanvas.ctx.closePath()
-                geoCanvas.ctx.stroke()
-            } else if (shape === 'triangle_right') {
-                const dr2 = (size - resolution) / 2
-                geoCanvas.ctx.beginPath()
-                geoCanvas.ctx.moveTo(c.x - dr2, c.y - dr2)
-                geoCanvas.ctx.lineTo(c.x + resolution + dr2, c.y + r2)
-                geoCanvas.ctx.lineTo(c.x - dr2, c.y + resolution + dr2)
-                geoCanvas.ctx.closePath()
-                geoCanvas.ctx.stroke()
-            } else {
-                throw new Error('Unexpected shape:' + shape)
-            }
-        }
-
-        //update legends
-        this.updateLegends({ style: this, resolution: resolution, z: z, viewScale: viewScale })
-    }
-}
+//@ts-check
+'use strict'
+
+import { Style } from '../core/Style.js'
+
+/**
+ * @module style
+ * @author Julien Gaffuri
+ */
+export class StrokeStyle extends Style {
+    /** @param {object} opts */
+    constructor(opts) {
+        super(opts)
+        opts = opts || {}
+
+        /** A function returning the color of the cell.
+         * @type {function(import('../core/Dataset.js').Cell,number,number,object):string} */
+        this.strokeColor = opts.strokeColor || (() => '#666') //(c,r,z,vs) => {}
+
+        /** A function returning the size of a cell in geographical unit.
+         * @type {function(import('../core/Dataset.js').Cell,number,number,object):number} */
+        this.size = opts.size || ((cell, resolution) => resolution) //(c,r,z,vs) => {}
+
+        /** The stroke line width in geographical unit.
+         * @type {function(import('../core/Dataset.js').Cell,number,number,object):number} */
+        this.strokeWidth = opts.strokeWidth || ((cell, resolution, z) => z * 1.5) //(c,r,z,vs) => {}
+
+        /** A function returning the shape of a cell.
+         * @type {function(import("../core/Dataset.js").Cell,number,number,object):import("../core/Style.js").Shape} */
+        this.shape = opts.shape || (() => 'square') //(c,r,z,vs) => {}
+    }
+
+    /**
+     * Draw cells as squares, with various colors and size.
+     *
+     * @param {Array.<import("../core/Dataset").Cell>} cells
+     * @param {import("../core/GeoCanvas").GeoCanvas} geoCanvas
+     * @param {number} resolution
+     */
+    draw(cells, geoCanvas, resolution) {
+        //filter
+        if (this.filter) cells = cells.filter(this.filter)
+
+        //
+        const z = geoCanvas.view.z
+        const ctx = geoCanvas.offscreenCtx
+
+        //get view scale
+        const viewScale = this.viewScale ? this.viewScale(cells, resolution, z) : undefined
+
+        const r2 = resolution * 0.5
+        for (let c of cells) {
+            //color
+            const col = this.strokeColor ? this.strokeColor(c, resolution, z, viewScale) : undefined
+            if (!col || col === 'none') continue
+            ctx.strokeStyle = col
+
+            //size - in geo unit
+            const size = this.size ? this.size(c, resolution, z, viewScale) : resolution
+
+            //width
+            const wi = this.strokeWidth ? this.strokeWidth(c, resolution, z, viewScale) : 1 * z
+            if (!wi || wi <= 0) continue
+            ctx.lineWidth = wi
+
+            //shape
+            const shape = this.shape ? this.shape(c, resolution, z, viewScale) : 'square'
+            if (shape === 'none') continue
+
+            //get offset
+            const offset = this.offset(c, resolution, z)
+
+            if (shape === 'square') {
+                //draw square
+                const d = resolution * (1 - size / resolution) * 0.5
+                ctx.beginPath()
+                ctx.rect(c.x + d + offset.dx, c.y + d + offset.dy, size, size)
+                ctx.stroke()
+            } else if (shape === 'circle') {
+                //draw circle
+                ctx.beginPath()
+                ctx.arc(c.x + r2 + offset.dx, c.y + r2 + offset.dy, size * 0.5, 0, 2 * Math.PI, false)
+                ctx.stroke()
+            } else if (shape === 'diamond') {
+                const s2 = size * 0.5
+                ctx.beginPath()
+                ctx.moveTo(c.x + r2 - s2, c.y + r2)
+                ctx.lineTo(c.x + r2, c.y + r2 + s2)
+                ctx.lineTo(c.x + r2 + s2, c.y + r2)
+                ctx.lineTo(c.x + r2, c.y + r2 - s2)
+                ctx.lineTo(c.x + r2 - s2, c.y + r2)
+                ctx.stroke()
+            } else if (shape === 'donut') {
+                console.error('Not implemented')
+            } else if (shape === 'triangle_up') {
+                const dr2 = (size - resolution) / 2
+                ctx.beginPath()
+                ctx.moveTo(c.x - dr2, c.y - dr2)
+                ctx.lineTo(c.x + r2, c.y + resolution + dr2)
+                ctx.lineTo(c.x + resolution + dr2, c.y - dr2)
+                ctx.closePath()
+                ctx.stroke()
+            } else if (shape === 'triangle_down') {
+                const dr2 = (size - resolution) / 2
+                ctx.beginPath()
+                ctx.moveTo(c.x - dr2, c.y + resolution + dr2)
+                ctx.lineTo(c.x + r2, c.y - dr2)
+                ctx.lineTo(c.x + resolution + dr2, c.y + resolution + dr2)
+                ctx.closePath()
+                ctx.stroke()
+            } else if (shape === 'triangle_left') {
+                const dr2 = (size - resolution) / 2
+                ctx.beginPath()
+                ctx.moveTo(c.x + resolution + dr2, c.y + resolution + dr2)
+                ctx.lineTo(c.x - dr2, c.y + r2)
+                ctx.lineTo(c.x + resolution + dr2, c.y - dr2)
+                ctx.closePath()
+                ctx.stroke()
+            } else if (shape === 'triangle_right') {
+                const dr2 = (size - resolution) / 2
+                ctx.beginPath()
+                ctx.moveTo(c.x - dr2, c.y - dr2)
+                ctx.lineTo(c.x + resolution + dr2, c.y + r2)
+                ctx.lineTo(c.x - dr2, c.y + resolution + dr2)
+                ctx.closePath()
+                ctx.stroke()
+            } else {
+                throw new Error('Unexpected shape:' + shape)
+            }
+        }
+
+        //update legends
+        this.updateLegends({ style: this, resolution: resolution, z: z, viewScale: viewScale })
+    }
+}