@genome-spy/core 0.73.0 → 0.75.0

package/dist/src/view/testUtils.js

@@ -2,8 +2,15 @@
  * Utils for Jest tests
  * TODO: Find a better place and convention
  *
- * @typedef {import("../spec/view.js").ViewSpec} ViewSpec
+ * @typedef {import("../spec/root.js").RootSpec} RootSpec
  * @typedef {import("../types/viewContext.js").default} ViewContext
+ * @typedef {ViewContext & {
+ *   emitBroadcast: (
+ *     root: import("./view.js").default,
+ *     type: import("../genomeSpy.js").BroadcastEventType,
+ *     payload?: any
+ *   ) => void
+ * }} BroadcastingViewContext
  */
 
 import { checkForDuplicateScaleNames } from "./viewUtils.js";
@@ -11,90 +18,74 @@ import {
     initializeViewSubtree,
     loadViewSubtreeData,
 } from "../data/flowInit.js";
-import DataFlow from "../data/dataFlow.js";
-import { VIEW_ROOT_NAME, ViewFactory } from "./viewFactory.js";
-import GenomeStore from "../genome/genomeStore.js";
-import BmFontManager from "../fonts/bmFontManager.js";
+import { VIEW_ROOT_NAME } from "./viewFactory.js";
 import UnitView from "./unitView.js";
 import ContainerView from "./containerView.js";
+import {
+    createHeadlessEngine,
+    createHeadlessViewContext,
+} from "../genomeSpy/headlessBootstrap.js";
 
 /**
  * @param {import("./viewFactory.js").ViewFactoryOptions} [viewFactoryOptions]
  * @returns
  */
 export function createTestViewContext(viewFactoryOptions = {}) {
-    const viewFactory = new ViewFactory({
-        allowImport: false,
-        wrapRoot: false,
-        ...viewFactoryOptions,
-    });
-
-    const genomeStore = new GenomeStore(".");
-    genomeStore.initialize({
-        name: "test",
-        contigs: [
-            { name: "chr1", size: 20 },
-            { name: "chr2", size: 30 },
-        ],
+    return createHeadlessViewContext({
+        viewFactoryOptions,
     });
+}
 
-    const dataFlow = new DataFlow();
-
-    // @ts-expect-error
-    const c = /** @type {ViewContext} */ ({
-        createOrImportView: async function (
-            spec,
-            parent,
-            dataParent,
-            defaultName
-        ) {
-            return viewFactory.createOrImportView(
-                spec,
-                this,
-                parent,
-                dataParent,
-                defaultName
-            );
-        },
-
-        dataFlow,
-        genomeStore,
-
-        fontManager: new BmFontManager(),
-        animator: /** @type {import("../utils/animator.js").default} */ (
-            /** @type {any} */ ({
-                requestRender: /** @type {() => void} */ (() => undefined),
-                requestTransition:
-                    /** @type {(callback: () => void) => void} */ (
-                        (callback) => callback()
-                    ),
-                transition: (/** @type {any} */ options) => {
-                    const to = typeof options.to === "number" ? options.to : 1;
-                    options.onUpdate(to);
-                    return Promise.resolve();
-                },
-            })
-        ),
-
-        requestLayoutReflow: () => undefined,
-
-        isViewConfiguredVisible: () => true,
-
-        addBroadcastListener: () => undefined,
-        removeBroadcastListener: () => undefined,
-
-        //...partialContext,
-    });
+/**
+ * @param {import("./viewFactory.js").ViewFactoryOptions} [viewFactoryOptions]
+ * @returns {BroadcastingViewContext}
+ */
+export function createBroadcastingTestViewContext(viewFactoryOptions = {}) {
+    const context = /** @type {BroadcastingViewContext} */ (
+        createTestViewContext({
+            wrapRoot: true,
+            ...viewFactoryOptions,
+        })
+    );
+
+    /** @type {Map<string, Set<(message: any) => void>>} */
+    const listeners = new Map();
+
+    context.addBroadcastListener = (type, listener) => {
+        const typedListeners = listeners.get(type) ?? new Set();
+        typedListeners.add(listener);
+        listeners.set(type, typedListeners);
+    };
+
+    context.removeBroadcastListener = (type, listener) => {
+        listeners.get(type)?.delete(listener);
+    };
+
+    context.emitBroadcast = (root, type, payload) => {
+        const message = /** @type {import("./view.js").BroadcastMessage} */ ({
+            type,
+            payload,
+        });
+        root.visit((view) => view.handleBroadcast(message));
+        for (const listener of listeners.get(type) ?? []) {
+            listener(message);
+        }
+    };
 
-    return c;
+    return context;
 }
 
 /**
- * @type {<V extends import("./view.js").default>(spec: ViewSpec, viewClass: { new(...args: any[]): V }, ViewFactoryOptions?: import("./viewFactory.js").ViewFactoryOptions) => Promise<V>}
+ * @type {<V extends import("./view.js").default>(spec: RootSpec, viewClass: { new(...args: any[]): V }, ViewFactoryOptions?: import("./viewFactory.js").ViewFactoryOptions) => Promise<V>}
  */
 export async function create(spec, viewClass, viewFactoryOptions = {}) {
     const c = createTestViewContext(viewFactoryOptions);
-    const view = await c.createOrImportView(spec, null, null, VIEW_ROOT_NAME);
+    const view = await c.createOrImportView(
+        /** @type {import("../spec/view.js").ViewSpec} */ (spec),
+        null,
+        null,
+        VIEW_ROOT_NAME
+    );
 
     if (!(view instanceof viewClass)) {
         throw new Error("ViewClass and the spec do not match!");
@@ -106,7 +97,7 @@ export async function create(spec, viewClass, viewFactoryOptions = {}) {
 /**
  * Creates a view and initializes its data. Does not wrap it in an implicit root view.
  *
- * @type {<V extends import("./view.js").default>(spec: ViewSpec, viewClass: { new(...args: any[]): V }, context?: ViewContext, options?: {noData: boolean, implicitRoot: boolean}) => Promise<V>}
+ * @type {<V extends import("./view.js").default>(spec: RootSpec, viewClass: { new(...args: any[]): V }, context?: ViewContext, options?: {noData: boolean, implicitRoot: boolean}) => Promise<V>}
  */
 export async function createAndInitialize(spec, viewClass) {
     const view = await create(spec, viewClass);
@@ -126,3 +117,5 @@ export async function createAndInitialize(spec, viewClass) {
     await loadViewSubtreeData(view, dataSources);
     return view;
 }
+
+export { createHeadlessEngine };

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

@@ -1,6 +1,13 @@
 /**
  * @param {string | import("../spec/title.js").Title} title
+ * @param {import("../spec/config.js").GenomeSpyConfig[]} [configScopes]
+ * @returns {import("../spec/title.js").Title}
+ */
+export function resolveTitleSpec(title: string | import("../spec/title.js").Title, configScopes?: import("../spec/config.js").GenomeSpyConfig[]): import("../spec/title.js").Title;
+/**
+ * @param {string | import("../spec/title.js").Title} title
+ * @param {import("../spec/config.js").GenomeSpyConfig[]} [configScopes]
  * @returns {import("../spec/view.js").UnitSpec}
  */
-export default function createTitle(title: string | import("../spec/title.js").Title): import("../spec/view.js").UnitSpec;
+export default function createTitle(title: string | import("../spec/title.js").Title, configScopes?: import("../spec/config.js").GenomeSpyConfig[]): import("../spec/view.js").UnitSpec;
 //# sourceMappingURL=title.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"title.d.ts","sourceRoot":"","sources":["../../../src/view/title.js"],"names":[],"mappings":"AAuDA;;;GAGG;AACH,2CAHW,MAAM,GAAG,OAAO,kBAAkB,EAAE,KAAK,GACvC,OAAO,iBAAiB,EAAE,QAAQ,CA0G9C"}
+{"version":3,"file":"title.d.ts","sourceRoot":"","sources":["../../../src/view/title.js"],"names":[],"mappings":"AAuDA;;;;GAIG;AACH,wCAJW,MAAM,GAAG,OAAO,kBAAkB,EAAE,KAAK,iBACzC,OAAO,mBAAmB,EAAE,eAAe,EAAE,GAC3C,OAAO,kBAAkB,EAAE,KAAK,CAuC5C;AAED;;;;GAIG;AACH,2CAJW,MAAM,GAAG,OAAO,kBAAkB,EAAE,KAAK,iBACzC,OAAO,mBAAmB,EAAE,eAAe,EAAE,GAC3C,OAAO,iBAAiB,EAAE,QAAQ,CAmD9C"}

package/dist/src/view/title.js

@@ -1,43 +1,8 @@
 import { isString } from "vega-util";
-
-/** @type {Omit<Required<import("../spec/title.js").Title>, "text" | "style">} */
-const BASE_TITLE_STYLE = {
-    anchor: "middle",
-    frame: "group",
-    offset: 10,
-    orient: "top",
-    align: undefined,
-    angle: 0,
-    baseline: "alphabetic",
-    dx: 0,
-    dy: 0,
-    color: undefined,
-    font: undefined,
-    fontSize: 12,
-    fontStyle: "normal",
-    fontWeight: "normal",
-};
-
-/** @type {Partial<import("../spec/title.js").Title>} */
-const TRACK_TITLE_STYLE = {
-    orient: "left",
-    anchor: "middle",
-    align: "right",
-    baseline: "middle",
-    angle: 0,
-    fontSize: 12,
-};
-
-/** @type {Partial<import("../spec/title.js").Title>} */
-const OVERLAY_TITLE_STYLE = {
-    orient: "top",
-    anchor: "start",
-    align: "left",
-    baseline: "top",
-    offset: -10,
-    dx: 10,
-    fontSize: 12,
-};
+import {
+    getConfiguredStyleConfig,
+    getConfiguredTitleConfig,
+} from "../config/titleConfig.js";
 
 /** @type {Record<import("../spec/title.js").TitleAnchor, number>} */
 const ANCHORS = {
@@ -53,46 +18,19 @@ const ANCHOR_TO_ALIGN = {
     end: "right",
 };
 
+const DEFAULT_TITLE_STYLE = "group-title";
+
 /**
- * @param {string | import("../spec/title.js").Title} title
- * @returns {import("../spec/view.js").UnitSpec}
+ * @param {import("../spec/title.js").Title} spec
  */
-export default function createTitle(title) {
-    if (!title) {
-        return;
-    }
-
-    /** @type {import("../spec/title.js").Title} */
-    const titleSpec = isString(title) ? { text: title } : title;
-
-    if (!titleSpec.text || titleSpec.orient == "none") {
-        return;
-    }
-
-    // TODO: Make these configurable
-    /** @type {Partial<import("../spec/title.js").Title>} */
-    const config =
-        {
-            "track-title": TRACK_TITLE_STYLE,
-            overlay: OVERLAY_TITLE_STYLE,
-        }[titleSpec.style] ?? {};
-
-    // TODO: frame prop
-
-    /** @type {import("../spec/title.js").Title} */
-    const preliminarySpec = {
-        ...BASE_TITLE_STYLE,
-        ...config,
-        ...titleSpec,
-    };
-
+function getTitleOrientMetadata(spec) {
     /** @type {Partial<import("../spec/title.js").Title>} */
     let orientConfig = {};
     let xy = { x: 0, y: 0 };
 
-    const anchorPos = ANCHORS[preliminarySpec.anchor ?? "middle"];
+    const anchorPos = ANCHORS[spec.anchor ?? "middle"];
 
-    switch (preliminarySpec.orient) {
+    switch (spec.orient) {
         case "top":
             xy = { x: anchorPos, y: 1 };
             orientConfig = { baseline: "alphabetic", angle: 0 };
@@ -112,16 +50,68 @@ export default function createTitle(title) {
         default:
     }
 
+    return { orientConfig, xy };
+}
+
+/**
+ * @param {string | import("../spec/title.js").Title} title
+ * @param {import("../spec/config.js").GenomeSpyConfig[]} [configScopes]
+ * @returns {import("../spec/title.js").Title}
+ */
+export function resolveTitleSpec(title, configScopes = []) {
+    if (!title) {
+        return;
+    }
+
+    /** @type {import("../spec/title.js").Title} */
+    const titleSpec = isString(title) ? { text: title } : title;
+
+    if (!titleSpec.text || titleSpec.orient == "none") {
+        return;
+    }
+
+    const titleConfig = getConfiguredTitleConfig(configScopes);
+    const styleConfig = /** @type {import("../spec/config.js").TitleConfig} */ (
+        getConfiguredStyleConfig(
+            configScopes,
+            titleSpec.style ?? DEFAULT_TITLE_STYLE
+        )
+    );
+
+    // TODO: frame prop
+
     /** @type {import("../spec/title.js").Title} */
-    const spec = {
-        ...BASE_TITLE_STYLE,
+    const preliminarySpec = {
+        ...titleConfig,
+        ...styleConfig,
+        ...titleSpec,
+    };
+
+    const { orientConfig } = getTitleOrientMetadata(preliminarySpec);
+
+    return {
+        ...titleConfig,
         ...orientConfig,
-        ...config,
+        ...styleConfig,
         ...titleSpec,
     };
+}
+
+/**
+ * @param {string | import("../spec/title.js").Title} title
+ * @param {import("../spec/config.js").GenomeSpyConfig[]} [configScopes]
+ * @returns {import("../spec/view.js").UnitSpec}
+ */
+export default function createTitle(title, configScopes = []) {
+    const spec = resolveTitleSpec(title, configScopes);
+    if (!spec) {
+        return;
+    }
+
+    const { xy } = getTitleOrientMetadata(spec);
 
     const offsets = { xOffset: 0, yOffset: 0 };
-    switch (preliminarySpec.orient) {
+    switch (spec.orient) {
         case "top":
             offsets.yOffset = -spec.offset;
             break;

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

@@ -21,7 +21,7 @@ export default class UnitView<TSpec extends import("../spec/view.js").UnitSpec =
     constructor(spec: TSpec, context: import("../types/viewContext.js").default, layoutParent: import("./containerView.js").default, dataParent: import("./view.js").default, name: string, options?: import("./view.js").ViewOptions);
     /** @type {import("../marks/mark.js").default} */
     mark: import("../marks/mark.js").default;
-    getMarkType(): "link" | "point" | "text" | "rect" | "rule";
+    getMarkType(): "text" | "point" | "link" | "rect" | "rule" | "tick";
     /**
      * Pulls scales and axes up in the view hierarcy according to the resolution rules, using dataParents.
      * TODO: legends

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

@@ -1 +1 @@
-{"version":3,"file":"unitView.d.ts","sourceRoot":"","sources":["../../../src/view/unitView.js"],"names":[],"mappings":"AA+BA;;;;GAIG;AACH,wBAHU,MAAM,CAAC,OAAO,iBAAiB,EAAE,QAAQ,EAAE,cAAc,kBAAkB,EAAE,OAAO,CAAC,CAc7F;AAEF;;;GAGG;AACH,8BAHmD,KAAK,SAA3C,OAAQ,iBAAiB,EAAE,QAAS;IA2B7C;;;;;;;;OAQG;IACH,kBAPW,KAAK,WACL,OAAO,yBAAyB,EAAE,OAAO,gBACzC,OAAO,oBAAoB,EAAE,OAAO,cACpC,OAAO,WAAW,EAAE,OAAO,QAC3B,MAAM,YACN,OAAO,WAAW,EAAE,WAAW,EAyCzC;IAhCO,iDAAiD;IACjD,MADW,OAAO,kBAAkB,EAAE,OAAO,CACnB;IAyKlC,2DAIC;IAoBD;;;;;OAKG;IAEH,iEAqJC;IAUD;;;;;OAKG;IACH,4IAMC;IAED;;;;OAIG;IACH,sBAFa,OAAO,WAAW,EAAE,UAAU,EAAE,CAS5C;IAkBD;;OAEG;IACH,uDAEC;IAED;;OAEG;IACH,oCA0EC;IAED,uBAQC;IAgBD;;;;OAIG;IACH,8BAJW,MAAM,+DAEJ,OAAO,iBAAiB,EAAE,kBAAkB,CAKxD;;CACJ;iBAtlBgB,WAAW"}
+{"version":3,"file":"unitView.d.ts","sourceRoot":"","sources":["../../../src/view/unitView.js"],"names":[],"mappings":"AA4BA;;;;GAIG;AACH,wBAHU,MAAM,CAAC,OAAO,iBAAiB,EAAE,QAAQ,EAAE,cAAc,kBAAkB,EAAE,OAAO,CAAC,CAgB7F;AAEF;;;GAGG;AACH,8BAHmD,KAAK,SAA3C,OAAQ,iBAAiB,EAAE,QAAS;IA2B7C;;;;;;;;OAQG;IACH,kBAPW,KAAK,WACL,OAAO,yBAAyB,EAAE,OAAO,gBACzC,OAAO,oBAAoB,EAAE,OAAO,cACpC,OAAO,WAAW,EAAE,OAAO,QAC3B,MAAM,YACN,OAAO,WAAW,EAAE,WAAW,EAmDzC;IA1CO,iDAAiD;IACjD,MADW,OAAO,kBAAkB,EAAE,OAAO,CACnB;IAiLlC,oEAIC;IAoBD;;;;;OAKG;IACH,iEAOC;IAUD;;;;;OAKG;IACH,4IAQC;IAED;;;;OAIG;IACH,sBAFa,OAAO,WAAW,EAAE,UAAU,EAAE,CAS5C;IAkBD;;OAEG;IACH,uDAEC;IAED;;OAEG;IACH,oCAsFC;IAED,uBAQC;IAgBD;;;;OAIG;IACH,8BAJW,MAAM,+DAEJ,OAAO,iBAAiB,EAAE,kBAAkB,CAKxD;;CACJ;iBAjegB,WAAW"}