@graphty/graph-io 0.3.47 → 0.3.49

package/dist/src/formats/json/positions.js

@@ -3,18 +3,29 @@
  * document has a role-`position` column the importer already flipped to y up. A plain
  * `{ nodes: [{ x, y }] }` file is read as graphty-element's own convention (center, y up, file
  * units) and never flipped, unless it carries a positive marker of a y-down tool: d3-force's
- * simulation keys (`vx`, `vy`, `fx`, `fy`, `index`) or vis's `physics`.
+ * simulation keys (`vx`, `vy`, `fx`, `fy`, `index`) or vis's `physics`. A vis-network document
+ * (edges with `from` / `to`) is always y down in canvas px: vis-network draws `x` / `y` straight onto
+ * its canvas. A Cytoscape compound node's saved position is not read: Cytoscape.js draws a compound
+ * around its children.
  */
+import { jsonShapeOf } from "./dialect.js";
+/**
+ * How sigma.js fits a graphology graph into its canvas: the bounding box of the positions, 30 px in
+ * from each side, with node sizes in the positions' unit and label sizes in the canvas's px
+ * (sigma 4.0.1 settings: `stagePadding: 30`, `itemSizesReference: "positions"`, `autoRescale: true`).
+ */
+const SIGMA_FIT = { padding: 30 };
 /** Node keys that mark a y-down drawing. */
 const Y_DOWN_MARKERS = ["vx", "vy", "fx", "fy", "index", "physics"];
 /**
  * The spelling of a JSON file's positions.
  * @param snapshot - the graph the JSON importer read
- * @returns the plain x / y columns, or null to read the role-`position` column as declared
+ * @returns the plain x / y columns, the role-`position` column's spelling, or null to read that column as declared
  */
 export function jsonPositions(snapshot) {
     if (snapshot.nodes.byRole("position") !== null) {
-        return null;
+        // cy.json() saves a compound node's position too, but Cytoscape.js draws the compound around its children
+        return jsonShapeOf(snapshot)?.dialect === "cytoscape" ? { containersFollowChildren: true } : null;
     }
     const x = numeric(snapshot.nodes.get("x"));
     const y = numeric(snapshot.nodes.get("y"));
@@ -23,13 +34,18 @@ export function jsonPositions(snapshot) {
     }
     const z = numeric(snapshot.nodes.get("z"));
     // a z means a 3D drawing (3d-force-graph), drawn y up even with the d3 keys
-    const down = z === null && Y_DOWN_MARKERS.some((name) => snapshot.nodes.get(name) !== null);
+    const dialect = jsonShapeOf(snapshot)?.dialect;
+    // sigma.js draws every graphology file y up: d3-force's keys in one do not make it a d3 drawing
+    // (graphology-specimen-node-sizes-opacity-p3)
+    const markers = dialect !== "graphology" && Y_DOWN_MARKERS.some((name) => snapshot.nodes.get(name) !== null);
+    const down = z === null && (dialect === "vis" || markers);
     return {
         x: x.meta.name,
         y: y.meta.name,
         ...(z === null ? {} : { z: z.meta.name }),
         yAxis: down ? "down" : "up",
         units: down ? "px" : "file",
+        ...(dialect === "graphology" ? { viewerFit: SIGMA_FIT } : {}),
     };
 }
 /**

package/dist/src/formats/json/positions.js.map

@@ -1 +1 @@
-{"version":3,"file":"positions.js","sourceRoot":"","sources":["../../../../src/formats/json/positions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,4CAA4C;AAC5C,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAU,CAAC;AAE7E;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,QAAuB;IACjD,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,4EAA4E;IAC5E,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IAC5F,OAAO;QACH,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI;QACd,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI;QACd,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;QAC3B,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;KAC9B,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,OAAO,CAAC,MAAqB;IAClC,MAAM,aAAa,GAAsB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC5E,OAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACnH,CAAC"}
+{"version":3,"file":"positions.js","sourceRoot":"","sources":["../../../../src/formats/json/positions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;;;GAIG;AACH,MAAM,SAAS,GAAc,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAE7C,4CAA4C;AAC5C,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAU,CAAC;AAE7E;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,QAAuB;IACjD,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7C,0GAA0G;QAC1G,OAAO,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACtG,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,4EAA4E;IAC5E,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC/C,gGAAgG;IAChG,8CAA8C;IAC9C,MAAM,OAAO,GAAG,OAAO,KAAK,YAAY,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC;IAC7G,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,OAAO,CAAC,CAAC;IAC1D,OAAO;QACH,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI;QACd,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI;QACd,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACzC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;QAC3B,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;QAC3B,GAAG,CAAC,OAAO,KAAK,YAAY,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChE,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,OAAO,CAAC,MAAqB;IAClC,MAAM,aAAa,GAAsB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAC5E,OAAO,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACnH,CAAC"}

package/dist/src/formats/json/styles.d.ts

@@ -5,7 +5,7 @@
  * - Cytoscape.js: the stylesheet (an array or a CSS-like text) over the raw element JSON, through graph-io's
  *   Cytoscape.js engine, with Cytoscape.js's defaults beneath it; an element's own `style` is a bypass. Cytoscape
  *   desktop's export without a stylesheet gets Cytoscape desktop's default style instead.
- * - graphology: the keys sigma.js draws (`color`, `size`, `label`, `hidden`), with sigma's defaults. Gephi's JSON
+ * - graphology: the keys sigma.js draws (`color`, `size` (a radius), `label`), with sigma's defaults. Gephi's JSON
  *   export for sigma.js is read the same way.
  * - vis.js: the keys vis-network draws, `options.nodes` and `options.edges` as declared defaults and
  *   `options.groups` as group rules, with vis-network's defaults, its palette for groups the file does not define,
@@ -46,9 +46,20 @@ export interface JsonStyleSource {
     readonly groups?: unknown;
     /** graphology: whether the document is Gephi's JSON export (`id` instead of `key`). */
     readonly gephi?: boolean;
+    /** graphology: the sigma.js settings the drawing uses (the `sigmaSettings` import option). */
+    readonly sigma?: SigmaSettings;
     /** node-link: whether the document has NetworkX's `directed`, `multigraph` and `graph` keys. */
     readonly networkx?: boolean;
 }
+/** The sigma.js settings that change what graph-io reads from a graphology document; the rest are the application's. */
+export interface SigmaSettings {
+    /** Whether sigma draws edge labels (`renderEdgeLabels`, off by default). */
+    readonly renderEdgeLabels: boolean;
+    /** Whose edge labels it draws (`edgeLabelAnchors`): between two labeled nodes ("nodeLabels", the default), or every edge's. */
+    readonly edgeLabelAnchors: "nodeLabels" | "allNodes";
+}
+/** sigma.js's own settings. */
+export declare const SIGMA_DEFAULT_SETTINGS: SigmaSettings;
 /**
  * The styles of a JSON document, read by its dialect's reader from what the import kept.
  * @param snapshot - the graph the import built

package/dist/src/formats/json/styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../../src/formats/json/styles.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAS3D,OAAO,EAGH,KAAK,uBAAuB,EAE/B,MAAM,2BAA2B,CAAC;AAKnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAIpE,OAAO,KAAK,EAGR,cAAc,EAKd,gBAAgB,EAEhB,WAAW,EAEX,sBAAsB,EACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAgB,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,4CAA4C;IAC5C,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;IACpC,iEAAiE;IACjE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,yDAAyD;IACzD,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,+EAA+E;IAC/E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,gFAAgF;IAChF,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,wCAAwC;IACxC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,gGAAgG;IAChG,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC/B;AAWD;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,gBAAgB,GAAG,cAAc,GAAG,IAAI,CAoBpG;AAssCD;;;;GAIG;AACH,eAAO,MAAM,MAAM,EAAE,QAAQ,CACzB,MAAM,CAAC,WAAW,GAAG,YAAY,GAAG,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAAC,CA0C/F,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,EAAE,sBAQpC,CAAC;AAEH,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC7B,gHAAgH;IAChH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,iFAAiF;IACjF,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,EAAE,SAAS,uBAAuB,EAAE,GAAG,IAAI,CAAC;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACnF,mEAAmE;IACnE,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;CACvC;AAKD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC5B,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,kBAAkB,GAAG,SAAS,GACtC,gBAAgB,GAAG,IAAI,CA+CzB;AAmUD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,8BAA8B,CAAC"}
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../../src/formats/json/styles.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAS3D,OAAO,EAGH,KAAK,uBAAuB,EAE/B,MAAM,2BAA2B,CAAC;AAMnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAIpE,OAAO,KAAK,EAGR,cAAc,EAKd,gBAAgB,EAEhB,WAAW,EAEX,sBAAsB,EACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAgB,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,4CAA4C;IAC5C,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;IACpC,iEAAiE;IACjE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,yDAAyD;IACzD,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,+EAA+E;IAC/E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,gFAAgF;IAChF,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,wCAAwC;IACxC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,uFAAuF;IACvF,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,8FAA8F;IAC9F,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IAC/B,gGAAgG;IAChG,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,wHAAwH;AACxH,MAAM,WAAW,aAAa;IAC1B,4EAA4E;IAC5E,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC,+HAA+H;IAC/H,QAAQ,CAAC,gBAAgB,EAAE,YAAY,GAAG,UAAU,CAAC;CACxD;AAED,+BAA+B;AAC/B,eAAO,MAAM,sBAAsB,EAAE,aAA2E,CAAC;AAWjH;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,gBAAgB,GAAG,cAAc,GAAG,IAAI,CAoBpG;AA89FD;;;;GAIG;AACH,eAAO,MAAM,MAAM,EAAE,QAAQ,CACzB,MAAM,CAAC,WAAW,GAAG,YAAY,GAAG,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAAC,CA0C/F,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,EAAE,sBAQpC,CAAC;AAEH,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC7B,gHAAgH;IAChH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,iFAAiF;IACjF,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,EAAE,SAAS,uBAAuB,EAAE,GAAG,IAAI,CAAC;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACnF,mEAAmE;IACnE,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;CACvC;AAKD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC5B,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,kBAAkB,GAAG,SAAS,GACtC,gBAAgB,GAAG,IAAI,CA+CzB;AAmUD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,8BAA8B,CAAC"}