@genome-spy/core 0.24.2 → 0.25.0

package/package.json

@@ -7,7 +7,7 @@
   },
   "contributors": [],
   "license": "BSD-2-Clause",
-  "version": "0.24.2",
+  "version": "0.25.0",
   "main": "dist/index.js",
   "module": "src/index.js",
   "exports": {
@@ -53,5 +53,5 @@
     "vega-scale": "^7.1.1",
     "vega-util": "^1.16.0"
   },
-  "gitHead": "587ef91161457b17a039f82111d15df339e1e9f5"
+  "gitHead": "1b8f0acaf7aaf15b1c6d348b7a1d891e41dbc977"
 }

package/src/data/dataFlow.js

@@ -4,6 +4,8 @@
  * @typedef {import("./collector").default} Collector
  */
 
+import NamedSource from "./sources/namedSource";
+
 /**
  * @template H A key (string, object, whatever) that is used to retrieve
  *      data sources and collectors.
@@ -76,6 +78,43 @@ export default class DataFlow {
         return this._dataSourcesByHost.get(key);
     }
 
+    /**
+     *
+     * @param {string} name
+     */
+    findNamedDataSource(name) {
+        /** @type {NamedSource} */
+        let namedSource;
+        /** @type {H[]} */
+        let hosts = [];
+
+        // Note: If a named sources with the same name are present at multiple locations in the
+        // view hierarchy, the should actually be exactly the same instance. It's arranged that
+        // way in the data flow optimization phase.
+
+        for (const [host, dataSource] of this._dataSourcesByHost.entries()) {
+            if (dataSource instanceof NamedSource) {
+                if (name == dataSource.identifier) {
+                    if (namedSource && namedSource !== dataSource) {
+                        // TODO: Write a test case for this and remove the runtime check.
+                        throw new Error(
+                            `Found multiple instances of named data: ${name}. Data flow optimization is broken (it's a bug).`
+                        );
+                    }
+                    namedSource = dataSource;
+                    hosts.push(host);
+                }
+            }
+        }
+
+        if (namedSource) {
+            return {
+                dataSource: namedSource,
+                hosts,
+            };
+        }
+    }
+
     /**
      *
      * @param {Collector} collector

package/src/data/sources/namedSource.js

@@ -10,14 +10,20 @@ export function isNamedData(data) {
 }
 
 export default class NamedSource extends DataSource {
+    /**
+     * Data that has been provided explicitly using the updateDynamicData method
+     * @type {any[]}
+     */
+    #explicitData;
+
     /**
      * @param {import("../../spec/data").NamedData} params
-     * @param {function(string):any[]} getNamedData
+     * @param {function(string):any[]} provider Function that retrieves a dataset using a name
      */
-    constructor(params, getNamedData) {
+    constructor(params, provider) {
         super();
 
-        this.getNamedData = getNamedData;
+        this.provider = provider;
         this.params = params;
     }
 
@@ -28,17 +34,20 @@ export default class NamedSource extends DataSource {
         return this.params.name;
     }
 
-    _getValues() {
-        const data = this.getNamedData(this.params.name);
-        if (data) {
-            return data;
-        } else {
-            throw new Error("Cannot find named data: " + this.params.name);
-        }
+    /**
+     * Update the named data. If data is omitted, a data provider is used instead.
+     *
+     * @param {import("../flowNode").Datum[]} [data]
+     */
+    updateDynamicData(data) {
+        // TODO: Throw is data is undefined and the provider is unable to provide any data
+        this.#explicitData = data;
+        this.loadSynchronously();
     }
 
     loadSynchronously() {
-        const data = this._getValues();
+        const data =
+            this.#explicitData ?? this.provider(this.params.name) ?? [];
 
         /** @type {(x: any) => import("../flowNode").Datum} */
         let wrap = (x) => x;

package/src/embedApi.d.ts

@@ -17,9 +17,9 @@ export type EmbedFunction = (
 
 export interface EmbedOptions {
     /**
-     * A function that allows retrieval of named data sources.
-     *
-     * TODO: Support dynamic updates, i.e., pushing new data.
+     * A function that allows retrieval of named data. There are two ways to provide named data:
+     * 1. A data provider (this)
+     * 2. Explicit updates using the `updateNamedData` method (the other).
      */
     namedDataProvider?: (name: string) => any[];
 
@@ -52,8 +52,16 @@ export interface EmbedResult {
     removeEventListener: (type: string, listener: (event: any) => void) => void;
 
     /**
-     * Returns a named _ScaleResolution_ object that allows for attaching event
+     * Returns a named `ScaleResolution` object that allows for attaching event
      * listeners and controlling the scale domain.
      */
     getScaleResolutionByName: (name: string) => ScaleResolutionApi;
+
+    /**
+     * Updates a named dataset
+     *
+     * @param name data source to update
+     * @param data new data. If left undefined, the data is retrieved from a provider.
+     */
+    updateNamedData: (name: string, data?: any[]) => void;
 }

package/src/genomeSpy.js

@@ -137,10 +137,9 @@ export default class GenomeSpy {
     }
 
     /**
-     *
      * @param {string} name
      */
-    getNamedData(name) {
+    getNamedDataFromProvider(name) {
         for (const provider of this.namedDataProviders) {
             const data = provider(name);
             if (data) {
@@ -149,6 +148,36 @@ export default class GenomeSpy {
         }
     }
 
+    /**
+     *
+     * @param {string} name
+     * @param {any[]} data
+     */
+    updateNamedData(name, data) {
+        const namedSource =
+            this.viewRoot.context.dataFlow.findNamedDataSource(name);
+        if (!namedSource) {
+            throw new Error("No such named data source: " + name);
+        }
+
+        namedSource.dataSource.updateDynamicData(data);
+
+        // Scale domains may need adjustment.
+        // TODO: Refactor so that Collectors handle scale extents etc.
+        for (const host of namedSource.hosts) {
+            host.visit((view) => {
+                for (const resolution of Object.values(
+                    view.resolutions.scale
+                )) {
+                    // TODO: Only update domain
+                    resolution.reconfigure();
+                }
+            });
+        }
+
+        this.animator.requestRender();
+    }
+
     /**
      * Broadcast a message to all views
      *
@@ -243,7 +272,7 @@ export default class GenomeSpy {
                 // placeholder
             },
             updateTooltip: this.updateTooltip.bind(this),
-            getNamedData: this.getNamedData.bind(this),
+            getNamedDataFromProvider: this.getNamedDataFromProvider.bind(this),
             getCurrentHover: () => this._currentHover,
 
             addKeyboardListener: (type, listener) => {

package/src/index.js

@@ -11,6 +11,7 @@ export { GenomeSpy, html, icon };
  * Embeds GenomeSpy into the DOM
  *
  * @type {import("./embedApi.js").EmbedFunction}
+ * @returns {Promise<import("./embedApi").EmbedResult>}
  */
 export async function embed(el, spec, options = {}) {
     /** @type {HTMLElement} */
@@ -85,6 +86,8 @@ export async function embed(el, spec, options = {}) {
         getScaleResolutionByName(name) {
             return genomeSpy.getNamedScaleResolutions().get(name);
         },
+
+        updateNamedData: genomeSpy.updateNamedData.bind(genomeSpy),
     };
 }
 

package/src/view/flowBuilder.js

@@ -116,7 +116,11 @@ export function buildDataFlow(root, existingFlow) {
             const dataSource = isDynamicCallbackData(view.spec.data)
                 ? view.getDynamicDataSource()
                 : isNamedData(view.spec.data)
-                ? new NamedSource(view.spec.data, view.context.getNamedData)
+                ? // TODO: Only one NamedSource instance per unique name should exists
+                  new NamedSource(
+                      view.spec.data,
+                      view.context.getNamedDataFromProvider
+                  )
                 : createDataSource(view.spec.data, view.getBaseUrl());
 
             currentNode = dataSource;

package/src/view/viewContext.d.ts

@@ -48,7 +48,7 @@ export default interface ViewContext {
         listener: (event: KeyboardEvent) => void
     ) => void;
 
-    getNamedData: (name: string) => any[];
+    getNamedDataFromProvider: (name: string) => any[];
 
     isViewVisible: (view: View) => boolean;