@genome-spy/core 0.36.1 → 0.37.0

package/dist/src/view/testUtils.js

@@ -0,0 +1,101 @@
+/**
+ * Utils for Jest tests
+ * TODO: Find a better place and convention
+ *
+ * @typedef {import("../spec/view").ViewSpec} ViewSpec
+ * @typedef {import("../types/viewContext").default} ViewContext
+ */
+
+import { resolveScalesAndAxes, initializeData } from "./viewUtils";
+import AccessorFactory from "../encoder/accessor";
+import DataFlow from "../data/dataFlow";
+import { ViewFactory } from "./viewFactory";
+import GenomeStore from "../genome/genomeStore";
+import ImplicitRootView from "./implicitRootView";
+import View from "./view";
+import BmFontManager from "../fonts/bmFontManager";
+
+/**
+ *
+ * @param {Partial<ViewContext>} partialContext
+ * @returns
+ */
+export function createTestViewContext(partialContext = {}) {
+    const viewTypeRegistry = new ViewFactory();
+
+    const genomeStore = new GenomeStore(".");
+    genomeStore.initialize({
+        name: "test",
+        contigs: [
+            { name: "chr1", size: 20 },
+            { name: "chr2", size: 30 },
+        ],
+    });
+
+    const c = /** @type {ViewContext} */ ({
+        accessorFactory: new AccessorFactory(),
+
+        createView: function (spec, parent, defaultName) {
+            return viewTypeRegistry.createView(spec, c, parent, defaultName);
+        },
+
+        dataFlow: new DataFlow(),
+        genomeStore,
+
+        fontManager: new BmFontManager(),
+
+        isViewConfiguredVisible: () => true,
+
+        ...partialContext,
+    });
+
+    return c;
+}
+
+/** @type {<V extends View>(spec: ViewSpec, viewClass: { new(...args: any[]): V }, context?: ViewContext) => V} */
+export function create(spec, viewClass, context = undefined) {
+    const c = createTestViewContext(context);
+    const view = c.createView(spec, null, null, "root");
+
+    if (!(view instanceof viewClass)) {
+        throw new Error("ViewClass and the spec do not match!");
+    }
+
+    return view;
+}
+
+/**
+ * Creates a view and initializes its data. Does not wrap it in an implicit root view.
+ *
+ * @type {<V extends View>(spec: ViewSpec, viewClass: { new(...args: any[]): V }, context?: ViewContext, options?: {noData: boolean, implicitRoot: boolean}) => Promise<V>}
+ */
+export async function createAndInitialize(
+    spec,
+    viewClass,
+    context = undefined,
+    options = { noData: false, implicitRoot: false }
+) {
+    const view = create(spec, viewClass, context);
+
+    resolveScalesAndAxes(view);
+    await initializeData(view, view.context.dataFlow);
+    return view;
+}
+
+/**
+ * Creates a view and wraps it in an implicit root view if needed.
+ * Does not initialize data.
+ *
+ * @param {ViewSpec} spec
+ */
+export async function createAndWrap(spec) {
+    const view = create(spec, View);
+
+    const root =
+        view.needsAxes.x || view.needsAxes.y
+            ? new ImplicitRootView(view.context, view)
+            : view;
+
+    resolveScalesAndAxes(root);
+    return root;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * @param {string | import("../spec/title").Title} title
+ * @returns {import("../spec/view").UnitSpec}
+ */
+export default function createTitle(title: string | import("../spec/title").Title): import("../spec/view").UnitSpec;
+//# sourceMappingURL=title.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"title.d.ts","sourceRoot":"","sources":["../../../src/view/title.js"],"names":[],"mappings":"AAuDA;;;GAGG;AACH,2CAHW,MAAM,GAAG,OAAO,eAAe,EAAE,KAAK,GACpC,OAAO,cAAc,EAAE,QAAQ,CA2G3C"}

package/dist/src/view/title.js

@@ -0,0 +1,165 @@
+import { isString } from "vega-util";
+
+/** @type {Omit<Required<import("../spec/title").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").Title>} */
+const TRACK_TITLE_STYLE = {
+    orient: "left",
+    anchor: "middle",
+    align: "right",
+    baseline: "middle",
+    angle: 0,
+    fontSize: 12,
+};
+
+/** @type {Partial<import("../spec/title").Title>} */
+const OVERLAY_TITLE_STYLE = {
+    orient: "top",
+    anchor: "start",
+    align: "left",
+    baseline: "top",
+    offset: -10,
+    dx: 10,
+    fontSize: 12,
+};
+
+/** @type {Record<import("../spec/title").TitleAnchor, number>} */
+const ANCHORS = {
+    start: 0,
+    middle: 0.5,
+    end: 1,
+};
+
+/** @type {Record<import("../spec/title").TitleAnchor, import("../spec/font").Align>} */
+const ANCHOR_TO_ALIGN = {
+    start: "left",
+    middle: "center",
+    end: "right",
+};
+
+/**
+ * @param {string | import("../spec/title").Title} title
+ * @returns {import("../spec/view").UnitSpec}
+ */
+export default function createTitle(title) {
+    if (!title) {
+        return;
+    }
+
+    /** @type {import("../spec/title").Title} */
+    const titleSpec = isString(title) ? { text: title } : title;
+
+    if (!titleSpec.text || titleSpec.orient == "none") {
+        return;
+    }
+
+    // TODO: Make these configurable
+    /** @type {Partial<import("../spec/title").Title>} */
+    const config =
+        {
+            "track-title": TRACK_TITLE_STYLE,
+            overlay: OVERLAY_TITLE_STYLE,
+        }[titleSpec.style] ?? {};
+
+    // TODO: frame prop
+
+    /** @type {import("../spec/title").Title} */
+    const preliminarySpec = {
+        ...BASE_TITLE_STYLE,
+        ...config,
+        ...titleSpec,
+    };
+
+    /** @type {Partial<import("../spec/title").Title>} */
+    let orientConfig = {};
+    let xy = { x: 0, y: 0 };
+
+    const anchorPos = ANCHORS[preliminarySpec.anchor ?? "middle"];
+
+    switch (preliminarySpec.orient) {
+        case "top":
+            xy = { x: anchorPos, y: 1 };
+            orientConfig = { baseline: "alphabetic", angle: 0 };
+            break;
+        case "right":
+            xy = { x: 1, y: 1 - anchorPos };
+            orientConfig = { baseline: "alphabetic", angle: 90 };
+            break;
+        case "bottom":
+            xy = { x: anchorPos, y: 0 };
+            orientConfig = { baseline: "top", angle: 0 };
+            break;
+        case "left":
+            xy = { x: 0, y: anchorPos };
+            orientConfig = { baseline: "alphabetic", angle: -90 };
+            break;
+        default:
+    }
+
+    /** @type {import("../spec/title").Title} */
+    const spec = {
+        ...BASE_TITLE_STYLE,
+        ...orientConfig,
+        ...config,
+        ...titleSpec,
+    };
+
+    const offsets = { xOffset: 0, yOffset: 0 };
+    switch (preliminarySpec.orient) {
+        case "top":
+            offsets.yOffset = -spec.offset;
+            break;
+        case "right":
+            offsets.xOffset = spec.offset;
+            break;
+        case "bottom":
+            offsets.yOffset = spec.offset;
+            break;
+        case "left":
+            offsets.xOffset = -spec.offset;
+            break;
+        default:
+    }
+
+    return {
+        configurableVisibility: false,
+        data: { values: [{}] },
+        mark: {
+            type: "text",
+            tooltip: null,
+            clip: false,
+
+            ...xy,
+            ...offsets,
+
+            text: spec.text,
+
+            align: spec.align ?? ANCHOR_TO_ALIGN[spec.anchor],
+            angle: spec.angle,
+            baseline: spec.baseline,
+            dx: spec.dx,
+            dy: spec.dy,
+            color: spec.color,
+            font: spec.font,
+            size: spec.fontSize,
+            fontStyle: spec.fontStyle,
+            fontWeight: spec.fontWeight,
+        },
+    };
+}

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

@@ -0,0 +1,93 @@
+/**
+ *
+ * @type {Object.<string, typeof import("../marks/mark").default>}
+ * TODO: Find a proper place, make extendible
+ */
+export const markTypes: {
+    [x: string]: typeof import("../marks/mark").default;
+};
+export default class UnitView extends ContainerView {
+    /**
+     * @typedef {import("../spec/channel").Channel} Channel
+     * @typedef {import("./view").default} View
+     * @typedef {import("./layerView").default} LayerView
+     * @typedef {import("../utils/domainArray").DomainArray} DomainArray
+     * @typedef {import("../spec/view").ResolutionTarget} ResolutionTarget
+     *
+     */
+    /**
+     *
+     * @param {import("../spec/view").UnitSpec} spec
+     * @param {import("../types/viewContext").default} context
+     * @param {import("./containerView").default} layoutParent
+     * @param {import("./view").default} dataParent
+     * @param {string} name
+     */
+    constructor(spec: import("../spec/view").UnitSpec, context: import("../types/viewContext").default, layoutParent: import("./containerView").default, dataParent: import("./view").default, name: string);
+    spec: import("../spec/view").UnitSpec;
+    /** @type {import("../marks/mark").default} */
+    mark: import("../marks/mark").default;
+    /**
+     * Not nice! Inconsistent when faceting!
+     * TODO: Something. Maybe store only width/height
+     * @type {import("../utils/layout/rectangle").default}
+     */
+    coords: import("../utils/layout/rectangle").default;
+    /**
+     * @param {import("./renderingContext/viewRenderingContext").default} context
+     * @param {import("../utils/layout/rectangle").default} coords
+     * @param {import("../types/rendering").RenderingOptions} [options]
+     */
+    render(context: import("./renderingContext/viewRenderingContext").default, coords: import("../utils/layout/rectangle").default, options?: import("../types/rendering").RenderingOptions): void;
+    getMarkType(): import("../spec/mark").MarkType;
+    /**
+     * Pulls scales and axes up in the view hierarcy according to the resolution rules, using dataParents.
+     * TODO: legends
+     *
+     * @param {ResolutionTarget} type
+     */
+    resolve(type: import("../spec/view").ResolutionTarget): void;
+    /**
+     *
+     * @param {Channel} channel
+     */
+    getAccessor(channel: import("../spec/channel").Channel): import("../types/encoder").Accessor;
+    /**
+     * Returns a collector that is associated with this view.
+     */
+    getCollector(): import("../data/collector").default;
+    /**
+     * @param {Channel} channel A primary channel
+     */
+    _validateDomainQuery(channel: import("../spec/channel").Channel): import("../spec/channel").ChromPosDef | import("../spec/channel").PositionDatumDef | import("../spec/channel").MarkPropExprDef<import("../spec/channel").Type> | import("../spec/channel").MarkPropDatumDef<import("../spec/channel").Type> | import("../spec/channel").MarkPropDatumDef<import("../spec/channel").TypeForShape> | import("../spec/channel").PositionFieldDef<string> | import("../spec/channel").MarkPropFieldDef<string, import("../spec/channel").Type> | import("../spec/channel").MarkPropFieldDef<string, import("../spec/channel").TypeForShape>;
+    /**
+     * Returns the domain of the specified channel of this domain/mark.
+     *
+     * @param {import("../spec/channel").ChannelWithScale} channel A primary channel
+     * @returns {DomainArray}
+     */
+    getConfiguredDomain(channel: import("../spec/channel").ChannelWithScale): import("../utils/domainArray").DomainArray;
+    /**
+     * Extracts the domain from the data.
+     *
+     * TODO: Optimize! Now this performs redundant work if multiple views share the same collector.
+     * Also, all relevant fields should be processed in one iteration: https://jsbench.me/y5kkqy52jo/1
+     * In fact, domain extraction could be a responsibility of the collector: As it handles data items,
+     * it extracts domains for all fields (and data types) that need extracted domains.
+     * Alternatively, extractor nodes could be added to the data flow, just like Vega does
+     * (with aggregate and extent).
+     *
+     * @param {Channel} channel
+     * @returns {DomainArray}
+     */
+    extractDataDomain(channel: import("../spec/channel").Channel): import("../utils/domainArray").DomainArray;
+    getZoomLevel(): number;
+    /**
+     * @param {string} channel
+     * @param {ResolutionTarget} resolutionType
+     * @returns {import("../spec/view").ResolutionBehavior}
+     */
+    getDefaultResolution(channel: string, resolutionType: import("../spec/view").ResolutionTarget): import("../spec/view").ResolutionBehavior;
+}
+import ContainerView from "./containerView";
+//# sourceMappingURL=unitView.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"unitView.d.ts","sourceRoot":"","sources":["../../../src/view/unitView.js"],"names":[],"mappings":"AAqBA;;;;GAIG;AACH;QAHkB,MAAM,GAAE,cAAc,eAAe,EAAE,OAAO;EAS9D;AAEF;IACI;;;;;;;OAOG;IACH;;;;;;;OAOG;IACH,kBANW,OAAO,cAAc,EAAE,QAAQ,WAC/B,OAAO,sBAAsB,EAAE,OAAO,gBACtC,OAAO,iBAAiB,EAAE,OAAO,cACjC,OAAO,QAAQ,EAAE,OAAO,QACxB,MAAM,EAuBhB;IAlBG,sCAAgB;IAIZ,8CAA8C;IAC9C,MADW,OAAO,eAAe,EAAE,OAAO,CAChB;IAK9B;;;;OAIG;IACH,QAFU,OAAO,2BAA2B,EAAE,OAAO,CAE9B;IAK3B;;;;OAIG;IACH,gBAJW,OAAO,yCAAyC,EAAE,OAAO,UACzD,OAAO,2BAA2B,EAAE,OAAO,YAC3C,OAAO,oBAAoB,EAAE,gBAAgB,QAYvD;IAED,+CAIC;IAED;;;;;OAKG;IACH,6DAoEC;IAED;;;OAGG;IACH,6FASC;IAkBD;;OAEG;IACH,oDAEC;IAED;;OAEG;IACH,0mBAcC;IAED;;;;;OAKG;IACH,6BAHW,OAAO,iBAAiB,EAAE,gBAAgB,8CAkBpD;IAED;;;;;;;;;;;;OAYG;IACH,0GA2CC;IAED,uBAQC;IAgBD;;;;OAIG;IACH,8BAJW,MAAM,4DAEJ,OAAO,cAAc,EAAE,kBAAkB,CAKrD;CACJ;0BAlVyB,iBAAiB"}