@genome-spy/core 0.78.0 → 0.79.1

package/dist/src/paramRuntime/viewParamRuntime.js

@@ -17,6 +17,23 @@ export {
     withoutExprRef,
 } from "./paramUtils.js";
 
+/**
+ * @typedef {object} ViewParamRuntimeDebugState
+ * @prop {string} scopeId
+ * @prop {boolean} disposed
+ * @prop {ViewParamDebugState[]} params
+ */
+
+/**
+ * @typedef {object} ViewParamDebugState
+ * @prop {string} name
+ * @prop {"auto" | "base" | "derived" | "selection" | "push"} kind
+ * @prop {any} value
+ * @prop {boolean} writable
+ * @prop {boolean} configured
+ * @prop {import("../spec/parameter.js").Parameter | undefined} config
+ */
+
 /**
  * A class that manages parameters and expressions.
  * Supports nesting and scoped parameters through a shared runtime graph.
@@ -352,6 +369,32 @@ export default class ViewParamRuntime {
         }
     }
 
+    /**
+     * @returns {ViewParamRuntimeDebugState}
+     */
+    getDebugState() {
+        /** @type {ViewParamDebugState[]} */
+        const params = [];
+
+        for (const [name, ref] of this.#localRefs) {
+            const config = this.#paramConfigs.get(name);
+            params.push({
+                name,
+                kind: getParamKind(config),
+                value: ref.get(),
+                writable: this.#allocatedSetters.has(name),
+                configured: Boolean(config),
+                config: config ? structuredClone(config) : undefined,
+            });
+        }
+
+        return {
+            scopeId: this.#scopeId,
+            disposed: this.#disposed,
+            params,
+        };
+    }
+
     // Setter lifecycle is scope-owned: setters are dropped when the runtime scope
     // is disposed. A standalone deallocation API is intentionally not exposed.
 
@@ -487,3 +530,23 @@ export default class ViewParamRuntime {
         return false;
     }
 }
+
+/**
+ * @param {import("../spec/parameter.js").Parameter | undefined} config
+ * @returns {"auto" | "base" | "derived" | "selection" | "push"}
+ */
+function getParamKind(config) {
+    if (!config) {
+        return "auto";
+    }
+
+    if (config.push === "outer") {
+        return "push";
+    } else if ("select" in config) {
+        return "selection";
+    } else if ("expr" in config) {
+        return "derived";
+    } else {
+        return "base";
+    }
+}

package/dist/src/scales/axisResolution.d.ts

@@ -23,8 +23,43 @@ export default class AxisResolution {
      * @returns {boolean}
      */
     removeMember(member: AxisResolutionMember): boolean;
+    /**
+     * @returns {boolean} True when at least one non-chrome axis-contributing view is visible.
+     */
+    hasVisibleNonChromeMember(): boolean;
+    getDebugState(): {
+        kind: string;
+        channel: import("../spec/channel.js").PrimaryPositionalChannel;
+        hostView: any;
+        scaleResolution: any;
+        title: string;
+        axisProps: import("../spec/axis.js").GenomeAxis;
+        hasVisibleNonChromeMember: boolean;
+        members: {
+            view: import("../view/unitView.js").default<import("../spec/view.js").UnitSpec>;
+            channel: import("../spec/channel.js").PositionalChannel;
+            channelDef: import("../spec/channel.js").ChannelDefWithScale;
+        }[];
+        viewLevelAxisConfig: {
+            view: import("../view/view.js").default<import("../spec/view.js").ViewSpec>;
+            config: Partial<import("../spec/axis.js").Axis & import("../spec/axis.js").GenomeAxis>;
+        };
+    };
     getAxisProps(): import("../spec/axis.js").GenomeAxis;
     getTitle(): string;
+    /**
+     * @param {import("../view/view.js").default} view
+     * @param {Partial<import("../spec/axis.js").Axis & import("../spec/axis.js").GenomeAxis>} config
+     */
+    attachViewLevelAxisConfig(view: import("../view/view.js").default, config: Partial<import("../spec/axis.js").Axis & import("../spec/axis.js").GenomeAxis>): void;
+    /**
+     * @param {import("../view/view.js").default} view
+     */
+    clearViewLevelAxisConfig(view: import("../view/view.js").default): void;
+    getViewLevelAxisConfig(): {
+        view: import("../view/view.js").default;
+        config: Partial<import("../spec/axis.js").Axis & import("../spec/axis.js").GenomeAxis>;
+    };
     #private;
 }
 export type AxisResolutionMember<T extends import("../spec/channel.js").PositionalChannel = import("../spec/channel.js").PositionalChannel> = {

package/dist/src/scales/axisResolution.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"axisResolution.d.ts","sourceRoot":"","sources":["../../../src/scales/axisResolution.js"],"names":[],"mappings":"AAeA;;;;;;;GAOG;AACH;IASI;;OAEG;IACH,qBAFW,OAAO,oBAAoB,EAAE,wBAAwB,EAI/D;IADG,+DAAsB;IAG1B,2BAGC;IAiCD;;;OAGG;IACH,uBAHW,oBAAoB,GAClB,MAAM,OAAO,CAQzB;IAED;;;OAGG;IACH,qBAHW,oBAAoB,GAClB,OAAO,CAQnB;IAED,qDA0BC;IAED,mBAmEC;;CACJ;iCAnL6D,CAAC,SAAlD,OAAQ,oBAAoB,EAAE,iBAAkB;UAGnD,OAAO,qBAAqB,EAAE,OAAO;aACrC,CAAC;gBACD,OAAO,oBAAoB,EAAE,mBAAmB"}
+{"version":3,"file":"axisResolution.d.ts","sourceRoot":"","sources":["../../../src/scales/axisResolution.js"],"names":[],"mappings":"AAgBA;;;;;;;GAOG;AACH;IAYI;;OAEG;IACH,qBAFW,OAAO,oBAAoB,EAAE,wBAAwB,EAI/D;IADG,+DAAsB;IAG1B,2BAGC;IAiCD;;;OAGG;IACH,uBAHW,oBAAoB,GAClB,MAAM,OAAO,CASzB;IAED;;;OAGG;IACH,qBAHW,oBAAoB,GAClB,OAAO,CAQnB;IAED;;OAEG;IACH,6BAFa,OAAO,CAanB;IAED;;;;;;;;;;;;;;;;;MAwBC;IAED,qDA0BC;IAED,mBAuEC;IAED;;;OAGG;IACH,gCAHW,OAAO,iBAAiB,EAAE,OAAO,UACjC,OAAO,CAAC,OAAO,iBAAiB,EAAE,IAAI,GAAG,OAAO,iBAAiB,EAAE,UAAU,CAAC,QAuBxF;IAED;;OAEG;IACH,+BAFW,OAAO,iBAAiB,EAAE,OAAO,QAO3C;IAED;cA3PmB,OAAO,iBAAiB,EAAE,OAAO;gBAAU,OAAO,CAAC,OAAO,iBAAiB,EAAE,IAAI,GAAG,OAAO,iBAAiB,EAAE,UAAU,CAAC;MA6P3I;;CAiBJ;iCA9R6D,CAAC,SAAlD,OAAQ,oBAAoB,EAAE,iBAAkB;UAGnD,OAAO,qBAAqB,EAAE,OAAO;aACrC,CAAC;gBACD,OAAO,oBAAoB,EAAE,mBAAmB"}

package/dist/src/scales/axisResolution.js

@@ -11,6 +11,7 @@ import coalesce from "../utils/coalesce.js";
 
 import mergeObjects from "../utils/mergeObjects.js";
 import { getCachedOrCall, invalidate } from "../utils/propertyCacher.js";
+import { isChromeView } from "../view/viewSelectors.js";
 import { orderResolutionMembers } from "./resolutionMemberOrder.js";
 
 /**
@@ -30,6 +31,9 @@ export default class AxisResolution {
     /** @type {Set<AxisResolutionMember>} The involved views */
     #members = new Set();
 
+    /** @type {{ view: import("../view/view.js").default, config: Partial<import("../spec/axis.js").Axis & import("../spec/axis.js").GenomeAxis> } | undefined} */
+    #viewLevelAxisConfig;
+
     /**
      * @param {import("../spec/channel.js").PrimaryPositionalChannel} channel
      */
@@ -78,6 +82,7 @@ export default class AxisResolution {
      * @returns {() => boolean}
      */
     registerMember(member) {
+        this.#assertNoMixing(member);
         this.#addMember(member);
         return () => {
             const removed = this.removeMember(member);
@@ -97,15 +102,57 @@ export default class AxisResolution {
         return removed;
     }
 
+    /**
+     * @returns {boolean} True when at least one non-chrome axis-contributing view is visible.
+     */
+    hasVisibleNonChromeMember() {
+        for (const member of this.#members) {
+            if (
+                member.view.isVisible() &&
+                !member.view.getLayoutAncestors().some(isChromeView)
+            ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    getDebugState() {
+        return {
+            kind: "axis",
+            channel: this.channel,
+            hostView:
+                this.scaleResolution?.getDebugState().hostView ??
+                this.#viewLevelAxisConfig?.view ??
+                this.#members.values().next().value?.view,
+            scaleResolution: this.scaleResolution,
+            title: this.getTitle(),
+            axisProps: this.getAxisProps(),
+            hasVisibleNonChromeMember: this.hasVisibleNonChromeMember(),
+            members: orderResolutionMembers(this.#members).map((member) => ({
+                view: member.view,
+                channel: member.channel,
+                channelDef: structuredClone(member.channelDef),
+            })),
+            viewLevelAxisConfig: this.#viewLevelAxisConfig
+                ? {
+                      view: this.#viewLevelAxisConfig.view,
+                      config: structuredClone(this.#viewLevelAxisConfig.config),
+                  }
+                : undefined,
+        };
+    }
+
     getAxisProps() {
         return getCachedOrCall(this, "axisProps", () => {
-            const propArray = orderResolutionMembers(this.#members).map(
-                (member) => {
-                    const channelDef =
-                        member.view.mark.encoding[member.channel];
-                    return "axis" in channelDef && channelDef.axis;
-                }
-            );
+            const propArray = this.#viewLevelAxisConfig
+                ? [this.#viewLevelAxisConfig.config]
+                : orderResolutionMembers(this.#members).map((member) => {
+                      const channelDef =
+                          member.view.mark.encoding[member.channel];
+                      return "axis" in channelDef && channelDef.axis;
+                  });
 
             if (
                 propArray.length > 0 &&
@@ -126,6 +173,10 @@ export default class AxisResolution {
     }
 
     getTitle() {
+        if (this.#viewLevelAxisConfig?.config.title !== undefined) {
+            return this.#viewLevelAxisConfig.config.title;
+        }
+
         /** @param {AxisResolutionMember} member} */
         const computeTitle = (member) => {
             const channelDef = getChannelDefWithScale(
@@ -193,4 +244,61 @@ export default class AxisResolution {
 
         return uniqueTitles.size ? [...uniqueTitles].join(", ") : null;
     }
+
+    /**
+     * @param {import("../view/view.js").default} view
+     * @param {Partial<import("../spec/axis.js").Axis & import("../spec/axis.js").GenomeAxis>} config
+     */
+    attachViewLevelAxisConfig(view, config) {
+        if (
+            this.#viewLevelAxisConfig &&
+            this.#viewLevelAxisConfig.view !== view
+        ) {
+            throw new Error(
+                `Multiple view-level axis configs target the same ${this.channel} axis resolution.`
+            );
+        }
+
+        for (const member of this.#members) {
+            const channelDef = member.view.mark.encoding[member.channel];
+            if ("axis" in channelDef && channelDef.axis !== undefined) {
+                throw new Error(
+                    `Cannot mix view-level axes.${this.channel} with encoding.${member.channel}.axis in the same axis resolution.`
+                );
+            }
+        }
+
+        this.#viewLevelAxisConfig = { view, config };
+        invalidate(this, "axisProps");
+    }
+
+    /**
+     * @param {import("../view/view.js").default} view
+     */
+    clearViewLevelAxisConfig(view) {
+        if (this.#viewLevelAxisConfig?.view === view) {
+            this.#viewLevelAxisConfig = undefined;
+            invalidate(this, "axisProps");
+        }
+    }
+
+    getViewLevelAxisConfig() {
+        return this.#viewLevelAxisConfig;
+    }
+
+    /**
+     * @param {AxisResolutionMember} member
+     */
+    #assertNoMixing(member) {
+        if (!this.#viewLevelAxisConfig) {
+            return;
+        }
+
+        const channelDef = member.view.mark.encoding[member.channel];
+        if ("axis" in channelDef && channelDef.axis !== undefined) {
+            throw new Error(
+                `Cannot mix view-level axes.${this.channel} with encoding.${member.channel}.axis in the same axis resolution.`
+            );
+        }
+    }
 }

package/dist/src/scales/legendResolution.d.ts

@@ -0,0 +1,83 @@
+export default class LegendResolution {
+    /**
+     * @param {import("../spec/channel.js").ChannelWithScale} channel
+     */
+    constructor(channel: import("../spec/channel.js").ChannelWithScale);
+    channel: import("../spec/channel.js").ChannelWithScale;
+    /**
+     * @param {LegendResolutionMember} member
+     * @returns {() => boolean}
+     */
+    registerMember(member: LegendResolutionMember): () => boolean;
+    /**
+     * @param {LegendResolutionMember} member
+     * @returns {boolean}
+     */
+    removeMember(member: LegendResolutionMember): boolean;
+    /**
+     * @returns {LegendDefinition[]}
+     */
+    getLegendDefs(): LegendDefinition[];
+    /**
+     * @returns {boolean}
+     */
+    hasVisibleNonChromeMember(): boolean;
+    getDebugState(): {
+        kind: string;
+        channel: import("../spec/channel.js").ChannelWithScale;
+        hostView: any;
+        legendDefs: {
+            view: import("../view/unitView.js").default<import("../spec/view.js").UnitSpec>;
+            scaleResolution: import("./scaleResolution.js").default;
+            legend: import("../spec/legend.js").LegendConfig;
+            channel: import("../spec/channel.js").ChannelWithScale;
+            field?: string;
+            type: LegendType;
+            symbolChannels?: Partial<Record<import("../spec/channel.js").ChannelWithScale, string>>;
+            symbolGeometry?: "point" | "stroke";
+            format?: string;
+            dataType: import("../spec/channel.js").Type;
+        }[];
+        hasVisibleNonChromeMember: boolean;
+        members: {
+            view: import("../view/unitView.js").default<import("../spec/view.js").UnitSpec>;
+            channel: import("../spec/channel.js").ChannelWithScale;
+        }[];
+        viewLevelLegendConfig: {
+            view: import("../view/view.js").default<import("../spec/view.js").ViewSpec>;
+            config: import("../spec/legend.js").Legend;
+        };
+    };
+    /**
+     * @param {import("../view/view.js").default} view
+     * @param {import("../spec/legend.js").Legend} config
+     */
+    attachViewLevelLegendConfig(view: import("../view/view.js").default, config: import("../spec/legend.js").Legend): void;
+    /**
+     * @param {import("../view/view.js").default} view
+     */
+    clearViewLevelLegendConfig(view: import("../view/view.js").default): void;
+    getViewLevelLegendConfig(): {
+        view: import("../view/view.js").default;
+        config: import("../spec/legend.js").Legend;
+    };
+    #private;
+}
+export type LegendType = "symbol" | "gradient";
+export type LegendResolutionMember = {
+    view: import("../view/unitView.js").default;
+    channel: import("../spec/channel.js").ChannelWithScale;
+};
+export type LegendDefinition = {
+    view: import("../view/unitView.js").default;
+    channel: import("../spec/channel.js").ChannelWithScale;
+    field?: string;
+    type: LegendType;
+    symbolChannels?: Partial<Record<import("../spec/channel.js").ChannelWithScale, string>>;
+    symbolGeometry?: "point" | "stroke";
+    legend: import("../spec/legend.js").LegendConfig;
+    format?: string;
+    dataType: import("../spec/channel.js").Type;
+    scaleResolution: import("./scaleResolution.js").default;
+};
+//# sourceMappingURL=legendResolution.d.ts.map

package/dist/src/scales/legendResolution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legendResolution.d.ts","sourceRoot":"","sources":["../../../src/scales/legendResolution.js"],"names":[],"mappings":"AA2CA;IAOI;;OAEG;IACH,qBAFW,OAAO,oBAAoB,EAAE,gBAAgB,EAIvD;IADG,uDAAsB;IAG1B;;;OAGG;IACH,uBAHW,sBAAsB,GACpB,MAAM,OAAO,CAMzB;IAED;;;OAGG;IACH,qBAHW,sBAAsB,GACpB,OAAO,CAInB;IAED;;OAEG;IACH,iBAFa,gBAAgB,EAAE,CAoB9B;IAgGD;;OAEG;IACH,6BAFa,OAAO,CAanB;IAED;;;;;;;;qBA7LY,OAAO,oBAAoB,EAAE,gBAAgB;oBAC9C,MAAM;kBACR,UAAU;6BACC,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;6BACtE,OAAO,GAAG,QAAQ;qBAE1B,MAAM;sBACL,OAAO,oBAAoB,EAAE,IAAI;;;;;;;;;;;MAmN7C;IAED;;;OAGG;IACH,kCAHW,OAAO,iBAAiB,EAAE,OAAO,UACjC,OAAO,mBAAmB,EAAE,MAAM,QAqB5C;IAED;;OAEG;IACH,iCAFW,OAAO,iBAAiB,EAAE,OAAO,QAM3C;IAED;cAlOmB,OAAO,iBAAiB,EAAE,OAAO;gBAAU,OAAO,mBAAmB,EAAE,MAAM;MAoO/F;;CAYJ;yBAnRY,QAAQ,GAAG,UAAU;;UAExB,OAAO,qBAAqB,EAAE,OAAO;aACrC,OAAO,oBAAoB,EAAE,gBAAgB;;+BAE1C;IACN,IAAI,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;IAC5C,OAAO,EAAE,OAAO,oBAAoB,EAAE,gBAAgB,CAAC;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;IACxF,cAAc,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;IACpC,MAAM,EAAE,OAAO,mBAAmB,EAAE,YAAY,CAAC;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,oBAAoB,EAAE,IAAI,CAAC;IAC5C,eAAe,EAAE,OAAO,sBAAsB,EAAE,OAAO,CAAA;CAC1D"}