vega-functions 5.11.0 → 5.13.0

package/build/vega-functions.module.js

@@ -1,11 +1,11 @@
-import { truthy, error, hasOwnProperty, isFunction, isString, stringValue, extend, isArray, isObject, peek, identity, array as array$1, isBoolean, isDate, isNumber, isRegExp, toBoolean, toDate, toNumber, toString, flush, lerp, pad, span, inrange, truncate, quarter, utcquarter, extent, clampRange, panLinear, panLog, panPow, panSymlog, zoomLinear, zoomLog, zoomPow, zoomSymlog } from 'vega-util';
-import { Literal, constants, codegen, functions, parse, CallExpression } from 'vega-expression';
+import { truthy, error, hasOwnProperty, isFunction, isString, stringValue, extend, isArray, isObject, field, peek, identity, array as array$1, isBoolean, isDate, isNumber, isRegExp, toBoolean, toDate, toNumber, toString, flush, lerp, pad, span, inrange, truncate, quarter, utcquarter, extent, clampRange, panLinear, panLog, panPow, panSymlog, zoomLinear, zoomLog, zoomPow, zoomSymlog } from 'vega-util';
+import { Literal, codegenExpression, constants, functions, parseExpression, CallExpression } from 'vega-expression';
 import { geoBounds as geoBounds$1, geoCentroid as geoCentroid$1, geoArea as geoArea$1 } from 'd3-geo';
 import { rgb, lab, hcl, hsl } from 'd3-color';
 import { isTuple } from 'vega-dataflow';
 import { bandSpace, scale as scale$1, scaleFraction } from 'vega-scale';
 import { Gradient, pathRender, pathParse, Bounds, intersect as intersect$1 } from 'vega-scenegraph';
-import { selectionVisitor, selectionTest, selectionResolve } from 'vega-selections';
+import { selectionVisitor, selectionTest, selectionIdTest, selectionResolve, selectionTuples } from 'vega-selections';
 import { random, cumulativeNormal, cumulativeLogNormal, cumulativeUniform, densityNormal, densityLogNormal, densityUniform, quantileNormal, quantileLogNormal, quantileUniform, sampleNormal, sampleLogNormal, sampleUniform } from 'vega-statistics';
 import { utcOffset, utcSequence, timeOffset, timeSequence, timeUnitSpecifier, week, utcweek, dayofyear, utcdayofyear } from 'vega-time';
 import { range as range$1 } from 'd3-array';
@@ -317,6 +317,12 @@ function pinchAngle(event) {
   return Math.atan2(t[0].clientY - t[1].clientY, t[0].clientX - t[1].clientX);
 }
 
+const accessors = {};
+function pluck (data, name) {
+  const accessor = accessors[name] || (accessors[name] = field(name));
+  return isArray(data) ? data.map(accessor) : accessor(data);
+}
+
 function array(seq) {
   return isArray(seq) || ArrayBuffer.isView(seq) ? seq : null;
 }
@@ -325,16 +331,32 @@ function sequence(seq) {
   return array(seq) || (isString(seq) ? seq : null);
 }
 
-function join(seq, ...args) {
+function join(seq) {
+  for (var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+    args[_key - 1] = arguments[_key];
+  }
+
   return array(seq).join(...args);
 }
-function indexof(seq, ...args) {
+function indexof(seq) {
+  for (var _len2 = arguments.length, args = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+    args[_key2 - 1] = arguments[_key2];
+  }
+
   return sequence(seq).indexOf(...args);
 }
-function lastindexof(seq, ...args) {
+function lastindexof(seq) {
+  for (var _len3 = arguments.length, args = new Array(_len3 > 1 ? _len3 - 1 : 0), _key3 = 1; _key3 < _len3; _key3++) {
+    args[_key3 - 1] = arguments[_key3];
+  }
+
   return sequence(seq).lastIndexOf(...args);
 }
-function slice(seq, ...args) {
+function slice(seq) {
+  for (var _len4 = arguments.length, args = new Array(_len4 > 1 ? _len4 - 1 : 0), _key4 = 1; _key4 < _len4; _key4++) {
+    args[_key4 - 1] = arguments[_key4];
+  }
+
   return sequence(seq).slice(...args);
 }
 function replace(str, pattern, repl) {
@@ -468,6 +490,98 @@ function filter(opt) {
   return p;
 }
 
+/**
+ * Appends a new point to the lasso
+ * 
+ * @param {*} lasso the lasso in pixel space
+ * @param {*} x the x coordinate in pixel space
+ * @param {*} y the y coordinate in pixel space
+ * @param {*} minDist the minimum distance, in pixels, that thenew point needs to be apart from the last point
+ * @returns a new array containing the lasso with the new point
+ */
+
+function lassoAppend(lasso, x, y) {
+  let minDist = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 5;
+  const last = lasso[lasso.length - 1]; // Add point to lasso if distance to last point exceed minDist or its the first point
+
+  if (last === undefined || Math.sqrt((last[0] - x) ** 2 + (last[1] - y) ** 2) > minDist) {
+    lasso.push([x, y]);
+    return [...lasso];
+  }
+
+  return lasso;
+}
+/**
+ * Generates a svg path command which draws a lasso
+ * 
+ * @param {*} lasso the lasso in pixel space in the form [[x,y], [x,y], ...]
+ * @returns the svg path command that draws the lasso
+ */
+
+function lassoPath(lasso) {
+  return (lasso !== null && lasso !== void 0 ? lasso : []).reduce((svg, _ref, i) => {
+    let [x, y] = _ref;
+    return svg += i == 0 ? "M ".concat(x, ",").concat(y, " ") : i === lasso.length - 1 ? ' Z' : "L ".concat(x, ",").concat(y, " ");
+  }, '');
+}
+/**
+ * Inverts the lasso from pixel space to an array of vega scenegraph tuples
+ * 
+ * @param {*} data the dataset
+ * @param {*} pixelLasso the lasso in pixel space, [[x,y], [x,y], ...]
+ * @param {*} unit the unit where the lasso is defined
+ * 
+ * @returns an array of vega scenegraph tuples
+ */
+
+function intersectLasso(markname, pixelLasso, unit) {
+  const {
+    x,
+    y,
+    mark
+  } = unit;
+  const bb = new Bounds().set(Number.MAX_SAFE_INTEGER, Number.MAX_SAFE_INTEGER, Number.MIN_SAFE_INTEGER, Number.MIN_SAFE_INTEGER); // Get bounding box around lasso
+
+  for (const [px, py] of pixelLasso) {
+    if (px < bb.x1) bb.x1 = px;
+    if (px > bb.x2) bb.x2 = px;
+    if (py < bb.y1) bb.y1 = py;
+    if (py > bb.y2) bb.y2 = py;
+  } // Translate bb against unit coordinates
+
+
+  bb.translate(x, y);
+  const intersection = intersect([[bb.x1, bb.y1], [bb.x2, bb.y2]], markname, mark); // Check every point against the lasso
+
+  return intersection.filter(tuple => pointInPolygon(tuple.x, tuple.y, pixelLasso));
+}
+/**
+ * Performs a test if a point is inside a polygon based on the idea from
+ * https://wrf.ecse.rpi.edu/Research/Short_Notes/pnpoly.html
+ * 
+ * This method will not need the same start/end point since it wraps around the edges of the array
+ * 
+ * @param {*} test a point to test against
+ * @param {*} polygon a polygon in the form [[x,y], [x,y], ...]
+ * @returns true if the point lies inside the polygon, false otherwise
+ */
+
+function pointInPolygon(testx, testy, polygon) {
+  let intersections = 0;
+
+  for (let i = 0, j = polygon.length - 1; i < polygon.length; j = i++) {
+    const [prevX, prevY] = polygon[j];
+    const [x, y] = polygon[i]; // count intersections
+
+    if (y > testy != prevY > testy && testx < (prevX - x) * (testy - y) / (prevY - y) + x) {
+      intersections++;
+    }
+  } // point is in polygon if intersection count is odd
+
+
+  return intersections & 1;
+}
+
 const functionContext = {
   random() {
     return random();
@@ -505,7 +619,12 @@ const functionContext = {
   },
 
   toBoolean,
-  toDate,
+
+  toDate(_) {
+    return toDate(_);
+  },
+
+  // suppress extra arguments
   toNumber,
   toString,
   indexof,
@@ -519,6 +638,7 @@ const functionContext = {
   merge,
   pad,
   peek,
+  pluck,
   span,
   inrange,
   truncate,
@@ -552,7 +672,12 @@ const functionContext = {
   warn,
   info,
   debug,
-  extent,
+
+  extent(_) {
+    return extent(_);
+  },
+
+  // suppress extra arguments
   inScope,
   intersect,
   clampRange,
@@ -573,7 +698,10 @@ const functionContext = {
   zoomPow,
   zoomSymlog,
   encode,
-  modify
+  modify,
+  lassoAppend,
+  lassoPath,
+  intersectLasso
 };
 const eventFunctions = ['view', 'item', 'group', 'xy', 'x', 'y'],
       // event functions
@@ -594,7 +722,7 @@ const codegenParams = {
   visitors: astVisitors
 }; // export code generator
 
-const codeGenerator = codegen(codegenParams); // Build expression function registry
+const codeGenerator = codegenExpression(codegenParams); // Build expression function registry
 
 function buildFunctions(codegen) {
   const fn = functions(codegen);
@@ -641,7 +769,9 @@ expressionFunction('treePath', treePath, dataVisitor);
 expressionFunction('treeAncestors', treeAncestors, dataVisitor); // register Vega-Lite selection functions
 
 expressionFunction('vlSelectionTest', selectionTest, selectionVisitor);
+expressionFunction('vlSelectionIdTest', selectionIdTest, selectionVisitor);
 expressionFunction('vlSelectionResolve', selectionResolve, selectionVisitor);
+expressionFunction('vlSelectionTuples', selectionTuples);
 
 function parser (expr, scope) {
   const params = {}; // parse the expression to an abstract syntax tree (ast)
@@ -650,7 +780,7 @@ function parser (expr, scope) {
 
   try {
     expr = isString(expr) ? expr : stringValue(expr) + '';
-    ast = parse(expr);
+    ast = parseExpression(expr);
   } catch (err) {
     error('Expression parse error: ' + expr);
   } // analyze ast function calls for dependencies
@@ -684,4 +814,4 @@ function parser (expr, scope) {
   };
 }
 
-export { DataPrefix, IndexPrefix, ScalePrefix, SignalPrefix, bandspace, bandwidth, codeGenerator, codegenParams, containerSize, contrast, copy, data, dataVisitor, dayAbbrevFormat, dayFormat, debug, domain, encode, expressionFunction, format, functionContext, geoArea, geoBounds, geoCentroid, geoShape, inScope, indata, indataVisitor, indexof, info, invert, join, lastindexof, luminance, merge, modify, monthAbbrevFormat, monthFormat, parser as parseExpression, pathShape, pinchAngle, pinchDistance, range, replace, reverse, scale, scaleGradient, scaleVisitor, screen, setdata, slice, timeFormat, timeParse, treeAncestors, treePath, utcFormat, utcParse, warn, windowSize };
+export { DataPrefix, IndexPrefix, ScalePrefix, SignalPrefix, bandspace, bandwidth, codeGenerator, codegenParams, containerSize, contrast, copy, data, dataVisitor, dayAbbrevFormat, dayFormat, debug, domain, encode, expressionFunction, format, functionContext, geoArea, geoBounds, geoCentroid, geoShape, inScope, indata, indataVisitor, indexof, info, invert, join, lastindexof, luminance, merge, modify, monthAbbrevFormat, monthFormat, parser as parseExpression, pathShape, pinchAngle, pinchDistance, pluck, range, replace, reverse, scale, scaleGradient, scaleVisitor, screen, setdata, slice, timeFormat, timeParse, treeAncestors, treePath, utcFormat, utcParse, warn, windowSize };

package/index.js

@@ -54,6 +54,10 @@ export {
   pinchAngle
 } from './src/functions/pinch';
 
+export {
+  default as pluck
+} from './src/functions/pluck';
+
 export {
   indexof,
   join,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vega-functions",
-  "version": "5.11.0",
+  "version": "5.13.0",
   "description": "Custom functions for the Vega expression language.",
   "keywords": [
     "vega",
@@ -21,20 +21,20 @@
     "prepublishOnly": "yarn test && yarn build"
   },
   "dependencies": {
-    "d3-array": "^2.7.1",
-    "d3-color": "^2.0.0",
-    "d3-geo": "^2.0.1",
+    "d3-array": "^3.1.1",
+    "d3-color": "^3.0.1",
+    "d3-geo": "^3.0.1",
     "vega-dataflow": "^5.7.3",
-    "vega-expression": "^4.0.1",
-    "vega-scale": "^7.1.1",
-    "vega-scenegraph": "^4.9.2",
-    "vega-selections": "^5.2.0",
+    "vega-expression": "^5.0.0",
+    "vega-scale": "^7.2.0",
+    "vega-scenegraph": "^4.9.3",
+    "vega-selections": "^5.3.1",
     "vega-statistics": "^1.7.9",
-    "vega-time": "^2.0.4",
+    "vega-time": "^2.1.0",
     "vega-util": "^1.16.0"
   },
   "devDependencies": {
-    "vega-format": "^1.0.4"
+    "vega-format": "^1.1.0"
   },
-  "gitHead": "0f8859294bb83eb637da209d952faf65eebcf908"
+  "gitHead": "9a3faca4395cade9ecdfde90af98f1c53e9916b2"
 }

package/src/codegen.js

@@ -1,5 +1,5 @@
 import {
-  codegen,
+  codegenExpression,
   constants,
   functions
 } from 'vega-expression';
@@ -9,8 +9,10 @@ import {
 } from 'vega-dataflow';
 
 import {
+  selectionIdTest,
   selectionResolve,
   selectionTest,
+  selectionTuples,
   selectionVisitor
 } from 'vega-selections';
 
@@ -138,6 +140,8 @@ import {
   pinchDistance
 } from './functions/pinch';
 
+import pluck from './functions/pluck';
+
 import {
   indexof,
   join,
@@ -147,6 +151,12 @@ import {
   slice
 } from './functions/sequence';
 
+import {
+  intersectLasso,
+  lassoAppend,
+  lassoPath
+} from './functions/lasso';
+
 import {
   bandspace,
   bandwidth,
@@ -215,7 +225,7 @@ export const functionContext = {
   isTuple,
   isValid(_) { return _ != null && _ === _; },
   toBoolean,
-  toDate,
+  toDate(_) { return toDate(_); }, // suppress extra arguments
   toNumber,
   toString,
   indexof,
@@ -229,6 +239,7 @@ export const functionContext = {
   merge,
   pad,
   peek,
+  pluck,
   span,
   inrange,
   truncate,
@@ -262,7 +273,7 @@ export const functionContext = {
   warn,
   info,
   debug,
-  extent,
+  extent(_) { return extent(_); }, // suppress extra arguments
   inScope,
   intersect,
   clampRange,
@@ -283,7 +294,10 @@ export const functionContext = {
   zoomPow,
   zoomSymlog,
   encode,
-  modify
+  modify,
+  lassoAppend,
+  lassoPath,
+  intersectLasso
 };
 
 const eventFunctions = ['view', 'item', 'group', 'xy', 'x', 'y'], // event functions
@@ -303,7 +317,7 @@ export const codegenParams = {
 };
 
 // export code generator
-export const codeGenerator = codegen(codegenParams);
+export const codeGenerator = codegenExpression(codegenParams);
 
 // Build expression function registry
 function buildFunctions(codegen) {
@@ -351,4 +365,6 @@ expressionFunction('treeAncestors', treeAncestors, dataVisitor);
 
 // register Vega-Lite selection functions
 expressionFunction('vlSelectionTest', selectionTest, selectionVisitor);
+expressionFunction('vlSelectionIdTest', selectionIdTest, selectionVisitor);
 expressionFunction('vlSelectionResolve', selectionResolve, selectionVisitor);
+expressionFunction('vlSelectionTuples', selectionTuples);

package/src/functions/lasso.js

@@ -0,0 +1,110 @@
+import intersect from './intersect';
+import { Bounds } from 'vega-scenegraph';
+
+/**
+ * Appends a new point to the lasso
+ * 
+ * @param {*} lasso the lasso in pixel space
+ * @param {*} x the x coordinate in pixel space
+ * @param {*} y the y coordinate in pixel space
+ * @param {*} minDist the minimum distance, in pixels, that thenew point needs to be apart from the last point
+ * @returns a new array containing the lasso with the new point
+ */
+export function lassoAppend(lasso, x, y, minDist = 5) {
+    const last = lasso[lasso.length - 1];
+
+    // Add point to lasso if distance to last point exceed minDist or its the first point
+    if (last === undefined || Math.sqrt(((last[0] - x) ** 2) + ((last[1] - y) ** 2)) > minDist) {
+        lasso.push([x, y]);
+
+        return [...lasso];
+    }
+
+    return lasso;
+}
+
+
+/**
+ * Generates a svg path command which draws a lasso
+ * 
+ * @param {*} lasso the lasso in pixel space in the form [[x,y], [x,y], ...]
+ * @returns the svg path command that draws the lasso
+ */
+export function lassoPath(lasso) {
+    return (lasso ?? []).reduce((svg, [x, y], i) => {
+        return svg += i == 0
+            ? `M ${x},${y} `
+            : i === lasso.length - 1
+                ? ' Z'
+                : `L ${x},${y} `;
+    }, '');
+}
+
+
+
+/**
+ * Inverts the lasso from pixel space to an array of vega scenegraph tuples
+ * 
+ * @param {*} data the dataset
+ * @param {*} pixelLasso the lasso in pixel space, [[x,y], [x,y], ...]
+ * @param {*} unit the unit where the lasso is defined
+ * 
+ * @returns an array of vega scenegraph tuples
+ */
+export function intersectLasso(markname, pixelLasso, unit) {
+    const { x, y, mark } = unit;
+
+    const bb = new Bounds().set(
+        Number.MAX_SAFE_INTEGER,
+        Number.MAX_SAFE_INTEGER,
+        Number.MIN_SAFE_INTEGER,
+        Number.MIN_SAFE_INTEGER
+    );
+
+    // Get bounding box around lasso
+    for (const [px, py] of pixelLasso) {
+        if (px < bb.x1) bb.x1 = px;
+        if (px > bb.x2) bb.x2 = px;
+        if (py < bb.y1) bb.y1 = py;
+        if (py > bb.y2) bb.y2 = py;
+    }
+
+    // Translate bb against unit coordinates
+    bb.translate(x, y);
+
+    const intersection = intersect([[bb.x1, bb.y1], [bb.x2, bb.y2]],
+        markname,
+        mark);
+
+    // Check every point against the lasso
+    return intersection.filter(tuple => pointInPolygon(tuple.x, tuple.y, pixelLasso));
+}
+
+
+
+/**
+ * Performs a test if a point is inside a polygon based on the idea from
+ * https://wrf.ecse.rpi.edu/Research/Short_Notes/pnpoly.html
+ * 
+ * This method will not need the same start/end point since it wraps around the edges of the array
+ * 
+ * @param {*} test a point to test against
+ * @param {*} polygon a polygon in the form [[x,y], [x,y], ...]
+ * @returns true if the point lies inside the polygon, false otherwise
+ */
+function pointInPolygon(testx, testy, polygon) {
+    let intersections = 0;
+
+    for (let i = 0, j = polygon.length - 1; i < polygon.length; j = i++) {
+        const [prevX, prevY] = polygon[j];
+        const [x, y] = polygon[i];
+
+        // count intersections
+        if (((y > testy) != (prevY > testy)) && (testx < (prevX - x) * (testy - y) / (prevY - y) + x)) {
+            intersections++;
+        }
+    }
+
+    // point is in polygon if intersection count is odd
+    return intersections & 1;
+}

package/src/functions/pluck.js

@@ -0,0 +1,9 @@
+import {field, isArray} from 'vega-util';
+
+// memoize accessor functions
+const accessors = {};
+
+export default function(data, name) {
+  const accessor = accessors[name] || (accessors[name] = field(name));
+  return isArray(data) ? data.map(accessor) : accessor(data);
+}

package/src/parser.js

@@ -1,6 +1,6 @@
 import {codeGenerator, codegenParams} from './codegen';
 import {SignalPrefix} from './constants';
-import {CallExpression, parse} from 'vega-expression';
+import {CallExpression, parseExpression} from 'vega-expression';
 import {error, extend, hasOwnProperty, isString, stringValue} from 'vega-util';
 
 export default function(expr, scope) {
@@ -10,7 +10,7 @@ export default function(expr, scope) {
   let ast;
   try {
     expr = isString(expr) ? expr : (stringValue(expr) + '');
-    ast = parse(expr);
+    ast = parseExpression(expr);
   } catch (err) {
     error('Expression parse error: ' + expr);
   }