@genome-spy/core 0.36.0 → 0.37.0

package/dist/src/utils/layout/grid.d.ts

@@ -0,0 +1,29 @@
+/**
+ * An utility class for indexing cells in a wrapping grid layout
+ */
+export default class Grid {
+    /**
+     *
+     * @param {number} nChildren
+     * @param {number} [maxCols]
+     */
+    constructor(nChildren: number, maxCols?: number);
+    n: number;
+    maxCols: number;
+    get nRows(): number;
+    get nCols(): number;
+    get rowIndices(): number[][];
+    get colIndices(): number[][];
+    /**
+     * @param {number} col
+     * @param {number} row
+     */
+    getCellIndex(col: number, row: number): number;
+    /**
+     *
+     * @param {number} index
+     * @returns {[number, number]}
+     */
+    getCellCoords(index: number): [number, number];
+}
+//# sourceMappingURL=grid.d.ts.map

package/dist/src/utils/layout/grid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grid.d.ts","sourceRoot":"","sources":["../../../../src/utils/layout/grid.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;IACI;;;;OAIG;IACH,uBAHW,MAAM,YACN,MAAM,EAKhB;IAFG,UAAkB;IAClB,gBAAkC;IAGtC,oBAEC;IAED,oBAEC;IAED,6BAmBC;IAED,6BAmBC;IAED;;;OAGG;IACH,kBAHW,MAAM,OACN,MAAM,UAchB;IAED;;;;OAIG;IACH,qBAHW,MAAM,GACJ,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ5B;CACJ"}

package/dist/src/utils/layout/grid.js

@@ -0,0 +1,95 @@
+/**
+ * An utility class for indexing cells in a wrapping grid layout
+ */
+export default class Grid {
+    /**
+     *
+     * @param {number} nChildren
+     * @param {number} [maxCols]
+     */
+    constructor(nChildren, maxCols) {
+        this.n = nChildren;
+        this.maxCols = maxCols ?? Infinity;
+    }
+
+    get nRows() {
+        return this.maxCols == Infinity ? 1 : Math.ceil(this.n / this.maxCols);
+    }
+
+    get nCols() {
+        return Math.min(this.n, this.maxCols);
+    }
+
+    get rowIndices() {
+        /** @type {number[][]} */
+        const rows = [];
+
+        const nCols = this.nCols;
+        const nRows = this.nRows;
+
+        for (let row = 0; row < nRows; row++) {
+            /** @type {number[]} */
+            const arr = [];
+            rows.push(arr);
+            for (let col = 0; col < nCols; col++) {
+                const i = row * nCols + col;
+                if (i < this.n) {
+                    arr.push(i);
+                }
+            }
+        }
+        return rows;
+    }
+
+    get colIndices() {
+        /** @type {number[][]} */
+        const cols = [];
+
+        const nCols = this.nCols;
+        const nRows = this.nRows;
+
+        for (let col = 0; col < nCols; col++) {
+            /** @type {number[]} */
+            const arr = [];
+            cols.push(arr);
+            for (let row = 0; row < nRows; row++) {
+                const i = row * nCols + col;
+                if (i < this.n) {
+                    arr.push(i);
+                }
+            }
+        }
+        return cols;
+    }
+
+    /**
+     * @param {number} col
+     * @param {number} row
+     */
+    getCellIndex(col, row) {
+        let i = 0;
+
+        if (this.maxCols == Infinity) {
+            i = row == 0 ? col : undefined;
+        } else if (col >= this.maxCols) {
+            return undefined;
+        } else {
+            i = row * this.nCols + col;
+        }
+
+        return i < this.n ? i : undefined;
+    }
+
+    /**
+     *
+     * @param {number} index
+     * @returns {[number, number]}
+     */
+    getCellCoords(index) {
+        if (index < 0 || index >= this.n) {
+            return undefined;
+        }
+
+        return [index % this.nCols, Math.floor(index / this.nCols)];
+    }
+}

package/dist/src/utils/layout/grid.test.js

@@ -0,0 +1,71 @@
+import { expect, test, describe } from "vitest";
+
+import Grid from "./grid";
+
+describe("Grid indexing", () => {
+    test("Single row", () => {
+        const g = new Grid(3);
+
+        expect(g.maxCols).toEqual(Infinity);
+        expect(g.nCols).toEqual(3);
+        expect(g.nRows).toEqual(1);
+        expect(g.colIndices).toEqual([[0], [1], [2]]);
+        expect(g.rowIndices).toEqual([[0, 1, 2]]);
+        expect(g.getCellIndex(1, 0)).toEqual(1);
+        expect(g.getCellIndex(1, 1)).toBeUndefined();
+        expect(g.getCellCoords(1)).toEqual([1, 0]);
+        expect(g.getCellCoords(-1)).toBeUndefined();
+        expect(g.getCellCoords(3)).toBeUndefined();
+    });
+
+    test("Single column", () => {
+        const g = new Grid(3, 1);
+
+        expect(g.maxCols).toEqual(1);
+        expect(g.nCols).toEqual(1);
+        expect(g.nRows).toEqual(3);
+        expect(g.colIndices).toEqual([[0, 1, 2]]);
+        expect(g.rowIndices).toEqual([[0], [1], [2]]);
+        expect(g.getCellIndex(0, 1)).toEqual(1);
+        expect(g.getCellIndex(1, 1)).toBeUndefined();
+        expect(g.getCellCoords(1)).toEqual([0, 1]);
+    });
+
+    test("Two columns", () => {
+        const g = new Grid(6, 2);
+
+        expect(g.maxCols).toEqual(2);
+        expect(g.nCols).toEqual(2);
+        expect(g.nRows).toEqual(3);
+        expect(g.colIndices).toEqual([
+            [0, 2, 4],
+            [1, 3, 5],
+        ]);
+        expect(g.rowIndices).toEqual([
+            [0, 1],
+            [2, 3],
+            [4, 5],
+        ]);
+        expect(g.getCellIndex(1, 0)).toEqual(1);
+        expect(g.getCellIndex(0, 1)).toEqual(2);
+        expect(g.getCellIndex(1, 1)).toEqual(3);
+        expect(g.getCellCoords(3)).toEqual([1, 1]);
+    });
+
+    test("Two columns, second is partial", () => {
+        const g = new Grid(5, 2);
+
+        expect(g.maxCols).toEqual(2);
+        expect(g.nCols).toEqual(2);
+        expect(g.nRows).toEqual(3);
+        expect(g.colIndices).toEqual([
+            [0, 2, 4],
+            [1, 3],
+        ]);
+        expect(g.rowIndices).toEqual([[0, 1], [2, 3], [4]]);
+        expect(g.getCellIndex(1, 0)).toEqual(1);
+        expect(g.getCellIndex(0, 1)).toEqual(2);
+        expect(g.getCellIndex(1, 2)).toBeUndefined();
+        expect(g.getCellCoords(3)).toEqual([1, 1]);
+    });
+});

package/dist/src/utils/layout/padding.d.ts

@@ -0,0 +1,83 @@
+/**
+ * A class for handing paddings, borders, margins, etc.
+ *
+ * @typedef {import("../../spec/view").Paddings} Paddings
+ * @typedef {import("../../spec/view").PaddingConfig} PaddingConfig
+ */
+export default class Padding {
+    /**
+     *
+     * @param {PaddingConfig} config
+     */
+    static createFromConfig(config: PaddingConfig): Padding;
+    /**
+     * @param {Paddings} paddings
+     */
+    static createFromRecord(paddings: Paddings): Padding;
+    /**
+     * Returns a zeroed padding.
+     */
+    static zero(): Padding;
+    /**
+     *
+     * @param {number} value
+     */
+    static createUniformPadding(value: number): Padding;
+    /**
+     * @param {number} top
+     * @param {number} right
+     * @param {number} bottom
+     * @param {number} left
+     */
+    constructor(top: number, right: number, bottom: number, left: number);
+    /** @readonly */ readonly top: number;
+    /** @readonly */ readonly right: number;
+    /** @readonly */ readonly bottom: number;
+    /** @readonly */ readonly left: number;
+    /**
+     * Returns the sum of left and right
+     */
+    get width(): number;
+    /**
+     * Returns the sum of top and bottom
+     */
+    get height(): number;
+    /**
+     * @param {number} amount In pixels
+     */
+    expand(amount: number): Padding;
+    /**
+     *
+     * @param {Padding} padding padding to add
+     */
+    add(padding: Padding): Padding;
+    /**
+     *
+     * @param {Padding} padding padding to subtract
+     */
+    subtract(padding: Padding): Padding;
+    /**
+     *
+     * @param {Padding} padding padding to union
+     */
+    union(padding: Padding): Padding;
+    /**
+     * Returns a new padding with the left and right, but with the top and bottom set to 0.
+     */
+    getHorizontal(): Padding;
+    /**
+     * Returns a new padding with the same top and bottom, but with the left and right set to 0.
+     */
+    getVertical(): Padding;
+    get horizontalTotal(): number;
+    get verticalTotal(): number;
+}
+/**
+ * A class for handing paddings, borders, margins, etc.
+ */
+export type Paddings = import("../../spec/view").Paddings;
+/**
+ * A class for handing paddings, borders, margins, etc.
+ */
+export type PaddingConfig = import("../../spec/view").PaddingConfig;
+//# sourceMappingURL=padding.d.ts.map

package/dist/src/utils/layout/padding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"padding.d.ts","sourceRoot":"","sources":["../../../../src/utils/layout/padding.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH;IAyGI;;;OAGG;IACH,gCAFW,aAAa,WAUvB;IAED;;OAEG;IACH,kCAFW,QAAQ,WASlB;IAED;;OAEG;IACH,uBAEC;IAED;;;OAGG;IACH,mCAFW,MAAM,WAIhB;IA/ID;;;;;OAKG;IACH,iBALW,MAAM,SACN,MAAM,UACN,MAAM,QACN,MAAM,EAOhB;IAJG,gBAAgB,CAAC,qBAAmB;IACpC,gBAAgB,CAAC,uBAAuB;IACxC,gBAAgB,CAAC,wBAAyB;IAC1C,gBAAgB,CAAC,sBAAqB;IAG1C;;OAEG;IACH,oBAEC;IAED;;OAEG;IACH,qBAEC;IAED;;OAEG;IACH,eAFW,MAAM,WAahB;IAED;;;OAGG;IACH,aAFW,OAAO,WASjB;IAED;;;OAGG;IACH,kBAFW,OAAO,WASjB;IAED;;;OAGG;IACH,eAFW,OAAO,WASjB;IAED;;OAEG;IACH,yBAEC;IAED;;OAEG;IACH,uBAEC;IAED,8BAEC;IAED,4BAEC;CA0CJ;;;;uBApJY,OAAO,iBAAiB,EAAE,QAAQ;;;;4BAClC,OAAO,iBAAiB,EAAE,aAAa"}

package/dist/src/utils/layout/padding.js

@@ -0,0 +1,155 @@
+/**
+ * A class for handing paddings, borders, margins, etc.
+ *
+ * @typedef {import("../../spec/view").Paddings} Paddings
+ * @typedef {import("../../spec/view").PaddingConfig} PaddingConfig
+ */
+export default class Padding {
+    /**
+     * @param {number} top
+     * @param {number} right
+     * @param {number} bottom
+     * @param {number} left
+     */
+    constructor(top, right, bottom, left) {
+        /** @readonly */ this.top = top || 0;
+        /** @readonly */ this.right = right || 0;
+        /** @readonly */ this.bottom = bottom || 0;
+        /** @readonly */ this.left = left || 0;
+    }
+
+    /**
+     * Returns the sum of left and right
+     */
+    get width() {
+        return this.left + this.right;
+    }
+
+    /**
+     * Returns the sum of top and bottom
+     */
+    get height() {
+        return this.top + this.bottom;
+    }
+
+    /**
+     * @param {number} amount In pixels
+     */
+    expand(amount) {
+        if (amount <= 0) {
+            return this;
+        }
+
+        return new Padding(
+            this.top + amount,
+            this.right + amount,
+            this.bottom + amount,
+            this.left + amount
+        );
+    }
+
+    /**
+     *
+     * @param {Padding} padding padding to add
+     */
+    add(padding) {
+        return new Padding(
+            this.top + padding.top,
+            this.right + padding.right,
+            this.bottom + padding.bottom,
+            this.left + padding.left
+        );
+    }
+
+    /**
+     *
+     * @param {Padding} padding padding to subtract
+     */
+    subtract(padding) {
+        return new Padding(
+            this.top - padding.top,
+            this.right - padding.right,
+            this.bottom - padding.bottom,
+            this.left - padding.left
+        );
+    }
+
+    /**
+     *
+     * @param {Padding} padding padding to union
+     */
+    union(padding) {
+        return new Padding(
+            Math.max(this.top, padding.top),
+            Math.max(this.right, padding.right),
+            Math.max(this.bottom, padding.bottom),
+            Math.max(this.left, padding.left)
+        );
+    }
+
+    /**
+     * Returns a new padding with the left and right, but with the top and bottom set to 0.
+     */
+    getHorizontal() {
+        return new Padding(0, this.right, 0, this.left);
+    }
+
+    /**
+     * Returns a new padding with the same top and bottom, but with the left and right set to 0.
+     */
+    getVertical() {
+        return new Padding(this.top, 0, this.bottom, 0);
+    }
+
+    get horizontalTotal() {
+        return this.left + this.right;
+    }
+
+    get verticalTotal() {
+        return this.top + this.bottom;
+    }
+
+    /**
+     *
+     * @param {PaddingConfig} config
+     */
+    static createFromConfig(config) {
+        if (typeof config == "number") {
+            return this.createUniformPadding(config);
+        } else if (config) {
+            return this.createFromRecord(config);
+        } else {
+            return zeroPadding;
+        }
+    }
+
+    /**
+     * @param {Paddings} paddings
+     */
+    static createFromRecord(paddings) {
+        return new Padding(
+            paddings.top,
+            paddings.right,
+            paddings.bottom,
+            paddings.left
+        );
+    }
+
+    /**
+     * Returns a zeroed padding.
+     */
+    static zero() {
+        return zeroPadding;
+    }
+
+    /**
+     *
+     * @param {number} value
+     */
+    static createUniformPadding(value) {
+        return new Padding(value, value, value, value);
+    }
+}
+
+const zeroPadding = Padding.createUniformPadding(0);
+Object.freeze(zeroPadding);

package/dist/src/utils/layout/point.d.ts

@@ -0,0 +1,16 @@
+export default class Point {
+    /**
+     *
+     * @param {number} x
+     * @param {number} y
+     */
+    constructor(x: number, y: number);
+    /** @readonly */ readonly x: number;
+    /** @readonly */ readonly y: number;
+    /**
+     *
+     * @param {Point} point
+     */
+    equals(point: Point): boolean;
+}
+//# sourceMappingURL=point.d.ts.map

package/dist/src/utils/layout/point.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"point.d.ts","sourceRoot":"","sources":["../../../../src/utils/layout/point.js"],"names":[],"mappings":"AAAA;IACI;;;;OAIG;IACH,eAHW,MAAM,KACN,MAAM,EAKhB;IAFG,gBAAgB,CAAC,mBAAU;IAC3B,gBAAgB,CAAC,mBAAU;IAG/B;;;OAGG;IACH,cAFW,KAAK,WAQf;CACJ"}

package/dist/src/utils/layout/point.js

@@ -0,0 +1,23 @@
+export default class Point {
+    /**
+     *
+     * @param {number} x
+     * @param {number} y
+     */
+    constructor(x, y) {
+        /** @readonly */ this.x = x;
+        /** @readonly */ this.y = y;
+    }
+
+    /**
+     *
+     * @param {Point} point
+     */
+    equals(point) {
+        if (!point) {
+            return false;
+        }
+
+        return point === this || (point.x === this.x && point.y === this.y);
+    }
+}

package/dist/src/utils/layout/rectangle.d.ts

@@ -0,0 +1,142 @@
+/**
+ * An immutable rectangle with a scene-graph -like hierarchy.
+ * Allows for implementing scrolling viewports etc.
+ *
+ * @typedef {("x" | "y" | "width" | "height")} Prop
+ * @typedef {import("./padding").default } Padding
+ * @typedef {() => number} Accessor
+ */
+export default class Rectangle {
+    /**
+     *
+     * @param {number} x
+     * @param {number} y
+     * @param {number} width
+     * @param {number} height
+     */
+    static create(x: number, y: number, width: number, height: number): Rectangle;
+    static ZERO: Rectangle;
+    /**
+     *
+     * @param {Accessor} x
+     * @param {Accessor} y
+     * @param {Accessor} width
+     * @param {Accessor} height
+     */
+    constructor(x: Accessor, y: Accessor, width: Accessor, height: Accessor);
+    /**
+     * @param {Prop} prop
+     * @param {number | function():number} value
+     * @returns {Accessor}
+     */
+    _offset(prop: Prop, value: number | (() => number)): Accessor;
+    /**
+     * @param {Prop} prop
+     */
+    _passThrough(prop: Prop): Accessor;
+    /** @readonly */ readonly _x: Accessor;
+    /** @readonly */ readonly _y: Accessor;
+    /** @readonly */ readonly _width: Accessor;
+    /** @readonly */ readonly _height: Accessor;
+    /**
+     * @returns {number}
+     */
+    get x(): number;
+    /**
+     * @returns {number}
+     */
+    get y(): number;
+    /**
+     * @returns {number}
+     */
+    get width(): number;
+    /**
+     * @returns {number}
+     */
+    get height(): number;
+    get x2(): number;
+    get y2(): number;
+    /**
+     * Returns true if the given rectangle is the same or equal rectangle.
+     *
+     * @param {Rectangle} rectangle
+     */
+    equals(rectangle: Rectangle): boolean;
+    /**
+     *
+     * @param {Partial<Record<Prop, number | function():number>>} props
+     */
+    modify(props: Partial<Record<Prop, number | (() => number)>>): Rectangle;
+    /**
+     *
+     * @param {number | function():number} x
+     * @param {number | function():number} y
+     */
+    translate(x: number | (() => number), y: number | (() => number)): Rectangle;
+    /**
+     * Returns a copy of this rectangle translated by the given rectangle.
+     *
+     * @param {Rectangle} rectangle
+     */
+    translateBy(rectangle: Rectangle): Rectangle;
+    /**
+     *
+     * @param {Padding} padding
+     */
+    expand(padding: Padding, direction?: number): Rectangle;
+    /**
+     *
+     * @param {Padding} padding
+     */
+    shrink(padding: Padding): Rectangle;
+    /**
+     * Returns an intersection of this and the other rectangle.
+     *
+     * @param {Rectangle} rectangle
+     */
+    intersect(rectangle: Rectangle): Rectangle;
+    /**
+     * Returns true if width and height are greater than equal to zero.
+     */
+    isDefined(): boolean;
+    /**
+     * Returns a flattened rectangle, i.e., drops the hierarchy and materializes
+     * the parameters.
+     */
+    flatten(): Rectangle;
+    /**
+     * Tests whether the rectangle contains the given point. Uses half open intervals.
+     *
+     * @param {number} x
+     * @param {number} y
+     */
+    containsPoint(x: number, y: number): boolean;
+    /**
+     * Normalizes a point with respect to this rectangle
+     *
+     * @param {number} x
+     * @param {number} y
+     */
+    normalizePoint(x: number, y: number): {
+        x: number;
+        y: number;
+    };
+    toString(): string;
+    toRoundedString(): string;
+}
+/**
+ * An immutable rectangle with a scene-graph -like hierarchy.
+ * Allows for implementing scrolling viewports etc.
+ */
+export type Prop = ("x" | "y" | "width" | "height");
+/**
+ * An immutable rectangle with a scene-graph -like hierarchy.
+ * Allows for implementing scrolling viewports etc.
+ */
+export type Padding = import("./padding").default;
+/**
+ * An immutable rectangle with a scene-graph -like hierarchy.
+ * Allows for implementing scrolling viewports etc.
+ */
+export type Accessor = () => number;
+//# sourceMappingURL=rectangle.d.ts.map

package/dist/src/utils/layout/rectangle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rectangle.d.ts","sourceRoot":"","sources":["../../../../src/utils/layout/rectangle.js"],"names":[],"mappings":"AAQA;;;;;;;GAOG;AACH;IACI;;;;;;OAMG;IACH,iBALW,MAAM,KACN,MAAM,SACN,MAAM,UACN,MAAM,aAShB;IAED,uBAA2C;IA+B3C;;;;;;OAMG;IACH,eALW,QAAQ,KACR,QAAQ,SACR,QAAQ,UACR,QAAQ,EAOlB;IAzCD;;;;OAIG;IACH,cAJW,IAAI,SACJ,MAAM,UAAc,MAAM,CAAA,GACxB,QAAQ,CAiBpB;IAED;;OAEG;IACH,mBAFW,IAAI,YAId;IAUG,gBAAgB,CAAC,sBAAW;IAC5B,gBAAgB,CAAC,sBAAW;IAC5B,gBAAgB,CAAC,0BAAmB;IACpC,gBAAgB,CAAC,2BAAqB;IAG1C;;OAEG;IACH,gBAEC;IAED;;OAEG;IACH,gBAEC;IAED;;OAEG;IACH,oBAEC;IAED;;OAEG;IACH,qBAEC;IAED,iBAEC;IAED,iBAEC;IAED;;;;OAIG;IACH,kBAFW,SAAS,WAcnB;IAED;;;OAGG;IACH,cAFW,QAAQ,OAAO,IAAI,EAAE,MAAM,UAAc,MAAM,CAAA,CAAC,CAAC,aAkB3D;IAED;;;;OAIG;IACH,aAHW,MAAM,UAAc,MAAM,CAAA,KAC1B,MAAM,UAAc,MAAM,CAAA,aAapC;IAED;;;;OAIG;IACH,uBAFW,SAAS,aAKnB;IAED;;;OAGG;IACH,gBAFW,OAAO,iCA0BjB;IAED;;;OAGG;IACH,gBAFW,OAAO,aAIjB;IAED;;;;OAIG;IACH,qBAFW,SAAS,aAenB;IAED;;OAEG;IACH,qBAEC;IAED;;;OAGG;IACH,qBAOC;IAED;;;;;OAKG;IACH,iBAHW,MAAM,KACN,MAAM,WAIhB;IAED;;;;;OAKG;IACH,kBAHW,MAAM,KACN,MAAM;;;MAOhB;IAED,mBAEC;IAED,0BAMC;CACJ;;;;;mBA3RY,CAAC,GAAG,GAAG,GAAG,GAAG,OAAO,GAAG,QAAQ,CAAC;;;;;sBAChC,OAAO,WAAW,EAAE,OAAO;;;;;uBAC3B,MAAM,MAAM"}