@genome-spy/core 0.45.0 → 0.46.1

package/dist/src/view/paramMediator.d.ts

@@ -52,10 +52,11 @@ export default class ParamMediator {
      *
      * @param {string} paramName
      * @param {T} initialValue
+     * @param {boolean} [passive] If true, the setter will not notify listeners when the value changes.
      * @returns {(value: T) => void}
      * @template T
      */
-    allocateSetter<T>(paramName: string, initialValue: T): (value: T) => void;
+    allocateSetter<T>(paramName: string, initialValue: T, passive?: boolean): (value: T) => void;
     /**
      * Gets an existing setter for a parameter. Throws if the setter is not found.
      * @param {string} paramName

package/dist/src/view/paramMediator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paramMediator.d.ts","sourceRoot":"","sources":["../../../src/view/paramMediator.js"],"names":[],"mappings":"AAsQA;;;GAGG;AACH,6BAHW,GAAG,+CAKb;AAED;;;;;;;GAOG;AACH,oFASC;AAED;;;;;;;;;;GAUG;AACH,mFANW,aAAa,+CAEW,IAAI,KAwCtC;AA7UD;;;;;GAKG;AACH;IA2BI;;;;;OAKG;IACH,2BALW,MAAM,aAAa,EAU7B;IA7BD;;;OAGG;IACH,0BAHU,IAAI,MAAM,EAAE,IAAI,MAAM,IAAI,CAAC,CAAC,CAGvB;IA2Bf;;;OAGG;IACH,gFAzCqB,GAAG,KAAK,IAAI,CAkEhC;IAED;;;;;;OAMG;IACH,6BALW,MAAM,kCAEU,IAAI,CA8B9B;IAED;;;OAGG;IACH,qBAFW,MAAM,WA9Fc,GAAG,KAAK,IAAI,CAsG1C;IAED;;;OAGG;IACH,oBAFW,MAAM,OAIhB;IAED;;;OAGG;IACH,qBAFW,MAAM,OAKhB;IAED;;OAEG;IACH,0FAIC;IAED;;;;;OAKG;IACH,0CAJW,MAAM,GACJ,aAAa,CASzB;IAID;;;;OAIG;IACH,uBAFW,MAAM,mBA4EhB;IAED;;;;OAIG;IACH,qBAFW,MAAM,OAKhB;;CACJ;;;;;;4BA7P4F,MAAM,IAAI,KAAK,IAAI;gBAAc,MAAM,IAAI;gBAAc,MAAM,MAAM"}
+{"version":3,"file":"paramMediator.d.ts","sourceRoot":"","sources":["../../../src/view/paramMediator.js"],"names":[],"mappings":"AAuQA;;;GAGG;AACH,6BAHW,GAAG,+CAKb;AAED;;;;;;;GAOG;AACH,oFASC;AAED;;;;;;;;;;GAUG;AACH,mFANW,aAAa,+CAEW,IAAI,KAwCtC;AA9UD;;;;;GAKG;AACH;IA2BI;;;;;OAKG;IACH,2BALW,MAAM,aAAa,EAU7B;IA7BD;;;OAGG;IACH,0BAHU,IAAI,MAAM,EAAE,IAAI,MAAM,IAAI,CAAC,CAAC,CAGvB;IA2Bf;;;OAGG;IACH,gFAzCqB,GAAG,KAAK,IAAI,CAkEhC;IAED;;;;;;;OAOG;IACH,6BANW,MAAM,6BAEN,OAAO,iBACS,IAAI,CA8B9B;IAED;;;OAGG;IACH,qBAFW,MAAM,WA/Fc,GAAG,KAAK,IAAI,CAuG1C;IAED;;;OAGG;IACH,oBAFW,MAAM,OAIhB;IAED;;;OAGG;IACH,qBAFW,MAAM,OAKhB;IAED;;OAEG;IACH,0FAIC;IAED;;;;;OAKG;IACH,0CAJW,MAAM,GACJ,aAAa,CASzB;IAID;;;;OAIG;IACH,uBAFW,MAAM,mBA4EhB;IAED;;;;OAIG;IACH,qBAFW,MAAM,OAKhB;;CACJ;;;;;;4BA9P4F,MAAM,IAAI,KAAK,IAAI;gBAAc,MAAM,IAAI;gBAAc,MAAM,MAAM"}

package/dist/src/view/paramMediator.js

@@ -82,10 +82,11 @@ export default class ParamMediator {
      *
      * @param {string} paramName
      * @param {T} initialValue
+     * @param {boolean} [passive] If true, the setter will not notify listeners when the value changes.
      * @returns {(value: T) => void}
      * @template T
      */
-    allocateSetter(paramName, initialValue) {
+    allocateSetter(paramName, initialValue, passive = false) {
         if (this.#allocatedSetters.has(paramName)) {
             throw new Error(
                 "Setter already allocated for parameter: " + paramName
@@ -99,7 +100,7 @@ export default class ParamMediator {
                 this.#paramValues.set(paramName, value);
 
                 const listeners = this.paramListeners.get(paramName);
-                if (listeners) {
+                if (listeners && !passive) {
                     for (const listener of listeners) {
                         listener();
                     }

package/dist/src/view/paramMediator.test.js

@@ -55,6 +55,19 @@ describe("Single-level ParamMediator", () => {
         expect(calls).toBe(2);
     });
 
+    test("Passive parameter does not trigger listeners", () => {
+        const pm = new ParamMediator();
+        const setter = pm.allocateSetter("foo", 42, true);
+        const expr = pm.createExpression("foo");
+
+        let result = expr();
+
+        expr.addListener(() => (result = expr()));
+
+        setter(50);
+        expect(result).toBe(42);
+    });
+
     test("Expression invalidation", () => {
         const pm = new ParamMediator();
         const setter = pm.allocateSetter("foo", 42);

package/dist/src/view/viewFactory.d.ts

@@ -55,7 +55,7 @@ export function isSampleSpec(spec: import("../spec/view.js").ViewSpec): spec is
 export const VIEW_ROOT_NAME: "viewRoot";
 /**
  * @typedef {object} ViewFactoryOptions
- * @property {boolean} [allowImport]
+ * @property {boolean} [allowImport] allows imports from urls
  * @property {boolean} [wrapRoot]
  */
 /**
@@ -102,6 +102,9 @@ export class ViewFactory {
     #private;
 }
 export type ViewFactoryOptions = {
+    /**
+     * allows imports from urls
+     */
     allowImport?: boolean;
     wrapRoot?: boolean;
 };

package/dist/src/view/viewFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"viewFactory.d.ts","sourceRoot":"","sources":["../../../src/view/viewFactory.js"],"names":[],"mappings":"AAoPA;;;;GAIG;AACH,iHAEC;AAED;;;;GAIG;AACH,mHAEC;AAED;;;;GAIG;AACH,mHAOC;AAED;;;;GAIG;AACH,yIAMC;AAED;;;;GAIG;AACH,mCAHW,MAAM,gDAKhB;AAED;;;;GAIG;AACH,uHAEC;AAED;;;;GAIG;AACH,6FAEC;AAED;;;;GAIG;AACH,qHAEC;AAED;;;;GAIG;AACH,2HAOC;AAtUD,wCAAyC;AAEzC;;;;GAIG;AAEH;;GAEG;AACH;IAiBI;;OAEG;IACH,sBAFW,kBAAkB,EAoC5B;IAjCG,2CAA2C;IAC3C,SADW,SAAS,kBAAkB,CAAC,CAKtC;IA8BL;;;OAGG;IACH,qEAlDiC,OAAO,yHAC2B,OAAO,oBAAoB,EAAE,OAAO,eAAe,OAAO,WAAW,EAAE,OAAO,gBAAgB,MAAM,KAAK,IAAI,QAmD/K;IAED;;;;;;OAMG;IACH,wHAJW,OAAO,oBAAoB,EAAE,OAAO,eACpC,OAAO,WAAW,EAAE,OAAO,gBAC3B,MAAM,QAmBhB;IAED;;;;OAIG;IACH,iGAQC;IAED;;;;;;;;;;OAUG;IACH,uKALW,OAAO,oBAAoB,EAAE,OAAO,eACpC,OAAO,WAAW,EAAE,OAAO,gBAC3B,MAAM,4DACc,IAAI,iBA8DlC;;CACJ;;kBAxLa,OAAO;eACP,OAAO;;iBAfJ,WAAW"}
+{"version":3,"file":"viewFactory.d.ts","sourceRoot":"","sources":["../../../src/view/viewFactory.js"],"names":[],"mappings":"AAgRA;;;;GAIG;AACH,iHAEC;AAED;;;;GAIG;AACH,mHAEC;AAED;;;;GAIG;AACH,mHAOC;AAED;;;;GAIG;AACH,yIAMC;AAED;;;;GAIG;AACH,mCAHW,MAAM,gDAKhB;AAED;;;;GAIG;AACH,uHAEC;AAED;;;;GAIG;AACH,6FAEC;AAED;;;;GAIG;AACH,qHAEC;AAED;;;;GAIG;AACH,2HAOC;AAlWD,wCAAyC;AAEzC;;;;GAIG;AAEH;;GAEG;AACH;IAiBI;;OAEG;IACH,sBAFW,kBAAkB,EAoC5B;IAjCG,2CAA2C;IAC3C,SADW,SAAS,kBAAkB,CAAC,CAKtC;IA8BL;;;OAGG;IACH,qEAlDiC,OAAO,yHAC2B,OAAO,oBAAoB,EAAE,OAAO,eAAe,OAAO,WAAW,EAAE,OAAO,gBAAgB,MAAM,KAAK,IAAI,QAmD/K;IAED;;;;;;OAMG;IACH,wHAJW,OAAO,oBAAoB,EAAE,OAAO,eACpC,OAAO,WAAW,EAAE,OAAO,gBAC3B,MAAM,QAmBhB;IAED;;;;OAIG;IACH,iGAQC;IAED;;;;;;;;;;OAUG;IACH,uKALW,OAAO,oBAAoB,EAAE,OAAO,eACpC,OAAO,WAAW,EAAE,OAAO,gBAC3B,MAAM,4DACc,IAAI,iBAuElC;;CACJ;;;;;kBAjMa,OAAO;eACP,OAAO;;iBAfJ,WAAW"}

package/dist/src/view/viewFactory.js

@@ -13,7 +13,7 @@ export const VIEW_ROOT_NAME = "viewRoot";
 
 /**
  * @typedef {object} ViewFactoryOptions
- * @property {boolean} [allowImport]
+ * @property {boolean} [allowImport] allows imports from urls
  * @property {boolean} [wrapRoot]
  */
 
@@ -148,24 +148,33 @@ export class ViewFactory {
         let viewSpec;
 
         if (isImportSpec(spec)) {
-            if (this.options.allowImport) {
-                viewSpec = await loadExternalViewSpec(
-                    spec,
-                    dataParent.getBaseUrl(),
-                    context
-                );
+            /** @type {ViewSpec} */
+            let importedSpec;
 
-                if (validator) {
-                    validator(viewSpec);
+            if ("url" in spec.import) {
+                if (this.options.allowImport) {
+                    importedSpec = await loadExternalViewSpec(
+                        spec,
+                        dataParent.getBaseUrl(),
+                        context
+                    );
+                } else {
+                    throw new ViewError(
+                        "Importing views is not allowed!",
+                        layoutParent
+                    );
                 }
-
-                applyParamsToImportedSpec(viewSpec, spec.import);
+            } else if ("template" in spec.import) {
+                importedSpec = findTemplate(spec.import.template, dataParent);
             } else {
-                throw new ViewError(
-                    "Importing views is not allowed!",
-                    layoutParent
-                );
+                throw new Error("Invalid import: " + JSON.stringify(spec));
             }
+
+            validator?.(importedSpec);
+
+            applyParamsToImportedSpec(importedSpec, spec);
+
+            viewSpec = importedSpec;
         } else {
             viewSpec = spec;
         }
@@ -200,19 +209,38 @@ export class ViewFactory {
 }
 
 /**
- *
+ * @param {string} name
+ * @param {View} view Start searching from this view, then search within its parent, etc.
+ */
+function findTemplate(name, view) {
+    const template = view.spec?.templates?.[name];
+    if (template) {
+        // Ensure that the template is not altered
+        return structuredClone(template);
+    }
+
+    if (view.dataParent) {
+        return findTemplate(name, view.dataParent);
+    } else {
+        throw new Error(
+            `Cannot find template "${name}" in current view or its ancestors!`
+        );
+    }
+}
+
+/**
  * @param {ViewSpec} importedSpec
- * @param {import("../spec/view.js").ImportParams} importParams
+ * @param {import("../spec/view.js").ImportSpec} importSpec
  */
-function applyParamsToImportedSpec(importedSpec, importParams) {
-    if (importParams.name != null) {
-        importedSpec.name = importParams.name;
+function applyParamsToImportedSpec(importedSpec, importSpec) {
+    if (importSpec.name != null) {
+        importedSpec.name = importSpec.name;
     }
 
-    const params = isArray(importParams.params)
-        ? importParams.params
-        : isObject(importParams.params)
-        ? Object.entries(importParams.params).map(([name, value]) => ({
+    const params = isArray(importSpec.params)
+        ? importSpec.params
+        : isObject(importSpec.params)
+        ? Object.entries(importSpec.params).map(([name, value]) => ({
               name,
               value,
           }))

package/dist/src/view/viewUtils.d.ts

@@ -10,12 +10,6 @@ export function isFacetFieldDef(def: import("../spec/channel.js").ChannelDef | i
  * @returns {spec is FacetMapping}
  */
 export function isFacetMapping(def: import("../spec/channel.js").FacetFieldDef | import("../spec/view.js").FacetMapping): spec is FacetMapping;
-/**
- *
- * @param {object} config
- * @returns {config is ImportConfig}
- */
-export function isImportConfig(config: object): config is ImportConfig;
 /**
  * Returns all marks in the order (DFS) they are rendered
  * @param {View} root
@@ -60,8 +54,9 @@ export function findEncodedFields(view: View): {
  * @param {import("../spec/view.js").ImportSpec} spec
  * @param {string} baseUrl
  * @param {import("../types/viewContext.js").default} viewContext
+ * @returns {Promise<import("../spec/view.js").ViewSpec>}
  */
-export function loadExternalViewSpec(spec: import("../spec/view.js").ImportSpec, baseUrl: string, viewContext: import("../types/viewContext.js").default): Promise<any>;
+export function loadExternalViewSpec(spec: import("../spec/view.js").ImportSpec, baseUrl: string, viewContext: import("../types/viewContext.js").default): Promise<import("../spec/view.js").ViewSpec>;
 /**
  * @param {function(View, View[]):void} visitor
  */

package/dist/src/view/viewUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"viewUtils.d.ts","sourceRoot":"","sources":["../../../src/view/viewUtils.js"],"names":[],"mappings":"AAWA;;;;GAIG;AACH,qCAHW,OAAO,oBAAoB,EAAE,UAAU,GAAG,OAAO,iBAAiB,EAAE,YAAY,yBAK1F;AAED;;;;GAIG;AACH,oCAHW,OAAO,oBAAoB,EAAE,aAAa,GAAG,OAAO,iBAAiB,EAAE,YAAY,wBAQ7F;AAED;;;;GAIG;AACH,uCAHW,MAAM,0BAKhB;AAED;;;GAGG;AACH,+BAFW,IAAI,wCAMd;AAED;;;;GAIG;AACH,wCAFW,IAAI,UASd;AAED;;GAEG;AACH,kDAFW,IAAI,QAiBd;AAED;;;;;;;GAOG;AACH,4CAFW,IAAI,QAUd;AAED;;;;GAIG;AACH,qCAJW,IAAI,iBACJ,OAAO,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,wDAcrD;AAED;;;GAGG;AACH,wCAFW,IAAI;UAGO,QAAQ;aAAW,OAAO,oBAAoB,EAAE,OAAO;WAAS,OAAO,oBAAoB,EAAE,KAAK;UAAQ,OAAO,oBAAoB,EAAE,IAAI;IAqBhK;AAED;;;;GAIG;AACH,2CAJW,OAAO,iBAAiB,EAAE,UAAU,WACpC,MAAM,eACN,OAAO,yBAAyB,EAAE,OAAO,gBA8BnD;AAED;;GAEG;AACH,gDAFoB,IAAI,QAAE,IAAI,EAAE,KAAE,IAAI,+BAkBrC;AAED;;;;;;GAMG;AACH,4CAJW,IAAI,QACJ,MAAM,GACJ,IAAI,EAAE,CAalB;AAED;;;GAGG;AACH,0CAFW,IAAI,eAqBd;AAOD;;GAEG;AACH,gDAFW,IAAI,mDAId;AAED;;GAEG;AACH,kDAFW,OAAO,wBAAwB,EAAE,cAAc;;;EAczD;AAxBM,uCAFI,MAAM,WAE0D;iBAxP9B,WAAW;qBAFnC,eAAe"}
+{"version":3,"file":"viewUtils.d.ts","sourceRoot":"","sources":["../../../src/view/viewUtils.js"],"names":[],"mappings":"AAWA;;;;GAIG;AACH,qCAHW,OAAO,oBAAoB,EAAE,UAAU,GAAG,OAAO,iBAAiB,EAAE,YAAY,yBAK1F;AAED;;;;GAIG;AACH,oCAHW,OAAO,oBAAoB,EAAE,aAAa,GAAG,OAAO,iBAAiB,EAAE,YAAY,wBAQ7F;AAED;;;GAGG;AACH,+BAFW,IAAI,wCAMd;AAED;;;;GAIG;AACH,wCAFW,IAAI,UASd;AAED;;GAEG;AACH,kDAFW,IAAI,QAiBd;AAED;;;;;;;GAOG;AACH,4CAFW,IAAI,QAUd;AAED;;;;GAIG;AACH,qCAJW,IAAI,iBACJ,OAAO,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,wDAcrD;AAED;;;GAGG;AACH,wCAFW,IAAI;UAGO,QAAQ;aAAW,OAAO,oBAAoB,EAAE,OAAO;WAAS,OAAO,oBAAoB,EAAE,KAAK;UAAQ,OAAO,oBAAoB,EAAE,IAAI;IAqBhK;AAED;;;;;GAKG;AACH,2CALW,OAAO,iBAAiB,EAAE,UAAU,WACpC,MAAM,eACN,OAAO,yBAAyB,EAAE,OAAO,GACvC,QAAQ,OAAO,iBAAiB,EAAE,QAAQ,CAAC,CA6BvD;AAED;;GAEG;AACH,gDAFoB,IAAI,QAAE,IAAI,EAAE,KAAE,IAAI,+BAkBrC;AAED;;;;;;GAMG;AACH,4CAJW,IAAI,QACJ,MAAM,GACJ,IAAI,EAAE,CAalB;AAED;;;GAGG;AACH,0CAFW,IAAI,eAqBd;AAOD;;GAEG;AACH,gDAFW,IAAI,mDAId;AAED;;GAEG;AACH,kDAFW,OAAO,wBAAwB,EAAE,cAAc;;;EAczD;AAxBM,uCAFI,MAAM,WAE0D;iBA/O9B,WAAW;qBAFnC,eAAe"}

package/dist/src/view/viewUtils.js

@@ -30,15 +30,6 @@ export function isFacetMapping(def) {
     );
 }
 
-/**
- *
- * @param {object} config
- * @returns {config is ImportConfig}
- */
-export function isImportConfig(config) {
-    return "name" in config || "url" in config;
-}
-
 /**
  * Returns all marks in the order (DFS) they are rendered
  * @param {View} root
@@ -151,34 +142,34 @@ export function findEncodedFields(view) {
  * @param {import("../spec/view.js").ImportSpec} spec
  * @param {string} baseUrl
  * @param {import("../types/viewContext.js").default} viewContext
+ * @returns {Promise<import("../spec/view.js").ViewSpec>}
  */
 export async function loadExternalViewSpec(spec, baseUrl, viewContext) {
-    if (!spec.import.url) {
-        throw new Error(
-            "Cannot import, not an import spec: " + JSON.stringify(spec)
-        );
-    }
+    const importParam = spec.import;
+    if ("url" in importParam) {
+        const loader = vegaLoader({ baseURL: baseUrl });
+        const url = importParam.url;
 
-    const loader = vegaLoader({ baseURL: baseUrl });
-    const url = spec.import.url;
+        const importedSpec = JSON.parse(
+            await loader.load(url).catch((/** @type {Error} */ e) => {
+                throw new Error(
+                    `Could not load imported view spec: ${url} \nReason: ${e.message}`
+                );
+            })
+        );
 
-    const importedSpec = JSON.parse(
-        await loader.load(url).catch((/** @type {Error} */ e) => {
+        if (viewContext.isViewSpec(importedSpec)) {
+            importedSpec.baseUrl = url.match(/^[^?#]*\//)?.[0];
+            return importedSpec;
+        } else {
             throw new Error(
-                `Could not load imported view spec: ${url} \nReason: ${e.message}`
+                `The imported spec "${url}" is not a view spec: ${JSON.stringify(
+                    spec
+                )}`
             );
-        })
-    );
-
-    if (viewContext.isViewSpec(importedSpec)) {
-        importedSpec.baseUrl = url.match(/^[^?#]*\//)?.[0];
-        return importedSpec;
+        }
     } else {
-        throw new Error(
-            `The imported spec "${url}" is not a view spec: ${JSON.stringify(
-                spec
-            )}`
-        );
+        throw new Error("Not an url import: " + JSON.stringify(importParam));
     }
 }
 

package/package.json

@@ -7,7 +7,7 @@
   },
   "contributors": [],
   "license": "MIT",
-  "version": "0.45.0",
+  "version": "0.46.1",
   "jsdelivr": "dist/bundle/index.js",
   "unpkg": "dist/bundle/index.js",
   "browser": "dist/bundle/index.js",
@@ -64,5 +64,5 @@
     "vega-scale": "^7.3.1",
     "vega-util": "^1.17.2"
   },
-  "gitHead": "7b6de39e856c85c755b2134bf451780c8b7922bb"
+  "gitHead": "9e43f979e60032c4a6a3780b1eba429358917bd7"
 }