@genome-spy/core 0.73.0 → 0.75.0

package/dist/src/marks/rule.js

@@ -12,8 +12,11 @@ import COMMON_SHADER from "./rule.common.glsl.js";
 import { RuleVertexBuilder } from "../gl/dataToVertices.js";
 import { isChannelDefWithScale } from "../encoder/encoder.js";
 
+const HORIZONTAL = "horizontal";
+const VERTICAL = "vertical";
+
 /**
- * @extends {Mark<import("../spec/mark.js").RuleProps>}
+ * @extends {Mark<import("../spec/mark.js").RuleProps | import("../spec/mark.js").TickProps>}
  */
 export default class RuleMark extends Mark {
     /**
@@ -23,20 +26,6 @@ export default class RuleMark extends Mark {
         super(unitView);
 
         this.dashTextureSize = 0;
-
-        this.augmentDefaultProperties({
-            x2: undefined,
-            y2: undefined,
-            size: 1,
-            color: "black",
-            opacity: 1.0,
-
-            minLength: 0.0,
-            /** @type {number[]} */
-            strokeDash: null,
-            strokeDashOffset: 0,
-            strokeCap: "butt",
-        });
     }
 
     /**
@@ -67,8 +56,11 @@ export default class RuleMark extends Mark {
      * @param {import("../spec/channel.js").Encoding} encoding
      * @returns {import("../spec/channel.js").Encoding}
      */
-    // eslint-disable-next-line complexity
     fixEncoding(encoding) {
+        if (this.getType() == "tick") {
+            return this.fixTickEncoding(encoding);
+        }
+
         // TODO: Write test for this mess
         if (encoding.x && encoding.y && encoding.x2 && encoding.y2) {
             // Everything is defined
@@ -122,6 +114,31 @@ export default class RuleMark extends Mark {
         return encoding;
     }
 
+    /**
+     * @param {import("../spec/channel.js").Encoding} encoding
+     * @returns {import("../spec/channel.js").Encoding}
+     */
+    fixTickEncoding(encoding) {
+        const props = /** @type {import("../spec/mark.js").TickProps} */ (
+            this.properties
+        );
+
+        encoding.x ??= { value: 0.5 };
+        encoding.y ??= { value: 0.5 };
+        encoding.size = { value: props.thickness };
+
+        const orient = props.orient ?? inferTickOrient(encoding);
+        if (!orient) {
+            throw new Error(
+                "Cannot infer tick orientation from the encoding. Specify the tick mark's orient explicitly."
+            );
+        }
+
+        applyTickSpan(encoding, orient);
+
+        return encoding;
+    }
+
     async initializeGraphics() {
         await super.initializeGraphics();
 
@@ -267,3 +284,95 @@ function createDashTextureArray(pattern) {
 
     return texture;
 }
+
+/**
+ * @param {import("../spec/channel.js").Encoding} encoding
+ * @returns {"vertical" | "horizontal" | undefined}
+ */
+function inferTickOrient(encoding) {
+    if (!encoding.y) {
+        return VERTICAL;
+    } else if (!encoding.x) {
+        return HORIZONTAL;
+    }
+
+    const xBand = isBandChannelDef(encoding.x);
+    const yBand = isBandChannelDef(encoding.y);
+
+    if (!xBand && yBand) {
+        return VERTICAL;
+    } else if (xBand && !yBand) {
+        return HORIZONTAL;
+    } else {
+        return undefined;
+    }
+}
+
+/**
+ * @param {import("../spec/channel.js").Encoding} encoding
+ * @param {"vertical" | "horizontal"} orient
+ */
+function applyTickSpan(encoding, orient) {
+    if (orient == VERTICAL) {
+        encoding.x2 = encoding.x;
+
+        if (isBandChannelDef(encoding.y)) {
+            const [primary, secondary] = createBandCoverage(encoding.y);
+            encoding.y = primary;
+            encoding.y2 = secondary;
+        } else {
+            encoding.y = { value: 0 };
+            encoding.y2 = { value: 1 };
+        }
+    } else {
+        encoding.y2 = encoding.y;
+
+        if (isBandChannelDef(encoding.x)) {
+            const [primary, secondary] = createBandCoverage(encoding.x);
+            encoding.x = primary;
+            encoding.x2 = secondary;
+        } else {
+            encoding.x = { value: 0 };
+            encoding.x2 = { value: 1 };
+        }
+    }
+}
+
+/**
+ * @param {import("../spec/channel.js").ChannelDef} channelDef
+ * @returns {channelDef is import("../spec/channel.js").ChannelDefWithScale}
+ */
+function isBandChannelDef(channelDef) {
+    return (
+        isChannelDefWithScale(channelDef) &&
+        (channelDef.type == "ordinal" || channelDef.type == "nominal")
+    );
+}
+
+/**
+ * @param {import("../spec/channel.js").ChannelDefWithScale} channelDef
+ * @param {number} band
+ * @returns {import("../spec/channel.js").ChannelDefWithScale}
+ */
+function withBand(channelDef, band) {
+    return /** @type {import("../spec/channel.js").ChannelDefWithScale} */ ({
+        ...channelDef,
+        band,
+    });
+}
+
+/**
+ * @param {import("../spec/channel.js").ChannelDefWithScale} channelDef
+ * @returns {[import("../spec/channel.js").ChannelDefWithScale, import("../spec/channel.js").ChannelDefWithScale]}
+ */
+function createBandCoverage(channelDef) {
+    const band = /** @type {import("../spec/channel.js").BandMixins} */ (
+        channelDef
+    ).band;
+    const adjustment = (1 - (band ?? 1)) / 2;
+
+    return [
+        withBand(channelDef, adjustment),
+        withBand(channelDef, 1 - adjustment),
+    ];
+}

package/dist/src/marks/text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../src/marks/text.js"],"names":[],"mappings":"AAgCA;;;;;;;;;GASG;AACH;IACI;;OAEG;IACH;;OAEG;IACH,sBAFW,OAAO,qBAAqB,EAAE,OAAO,EA8D/C;IAbG,oDAMmD;CAuM1D;iBAhSgB,WAAW"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../src/marks/text.js"],"names":[],"mappings":"AAiCA;;;;;;;;;GASG;AACH;IACI;;OAEG;IACH;;OAEG;IACH,sBAFW,OAAO,qBAAqB,EAAE,OAAO,EAiB/C;IAbG,oDAMmD;CAyM1D;iBAtPgB,WAAW"}

package/dist/src/marks/text.js

@@ -12,7 +12,7 @@ import COMMON_SHADER from "./text.common.glsl.js";
 import { TextVertexBuilder } from "../gl/dataToVertices.js";
 
 import Mark from "./mark.js";
-import { fixPositional } from "./markUtils.js";
+import { fixCoveragePositional, fixHalfOpenRangedText } from "./markUtils.js";
 import { primaryPositionalChannels } from "../encoder/encoder.js";
 
 /** For GLSL uniforms */
@@ -28,6 +28,7 @@ const baselines = {
     middle: 0,
     bottom: 1,
     alphabetic: 1,
+    baseline: 1,
 };
 
 /**
@@ -49,51 +50,6 @@ export default class TextMark extends Mark {
      */
     constructor(unitView) {
         super(unitView);
-
-        this.augmentDefaultProperties({
-            x: 0.5,
-            y: 0.5,
-            x2: undefined,
-            y2: undefined,
-            text: "",
-            size: 11.0,
-            color: "black",
-            opacity: 1.0,
-
-            // Use the built-in default
-            font: undefined,
-            fontStyle: undefined,
-            fontWeight: undefined,
-
-            align: "center",
-            baseline: "middle",
-            dx: 0,
-            dy: 0,
-            angle: 0,
-
-            /** When only primary channel is defined with band/locus scale */
-            fitToBand: false,
-
-            squeeze: true,
-            paddingX: 0,
-            paddingY: 0,
-            flushX: true,
-            flushY: true,
-
-            /** Stretch letters so that they can be used with sequence logos etc... */
-            logoLetters: false,
-
-            viewportEdgeFadeWidthTop: 0,
-            viewportEdgeFadeWidthRight: 0,
-            viewportEdgeFadeWidthBottom: 0,
-            viewportEdgeFadeWidthLeft: 0,
-
-            viewportEdgeFadeDistanceTop: -Infinity,
-            viewportEdgeFadeDistanceRight: -Infinity,
-            viewportEdgeFadeDistanceBottom: -Infinity,
-            viewportEdgeFadeDistanceLeft: -Infinity,
-        });
-
         this.font = this.properties.font
             ? unitView.context.fontManager.getFont(
                   this.properties.font,
@@ -150,7 +106,9 @@ export default class TextMark extends Mark {
 
         for (const channel of primaryPositionalChannels) {
             if (this.properties.fitToBand) {
-                fixPositional(encoding, channel);
+                fixCoveragePositional(encoding, channel);
+            } else {
+                fixHalfOpenRangedText(encoding, channel);
             }
         }
 

package/dist/src/minimal.d.ts

@@ -0,0 +1,8 @@
+export const embed: (el: HTMLElement | string, spec: import("./spec/root.js").RootSpec | string, options?: import("./types/embedApi.js").EmbedOptions) => Promise<import("./types/embedApi.js").EmbedResult>;
+import GenomeSpy from "./genomeSpyBase.js";
+import { html } from "lit";
+import icon from "./img/bowtie.svg";
+import favIcon from "./img/genomespy-favicon.svg";
+import { loadSpec } from "./embedFactory.js";
+export { GenomeSpy, html, icon, favIcon, loadSpec };
+//# sourceMappingURL=minimal.d.ts.map

package/dist/src/minimal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimal.d.ts","sourceRoot":"","sources":["../../src/minimal.js"],"names":[],"mappings":"AAkBA,6MAA4C;sBAPtB,oBAAoB;qBAJrB,KAAK;iBAKT,kBAAkB;oBACf,6BAA6B;yBACX,mBAAmB"}

package/dist/src/minimal.js

@@ -0,0 +1,21 @@
+/**
+ * Lean GenomeSpy core entry point.
+ *
+ * Use this entry when you want the `embed` API without the default built-in
+ * eager and lazy format registrations. Import the optional data source and
+ * format modules you need explicitly.
+ */
+import { html } from "lit";
+
+// Lean core entry point: shares the embed API, but skips built-in optional
+// eager and lazy format registrations.
+import GenomeSpy from "./genomeSpyBase.js";
+import icon from "./img/bowtie.svg";
+import favIcon from "./img/genomespy-favicon.svg";
+import { createEmbed, loadSpec } from "./embedFactory.js";
+
+export { GenomeSpy, html, icon, favIcon };
+
+export const embed = createEmbed(GenomeSpy);
+
+export { loadSpec };

package/dist/src/paramRuntime/expressionCompiler.d.ts

@@ -1,7 +1,8 @@
 /**
  * @param {string} expr
  * @param {Record<string, any>} [globalObject]
+ * @param {object} [context]
  * @returns {import("../utils/expression.js").ExpressionFunction}
  */
-export function compileExpression(expr: string, globalObject?: Record<string, any>): import("../utils/expression.js").ExpressionFunction;
+export function compileExpression(expr: string, globalObject?: Record<string, any>, context?: object): import("../utils/expression.js").ExpressionFunction;
 //# sourceMappingURL=expressionCompiler.d.ts.map

package/dist/src/paramRuntime/expressionCompiler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expressionCompiler.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/expressionCompiler.js"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wCAJW,MAAM,iBACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACjB,OAAO,wBAAwB,EAAE,kBAAkB,CAI/D"}
+{"version":3,"file":"expressionCompiler.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/expressionCompiler.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wCALW,MAAM,iBACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACnB,MAAM,GACJ,OAAO,wBAAwB,EAAE,kBAAkB,CAI/D"}

package/dist/src/paramRuntime/expressionCompiler.js

@@ -3,8 +3,9 @@ import createFunction from "../utils/expression.js";
 /**
  * @param {string} expr
  * @param {Record<string, any>} [globalObject]
+ * @param {object} [context]
  * @returns {import("../utils/expression.js").ExpressionFunction}
  */
-export function compileExpression(expr, globalObject = {}) {
-    return createFunction(expr, globalObject);
+export function compileExpression(expr, globalObject = {}, context = {}) {
+    return createFunction(expr, globalObject, context);
 }

package/dist/src/paramRuntime/expressionRef.d.ts

@@ -10,9 +10,12 @@
  *
  * @param {string} expr
  * @param {(name: string) => import("./types.js").ParamRef<any> | undefined} resolve
+ * @param {{ resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined }} [options]
  * @returns {BoundExpression}
  */
-export function bindExpression(expr: string, resolve: (name: string) => import("./types.js").ParamRef<any> | undefined): BoundExpression;
+export function bindExpression(expr: string, resolve: (name: string) => import("./types.js").ParamRef<any> | undefined, options?: {
+    resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined;
+}): BoundExpression;
 export type BoundExpression = {
     expression: import("./types.js").ExprRefFunction;
     dependencies: import("./types.js").ParamRef<any>[];

package/dist/src/paramRuntime/expressionRef.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expressionRef.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/expressionRef.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,qCAJW,MAAM,WACN,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,SAAS,GAC9D,eAAe,CA+E3B;8BA3FY;IACR,UAAU,EAAE,OAAO,YAAY,EAAE,eAAe,CAAC;IACjD,YAAY,EAAE,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAA;CACnD"}
+{"version":3,"file":"expressionRef.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/expressionRef.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;;;;;;;;GAQG;AACH,qCALW,MAAM,WACN,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,SAAS,YAChE;IAAE,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,8BAA8B,EAAE,OAAO,GAAG,SAAS,CAAA;CAAE,GAC1G,eAAe,CAqF3B;8BAlGY;IACR,UAAU,EAAE,OAAO,YAAY,EAAE,eAAe,CAAC;IACjD,YAAY,EAAE,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAA;CACnD"}

package/dist/src/paramRuntime/expressionRef.js

@@ -13,14 +13,15 @@ import { compileExpression } from "./expressionCompiler.js";
  *
  * @param {string} expr
  * @param {(name: string) => import("./types.js").ParamRef<any> | undefined} resolve
+ * @param {{ resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined }} [options]
  * @returns {BoundExpression}
  */
-export function bindExpression(expr, resolve) {
+export function bindExpression(expr, resolve, options = {}) {
     const globalObject = {};
 
     /** @type {import("./types.js").ExprRefFunction} */
     const expression = /** @type {any} */ (
-        compileExpression(expr, globalObject)
+        compileExpression(expr, globalObject, options)
     );
 
     /** @type {Map<string, import("./types.js").ParamRef<any>>} */
@@ -57,6 +58,9 @@ export function bindExpression(expr, resolve) {
         for (const ref of refsForParams.values()) {
             disposers.push(ref.subscribe(listener));
         }
+        for (const ref of expression.scaleDependencies ?? []) {
+            disposers.push(ref.subscribe(listener));
+        }
 
         let active = true;
         const unsubscribe = () => {
@@ -86,10 +90,13 @@ export function bindExpression(expr, resolve) {
         "|" +
         Array.from(refsForParams.values())
             .map((ref) => ref.id)
+            .concat((expression.scaleDependencies ?? []).map((ref) => ref.id))
             .join(",");
 
     return {
         expression,
-        dependencies: Array.from(refsForParams.values()),
+        dependencies: Array.from(refsForParams.values()).concat(
+            expression.scaleDependencies ?? []
+        ),
     };
 }

package/dist/src/paramRuntime/graphRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"graphRuntime.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/graphRuntime.js"],"names":[],"mappings":"AAoIA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH;IA6BI;;;;;;;OAOG;IACH,sBAJG;QAA2D,iBAAiB,GAApE,OAAO,wBAAwB,EAAE,OAAO;KAGlD,EAGA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eARa,CAAC,WACH,MAAM,QACN,MAAM,QACN,MAAM,GAAG,WAAW,gBACpB,CAAC,YACD;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAClB,OAAO,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAwDpD;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAPa,CAAC,WACH,MAAM,QACN,MAAM,QACN,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,MACpC,MAAM,CAAC,GACL,OAAO,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAuD5C;IAED;;;;;;;;;;;;OAYG;IACH,gBALW,MAAM,QACN,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,MACpC,MAAM,IAAI,GACR,MAAM,IAAI,CAwCtB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAJa,CAAC,MACH,MAAM,CAAC,GACL,CAAC,CAYb;IAED;;;;;;;;OAQG;IACH,iBA8CC;IAED;;;;;;;;;;OAUG;IACH,yBAJW;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAE1C,OAAO,CAAC,IAAI,CAAC,CAgDzB;;CA2EJ;0BA3mBY,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI;8BAEpC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;IAC3B,SAAS,EAAE,WAAW,CAAA;CACvB;yBAIS,CAAC,IACD,eAAe,GAAG;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAA;CACb;yBAIS,CAAC,IACD,eAAe,GAAG;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC,CAAA;CACZ;yBAIS;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,EAAE,EAAE,MAAM,IAAI,CAAA;CACf;AAgEJ;;;GAGG;AACH,6BAHW,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,GAChC,eAAe,CAa3B"}
+{"version":3,"file":"graphRuntime.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/graphRuntime.js"],"names":[],"mappings":"AA+IA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH;IA6BI;;;;;;;OAOG;IACH,sBAJG;QAA2D,iBAAiB,GAApE,OAAO,wBAAwB,EAAE,OAAO;KAGlD,EAGA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eARa,CAAC,WACH,MAAM,QACN,MAAM,QACN,MAAM,GAAG,WAAW,gBACpB,CAAC,YACD;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAClB,OAAO,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAwDpD;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAPa,CAAC,WACH,MAAM,QACN,MAAM,QACN,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,MACpC,MAAM,CAAC,GACL,OAAO,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAsD5C;IAED;;;;;;;;;;;;OAYG;IACH,gBALW,MAAM,QACN,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,MACpC,MAAM,IAAI,GACR,MAAM,IAAI,CAuCtB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,iBAJa,CAAC,MACH,MAAM,CAAC,GACL,CAAC,CAYb;IAED;;;;;;;;OAQG;IACH,iBA8CC;IAED;;;;;;;;;;OAUG;IACH,yBAJW;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAE1C,OAAO,CAAC,IAAI,CAAC,CAgDzB;;CA2EJ;0BApnBY,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI;8BAEpC;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;IAC3B,SAAS,EAAE,WAAW,CAAA;CACvB;yBAIS,CAAC,IACD,eAAe,GAAG;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAA;CACb;yBAIS,CAAC,IACD,eAAe,GAAG;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC,CAAA;CACZ;yBAIS;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,EAAE,EAAE,MAAM,IAAI,CAAA;CACf;AAgEJ;;;GAGG;AACH,6BAHW,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,GAChC,eAAe,CAa3B"}

package/dist/src/paramRuntime/graphRuntime.js

@@ -121,6 +121,17 @@ function getNode(ref) {
     return node;
 }
 
+/**
+ * @param {import("./types.js").ParamRef<any>} dep
+ * @returns {number}
+ */
+function getDependencyRank(dep) {
+    if (typeof (/** @type {any} */ (dep).rank) === "number") {
+        return /** @type {any} */ (dep).rank;
+    }
+    return getNode(dep).rank;
+}
+
 /**
  * @param {Set<() => void>} listeners
  */
@@ -291,9 +302,8 @@ export default class GraphRuntime {
      * @returns {import("./types.js").ParamRef<T>}
      */
     computed(ownerId, name, deps, fn) {
-        const depNodes = deps.map(getNode);
-        const maxRank = depNodes.reduce(
-            (previous, node) => Math.max(previous, node.rank),
+        const maxRank = deps.reduce(
+            (previous, dep) => Math.max(previous, getDependencyRank(dep)),
             0
         );
 
@@ -359,9 +369,8 @@ export default class GraphRuntime {
      * @returns {() => void} explicit disposer for manual teardown
      */
     effect(ownerId, deps, fn) {
-        const depNodes = deps.map(getNode);
-        const maxRank = depNodes.reduce(
-            (previous, node) => Math.max(previous, node.rank),
+        const maxRank = deps.reduce(
+            (previous, dep) => Math.max(previous, getDependencyRank(dep)),
             0
         );
 

package/dist/src/paramRuntime/paramRuntime.d.ts

@@ -89,9 +89,12 @@ export default class ParamRuntime {
      * @param {ScopeId} scope
      * @param {string} name
      * @param {string} expr
+     * @param {{ resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined }} [options]
      * @returns {import("./types.js").ParamRef<T>}
      */
-    registerDerived<T>(scope: ScopeId, name: string, expr: string): import("./types.js").ParamRef<T>;
+    registerDerived<T>(scope: ScopeId, name: string, expr: string, options?: {
+        resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined;
+    }): import("./types.js").ParamRef<T>;
     /**
      * Creates an expression function bound to scope-based parameter resolution.
      *
@@ -101,9 +104,12 @@ export default class ParamRuntime {
      *
      * @param {ScopeId} scope
      * @param {string} expr
+     * @param {{ resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined }} [options]
      * @returns {import("./types.js").ExprRefFunction}
      */
-    createExpression(scope: ScopeId, expr: string): import("./types.js").ExprRefFunction;
+    createExpression(scope: ScopeId, expr: string, options?: {
+        resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined;
+    }): import("./types.js").ExprRefFunction;
     /**
      * Resolves a parameter by name from `scope`, searching parent scopes as needed.
      * Returns the nearest matching binding, if any.

package/dist/src/paramRuntime/paramRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paramRuntime.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/paramRuntime.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH;IASI;;;;;;;;OAQG;IACH,0BAHW,OAAO,GACL,OAAO,CAYnB;IAED;;;;;;;;OAQG;IACH,oBAFW,OAAO,QAMjB;IAED;;;;;;;OAOG;IACH,wBAHW,OAAO,YACP,MAAM,IAAI,QAKpB;IAED;;;;;;;;;OASG;IACH,aAPa,CAAC,SACH,OAAO,QACP,MAAM,WACN,CAAC,YACD;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAClB,OAAO,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAYpD;IAED;;;;;;;;;;;;OAYG;IACH,kBAPa,CAAC,SACH,OAAO,QACP,MAAM,WACN,CAAC,YACD;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAClB,OAAO,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAYpD;IAED;;;;;;;;;;;OAWG;IACH,gBANa,CAAC,SACH,OAAO,QACP,MAAM,QACN,MAAM,GACJ,OAAO,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAgB5C;IAED;;;;;;;;;;OAUG;IACH,wBAJW,OAAO,QACP,MAAM,GACJ,OAAO,YAAY,EAAE,eAAe,CAOhD;IAED;;;;;;;;OAQG;IACH,QALa,CAAC,SACH,OAAO,QACP,MAAM,GACJ,OAAO,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAIxD;IAED;;;;;;;;;OASG;IACH,iBAJa,CAAC,MACH,MAAM,CAAC,GACL,CAAC,CAIb;IAED;;OAEG;IACH,iBAEC;IAED;;;;;OAKG;IACH,yBAHW;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1C,OAAO,CAAC,IAAI,CAAC,CAIzB;;CACJ;;;;;;;;;;;;;;;;;;;;;sBApMY,MAAM"}
+{"version":3,"file":"paramRuntime.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/paramRuntime.js"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH;IASI;;;;;;;;OAQG;IACH,0BAHW,OAAO,GACL,OAAO,CAYnB;IAED;;;;;;;;OAQG;IACH,oBAFW,OAAO,QAMjB;IAED;;;;;;;OAOG;IACH,wBAHW,OAAO,YACP,MAAM,IAAI,QAKpB;IAED;;;;;;;;;OASG;IACH,aAPa,CAAC,SACH,OAAO,QACP,MAAM,WACN,CAAC,YACD;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAClB,OAAO,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAYpD;IAED;;;;;;;;;;;;OAYG;IACH,kBAPa,CAAC,SACH,OAAO,QACP,MAAM,WACN,CAAC,YACD;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAClB,OAAO,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAYpD;IAED;;;;;;;;;;;;OAYG;IACH,gBAPa,CAAC,SACH,OAAO,QACP,MAAM,QACN,MAAM,YACN;QAAE,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,8BAA8B,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GAC1G,OAAO,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAiB5C;IAED;;;;;;;;;;;OAWG;IACH,wBALW,OAAO,QACP,MAAM,YACN;QAAE,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,8BAA8B,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GAC1G,OAAO,YAAY,EAAE,eAAe,CAShD;IAED;;;;;;;;OAQG;IACH,QALa,CAAC,SACH,OAAO,QACP,MAAM,GACJ,OAAO,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAIxD;IAED;;;;;;;;;OASG;IACH,iBAJa,CAAC,MACH,MAAM,CAAC,GACL,CAAC,CAIb;IAED;;OAEG;IACH,iBAEC;IAED;;;;;OAKG;IACH,yBAHW;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1C,OAAO,CAAC,IAAI,CAAC,CAIzB;;CACJ;;;;;;;;;;;;;;;;;;;;;sBAzMY,MAAM"}

package/dist/src/paramRuntime/paramRuntime.js

@@ -140,12 +140,14 @@ export default class ParamRuntime {
      * @param {ScopeId} scope
      * @param {string} name
      * @param {string} expr
+     * @param {{ resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined }} [options]
      * @returns {import("./types.js").ParamRef<T>}
      */
-    registerDerived(scope, name, expr) {
+    registerDerived(scope, name, expr, options) {
         const { expression, dependencies } = bindExpression(
             expr,
-            (globalName) => this.resolve(scope, globalName)
+            (globalName) => this.resolve(scope, globalName),
+            options
         );
 
         const ownerId = this.#paramStore.getOwnerId(scope);
@@ -167,11 +169,14 @@ export default class ParamRuntime {
      *
      * @param {ScopeId} scope
      * @param {string} expr
+     * @param {{ resolveScaleResolution?: (channel: string) => import("../scales/scaleResolution.js").default | undefined }} [options]
      * @returns {import("./types.js").ExprRefFunction}
      */
-    createExpression(scope, expr) {
-        const { expression } = bindExpression(expr, (globalName) =>
-            this.resolve(scope, globalName)
+    createExpression(scope, expr, options) {
+        const { expression } = bindExpression(
+            expr,
+            (globalName) => this.resolve(scope, globalName),
+            options
         );
         return expression;
     }

package/dist/src/paramRuntime/types.d.ts

@@ -2,6 +2,7 @@ export type ParamRef<T> = {
     id: string;
     name: string;
     kind: "base" | "derived" | "selection";
+    rank?: number;
     get: () => T;
     subscribe: (listener: () => void) => () => void;
 };

package/dist/src/paramRuntime/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/types.js"],"names":[],"mappings":"qBACa,CAAC,IACD;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,CAAC;IACvC,GAAG,EAAE,MAAM,CAAC,CAAC;IACb,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAA;CAChD;6BAIS,CAAC,IACD,QAAQ,CAAC,CAAC,CAAC,GAAG;IAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAA;CAAE;8BAIzC,OAAO,wBAAwB,EAAE,kBAAkB,GAAG;IAC9D,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;IAChD,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,UAAU,EAAE,MAAM,MAAM,CAAA;CACzB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/types.js"],"names":[],"mappings":"qBACa,CAAC,IACD;IACR,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,CAAC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC,CAAC;IACb,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAA;CAChD;6BAIS,CAAC,IACD,QAAQ,CAAC,CAAC,CAAC,GAAG;IAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAA;CAAE;8BAIzC,OAAO,wBAAwB,EAAE,kBAAkB,GAAG;IAC9D,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;IAChD,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,UAAU,EAAE,MAAM,MAAM,CAAA;CACzB"}

package/dist/src/paramRuntime/types.js

@@ -4,6 +4,7 @@
  *   id: string,
  *   name: string,
  *   kind: "base" | "derived" | "selection",
+ *   rank?: number,
  *   get: () => T,
  *   subscribe: (listener: () => void) => () => void
  * }} ParamRef

package/dist/src/paramRuntime/viewParamRuntime.d.ts

@@ -10,11 +10,12 @@
 export default class ViewParamRuntime {
     /**
      * @param {() => ViewParamRuntime} [parentFinder]
-     *      An optional function that returns the parent runtime.
-     *      N.B. The function must always return the same runtime for the same parent,
-     *      i.e., the changing the structure of the hierarchy is NOT supported.
+     * @param {(channel: import("../spec/channel.js").ChannelWithScale) => import("../scales/scaleResolution.js").default | undefined} [scaleResolutionResolver]
+     *      Optional resolver for scale channels in this runtime's view scope.
+     *      N.B. The function must always return the same resolution for the
+     *      same channel in the same view hierarchy.
      */
-    constructor(parentFinder?: () => ViewParamRuntime);
+    constructor(parentFinder?: () => ViewParamRuntime, scaleResolutionResolver?: (channel: import("../spec/channel.js").ChannelWithScale) => import("../scales/scaleResolution.js").default | undefined);
     /**
      * Registers a parameter definition into this runtime scope.
      *
@@ -71,6 +72,25 @@ export default class ViewParamRuntime {
      * Returns configs for all parameters that have been registered using `registerParam`.
      */
     get paramConfigs(): ReadonlyMap<string, import("../spec/parameter.js").Parameter>;
+    /**
+     * Returns true if this runtime scope owns a local binding for the parameter.
+     *
+     * @param {string} paramName
+     * @returns {boolean}
+     */
+    hasLocalParam(paramName: string): boolean;
+    /**
+     * Returns true if this runtime scope or any ancestor scope contains a
+     * parameter registered through `registerParam`.
+     *
+     * Auto-allocated setters such as layout width/height are intentionally
+     * ignored so that only explicit parameter configs shadow descendant
+     * auto-size params.
+     *
+     * @param {string} paramName
+     * @returns {boolean}
+     */
+    hasConfiguredParamInScopeChain(paramName: string): boolean;
     /**
      *
      * @param {string} paramName

package/dist/src/paramRuntime/viewParamRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"viewParamRuntime.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/viewParamRuntime.js"],"names":[],"mappings":"AAmBA;;;;;;;;GAQG;AACH;IAqCI;;;;;OAKG;IACH,2BALW,MAAM,gBAAgB,EAgBhC;IAED;;;;;;;;;;;OAWG;IACH,wEAjEqB,GAAG,KAAK,IAAI,CAyJhC;IAED;;;;;;;OAOG;IACH,eAFa,CAAC,aAJH,MAAM,gBACN,CAAC,YACD,OAAO,GACL,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAgC9B;IAED;;;;;;;;OAQG;IACH,oBAHW,MAAM,SACN,GAAG,QAWb;IAED;;;OAGG;IACH,oBAFW,MAAM,OAIhB;IAED;;;;;;;;OAQG;IACH,qBAJW,MAAM,YACN,MAAM,IAAI,GACR,MAAM,IAAI,CAiBtB;IAED;;;OAGG;IACH,qBAFW,MAAM,OAKhB;IAED;;OAEG;IACH,oBACsB,WAAW,CAAC,MAAM,2CAAY,CAGnD;IAED;;;;OAIG;IACH,+BAHW,MAAM,GACJ,gBAAgB,CAQ5B;IAKD;;;;OAIG;IACH,uBAFW,MAAM,wCAIhB;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,sBALW,MAAM,YACN,MAAM,IAAI;;;;;;;qBA7SX,OAAO;;;;;;2BAKP,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI;QA0S3B,eAAe,CAY3B;IA0BD;;;;OAIG;IACH,qBAFW,MAAM,OAKhB;IAED;;;;OAIG;IACH,iBAJa,CAAC,MACH,MAAM,CAAC,GACL,CAAC,CAIb;IAED,iBAEC;IAED;;;;;OAKG;IACH,yBAFW;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,iBAItD;IAED,gBAUC;IAED;;;;;OAKG;IACH,sBAFa,OAAO,CAiBnB;;CACJ;;;;;;;;8BAhaY,OAAO,wBAAwB,EAAE,kBAAkB,GAAG;IAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,MAAM,CAAA;CAAC"}
+{"version":3,"file":"viewParamRuntime.d.ts","sourceRoot":"","sources":["../../../src/paramRuntime/viewParamRuntime.js"],"names":[],"mappings":"AAmBA;;;;;;;;GAQG;AACH;IAwCI;;;;;;OAMG;IACH,2BANW,MAAM,gBAAgB,4BACtB,CAAC,OAAO,EAAE,OAAO,oBAAoB,EAAE,gBAAgB,KAAK,OAAO,8BAA8B,EAAE,OAAO,GAAG,SAAS,EAkBhI;IAED;;;;;;;;;;;OAWG;IACH,wEAvEqB,GAAG,KAAK,IAAI,CAkKhC;IAED;;;;;;;OAOG;IACH,eAFa,CAAC,aAJH,MAAM,gBACN,CAAC,YACD,OAAO,GACL,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAgC9B;IAED;;;;;;;;OAQG;IACH,oBAHW,MAAM,SACN,GAAG,QAWb;IAED;;;OAGG;IACH,oBAFW,MAAM,OAIhB;IAED;;;;;;;;OAQG;IACH,qBAJW,MAAM,YACN,MAAM,IAAI,GACR,MAAM,IAAI,CAiBtB;IAED;;;OAGG;IACH,qBAFW,MAAM,OAKhB;IAED;;OAEG;IACH,oBACsB,WAAW,CAAC,MAAM,2CAAY,CAGnD;IAED;;;;;OAKG;IACH,yBAHW,MAAM,GACJ,OAAO,CAKnB;IAED;;;;;;;;;;OAUG;IACH,0CAHW,MAAM,GACJ,OAAO,CAanB;IAED;;;;OAIG;IACH,+BAHW,MAAM,GACJ,gBAAgB,CAQ5B;IAKD;;;;OAIG;IACH,uBAFW,MAAM,wCAMhB;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,sBALW,MAAM,YACN,MAAM,IAAI;;;;;;;qBA3VX,OAAO;;;;;;2BAKP,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI;QAwV3B,eAAe,CAY3B;IA0BD;;;;OAIG;IACH,qBAFW,MAAM,OAKhB;IAED;;;;OAIG;IACH,iBAJa,CAAC,MACH,MAAM,CAAC,GACL,CAAC,CAIb;IAED,iBAEC;IAED;;;;;OAKG;IACH,yBAFW;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,iBAItD;IAED,gBAUC;IAED;;;;;OAKG;IACH,sBAFa,OAAO,CAiBnB;;CACJ;;;;;;;;8BA9cY,OAAO,wBAAwB,EAAE,kBAAkB,GAAG;IAAE,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,MAAM,CAAA;CAAC"}