@genome-spy/core 0.44.0 → 0.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/dist/bundle/index.es.js +6123 -5482
  2. package/dist/bundle/index.js +211 -148
  3. package/dist/schema.json +329 -79
  4. package/dist/src/data/collector.d.ts.map +1 -1
  5. package/dist/src/data/collector.js +4 -2
  6. package/dist/src/data/flowOptimizer.test.js +12 -3
  7. package/dist/src/data/sources/dataUtils.d.ts.map +1 -1
  8. package/dist/src/data/sources/dataUtils.js +3 -1
  9. package/dist/src/data/sources/lazy/bigBedSource.d.ts +1 -1
  10. package/dist/src/data/sources/lazy/bigBedSource.d.ts.map +1 -1
  11. package/dist/src/data/sources/lazy/bigBedSource.js +52 -20
  12. package/dist/src/data/sources/lazy/bigWigSource.d.ts +0 -1
  13. package/dist/src/data/sources/lazy/bigWigSource.d.ts.map +1 -1
  14. package/dist/src/data/sources/lazy/bigWigSource.js +30 -4
  15. package/dist/src/data/sources/lazy/singleAxisLazySource.d.ts.map +1 -1
  16. package/dist/src/data/sources/lazy/singleAxisLazySource.js +0 -2
  17. package/dist/src/data/sources/lazy/singleAxisWindowedSource.d.ts +6 -2
  18. package/dist/src/data/sources/lazy/singleAxisWindowedSource.d.ts.map +1 -1
  19. package/dist/src/data/sources/lazy/singleAxisWindowedSource.js +38 -20
  20. package/dist/src/data/sources/sequenceSource.d.ts.map +1 -1
  21. package/dist/src/data/sources/sequenceSource.js +14 -5
  22. package/dist/src/data/sources/sequenceSource.test.js +23 -5
  23. package/dist/src/data/sources/urlSource.d.ts.map +1 -1
  24. package/dist/src/data/sources/urlSource.js +15 -2
  25. package/dist/src/data/transforms/aggregate.d.ts.map +1 -1
  26. package/dist/src/data/transforms/aggregate.js +5 -2
  27. package/dist/src/encoder/encoder.d.ts +2 -4
  28. package/dist/src/encoder/encoder.d.ts.map +1 -1
  29. package/dist/src/encoder/encoder.js +8 -8
  30. package/dist/src/encoder/encoder.test.js +3 -0
  31. package/dist/src/genomeSpy.d.ts +7 -5
  32. package/dist/src/genomeSpy.d.ts.map +1 -1
  33. package/dist/src/genomeSpy.js +109 -132
  34. package/dist/src/gl/glslScaleGenerator.js +1 -1
  35. package/dist/src/index.d.ts +1 -1
  36. package/dist/src/index.d.ts.map +1 -1
  37. package/dist/src/index.js +1 -1
  38. package/dist/src/marks/mark.d.ts +8 -5
  39. package/dist/src/marks/mark.d.ts.map +1 -1
  40. package/dist/src/marks/mark.js +56 -12
  41. package/dist/src/marks/point.common.glsl.js +1 -1
  42. package/dist/src/marks/point.d.ts +1 -4
  43. package/dist/src/marks/point.d.ts.map +1 -1
  44. package/dist/src/marks/point.js +31 -23
  45. package/dist/src/marks/point.vertex.glsl.js +1 -1
  46. package/dist/src/marks/text.d.ts.map +1 -1
  47. package/dist/src/marks/text.js +15 -7
  48. package/dist/src/spec/data.d.ts +11 -10
  49. package/dist/src/spec/mark.d.ts +11 -21
  50. package/dist/src/spec/parameter.d.ts +11 -7
  51. package/dist/src/spec/root.d.ts +0 -8
  52. package/dist/src/spec/title.d.ts +5 -4
  53. package/dist/src/spec/view.d.ts +19 -4
  54. package/dist/src/styles/genome-spy.css.d.ts +1 -1
  55. package/dist/src/styles/genome-spy.css.d.ts.map +1 -1
  56. package/dist/src/styles/genome-spy.css.js +52 -5
  57. package/dist/src/styles/genome-spy.scss +63 -10
  58. package/dist/src/styles/update.sh +6 -0
  59. package/dist/src/tooltip/dataTooltipHandler.js +1 -1
  60. package/dist/src/tooltip/refseqGeneTooltipHandler.js +1 -1
  61. package/dist/src/tooltip/tooltipHandler.d.ts +1 -1
  62. package/dist/src/tooltip/tooltipHandler.d.ts.map +1 -1
  63. package/dist/src/tooltip/tooltipHandler.ts +1 -1
  64. package/dist/src/types/embedApi.d.ts +6 -0
  65. package/dist/src/types/viewContext.d.ts +2 -3
  66. package/dist/src/utils/debounce.d.ts +2 -2
  67. package/dist/src/utils/debounce.d.ts.map +1 -1
  68. package/dist/src/utils/debounce.js +5 -2
  69. package/dist/src/utils/expression.d.ts +2 -2
  70. package/dist/src/utils/expression.d.ts.map +1 -1
  71. package/dist/src/utils/expression.js +1 -1
  72. package/dist/src/utils/formatObject.d.ts +2 -2
  73. package/dist/src/utils/formatObject.d.ts.map +1 -1
  74. package/dist/src/utils/formatObject.js +2 -2
  75. package/dist/src/utils/inputBinding.d.ts +5 -0
  76. package/dist/src/utils/inputBinding.d.ts.map +1 -0
  77. package/dist/src/utils/inputBinding.js +115 -0
  78. package/dist/src/utils/ui/tooltip.js +1 -1
  79. package/dist/src/view/paramMediator.d.ts +108 -0
  80. package/dist/src/view/paramMediator.d.ts.map +1 -0
  81. package/dist/src/view/paramMediator.js +337 -0
  82. package/dist/src/view/paramMediator.test.js +211 -0
  83. package/dist/src/view/scaleResolution.d.ts.map +1 -1
  84. package/dist/src/view/scaleResolution.js +11 -6
  85. package/dist/src/view/view.d.ts +4 -1
  86. package/dist/src/view/view.d.ts.map +1 -1
  87. package/dist/src/view/view.js +19 -5
  88. package/dist/src/view/viewFactory.d.ts.map +1 -1
  89. package/dist/src/view/viewFactory.js +45 -0
  90. package/dist/src/view/viewUtils.d.ts +5 -1
  91. package/dist/src/view/viewUtils.d.ts.map +1 -1
  92. package/dist/src/view/viewUtils.js +9 -4
  93. package/package.json +16 -17
  94. package/dist/src/paramBroker.d.ts +0 -46
  95. package/dist/src/paramBroker.d.ts.map +0 -1
  96. package/dist/src/paramBroker.js +0 -118
@@ -0,0 +1,337 @@
1
+ import { isString } from "vega-util";
2
+ import createFunction from "../utils/expression.js";
3
+
4
+ /**
5
+ * A class that manages parameters and expressions.
6
+ * Supports nesting and scoped parameters.
7
+ *
8
+ * @typedef {import("../utils/expression.js").ExpressionFunction & { addListener: (listener: () => void) => void, invalidate: () => void, identifier: () => string}} ExprRefFunction
9
+ */
10
+ export default class ParamMediator {
11
+ /**
12
+ * @typedef {import("../spec/parameter.js").VariableParameter} VariableParameter
13
+ * @typedef {(value: any) => void} ParameterSetter
14
+ */
15
+
16
+ /** @type {Map<string, any>} */
17
+ #paramValues;
18
+
19
+ /**
20
+ * @type {Map<string, Set<() => void>>}
21
+ * @protected
22
+ */
23
+ paramListeners;
24
+
25
+ /** @type {Map<string, (value: any) => void>} */
26
+ #allocatedSetters = new Map();
27
+
28
+ /** @type {Map<string, ExprRefFunction>} */
29
+ #expressions = new Map();
30
+
31
+ /** @type {Map<string, VariableParameter>} */
32
+ #paramConfigs = new Map();
33
+
34
+ /** @type {() => ParamMediator} */
35
+ #parentFinder;
36
+
37
+ /**
38
+ * @param {() => ParamMediator} [parentFinder]
39
+ * An optional function that returns the parent mediator.
40
+ * N.B. The function must always return the same mediator for the same parent,
41
+ * i.e., the changing the structure of the hierarchy is NOT supported.
42
+ */
43
+ constructor(parentFinder) {
44
+ this.#parentFinder = parentFinder ?? (() => undefined);
45
+
46
+ this.#paramValues = new Map();
47
+ this.paramListeners = new Map();
48
+ }
49
+
50
+ /**
51
+ * @param {VariableParameter} param
52
+ * @returns {ParameterSetter}
53
+ */
54
+ registerParam(param) {
55
+ if ("value" in param && "expr" in param) {
56
+ throw new Error(
57
+ "Parameter must not have both value and expr: " + param.name
58
+ );
59
+ }
60
+
61
+ /** @type {ParameterSetter} */
62
+ let setter;
63
+
64
+ if ("value" in param) {
65
+ setter = this.allocateSetter(param.name, param.value);
66
+ } else if ("expr" in param) {
67
+ const expr = this.createExpression(param.expr);
68
+ // TODO: getSetter(param) should return a setter that throws if
69
+ // modifying the value is attempted.
70
+ const realSetter = this.allocateSetter(param.name, expr(null));
71
+ expr.addListener(() => realSetter(expr(null)));
72
+ // NOP
73
+ setter = (_) => undefined;
74
+ }
75
+
76
+ this.#paramConfigs.set(param.name, param);
77
+
78
+ return setter;
79
+ }
80
+
81
+ /**
82
+ *
83
+ * @param {string} paramName
84
+ * @param {T} initialValue
85
+ * @returns {(value: T) => void}
86
+ * @template T
87
+ */
88
+ allocateSetter(paramName, initialValue) {
89
+ if (this.#allocatedSetters.has(paramName)) {
90
+ throw new Error(
91
+ "Setter already allocated for parameter: " + paramName
92
+ );
93
+ }
94
+
95
+ /** @type {(value: any) => void} */
96
+ const setter = (value) => {
97
+ const previous = this.#paramValues.get(paramName);
98
+ if (value !== previous) {
99
+ this.#paramValues.set(paramName, value);
100
+
101
+ const listeners = this.paramListeners.get(paramName);
102
+ if (listeners) {
103
+ for (const listener of listeners) {
104
+ listener();
105
+ }
106
+ }
107
+ }
108
+ };
109
+
110
+ setter(initialValue);
111
+
112
+ this.#allocatedSetters.set(paramName, setter);
113
+
114
+ return setter;
115
+ }
116
+
117
+ /**
118
+ * Gets an existing setter for a parameter. Throws if the setter is not found.
119
+ * @param {string} paramName
120
+ */
121
+ getSetter(paramName) {
122
+ const setter = this.#allocatedSetters.get(paramName);
123
+ if (!setter) {
124
+ throw new Error("Setter not found for parameter: " + paramName);
125
+ }
126
+ return setter;
127
+ }
128
+
129
+ /**
130
+ * Get the value of a parameter from this mediator.
131
+ * @param {string} paramName
132
+ */
133
+ getValue(paramName) {
134
+ return this.#paramValues.get(paramName);
135
+ }
136
+
137
+ /**
138
+ * Get the value of a parameter from this mediator or the ancestors.
139
+ * @param {string} paramName
140
+ */
141
+ findValue(paramName) {
142
+ const mediator = this.findMediatorForParam(paramName);
143
+ return mediator?.getValue(paramName);
144
+ }
145
+
146
+ /**
147
+ * Returns configs for all parameters that have been registered using `registerParam`.
148
+ */
149
+ get paramConfigs() {
150
+ return /** @type {ReadonlyMap<string, VariableParameter>} */ (
151
+ this.#paramConfigs
152
+ );
153
+ }
154
+
155
+ /**
156
+ *
157
+ * @param {string} paramName
158
+ * @returns {ParamMediator}
159
+ * @protected
160
+ */
161
+ findMediatorForParam(paramName) {
162
+ if (this.#paramValues.has(paramName)) {
163
+ return this;
164
+ } else {
165
+ return this.#parentFinder()?.findMediatorForParam(paramName);
166
+ }
167
+ }
168
+
169
+ // TODO: deallocateSetter
170
+
171
+ /**
172
+ * Parse expr and return a function that returns the value of the parameter.
173
+ *
174
+ * @param {string} expr
175
+ */
176
+ createExpression(expr) {
177
+ if (this.#expressions.has(expr)) {
178
+ return this.#expressions.get(expr);
179
+ }
180
+
181
+ const globalObject = {};
182
+
183
+ /** @type {ExprRefFunction} */
184
+ const fn = /** @type {any} */ (createFunction(expr, globalObject));
185
+
186
+ /** @type {Map<string, ParamMediator>} */
187
+ const mediatorsForParams = new Map();
188
+
189
+ for (const param of fn.globals) {
190
+ const mediator = this.findMediatorForParam(param);
191
+ if (!mediator) {
192
+ throw new Error(
193
+ `Unknown variable "${param}" in expression: ${expr}`
194
+ );
195
+ }
196
+
197
+ mediatorsForParams.set(param, mediator);
198
+
199
+ Object.defineProperty(globalObject, param, {
200
+ enumerable: true,
201
+ get() {
202
+ return mediator.getValue(param);
203
+ },
204
+ });
205
+ }
206
+ // TODO: There should be a way to "materialize" the global object when
207
+ // it is used in expressions in transformation batches, i.e., when the same
208
+ // expression is applied to multiple data objects. In that case, the global
209
+ // object remains constant and the Map lookups cause unnecessary overhead.
210
+
211
+ // Keep track of them so that they can be detached later
212
+ const myListeners = new Set();
213
+
214
+ /**
215
+ *
216
+ * @param {() => void} listener
217
+ */
218
+ fn.addListener = (listener) => {
219
+ for (const [param, mediator] of mediatorsForParams) {
220
+ const listeners =
221
+ mediator.paramListeners.get(param) ?? new Set();
222
+ mediator.paramListeners.set(param, listeners);
223
+
224
+ listeners.add(listener);
225
+ myListeners.add(listener);
226
+ }
227
+ };
228
+
229
+ /**
230
+ * Detach listeners. This must be called if the expression is no longer used.
231
+ * TODO: What if the expression is used in multiple places?
232
+ */
233
+ fn.invalidate = () => {
234
+ for (const [param, mediator] of mediatorsForParams) {
235
+ for (const listener of myListeners) {
236
+ mediator.paramListeners.get(param)?.delete(listener);
237
+ }
238
+ }
239
+ };
240
+
241
+ // TODO: This should contain unique identifier for each parameter.
242
+ // As the same parameter name may be used in different branches of the
243
+ // hierarchy, they should be distinguished by a unique identifier, e.g.,
244
+ // a serial number of something similar.
245
+ fn.identifier = () => fn.code;
246
+
247
+ this.#expressions.set(expr, fn);
248
+
249
+ return fn;
250
+ }
251
+
252
+ /**
253
+ * A convenience method for evaluating an expression.
254
+ *
255
+ * @param {string} expr
256
+ */
257
+ evaluateAndGet(expr) {
258
+ const fn = this.createExpression(expr);
259
+ return fn();
260
+ }
261
+ }
262
+
263
+ /**
264
+ * @param {any} x
265
+ * @returns {x is import("../spec/parameter.js").ExprRef}
266
+ */
267
+ export function isExprRef(x) {
268
+ return typeof x == "object" && x != null && "expr" in x && isString(x.expr);
269
+ }
270
+
271
+ /**
272
+ * Removes ExprRef from the type and checks that the value is not an ExprRef.
273
+ * This is designed to be used with `activateExprRefProps`.
274
+ *
275
+ * @param {T | import("../spec/parameter.js").ExprRef} x
276
+ * @template T
277
+ * @returns {T}
278
+ */
279
+ export function withoutExprRef(x) {
280
+ if (isExprRef(x)) {
281
+ throw new Error(
282
+ `ExprRef ${JSON.stringify(
283
+ x
284
+ )} not allowed here. Expected a scalar value.`
285
+ );
286
+ }
287
+ return /** @type {T} */ (x);
288
+ }
289
+
290
+ /**
291
+ * Takes a record of properties that may have ExprRefs as values. Converts the
292
+ * ExprRefs to getters and setups a listener that is called when any of the
293
+ * expressions (upstream parameters) change.
294
+ *
295
+ * @param {ParamMediator} paramMediator
296
+ * @param {T} props The properties object
297
+ * @param {(props: (keyof T)[]) => void} [listener] Listener to be called when any of the expressions change
298
+ * @returns T
299
+ * @template {Record<string, any | import("../spec/parameter.js").ExprRef>} T
300
+ */
301
+ export function activateExprRefProps(paramMediator, props, listener) {
302
+ /** @type {Record<string, any | import("../spec/parameter.js").ExprRef>} */
303
+ const activatedProps = { ...props };
304
+
305
+ /** @type {(keyof T)[]} */
306
+ const alteredProps = [];
307
+
308
+ const batchPropertyChange = (/** @type {keyof T} */ prop) => {
309
+ alteredProps.push(prop);
310
+ if (alteredProps.length === 1) {
311
+ queueMicrotask(() => {
312
+ listener(alteredProps.slice());
313
+ alteredProps.length = 0;
314
+ });
315
+ }
316
+ };
317
+
318
+ for (const [key, value] of Object.entries(props)) {
319
+ if (isExprRef(value)) {
320
+ const fn = paramMediator.createExpression(value.expr);
321
+ if (listener) {
322
+ fn.addListener(() => batchPropertyChange(key));
323
+ }
324
+
325
+ Object.defineProperty(activatedProps, key, {
326
+ enumerable: true,
327
+ get() {
328
+ return fn();
329
+ },
330
+ });
331
+ } else {
332
+ activatedProps[key] = value;
333
+ }
334
+ }
335
+
336
+ return /** @type {T} */ (activatedProps);
337
+ }
@@ -0,0 +1,211 @@
1
+ import { describe, expect, test } from "vitest";
2
+ import ParamMediator, { activateExprRefProps } from "./paramMediator.js";
3
+
4
+ describe("Single-level ParamMediator", () => {
5
+ test("Trivial case", () => {
6
+ const pm = new ParamMediator();
7
+ pm.registerParam({ name: "foo", value: 42 });
8
+ expect(pm.getValue("foo")).toBe(42);
9
+ });
10
+
11
+ test("Setter", () => {
12
+ const pm = new ParamMediator();
13
+ const setter = pm.allocateSetter("foo", 42);
14
+ expect(pm.getValue("foo")).toBe(42);
15
+
16
+ setter(43);
17
+ expect(pm.getValue("foo")).toBe(43);
18
+ });
19
+
20
+ test("Expressions have access to parameters", () => {
21
+ const pm = new ParamMediator();
22
+ pm.registerParam({ name: "foo", value: 42 });
23
+ const expr = pm.createExpression("foo + 1");
24
+ expect(expr()).toBe(43);
25
+ });
26
+
27
+ test("Throws on an unknown parameter", () => {
28
+ const pm = new ParamMediator();
29
+ expect(() => pm.createExpression("foo")).toThrow();
30
+ });
31
+
32
+ test("Listener on an expression gets called (only) when a parameter changes", () => {
33
+ const pm = new ParamMediator();
34
+ const setter = pm.allocateSetter("foo", 42);
35
+ const expr = pm.createExpression("foo + 1");
36
+
37
+ let result;
38
+ let calls = 0;
39
+
40
+ expr.addListener(() => {
41
+ result = expr();
42
+ calls++;
43
+ });
44
+
45
+ setter(50);
46
+ expect(result).toBe(51);
47
+ expect(calls).toBe(1);
48
+
49
+ setter(60);
50
+ expect(result).toBe(61);
51
+ expect(calls).toBe(2);
52
+
53
+ setter(60);
54
+ expect(result).toBe(61);
55
+ expect(calls).toBe(2);
56
+ });
57
+
58
+ test("Expression invalidation", () => {
59
+ const pm = new ParamMediator();
60
+ const setter = pm.allocateSetter("foo", 42);
61
+ const expr = pm.createExpression("foo + 1");
62
+
63
+ let result = expr();
64
+ expect(result).toBe(43);
65
+
66
+ expr.addListener(() => (result = expr()));
67
+
68
+ setter(50);
69
+ expect(result).toBe(51);
70
+
71
+ expr.invalidate();
72
+ // Listeners should be invalidated now: the result must remain the same.
73
+ setter(60);
74
+ expect(result).toBe(51);
75
+ });
76
+
77
+ test("Expression parameter handles dependencies", () => {
78
+ const pm = new ParamMediator();
79
+ const setter = pm.registerParam({ name: "foo", value: 42 });
80
+ pm.registerParam({ name: "bar", expr: "foo + 1" });
81
+ pm.registerParam({ name: "baz", expr: "bar + 2" });
82
+
83
+ const expr = pm.createExpression("baz");
84
+
85
+ let result = expr();
86
+ expect(result).toBe(45);
87
+
88
+ expr.addListener(() => (result = expr()));
89
+
90
+ setter(52);
91
+ expect(result).toBe(55);
92
+ });
93
+
94
+ test("Throws if both value and expr are provided", () => {
95
+ const pm = new ParamMediator();
96
+ expect(() =>
97
+ pm.registerParam({ name: "foo", value: 42, expr: "bar" })
98
+ ).toThrow();
99
+ });
100
+ });
101
+
102
+ describe("Nested ParamMediators", () => {
103
+ test("Value in parent", () => {
104
+ const parent = new ParamMediator();
105
+ const child = new ParamMediator(() => parent);
106
+
107
+ parent.registerParam({ name: "foo", value: 42 });
108
+ expect(parent.findValue("foo")).toBe(42);
109
+ expect(child.findValue("foo")).toBe(42);
110
+ });
111
+
112
+ test("Value in child", () => {
113
+ const parent = new ParamMediator();
114
+ const child = new ParamMediator(() => parent);
115
+
116
+ child.registerParam({ name: "foo", value: 42 });
117
+ expect(parent.findValue("foo")).toBeUndefined();
118
+ expect(child.findValue("foo")).toBe(42);
119
+ });
120
+
121
+ test("Child overrides parent", () => {
122
+ const parent = new ParamMediator();
123
+ const child = new ParamMediator(() => parent);
124
+
125
+ parent.registerParam({ name: "foo", value: 1 });
126
+ child.registerParam({ name: "foo", value: 2 });
127
+
128
+ expect(parent.findValue("foo")).toBe(1);
129
+ expect(child.findValue("foo")).toBe(2);
130
+ });
131
+
132
+ test("Expression", () => {
133
+ const parent = new ParamMediator();
134
+ const child = new ParamMediator(() => parent);
135
+
136
+ parent.registerParam({ name: "foo", value: 1 });
137
+ child.registerParam({ name: "bar", value: 2 });
138
+
139
+ const expr = child.createExpression("foo + bar");
140
+ expect(expr()).toBe(3);
141
+ });
142
+
143
+ test("Listener on an expression", () => {
144
+ const parent = new ParamMediator();
145
+ const child = new ParamMediator(() => parent);
146
+
147
+ const parentSetter = parent.allocateSetter("foo", 1);
148
+ const childSetter = parent.allocateSetter("bar", 2);
149
+
150
+ const expr = child.createExpression("foo + bar");
151
+
152
+ let result = expr();
153
+ expr.addListener(() => (result = expr()));
154
+
155
+ expect(result).toBe(3);
156
+
157
+ parentSetter(10);
158
+ expect(result).toBe(12);
159
+
160
+ childSetter(20);
161
+ expect(result).toBe(30);
162
+ });
163
+ });
164
+
165
+ test("activateExprRefProps", async () => {
166
+ const pm = new ParamMediator();
167
+
168
+ const fooSetter = pm.registerParam({ name: "foo", value: 7 });
169
+ const barSetter = pm.registerParam({ name: "bar", value: 11 });
170
+
171
+ /** @type {Record<string, any | import("../spec/parameter.js").ExprRef} */
172
+ const props = {
173
+ a: 42,
174
+ b: { expr: "foo" },
175
+ c: { expr: "bar" },
176
+ };
177
+
178
+ /** @type {string[]} */
179
+ let altered = [];
180
+
181
+ const activatedProps = activateExprRefProps(pm, props, (props) => {
182
+ altered = props;
183
+ });
184
+
185
+ expect(activatedProps).toEqual({
186
+ a: 42,
187
+ b: 7,
188
+ c: 11,
189
+ });
190
+
191
+ fooSetter(8);
192
+
193
+ // Let the scheduled microtask call the listener
194
+ await Promise.resolve();
195
+
196
+ expect(altered).toEqual(["b"]);
197
+
198
+ fooSetter(1);
199
+ barSetter(2);
200
+
201
+ // Let the scheduled microtask call the listener
202
+ await Promise.resolve();
203
+
204
+ expect(altered).toEqual(["b", "c"]);
205
+
206
+ expect(activatedProps).toEqual({
207
+ a: 42,
208
+ b: 1,
209
+ c: 2,
210
+ });
211
+ });
@@ -1 +1 @@
1
- {"version":3,"file":"scaleResolution.d.ts","sourceRoot":"","sources":["../../../src/view/scaleResolution.js"],"names":[],"mappings":"AAy6BA;;;;;;;;;;GAUG;AACH,6CAFW,OAAO,WAAW,EAAE,OAAO,GAAG,OAAO,WAAW,EAAE,OAAO,EAAE,QA4BrE;AAh6BD,0CAA2C;AAC3C,gCAAiC;AACjC,gCAAiC;AACjC,4BAA6B;AAC7B,4BAA6B;AAE7B;;;;GAIG;AACH;;;;;;;GAOG;AACH;IAyCI;;OAEG;IACH,2DASC;IARG,8CAAsB;IACtB,oDAAoD;IACpD,SADW,gBAAgB,EAAE,CACZ;IACjB,+DAA+D;IAC/D,MADW,MAAM,CACD;IAEhB,iEAAiE;IACjE,MADW,MAAM,CACI;IAOzB;;;;;;;OAOG;IACH,4KAEC;IAED;;;OAGG;IACH,+KAEC;IAcD;;;;;;OAMG;IACH,kHA0BC;IAkLD;;;;OAIG;IACH,qEAMC;IAED;;;;OAIG;IACH,+DAQC;IAED;;OAEG;IACH,oBAyCC;IAED;;OAEG;IACH;eA3WkC,OAAO,kBAAkB,EAAE,KAAK;MAkZjE;IAED,mBAEC;IAED;;OAEG;IACH,oBAFa,mFAA6B,CAOzC;IAED;;;;OAIG;IACH,oBAKC;IAED;;OAEG;IACH,sBAGC;IAUD;;;;;;;OAOG;IACH,kBALW,MAAM,eACN,MAAM,OACN,MAAM,GACJ,OAAO,CAwEnB;IAED;;;;;;OAMG;IACH,eAJW,mFAA6B,aAC7B,OAAO,GAAG,MAAM,iBAgD1B;IAED;;;;OAIG;IACH,qBAcC;IAED;;;;;OAKG;IACH,uBAOC;IA8DD;;;OAGG;IACH,aAFa,OAAO,qBAAqB,EAAE,OAAO,CAajD;IAID;;;;;OAKG;IACH,uBAFW,MAAM,yDAUhB;IAED;;OAEG;IACH,iBAFW,MAAM,yDAKhB;IAED;;;OAGG;IACH,6EAFa,MAAM,CAQlB;IAED;;;OAGG;IACH,mHAFa,MAAM,EAAE,CAOpB;;CA6BJ;wIA5xBY;IAAC,IAAI,EAAE,OAAO,eAAe,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,CAAC,CAAA;CAAC"}
1
+ {"version":3,"file":"scaleResolution.d.ts","sourceRoot":"","sources":["../../../src/view/scaleResolution.js"],"names":[],"mappings":"AA86BA;;;;;;;;;;GAUG;AACH,6CAFW,OAAO,WAAW,EAAE,OAAO,GAAG,OAAO,WAAW,EAAE,OAAO,EAAE,QA4BrE;AAr6BD,0CAA2C;AAC3C,gCAAiC;AACjC,gCAAiC;AACjC,4BAA6B;AAC7B,4BAA6B;AAE7B;;;;GAIG;AACH;;;;;;;GAOG;AACH;IAyCI;;OAEG;IACH,2DASC;IARG,8CAAsB;IACtB,oDAAoD;IACpD,SADW,gBAAgB,EAAE,CACZ;IACjB,+DAA+D;IAC/D,MADW,MAAM,CACD;IAEhB,iEAAiE;IACjE,MADW,MAAM,CACI;IAWzB;;;;;;;OAOG;IACH,4KAEC;IAED;;;OAGG;IACH,+KAEC;IAcD;;;;;;OAMG;IACH,kHA0BC;IAmLD;;;;OAIG;IACH,qEAMC;IAED;;;;OAIG;IACH,+DAQC;IAED;;OAEG;IACH,oBAyCC;IAED;;OAEG;IACH;eAhXkC,OAAO,kBAAkB,EAAE,KAAK;MAuZjE;IAED,mBAEC;IAED;;OAEG;IACH,oBAFa,mFAA6B,CAOzC;IAED;;;;OAIG;IACH,oBAKC;IAED;;OAEG;IACH,sBAGC;IAUD;;;;;;;OAOG;IACH,kBALW,MAAM,eACN,MAAM,OACN,MAAM,GACJ,OAAO,CAwEnB;IAED;;;;;;OAMG;IACH,eAJW,mFAA6B,aAC7B,OAAO,GAAG,MAAM,iBAgD1B;IAED;;;;OAIG;IACH,qBAcC;IAED;;;;;OAKG;IACH,uBAOC;IA8DD;;;OAGG;IACH,aAFa,OAAO,qBAAqB,EAAE,OAAO,CAajD;IAID;;;;;OAKG;IACH,uBAFW,MAAM,yDAUhB;IAED;;OAEG;IACH,iBAFW,MAAM,yDAKhB;IAED;;;OAGG;IACH,6EAFa,MAAM,CAQlB;IAED;;;OAGG;IACH,mHAFa,MAAM,EAAE,CAOpB;;CA6BJ;wIAjyBY;IAAC,IAAI,EAAE,OAAO,eAAe,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,CAAC,CAAA;CAAC"}
@@ -36,7 +36,7 @@ import { NominalDomain } from "../utils/domainArray.js";
36
36
  import { easeCubicInOut } from "d3-ease";
37
37
  import { asArray, shallowArrayEquals } from "../utils/arrayUtils.js";
38
38
  import eerp from "../utils/eerp.js";
39
- import { isExprRef } from "../marks/mark.js";
39
+ import { isExprRef } from "./paramMediator.js";
40
40
 
41
41
  // Register scaleLocus to Vega-Scale.
42
42
  // Loci are discrete but the scale's domain can be adjusted in a continuous manner.
@@ -100,7 +100,7 @@ export default class ScaleResolution {
100
100
  * Keeps track of the expression references in the range. If range is modified,
101
101
  * new expressions are created and the old ones must be invalidated.
102
102
  *
103
- * @type {Set<import("../paramBroker.js").ExprRefFunction>}
103
+ * @type {Set<import("./paramMediator.js").ExprRefFunction>}
104
104
  */
105
105
  #rangeExprRefListeners = new Set();
106
106
 
@@ -118,8 +118,12 @@ export default class ScaleResolution {
118
118
  this.name = undefined;
119
119
  }
120
120
 
121
+ get #firstMemberView() {
122
+ return this.members[0].view;
123
+ }
124
+
121
125
  get #viewContext() {
122
- return this.members[0].view.context;
126
+ return this.#firstMemberView.context;
123
127
  }
124
128
 
125
129
  /**
@@ -338,9 +342,10 @@ export default class ScaleResolution {
338
342
 
339
343
  expressions = range.map((elem) => {
340
344
  if (isExprRef(elem)) {
341
- const fn = this.#viewContext.paramBroker.createExpression(
342
- elem.expr
343
- );
345
+ const fn =
346
+ this.#firstMemberView.paramMediator.createExpression(
347
+ elem.expr
348
+ );
344
349
  fn.addListener(evaluateAndSet);
345
350
  this.#rangeExprRefListeners.add(fn);
346
351
  return () => fn(null);
@@ -84,6 +84,8 @@ export default class View {
84
84
  * @type {Record<import("../spec/channel.js").PrimaryPositionalChannel, boolean>}
85
85
  */
86
86
  needsAxes: Record<import("../spec/channel.js").PrimaryPositionalChannel, boolean>;
87
+ /** @type {ParamMediator} */
88
+ paramMediator: ParamMediator;
87
89
  getPadding(): Padding;
88
90
  /**
89
91
  * Returns a padding that indicates how much axes and titles extend over the plot area.
@@ -267,7 +269,7 @@ export default class View {
267
269
  * Returns `true` if this view and its children supports picking.
268
270
  */
269
271
  isPickingSupported(): boolean;
270
- getTitleText(): string;
272
+ getTitleText(): any;
271
273
  /**
272
274
  * @param {any} key string
273
275
  * @param {function(key?):T} callable A function that produces a value to be cached
@@ -321,6 +323,7 @@ export type ViewOptions = {
321
323
  */
322
324
  contributesToScaleDomain?: boolean;
323
325
  };
326
+ import ParamMediator from "./paramMediator.js";
324
327
  import Padding from "./layout/padding.js";
325
328
  import { FlexDimensions } from "./layout/flexLayout.js";
326
329
  //# sourceMappingURL=view.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../../src/view/view.js"],"names":[],"mappings":"AAyBA,oBAAoB;AACpB,sCAAuC;AACvC,0BAA0B;AAC1B,sCAAuC;AAKvC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH;IAsBI;;;;;;;;;OASG;IACH,kBARW,OAAO,iBAAiB,EAAE,QAAQ,WAClC,OAAO,yBAAyB,EAAE,OAAO,gBACzC,OAAO,oBAAoB,EAAE,OAAO,cACpC,OAAO,WAAW,EAAE,OAAO,QAC3B,MAAM,YACN,WAAW,EAwCrB;IA3DD;;OAEG;IACH,wBAFmB,MAAM,KAAE,MAAM,CAEQ;IAEzC;;;;OAIG;IACH,QAFU,OAAO,uBAAuB,EAAE,OAAO,CAE1C;IAiBH,mDAAsB;IACtB,mDAAgC;IAChC,iBAA4B;IAC5B,aAA6B;IAC7B,yCAAgB;IAEhB;QACI;;;WAGG;eADO,QAAQ,OAAO,OAAO,oBAAoB,EAAE,gBAAgB,EAAE,OAAO,sBAAsB,EAAE,OAAO,CAAC,CAAC;QAGhH;;;WAGG;cADO,QAAQ,OAAO,OAAO,oBAAoB,EAAE,wBAAwB,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC,CAAC;MAG1H;IAID;;;;kCA/DE,OAAO;;;;kCAEP,OAAO;MAiER;IAED;;;OAGG;IACH,WAFU,OAAO,OAAO,oBAAoB,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAEzC;IAG3C,sBAIC;IAED;;;;OAIG;IACH,eAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,gBAFa,OAAO,CAMnB;IAED;;;;;OAKG;IACH,WAFa,cAAc,CAW1B;IAED;;OAEG;IACH,mBAFa,cAAc,CAkB1B;IAoED,+BAEC;IAED,2BAEC;IAED;;;;;;;;OAQG;IACH,aAFa,OAAO,CAMnB;IAED;;;;;;;OAOG;IACH,uBAFa,MAAM,CAMlB;IAED,wBAKC;IAkBD;;OAEG;IACH,6BAEC;IAED;;OAEG;IACH,2BAEC;IAED;;;;OAIG;IACH,yBAFW,gBAAgB,QAO1B;IAED;;;;OAIG;IACH,2BAHW,MAAM,kBACG,gBAAgB,KAAE,IAAI,QASzC;IAED;;;;;;;OAOG;IACH,+BALW,OAAO,uBAAuB,EAAE,OAAO,SAEvC,OAAO,8BAA8B,EAAE,OAAO,aAC9C,OAAO,QASjB;IAED;;;;;;;;;;OAUG;IACH,kCAJW,MAAM,YACN,wBAAwB,eACxB,OAAO,QAajB;IAED;;;;;;;OAOG;IACH,eAJW,OAAO,GACL,WAAW,CAmBvB;IAED;;OAEG;IACH,yBAOC;IAED;;OAEG;IACH,6BASC;IAED;;;OAGG;IACH,uBAEC;IApayB,yJAIN;IAgbpB;;;;;;OAMG;IACH,eAFY,OAAO,oBAAoB,EAAE,QAAQ,CAuBhD;IAED;;;;OAIG;IACH,+BAJW,IAAI,UAEM,MAAM,KAAE,GAAG,CAM/B;IAED;;;;;OAKG;IACH,6BAHW,IAAI,GACF,MAAM,EAAE,CASpB;IAED;;;;;;;;;;;;;;;OAeG;IACH,yBAFY,YAAY,CAIvB;IAED;;OAEG;IACH,4BAFW,OAAO,oBAAoB,EAAE,gBAAgB,0CAWvD;IAED;;OAEG;IACH,2BAFW,OAAO,oBAAoB,EAAE,iBAAiB,yCAWxD;IAED;;;;OAIG;IACH,iCAJW,OAAO,oBAAoB,EAAE,OAAO,GAAG,SAAS,kBAChD,OAAO,iBAAiB,EAAE,gBAAgB,GACxC,OAAO,iBAAiB,EAAE,kBAAkB,CAIxD;IAED;;;;OAIG;IACH,0CAJW,OAAO,oBAAoB,EAAE,OAAO,kBACpC,OAAO,iBAAiB,EAAE,gBAAgB,GACxC,OAAO,iBAAiB,EAAE,kBAAkB,CAQxD;IAED;;;;OAIG;IACH,8BAJW,OAAO,oBAAoB,EAAE,OAAO,kBACpC,OAAO,iBAAiB,EAAE,gBAAgB,GACxC,OAAO,iBAAiB,EAAE,kBAAkB,CAIxD;IAED;;OAEG;IACH,cAFa,MAAM,CAOlB;IAED;;OAEG;IACH,8BAEC;IAED,uBAKC;IAED;;;;;;OAMG;IACH,yBANW,GAAG,wCAQb;IAED;;;;OAIG;IACH,8BAHW,MAAM,cACN,MAAM,GAAG,SAAS,GAAG,WAAW,QAiB1C;IAED,4BAEC;IAED;;;;;OAKG;IACH,iCAFW,OAAO,8BAA8B,EAAE,OAAO,QAIxD;;CACJ;AAqEM,iCAHI,GAAG,0CAGkC;0BA9sBnC,8BAAsB,IAAI;qCAG5B,IAAI,KACF,WAAW;sBAEX,eAAe,GAAG;IAC9B,SAAgB,CAAC,SAAW,IAAI,KAAE,IAAI,CAAC;IACvC,cAAqB,CAAC,SAAW,IAAI,KAAE,IAAI,CAAC;IAC5C,aAAoB,CAAC,SAAW,IAAI,KAAE,IAAI,CAAA;CAAC;;;;;UAIlC,OAAO,iBAAiB,EAAE,kBAAkB;;;;cAC5C,GAAG;;gDAGF,OAAO,uBAAuB,EAAE,OAAO,SAEvC,OAAO,8BAA8B,EAAE,OAAO;;;;;+BAG/C,OAAO;;;;+BAEP,OAAO;;oBArDG,qBAAqB;+BADlC,wBAAwB"}
1
+ {"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../../src/view/view.js"],"names":[],"mappings":"AAyBA,oBAAoB;AACpB,sCAAuC;AACvC,0BAA0B;AAC1B,sCAAuC;AAKvC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH;IAsBI;;;;;;;;;OASG;IACH,kBARW,OAAO,iBAAiB,EAAE,QAAQ,WAClC,OAAO,yBAAyB,EAAE,OAAO,gBACzC,OAAO,oBAAoB,EAAE,OAAO,cACpC,OAAO,WAAW,EAAE,OAAO,QAC3B,MAAM,YACN,WAAW,EAmDrB;IAtED;;OAEG;IACH,wBAFmB,MAAM,KAAE,MAAM,CAEQ;IAEzC;;;;OAIG;IACH,QAFU,OAAO,uBAAuB,EAAE,OAAO,CAE1C;IAiBH,mDAAsB;IACtB,mDAAgC;IAChC,iBAA4B;IAC5B,aAA6B;IAC7B,yCAAgB;IAEhB;QACI;;;WAGG;eADO,QAAQ,OAAO,OAAO,oBAAoB,EAAE,gBAAgB,EAAE,OAAO,sBAAsB,EAAE,OAAO,CAAC,CAAC;QAGhH;;;WAGG;cADO,QAAQ,OAAO,OAAO,oBAAoB,EAAE,wBAAwB,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC,CAAC;MAG1H;IAID;;;;kCA/DE,OAAO;;;;kCAEP,OAAO;MAiER;IAED;;;OAGG;IACH,WAFU,OAAO,OAAO,oBAAoB,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAEzC;IAEvC,4BAA4B;IAC5B,eADW,aAAa,CAGvB;IASL,sBAIC;IAED;;;;OAIG;IACH,eAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,gBAFa,OAAO,CAMnB;IAED;;;;;OAKG;IACH,WAFa,cAAc,CAW1B;IAED;;OAEG;IACH,mBAFa,cAAc,CAkB1B;IAoED,+BAEC;IAED,2BAEC;IAED;;;;;;;;OAQG;IACH,aAFa,OAAO,CAMnB;IAED;;;;;;;OAOG;IACH,uBAFa,MAAM,CAMlB;IAED,wBAKC;IAkBD;;OAEG;IACH,6BAEC;IAED;;OAEG;IACH,2BAEC;IAED;;;;OAIG;IACH,yBAFW,gBAAgB,QAO1B;IAED;;;;OAIG;IACH,2BAHW,MAAM,kBACG,gBAAgB,KAAE,IAAI,QASzC;IAED;;;;;;;OAOG;IACH,+BALW,OAAO,uBAAuB,EAAE,OAAO,SAEvC,OAAO,8BAA8B,EAAE,OAAO,aAC9C,OAAO,QASjB;IAED;;;;;;;;;;OAUG;IACH,kCAJW,MAAM,YACN,wBAAwB,eACxB,OAAO,QAajB;IAED;;;;;;;OAOG;IACH,eAJW,OAAO,GACL,WAAW,CAmBvB;IAED;;OAEG;IACH,yBAOC;IAED;;OAEG;IACH,6BASC;IAED;;;OAGG;IACH,uBAEC;IA/aQ,yJAIN;IA2bH;;;;;;OAMG;IACH,eAFY,OAAO,oBAAoB,EAAE,QAAQ,CAuBhD;IAED;;;;OAIG;IACH,+BAJW,IAAI,UAEM,MAAM,KAAE,GAAG,CAM/B;IAED;;;;;OAKG;IACH,6BAHW,IAAI,GACF,MAAM,EAAE,CASpB;IAED;;;;;;;;;;;;;;;OAeG;IACH,yBAFY,YAAY,CAIvB;IAED;;OAEG;IACH,4BAFW,OAAO,oBAAoB,EAAE,gBAAgB,0CAWvD;IAED;;OAEG;IACH,2BAFW,OAAO,oBAAoB,EAAE,iBAAiB,yCAWxD;IAED;;;;OAIG;IACH,iCAJW,OAAO,oBAAoB,EAAE,OAAO,GAAG,SAAS,kBAChD,OAAO,iBAAiB,EAAE,gBAAgB,GACxC,OAAO,iBAAiB,EAAE,kBAAkB,CAIxD;IAED;;;;OAIG;IACH,0CAJW,OAAO,oBAAoB,EAAE,OAAO,kBACpC,OAAO,iBAAiB,EAAE,gBAAgB,GACxC,OAAO,iBAAiB,EAAE,kBAAkB,CAQxD;IAED;;;;OAIG;IACH,8BAJW,OAAO,oBAAoB,EAAE,OAAO,kBACpC,OAAO,iBAAiB,EAAE,gBAAgB,GACxC,OAAO,iBAAiB,EAAE,kBAAkB,CAIxD;IAED;;OAEG;IACH,cAFa,MAAM,CAOlB;IAED;;OAEG;IACH,8BAEC;IAED,oBASC;IAED;;;;;;OAMG;IACH,yBANW,GAAG,wCAQb;IAED;;;;OAIG;IACH,8BAHW,MAAM,cACN,MAAM,GAAG,SAAS,GAAG,WAAW,QAiB1C;IAED,4BAEC;IAED;;;;;OAKG;IACH,iCAFW,OAAO,8BAA8B,EAAE,OAAO,QAIxD;;CACJ;AAoEM,iCAHI,GAAG,0CAGkC;0BA5tBnC,8BAAsB,IAAI;qCAG5B,IAAI,KACF,WAAW;sBAEX,eAAe,GAAG;IAC9B,SAAgB,CAAC,SAAW,IAAI,KAAE,IAAI,CAAC;IACvC,cAAqB,CAAC,SAAW,IAAI,KAAE,IAAI,CAAC;IAC5C,aAAoB,CAAC,SAAW,IAAI,KAAE,IAAI,CAAA;CAAC;;;;;UAIlC,OAAO,iBAAiB,EAAE,kBAAkB;;;;cAC5C,GAAG;;gDAGF,OAAO,uBAAuB,EAAE,OAAO,SAEvC,OAAO,8BAA8B,EAAE,OAAO;;;;;+BAG/C,OAAO;;;;+BAEP,OAAO;;0BAxCwB,oBAAoB;oBAbzC,qBAAqB;+BADlC,wBAAwB"}
@@ -16,7 +16,7 @@ import { appendToBaseUrl } from "../utils/url.js";
16
16
  import { isDiscrete, bandSpace } from "vega-scale";
17
17
  import { peek } from "../utils/arrayUtils.js";
18
18
  import ViewError from "./viewError.js";
19
- import { isExprRef } from "../marks/mark.js";
19
+ import ParamMediator, { isExprRef } from "./paramMediator.js";
20
20
 
21
21
  // TODO: View classes have too many responsibilities. Come up with a way
22
22
  // to separate the concerns. However, most concerns are tightly tied to
@@ -128,6 +128,17 @@ export default class View {
128
128
  * @type {Record<import("../spec/channel.js").PrimaryPositionalChannel, boolean>}
129
129
  */
130
130
  this.needsAxes = { x: false, y: false };
131
+
132
+ /** @type {ParamMediator} */
133
+ this.paramMediator = new ParamMediator(
134
+ () => this.dataParent?.paramMediator
135
+ );
136
+
137
+ if (spec.params) {
138
+ for (const param of spec.params) {
139
+ this.paramMediator.registerParam(param);
140
+ }
141
+ }
131
142
  }
132
143
 
133
144
  getPadding() {
@@ -631,7 +642,11 @@ export default class View {
631
642
  getTitleText() {
632
643
  const title = this.spec.title;
633
644
  if (title) {
634
- return isString(title) ? title : title.text;
645
+ return isString(title)
646
+ ? title
647
+ : isExprRef(title.text)
648
+ ? this.paramMediator.evaluateAndGet(title.text.expr)
649
+ : title.text;
635
650
  }
636
651
  }
637
652
 
@@ -736,9 +751,8 @@ function createViewOpacityFunction(view) {
736
751
  return interpolate(unitsPerPixel) * parentOpacity;
737
752
  };
738
753
  } else if (isExprRef(opacityDef)) {
739
- const fn = view.context.paramBroker.createExpression(
740
- opacityDef.expr
741
- );
754
+ const fn = view.paramMediator.createExpression(opacityDef.expr);
755
+ fn.addListener(() => view.context.animator.requestRender());
742
756
  return (parentOpacity) => fn(null) * parentOpacity;
743
757
  }
744
758
  }