@macrostrat/column-views 3.4.2 → 3.5.1

package/src/prepare-units/helpers.ts

@@ -11,26 +11,40 @@ import {
 import {
   AgeRangeRelationship,
   compareAgeRanges,
+  mergeAgeRanges,
+  MergeMode,
 } from "@macrostrat/stratigraphy-utils";
 import type { ExtUnit, SectionInfo, StratigraphicPackage } from "./types";
 
 const dt = 0.001;
 
-export type UnitWithDefinedOverlap<T extends BaseUnit> = T & {
-  overlap: UnitOverlapInfo<T>;
+export type UnitWithLayoutParameters<T extends BaseUnit> = T & {
+  layout: UnitLayoutData<T>;
 };
 
-type UnitOverlapInfo<T extends BaseUnit> = {
+export type UnitWithLayoutHints<T extends BaseUnit> = T & {
+  layoutHints?: UnitLayoutHints;
+};
+
+interface UnitLayoutInfo {
   column: number;
   nColumns: number;
+}
+
+type UnitLayoutHints = Partial<UnitLayoutInfo>;
+
+type UnitLayoutData<T extends BaseUnit> = UnitLayoutInfo & {
+  totalColumns: number;
   unitGroup: UnitGroup<T>;
 };
 
 class UnitGroup<T extends BaseUnit> implements StratigraphicPackage {
   units: T[];
+  axisType: ColumnAxisType;
 
-  constructor(units: T[]) {
+  constructor(units: T[], axisType: ColumnAxisType = ColumnAxisType.AGE) {
     this.units = units;
+    this.axisType = axisType;
   }
 
   get t_age(): number {
@@ -41,7 +55,7 @@ class UnitGroup<T extends BaseUnit> implements StratigraphicPackage {
     return Math.max(...this.units.map((d) => d.b_age));
   }
 
-  getUnits(): UnitWithDefinedOverlap<T>[] {
+  getUnits(): UnitWithLayoutParameters<T>[] {
     return assignColumnsToUnitsWithinOverlappingGroup(this);
   }
 }
@@ -49,39 +63,51 @@ class UnitGroup<T extends BaseUnit> implements StratigraphicPackage {
 function groupUnitsByMutualOverlap<T extends BaseUnit>(
   units: T[],
   tolerance: number = dt,
+  axisType: ColumnAxisType = ColumnAxisType.AGE,
 ): UnitGroup<T>[] {
   /** Group units within a section that have mutual overlap. */
-  const sections = groupUnitsIntoSectionsByOverlap(
-    units,
-    ColumnAxisType.AGE,
-    tolerance,
-  );
+
+  const sections = groupUnitsIntoSectionsByOverlap(units, axisType, tolerance);
+
+  console.log("Grouped sections", sections);
+
   return sections.map((d) => {
-    return new UnitGroup(d.units);
+    return new UnitGroup(d.units, axisType);
   });
 }
 
 const sortByAge = createUnitSorter(ColumnAxisType.AGE);
 
 function assignColumnsToUnitsWithinOverlappingGroup<T extends BaseUnit>(
-  group: UnitGroup<T>,
-): UnitWithDefinedOverlap<T>[] {
+  group: UnitGroup<UnitWithLayoutHints<T>>,
+): UnitWithLayoutParameters<T>[] {
   /** A relatively naïve function to assign columns to units within a mutually overlapping group.
    * This gets the number of columns that would be needed to accommodate the units in the group.
    * It then assigns columns to units in the group based on the number of columns needed, with
    * lower units further to the left.
    */
 
-  const sortedUnits = [...group.units].sort((a, b) => b.b_age - a.b_age);
+  const sortedUnits = [...group.units].sort(createUnitSorter(group.axisType));
 
   const columns: T[][] = [];
 
+  let nColumns = 1;
+
   for (const unit of sortedUnits) {
+    let startIndex = 0;
+    let endIndex = 0;
     // Find a column that is not already occupied by an overlapping unit
+    const colHint = unit.layoutHints?.column;
+    if (colHint != null) {
+      columns[colHint] ??= [];
+      columns[colHint].push(unit);
+      continue;
+    }
     let didAddToExistingColumn = false;
+
     for (const column of columns) {
       const lastUnit = column[column.length - 1];
-      if (!unitsOverlap(unit, lastUnit, ColumnAxisType.AGE, dt)) {
+      if (!unitsOverlap(unit, lastUnit, group.axisType, dt)) {
         column.push(unit);
         didAddToExistingColumn = true;
         break;
@@ -92,14 +118,17 @@ function assignColumnsToUnitsWithinOverlappingGroup<T extends BaseUnit>(
     }
   }
 
-  const units: UnitWithDefinedOverlap<T>[] = columns.flatMap(
+  console.log(columns);
+
+  const units: UnitWithLayoutParameters<T>[] = columns.flatMap(
     (column, columnIndex) =>
       column.map((unit) => {
         return {
           ...unit,
-          overlap: {
+          layout: {
             column: columnIndex,
-            nColumns: columns.length,
+            nColumns: 1,
+            totalColumns: columns.length,
             unitGroup: group,
           },
         };
@@ -121,7 +150,7 @@ export function preprocessUnits<T extends UnitLong = UnitLong>(
     tolerance = 0.01; // 1cm tolerance for height/depth columns
   }
 
-  const unitGroups = groupUnitsByMutualOverlap(units, tolerance);
+  const unitGroups = groupUnitsByMutualOverlap(units, tolerance, axisType);
 
   const divisions: any[] = [];
   // Serialize all groups' units to a single array
@@ -186,7 +215,7 @@ export function groupUnitsIntoSectionsBySectionID<T extends UnitLong>(
 interface WorkingSection {
   units: UnitLong[];
   // Position or age
-  heightRange?: [number, number];
+  heightRange: [number, number];
 }
 
 export function groupUnitsIntoSectionsByOverlap<T extends BaseUnit>(
@@ -201,41 +230,60 @@ export function groupUnitsIntoSectionsByOverlap<T extends BaseUnit>(
    * */
   // Start with each unit as its own "section", and progressively merge...
   const sectionList: WorkingSection[] = [];
-  for (const unit of units) {
-    // Check if the unit overlaps with any existing section
-    const heightRange = getUnitHeightRange(unit, axisType);
-    let section: WorkingSection | undefined = sectionList.find(
-      (s) =>
-        compareAgeRanges(heightRange, s.heightRange, tolerance) !==
-        AgeRangeRelationship.Disjoint,
-    );
-    if (section == null) {
-      // No overlap, create a new section
-      sectionList.push({
-        heightRange,
-        units: [unit],
-      });
-    } else {
-      // Overlap, merge the unit into the section
-      section.units.push(unit);
-      // Update the height range
-      if (axisType == ColumnAxisType.DEPTH || axisType == ColumnAxisType.AGE) {
-        section.heightRange = [
-          Math.max(section.heightRange[0], heightRange[0]),
-          Math.min(section.heightRange[1], heightRange[1]),
-        ];
+
+  const initialSections: WorkingSection[] = units.map((unit) => {
+    return {
+      units: [unit],
+      heightRange: getUnitHeightRange(unit, axisType),
+    };
+  });
+
+  const isOverlapping = (a: WorkingSection, b: WorkingSection) => {
+    const res = compareAgeRanges(a.heightRange, b.heightRange, tolerance);
+    return res !== AgeRangeRelationship.Disjoint;
+  };
+
+  const mergeSections = (a: WorkingSection, b: WorkingSection) => {
+    return {
+      units: [...a.units, ...b.units],
+      heightRange: mergeAgeRanges(
+        [a.heightRange, b.heightRange],
+        MergeMode.Outer,
+      ),
+    };
+  };
+
+  // Merge overlapping sections progressively until no more merges are possible
+  let finalSectionList = initialSections;
+
+  while (true) {
+    let merged = false;
+    const nextSections: WorkingSection[] = [];
+
+    for (const section of finalSectionList) {
+      if (nextSections.length === 0) {
+        nextSections.push(section);
       } else {
-        section.heightRange = [
-          Math.min(section.heightRange[0], heightRange[0]),
-          Math.max(section.heightRange[1], heightRange[1]),
-        ];
+        const lastSection = nextSections[nextSections.length - 1];
+        if (isOverlapping(section, lastSection)) {
+          // Merge with the last section
+          nextSections[nextSections.length - 1] = mergeSections(lastSection, section);
+          merged = true;
+        } else {
+          nextSections.push(section);
+        }
       }
     }
+
+    finalSectionList = nextSections;
+
+    // Stop when no more merges occurred in this pass
+    if (!merged) {
+      break;
+    }
   }
-  // We should have a section for each unit, now we can convert to SectionInfo
-  // Ages have to be really actually ages, not heights
 
-  return sectionList.map((section, i) => {
+  return finalSectionList.map((section, i) => {
     const [b_age, t_age] = getSectionAgeRange(section.units);
     const [b_pos, t_pos] = getSectionPosRange(section.units, axisType);
     return {

package/src/prepare-units/index.ts

@@ -6,6 +6,7 @@ import {
   mergeOverlappingSections,
   preprocessSectionUnit,
   preprocessUnits,
+  UnitWithLayoutHints,
 } from "./helpers";
 import { ColumnAxisType } from "@macrostrat/column-components";
 import { useMemo } from "react";
@@ -43,7 +44,7 @@ export function usePreparedColumnUnits(
 }
 
 export function prepareColumnUnits(
-  units: UnitLong[],
+  units: UnitWithLayoutHints<UnitLong>[],
   options: PrepareColumnOptions,
 ): PreparedColumnData {
   /** Prepare units for rendering into Macrostrat columns */
@@ -184,6 +185,8 @@ export function prepareColumnUnits(
    * We do this after merging sections so that we can
    * handle cases where there are overlapping units across sections
    * */
+  console.log(sections2, "sections");
+
   const sectionsOut = sections2.map((section) => {
     return {
       ...section,

package/src/unit-details/panel.ts

@@ -93,7 +93,7 @@ export function UnitDetailsPanel({
         key: "json-view-toggle",
         className: classNames("json-view-toggle", { enabled: setShowJSON }),
         onClick(evt) {
-          setShowJSON(!showJSON);
+          setShowJSON(!_showJSON);
           evt.stopPropagation();
         },
       }),

package/src/units/boxes.module.sass

@@ -4,8 +4,8 @@
 .labeled-unit
   --column-unit-background-internal: var(--column-unit-background-color, var(--column-background-color))
   :global(.unit-overlay)
-    font-size: 10px
-    font-style: italic
+    font-size: var(--column-unit-font-size, 10px)
+    font-style: var(--column-unit-font-style, italic)
     display: flex
     align-items: center
     justify-content: center

package/src/units/index.ts

@@ -14,7 +14,7 @@ import { useEnvironments, useLithologies } from "@macrostrat/data-provider";
 import { useMemo } from "react";
 import { resolveID } from "./resolvers";
 import { BaseUnit, Lithology } from "@macrostrat/api-types";
-import { UnitWithDefinedOverlap } from "../prepare-units/helpers.ts";
+import { UnitWithLayoutParameters } from "../prepare-units/helpers.ts";
 
 export * from "./composite";
 export * from "./types";
@@ -58,7 +58,7 @@ export function BasicUnitComponent({ division, ...rest }) {
 }
 
 interface UnitComponentProps<T extends BaseUnit> {
-  division: UnitWithDefinedOverlap<T> | T;
+  division: UnitWithLayoutParameters<T> | T;
   nColumns: number;
   width?: number;
 }
@@ -78,11 +78,11 @@ export function UnitComponent<T extends BaseUnit>({
   let x = 0;
 
   let reducedWidth = _nColumns;
-  if ("overlap" in division) {
-    const overlap = division.overlap;
-    _nColumns = Math.min(_nColumns, overlap.nColumns);
-    columnIx = overlap.column;
-    reducedWidth = width / _nColumns;
+  if ("layout" in division) {
+    const layout = division.layout;
+    _nColumns = Math.min(_nColumns, layout.totalColumns);
+    columnIx = layout.column;
+    reducedWidth = width / layout.totalColumns / layout.nColumns;
     x = (columnIx * width) / _nColumns;
   }
   return h(TrackedLabeledUnit, {