@genome-spy/core 0.77.0 → 0.79.0

package/dist/src/view/containerMutationHelper.js

@@ -1,10 +1,27 @@
-import {
-    initializeViewSubtree,
-    loadViewSubtreeData,
-} from "../data/flowInit.js";
-import { configureViewOpacity } from "../genomeSpy/viewHierarchyConfig.js";
 import { ensureAssembliesForView } from "../genome/assemblyPreflight.js";
-import { finalizeSubtreeGraphics } from "./viewUtils.js";
+import { initializeViewDataForViews } from "../genomeSpy/viewDataInit.js";
+import {
+    attachViewLevelScaleConfigs,
+    clearViewLevelScaleConfigs,
+} from "../scales/viewLevelScaleConfig.js";
+import {
+    attachViewLevelAxisConfigs,
+    attachViewLevelLegendConfigs,
+    clearViewLevelGuideConfigs,
+} from "../scales/viewLevelGuideConfig.js";
+import { isChromeView } from "./viewSelectors.js";
+
+/**
+ * @param {unknown} value
+ * @returns {value is { getChildren: () => Iterable<import("./view.js").default> }}
+ */
+function hasGridChildChildren(value) {
+    return (
+        typeof value === "object" &&
+        value !== null &&
+        typeof (/** @type {any} */ (value).getChildren) === "function"
+    );
+}
 
 /**
  * Shared helper for dynamic container mutations.
@@ -30,6 +47,11 @@ export default class ContainerMutationHelper {
      *   removeView: (index: number) => void,
      *   prepareView?: (view: View, index: number, insertionResult: any) => Promise<void>,
      *   afterRemove?: (index: number) => Promise<void>,
+     *   syncMutationGuideViews?: (
+     *     view: View | undefined,
+     *     index: number | undefined,
+     *     insertionResult: any
+     *   ) => Promise<void>,
      *   defaultName?: (index: number, spec: ViewSpec | ImportSpec) => string,
      *   createViewOptions?: import("../types/viewContext.js").CreateViewOptions,
      *   requestLayout?: boolean
@@ -53,12 +75,14 @@ export default class ContainerMutationHelper {
      * @returns {Promise<View>}
      */
     async addChildSpec(childSpec, index) {
-        const { specs, insertAt } = this.options.getChildSpecs();
+        const { specs, insertAt, removeAt } = this.options.getChildSpecs();
         const insertIndex = index ?? specs.length;
         const name =
             this.options.defaultName?.(insertIndex, childSpec) ??
             this.container.getNextAutoName("child");
 
+        let specInserted = false;
+        let viewInserted = false;
         const childView = await this.container.context.createOrImportView(
             childSpec,
             this.container,
@@ -68,36 +92,68 @@ export default class ContainerMutationHelper {
             this.options.createViewOptions
         );
 
-        // Reminder: ensure assemblies from the real child hierarchy before any
-        // downstream work that may initialize scales (axis prep / encoders).
-        await ensureAssembliesForView(
-            childView,
-            this.container.context.genomeStore
-        );
+        try {
+            insertAt(insertIndex, childSpec);
+            specInserted = true;
+            const insertionResult = this.options.insertView(
+                childView,
+                insertIndex
+            );
+            viewInserted = true;
+
+            attachViewLevelScaleConfigs(this.container);
+            attachViewLevelAxisConfigs(this.container);
+            attachViewLevelLegendConfigs(this.container);
+
+            // Reminder: ensure assemblies from the real child hierarchy before any
+            // downstream work that may initialize scales (axis prep / encoders).
+            await ensureAssembliesForView(
+                childView,
+                this.container.context.genomeStore
+            );
 
-        insertAt(insertIndex, childSpec);
-        const insertionResult = this.options.insertView(childView, insertIndex);
+            if (this.options.prepareView) {
+                await this.options.prepareView(
+                    childView,
+                    insertIndex,
+                    insertionResult
+                );
+            }
 
-        if (this.options.prepareView) {
-            await this.options.prepareView(
+            // Guide views are container-specific. Sync them after configs and
+            // assemblies are ready so generated guide marks can initialize.
+            if (this.options.syncMutationGuideViews) {
+                await this.options.syncMutationGuideViews(
+                    childView,
+                    insertIndex,
+                    insertionResult
+                );
+            }
+
+            const viewsToInitialize = collectMutationInitializedViews(
+                this.container,
                 childView,
-                insertIndex,
                 insertionResult
             );
-        }
+            for (const view of viewsToInitialize) {
+                view.configureViewOpacity();
+            }
 
-        configureViewOpacity(childView);
+            await initializeViewDataForViews(
+                this.container,
+                this.container.context.dataFlow,
+                this.container.context.fontManager,
+                viewsToInitialize
+            );
+        } catch (error) {
+            if (viewInserted) {
+                await this.#rollbackInsertedChild(insertIndex, error);
+            } else if (specInserted) {
+                removeAt(insertIndex);
+            }
 
-        const visibilityPredicate = (
-            /** @type {import("./view.js").default} */ view
-        ) => view.isConfiguredVisible();
-        const { dataSources, graphicsPromises } = initializeViewSubtree(
-            childView,
-            this.container.context.dataFlow,
-            visibilityPredicate
-        );
-        await loadViewSubtreeData(childView, dataSources);
-        await finalizeSubtreeGraphics(graphicsPromises);
+            throw error;
+        }
 
         if (this.options.requestLayout !== false) {
             this.container.invalidateSizeCache();
@@ -107,23 +163,138 @@ export default class ContainerMutationHelper {
         return childView;
     }
 
+    /**
+     * @param {number} index
+     * @param {unknown} originalError
+     */
+    async #rollbackInsertedChild(index, originalError) {
+        try {
+            await this.removeChildAt(index, { requestLayout: false });
+        } catch (rollbackError) {
+            /** @type {any} */ (originalError).rollbackError = rollbackError;
+        }
+    }
+
     /**
      * Removes a child by index and updates the backing spec list.
      *
      * @param {number} index
+     * @param {{ requestLayout?: boolean }} [options]
      */
-    async removeChildAt(index) {
+    async removeChildAt(index, options = {}) {
         const { removeAt } = this.options.getChildSpecs();
+        clearViewLevelScaleConfigs(this.container);
+        clearViewLevelGuideConfigs(this.container);
         this.options.removeView(index);
         removeAt(index);
 
         if (this.options.afterRemove) {
             await this.options.afterRemove(index);
         }
+        attachViewLevelScaleConfigs(this.container);
+        attachViewLevelAxisConfigs(this.container);
+        attachViewLevelLegendConfigs(this.container);
 
-        if (this.options.requestLayout !== false) {
+        // Removed children may change shared guide ownership and visibility.
+        if (this.options.syncMutationGuideViews) {
+            await this.options.syncMutationGuideViews(
+                undefined,
+                undefined,
+                undefined
+            );
+        }
+
+        await this.initializeUninitializedChromeViews();
+
+        if (
+            this.options.requestLayout !== false &&
+            options.requestLayout !== false
+        ) {
             this.container.invalidateSizeCache();
             this.container.context.requestLayoutReflow();
         }
     }
+
+    /**
+     * Initializes generated guide/chrome views created by a dynamic mutation.
+     *
+     * Reorder operations can recreate shared axes or legends without touching
+     * normal child dataflow. This keeps those regenerated chrome views renderable
+     * without reloading or rebuilding existing track data.
+     */
+    async initializeUninitializedChromeViews() {
+        if (this.container.getDataInitializationState() === "none") {
+            return;
+        }
+
+        const viewsToInitialize = collectUninitializedChromeViews(
+            this.container
+        );
+        for (const view of viewsToInitialize) {
+            view.configureViewOpacity();
+        }
+
+        await initializeViewDataForViews(
+            this.container,
+            this.container.context.dataFlow,
+            this.container.context.fontManager,
+            viewsToInitialize
+        );
+    }
+}
+
+/**
+ * @param {import("./containerView.js").default} container
+ * @param {import("./view.js").default} childView
+ * @param {unknown} insertionResult
+ * @returns {Set<import("./view.js").default>}
+ */
+function collectMutationInitializedViews(
+    container,
+    childView,
+    insertionResult
+) {
+    const views = collectInsertedViews(childView, insertionResult);
+    collectUninitializedChromeViews(container, views);
+
+    return views;
+}
+
+/**
+ * @param {import("./containerView.js").default} container
+ * @param {Set<import("./view.js").default>} [views]
+ * @returns {Set<import("./view.js").default>}
+ */
+function collectUninitializedChromeViews(container, views = new Set()) {
+    for (const view of container.getDescendants()) {
+        if (
+            isChromeView(view) &&
+            view.getDataInitializationState() === "none"
+        ) {
+            for (const chromeView of view.getDescendants()) {
+                if (chromeView.getDataInitializationState() === "none") {
+                    views.add(chromeView);
+                }
+            }
+        }
+    }
+
+    return views;
+}
+
+/**
+ * @param {import("./view.js").default} childView
+ * @param {unknown} insertionResult
+ * @returns {Set<import("./view.js").default>}
+ */
+function collectInsertedViews(childView, insertionResult) {
+    if (hasGridChildChildren(insertionResult)) {
+        return new Set(
+            Array.from(insertionResult.getChildren()).flatMap((view) =>
+                view.getDescendants()
+            )
+        );
+    }
+
+    return new Set(childView.getDescendants());
 }

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

@@ -48,7 +48,7 @@ export default class FacetView extends ContainerView<import("../spec/view.js").C
     getAccessor(channel: "row" | "column"): any;
     updateFacets(): void;
     updateLabels(): void;
-    getFacetGroups(): string[] | number[] | boolean[];
+    getFacetGroups(): number[] | string[] | boolean[];
     /**
      * @param {import("./renderingContext/viewRenderingContext.js").default} context
      * @param {import("./layout/rectangle.js").default} coords

package/dist/src/view/gridView/gridChild.d.ts

@@ -38,20 +38,22 @@ export default class GridChild {
     backgroundStroke: UnitView;
     /** @type {Partial<Record<import("../../spec/axis.js").AxisOrient, AxisView>>} axes */
     axes: Partial<Record<import("../../spec/axis.js").AxisOrient, AxisView>>;
+    /** @type {AxisCandidate[]} */
+    axisCandidates: AxisCandidate[];
     /** @type {Partial<Record<import("../../spec/axis.js").AxisOrient, AxisGridView>>} gridLines */
     gridLines: Partial<Record<import("../../spec/axis.js").AxisOrient, AxisGridView>>;
+    /** @type {import("./gridChildLegends.js").GridChildLegends} */
+    legends: import("./gridChildLegends.js").GridChildLegends;
     /** @type {Partial<Record<import("./scrollbar.js").ScrollDirection, Scrollbar>>} */
     scrollbars: Partial<Record<import("./scrollbar.js").ScrollDirection, Scrollbar>>;
     /** @type {SelectionRect} */
     selectionRect: SelectionRect;
-    /** @type {UnitView} */
-    title: UnitView;
+    /** @type {TitleView} */
+    title: TitleView;
     /** @type {number} */
     backgroundZindex: number;
     /** @type {number | undefined} */
     backgroundStrokeZindex: number | undefined;
-    /** @type {number} */
-    titleZindex: number;
     /** @type {Rectangle} */
     coords: Rectangle;
     getChildren(): Generator<import("../view.js").default<import("../../spec/view.js").ViewSpec>, void, unknown>;
@@ -59,19 +61,67 @@ export default class GridChild {
      * Create view decorations, grid lines, axes, etc.
      */
     createAxes(): Promise<void>;
+    /**
+     * Allows subclasses such as SampleGridChild to keep multiple same-orient
+     * axis candidates. Ordinary GridView behavior still rejects duplicates.
+     *
+     * @protected
+     * @returns {boolean}
+     */
+    protected allowDuplicateAxes(): boolean;
+    /**
+     * @param {import("../../spec/axis.js").AxisOrient} orient
+     * @returns {AxisCandidate | undefined}
+     */
+    getActiveAxisCandidate(orient: import("../../spec/axis.js").AxisOrient): AxisCandidate | undefined;
+    /**
+     * @param {import("../../spec/axis.js").AxisOrient} orient
+     * @returns {AxisCandidate[]}
+     */
+    getActiveAxisCandidates(orient: import("../../spec/axis.js").AxisOrient): AxisCandidate[];
     /**
      * Disposes axis and gridline views so axes can be recreated safely.
      */
     disposeAxisViews(): void;
+    /**
+     * @param {import("../../spec/channel.js").PrimaryPositionalChannel} channel
+     * @param {import("../view.js").default} view
+     * @returns {import("../axisView.js").AxisLabelClipPolicy}
+     */
+    getAxisLabelClipPolicy(channel: import("../../spec/channel.js").PrimaryPositionalChannel, view: import("../view.js").default): import("../axisView.js").AxisLabelClipPolicy;
     getOverhang(): Padding;
+    getGuideOverhang(): Padding;
+    getTitleOverhang(): Padding;
+    getTitleZindex(): number;
+    /**
+     * @param {import("../renderingContext/viewRenderingContext.js").default} context
+     * @param {Rectangle} viewportCoords
+     * @param {import("../../types/rendering.js").RenderingOptions} options
+     */
+    renderTitle(context: import("../renderingContext/viewRenderingContext.js").default, viewportCoords: Rectangle, options: import("../../types/rendering.js").RenderingOptions): void;
+    /**
+     * Returns the frame used for rendering a view title. Reserved titles are
+     * placed outside guide overhang orthogonally, while the title frame controls
+     * the parallel anchor range.
+     *
+     * @param {Rectangle} viewportCoords
+     */
+    getTitleCoords(viewportCoords: Rectangle): Rectangle;
     getOverhangAndPadding(): Padding;
     #private;
 }
+export type AxisCandidate = {
+    axisView: AxisView;
+    channel: import("../../spec/channel.js").PrimaryPositionalChannel;
+    orient: import("../../spec/axis.js").AxisOrient;
+    resolution: import("../../scales/axisResolution.js").default;
+};
 import UnitView from "../unitView.js";
 import AxisView from "../axisView.js";
 import AxisGridView from "../axisGridView.js";
 import Scrollbar from "./scrollbar.js";
 import SelectionRect from "./selectionRect.js";
+import TitleView from "../titleView.js";
 import Rectangle from "../layout/rectangle.js";
 import Padding from "../layout/padding.js";
 //# sourceMappingURL=gridChild.d.ts.map

package/dist/src/view/gridView/gridChild.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gridChild.d.ts","sourceRoot":"","sources":["../../../../src/view/gridView/gridChild.js"],"names":[],"mappings":"AA42BA;;;;;GAKG;AACH,qDALW,OAAO,yBAAyB,EAAE,uBAAuB,CAAC,MAAM,CAAC,sBACjE,OAAO,aACP,MAAM,GACJ,OAAO,yBAAyB,EAAE,WAAW,GAAG,SAAS,CAyBrE;AAcD;;;GAGG;AACH,iDAHW,OAAO,oBAAoB,EAAE,cAAc,GACzC,OAAO,oBAAoB,EAAE,QAAQ,CA6BjD;AAED;;;GAGG;AACH,uDAHW,OAAO,oBAAoB,EAAE,cAAc,GACzC,OAAO,oBAAoB,EAAE,QAAQ,CA4CjD;AAx8BD;IACI;;;;;;OAMG;IAEH;;;;OAIG;IACH,kBAJW,OAAO,YAAY,EAAE,OAAO,gBAC5B,OAAO,qBAAqB,EAAE,OAAO,UACrC,MAAM,EAwHhB;IArHG,gGAAgC;IAChC,0EAAgB;IAChB,eAAoB;IAEpB,uBAAuB;IACvB,YADW,QAAQ,CACQ;IAE3B,uBAAuB;IACvB,kBADW,QAAQ,CACc;IAEjC,sFAAsF;IACtF,MADW,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAC/D;IAEd,+FAA+F;IAC/F,WADW,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAC9D;IAEnB,mFAAmF;IACnF,YADW,OAAO,CAAC,MAAM,CAAC,OAAO,gBAAgB,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,CAC3D;IAEpB,4BAA4B;IAC5B,eADW,aAAa,CACM;IAE9B,uBAAuB;IACvB,OADW,QAAQ,CACG;IAEtB,qBAAqB;IACrB,kBADW,MAAM,CACQ;IAEzB,iCAAiC;IACjC,wBADW,MAAM,GAAG,SAAS,CACU;IAEvC,qBAAqB;IACrB,aADW,MAAM,CACG;IAEpB,wBAAwB;IACxB,QADW,SAAS,CACQ;IA6hBhC,6GAiBC;IAED;;OAEG;IACH,4BA2LC;IAED;;OAEG;IACH,yBAWC;IAED,uBAqBC;IAED,iCAEC;;CACJ;qBAz1BoB,gBAAgB;qBANK,gBAAgB;yBADjC,oBAAoB;sBAYvB,gBAAgB;0BACoB,oBAAoB;sBARxD,wBAAwB;oBAF1B,sBAAsB"}
+{"version":3,"file":"gridChild.d.ts","sourceRoot":"","sources":["../../../../src/view/gridView/gridChild.js"],"names":[],"mappings":"AAiiCA;;;;;GAKG;AACH,qDALW,OAAO,yBAAyB,EAAE,uBAAuB,CAAC,MAAM,CAAC,sBACjE,OAAO,aACP,MAAM,GACJ,OAAO,yBAAyB,EAAE,WAAW,GAAG,SAAS,CAyBrE;AAcD;;;GAGG;AACH,iDAHW,OAAO,oBAAoB,EAAE,cAAc,GACzC,OAAO,oBAAoB,EAAE,QAAQ,CA6BjD;AAED;;;GAGG;AACH,uDAHW,OAAO,oBAAoB,EAAE,cAAc,GACzC,OAAO,oBAAoB,EAAE,QAAQ,CA4CjD;AArlCD;IACI;;;;;;OAMG;IAEH;;;;OAIG;IACH,kBAJW,OAAO,YAAY,EAAE,OAAO,gBAC5B,OAAO,qBAAqB,EAAE,OAAO,UACrC,MAAM,EAiHhB;IA9GG,gGAAgC;IAChC,0EAAgB;IAChB,eAAoB;IAEpB,uBAAuB;IACvB,YADW,QAAQ,CACQ;IAE3B,uBAAuB;IACvB,kBADW,QAAQ,CACc;IAEjC,sFAAsF;IACtF,MADW,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAC/D;IAEd,8BAA8B;IAC9B,gBADW,aAAa,EAAE,CACF;IAExB,+FAA+F;IAC/F,WADW,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAC9D;IAEnB,+DAA+D;IAC/D,SADW,OAAO,uBAAuB,EAAE,gBAAgB,CAC1C;IAEjB,mFAAmF;IACnF,YADW,OAAO,CAAC,MAAM,CAAC,OAAO,gBAAgB,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,CAC3D;IAEpB,4BAA4B;IAC5B,eADW,aAAa,CACM;IAE9B,wBAAwB;IACxB,OADW,SAAS,CACE;IAEtB,qBAAqB;IACrB,kBADW,MAAM,CACQ;IAEzB,iCAAiC;IACjC,wBADW,MAAM,GAAG,SAAS,CACU;IAEvC,wBAAwB;IACxB,QADW,SAAS,CACQ;IAmhBhC,6GAoBC;IAED;;OAEG;IACH,4BAuNC;IAED;;;;;;OAMG;IACH,gCAFa,OAAO,CAInB;IAED;;;OAGG;IACH,+BAHW,OAAO,oBAAoB,EAAE,UAAU,GACrC,aAAa,GAAG,SAAS,CAKrC;IAED;;;OAGG;IACH,gCAHW,OAAO,oBAAoB,EAAE,UAAU,GACrC,aAAa,EAAE,CAQ3B;IAED;;OAEG;IACH,yBAeC;IAED;;;;OAIG;IACH,gCAJW,OAAO,uBAAuB,EAAE,wBAAwB,QACxD,OAAO,YAAY,EAAE,OAAO,GAC1B,OAAO,gBAAgB,EAAE,mBAAmB,CAgBxD;IAED,uBAKC;IAED,4BAcC;IAED,4BAEC;IAED,yBAEC;IAED;;;;OAIG;IACH,qBAJW,OAAO,6CAA6C,EAAE,OAAO,kBAC7D,SAAS,WACT,OAAO,0BAA0B,EAAE,gBAAgB,QAQ7D;IAED;;;;;;OAMG;IACH,+BAFW,SAAS,aAgCnB;IAED,iCAEC;;CACJ;4BAp/BY;IACN,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,uBAAuB,EAAE,wBAAwB,CAAC;IAClE,MAAM,EAAE,OAAO,oBAAoB,EAAE,UAAU,CAAC;IAChD,UAAU,EAAE,OAAO,gCAAgC,EAAE,OAAO,CAAC;CAChE;qBA5BiB,gBAAgB;qBAN9B,gBAAgB;yBAJE,oBAAoB;sBAgBvB,gBAAgB;0BACoB,oBAAoB;sBARxD,iBAAiB;sBADjB,wBAAwB;oBAF1B,sBAAsB"}