@graphty/graph-io 0.3.43 → 0.3.44

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

@@ -0,0 +1,46 @@
+/**
+ * How a GML file's `graphics [ x y z ]` positions are spelled, for `extractPositions()`: the node's
+ * center in pixels, y growing downward (the GML specification, yFiles and Cytoscape) unless the
+ * `Creator` names a y-up tool (Gephi, Tulip).
+ */
+import { toolOf } from "../../common/units.js";
+import { median } from "../../positions/convert.js";
+/** The json column the importer keeps the rest of each node's graphics record in. */
+const GRAPHICS_COLUMN = "graphics";
+/**
+ * The spelling of a GML file's positions.
+ * @param snapshot - the graph the GML importer read
+ * @returns the spelling, or null when no node has a position
+ */
+export function gmlPositions(snapshot) {
+    if (snapshot.nodes.byRole("position") === null) {
+        return null;
+    }
+    const tool = toolOf(snapshot.meta.creator);
+    return {
+        units: "px",
+        // a z that is the same on every node collapses to 2D
+        sourceDims: 3,
+        yAxis: tool === "gephi" || tool === "tulip" ? "up" : "down",
+        tool,
+        medianNodeSize: graphicsMedian(snapshot),
+    };
+}
+/**
+ * The median node diameter from the graphics records' `w` and `h`.
+ * @param snapshot - the graph
+ * @returns the median of each node's mean of w and h, or null when no node has both
+ */
+function graphicsMedian(snapshot) {
+    const graphics = snapshot.nodes.get(GRAPHICS_COLUMN);
+    const sizes = [];
+    for (let row = 0; graphics !== null && row < graphics.length; row++) {
+        const g = graphics.isSet(row) ? graphics.value(row) : undefined;
+        const { w, h } = typeof g === "object" && g !== null ? g : {};
+        if (typeof w === "number" && typeof h === "number") {
+            sizes.push((w + h) / 2);
+        }
+    }
+    return median(sizes);
+}
+//# sourceMappingURL=positions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"positions.js","sourceRoot":"","sources":["../../../../src/formats/gml/positions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,qFAAqF;AACrF,MAAM,eAAe,GAAG,UAAU,CAAC;AAEnC;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,QAAuB;IAChD,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,IAAI,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3C,OAAO;QACH,KAAK,EAAE,IAAI;QACX,qDAAqD;QACrD,UAAU,EAAE,CAAC;QACb,KAAK,EAAE,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM;QAC3D,IAAI;QACJ,cAAc,EAAE,cAAc,CAAC,QAAQ,CAAC;KAC3C,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,QAAuB;IAC3C,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACrD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,QAAQ,KAAK,IAAI,IAAI,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QAClE,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAChE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAE,CAA6B,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3F,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACjD,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5B,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACzB,CAAC"}

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

@@ -0,0 +1,59 @@
+/**
+ * GML styles: each node's and edge's `graphics [ ... ]` and `LabelGraphics [ ... ]` records read the way the program
+ * that wrote the file draws them, and a graph's styles written back as yEd GML graphics.
+ *
+ * GML has one syntax and many vocabularies. The `Creator` line (top level, or inside the graph as Gephi writes it,
+ * quoted or not) names the writer: yEd and yFiles, Cytoscape, Gephi, OGDF and igraph are recognized; every other file
+ * (NetworkX writes no `Creator`) is read with the keys of the GML draft (Graphlet). A recognized drawing program's
+ * defaults go beneath the file's own values; igraph and unknown writers get none.
+ *
+ * Writing: the yEd keys (`fill`, `outline`, `outlineWidth`, `outlineStyle`, `w`, `h`, `type`; edge `fill`, `width`,
+ * `style`, `sourceArrow`, `targetArrow`, `smoothBends`; `LabelGraphics` `text`, `color`, `fontSize`, `fontName`,
+ * `fontStyle`) replace every style key any reader here reads, inside the records the graph already has, so positions,
+ * bends and other keys stay. The `graphty.styles` block and the per-element values its rules read are keys too,
+ * named by the GML writer's rule for names that are not GML keys (`graphty_styles`, `graphty_style_node_<key>`).
+ */
+import type { GraphSnapshot } from "@graphty/graph-format";
+import { type ExporterStyleInput } from "../../styles/io/writer.js";
+import type { ImporterStyles, StyleReadContext, StyleWriteCapabilities } from "../../styles/types.js";
+import type { LossNote } from "../../types.js";
+/**
+ * The graph key holding the `graphty.styles` block: the block's name under the GML writer's rule for names that are
+ * not GML keys.
+ * @category Built-in formats
+ */
+export declare const GML_STYLE_BLOCK_KEY: string;
+/**
+ * The styles of a GML file, read the way the program that wrote it draws them, with that program's defaults beneath:
+ * yEd, Cytoscape, Gephi and OGDF are recognized by the `Creator` line; igraph and every other writer get the GML
+ * draft's keys and no defaults. A file graphty wrote gives back its `graphty.styles` block.
+ * @param snapshot - the graph the import built
+ * @param context - the work budget
+ * @returns the styles, or null when the file has none
+ */
+export declare function gmlStyles(snapshot: GraphSnapshot, context: StyleReadContext): ImporterStyles | null;
+/**
+ * What the GML writer holds natively: yEd GML `graphics` and `LabelGraphics`. The `graphty.styles` block and the
+ * per-element values its rules read are keys of the graph and of each element.
+ * @category Built-in formats
+ */
+export declare const GML_STYLE_CAPABILITIES: StyleWriteCapabilities;
+/** A GML export with styles worked out. */
+interface GmlStyledExport {
+    /** The graph to write: yEd graphics written from the styles, the block and the per-element style values added. */
+    readonly snapshot: GraphSnapshot;
+    /** W_STYLE_APPROXIMATED for every value written as the nearest one yEd has. */
+    readonly notes: readonly LossNote[];
+}
+/**
+ * Works out a GML export with styles: every node's and edge's `graphics` and `LabelGraphics` records get yEd's keys
+ * for what graphty draws in place of every style key they had (positions, bends and other keys stay), the
+ * `graphty.styles` block becomes the graph key `graphty_styles` and the per-element values its rules read become
+ * element keys. Should two style columns map to one key, the values go inside the block instead.
+ * @param snapshot - the graph handed to the exporter
+ * @param input - the styles, or undefined when none are written
+ * @returns the styled export, or null without styles
+ */
+export declare function gmlStyledExport(snapshot: GraphSnapshot, input: ExporterStyleInput | undefined): GmlStyledExport | null;
+export {};
+//# sourceMappingURL=styles.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../../src/formats/gml/styles.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAmB3D,OAAO,EAAY,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAI9E,OAAO,KAAK,EACR,cAAc,EAGd,gBAAgB,EAIhB,sBAAsB,EACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AA0F/C;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,QAAiC,CAAC;AAwjBlE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,gBAAgB,GAAG,cAAc,GAAG,IAAI,CA6BnG;AAID;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,EAAE,sBAkCnC,CAAC;AA8RH,2CAA2C;AAC3C,UAAU,eAAe;IACrB,kHAAkH;IAClH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,+EAA+E;IAC/E,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;CACvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,kBAAkB,GAAG,SAAS,GACtC,eAAe,GAAG,IAAI,CAoCxB"}