@graphty/graphty-element 2.2.5 → 2.3.0

package/dist/graphty.js

@@ -1,6 +1,6 @@
-import { A as e, a as E, b as r, D as O, E as o, d as S, G as R, e as _, I as t, L, N as C, O as A, R as N, S as n, f as I, g as T, h as g, U as i, i as l } from "./chunks/index-BY1gnMiZ.js";
-import { a as p, S as G, b as f } from "./chunks/paletteRegistry-YSpPryiT.js";
-import { D as y, E as D } from "./chunks/DataSource-Dag8H5US.js";
+import { A as e, a as E, b as r, D as O, E as o, d as S, G as R, e as _, I as t, L, N as C, O as A, R as N, S as n, f as I, g as T, h as g, U as i, i as l } from "./chunks/index-CD0_RJv-.js";
+import { a as p, S as G, b as f } from "./chunks/paletteRegistry-DnWHQsAD.js";
+import { D as y, E as D } from "./chunks/DataSource-bt0DhBjG.js";
 import { k as P, l as U, g as c, h as m, A as u, C as x, i as B } from "./chunks/Algorithm-RQ629NLb.js";
 import { e as H, E as b, N as Y, a as F, P as W, R as k, S as K, d as v, b as w, c as Q } from "./chunks/NodeStyle-DKj7HjMJ.js";
 import { A as j, a as q, G as z, i as J, b as Z } from "./chunks/GraphtyError-BwcnblTH.js";

package/dist/session.js

@@ -1,10 +1,10 @@
 import { R, e as _ } from "./chunks/types-B7bX5c0K.js";
 import { A as c, a as C, G as p, i as m, b as g } from "./chunks/GraphtyError-BwcnblTH.js";
 import { g as O, h as U, i as I } from "./chunks/Algorithm-RQ629NLb.js";
-import { D as h } from "./chunks/GraphSession-mfo75G0q.js";
-import { a as N, b as y, c as D, d as v, Q as w, R as G, e as b, f as x, S as F, T as M, g as z, i as k, h as H, j as Y, k as j } from "./chunks/GraphSession-mfo75G0q.js";
-import { R as Q, t as X, u as B, v as J, w as K, x as V } from "./chunks/paletteRegistry-YSpPryiT.js";
-import { L as s } from "./chunks/scales-DOpwlWuz.js";
+import { D as h } from "./chunks/GraphSession-iNyKm7Ds.js";
+import { a as N, b as y, c as D, d as v, Q as w, R as G, e as b, f as x, S as F, T as M, g as z, i as k, h as H, j as Y, k as j } from "./chunks/GraphSession-iNyKm7Ds.js";
+import { R as Q, t as X, u as B, v as J, w as K, x as V } from "./chunks/paletteRegistry-DnWHQsAD.js";
+import { L as s } from "./chunks/scales-DyuwlJKI.js";
 const u = [
   {
     id: "fixed",

package/dist/src/algorithms/metrics/context.d.ts

@@ -13,10 +13,12 @@
  */
 import type { MetricRunContext } from "./types";
 /**
- * How many nodes a measurement visits between yields.
+ * How many nodes a measurement visits between progress reports.
  *
- * Large enough that the yields cost nothing on an ordinary graph, small enough that a very large
- * one gives the frame back several times a second.
+ * The frame is NOT given back at every chunk: a yield costs the host a whole frame, which on a
+ * large scene is far more than a chunk of work, so it is given back only once a frame's worth of
+ * work has built up since the last one -- the same budget every declared algorithm's pass uses,
+ * for the same reason (see `YIELD_BUDGET_MS`).
  */
 export declare const METRIC_CHUNK_SIZE = 2048;
 /**
@@ -31,8 +33,8 @@ export declare const METRIC_CHUNK_SIZE = 2048;
  */
 export declare function detachedRunContext(runId: string): MetricRunContext;
 /**
- * Visit every item, checking the signal, reporting progress and giving the host a turn between
- * chunks.
+ * Visit every item, checking the signal, reporting progress between chunks and giving the host a
+ * turn once a frame's worth of work has built up.
  * @param items - What to visit, in order.
  * @param context - Where progress goes and where cancellation arrives.
  * @param phase - What to call this step in a progress line.

package/dist/src/algorithms/results/types.d.ts

@@ -100,6 +100,21 @@ export interface AlgorithmRunContext {
      */
     yieldNow(): Promise<void>;
 }
+/**
+ * How long a per-element pass works before it hands the frame back.
+ *
+ * THE YIELD IS PRICED IN FRAMES, NOT IN ELEMENTS. Handing the frame back is a `setTimeout(0)`,
+ * and by the time the timer fires the host has drawn a frame -- which is the whole point of
+ * yielding, and also what it costs: on a scene of a thousand nodes and ten thousand edges a frame
+ * is about a hundred milliseconds on a discrete GPU and half a second on a software renderer.
+ * Yielding every 1,024 elements, as this used to, charged that frame for a chunk of work that
+ * took a few microseconds: a shortest-path run over 10,000 edges spent 0.5 ms searching and
+ * nine frames yielding, and came back after a second (issue #389). The frame is given back only
+ * once this much work has accumulated since the last one, so a pass that finishes inside a
+ * frame's budget never yields at all and a pass that takes seconds still yields several times a
+ * second.
+ */
+export declare const YIELD_BUDGET_MS = 16;
 /**
  * A context for work nobody is watching.
  *
@@ -118,7 +133,8 @@ export interface AlgorithmRunContext {
  */
 export declare function detachedRunContext(): AlgorithmRunContext;
 /**
- * Walk a list in chunks, reporting progress and yielding between them.
+ * Walk a list in chunks, reporting progress between them and yielding once a frame's worth of
+ * work has built up (see `YIELD_BUDGET_MS`, a module constant; TypeDoc cannot link an unexported name).
  *
  * Every per-element pass in every algorithm goes through this, so "report progress and yield"
  * is one decision made once rather than a loop each author writes their own way.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphty/graphty-element",
-  "version": "2.2.5",
+  "version": "2.3.0",
   "description": "A Web Component library for 3D/2D graph visualization built with Lit and Babylon.js",
   "type": "module",
   "customElements": "./dist/custom-elements.json",