@graphty/graph-io 0.3.47 → 0.3.49

package/dist/src/styles/cytoscape/lexicon.d.ts

@@ -11,9 +11,91 @@ import type { StyleTarget, StyleValue } from "../types.js";
  * @category Styles
  */
 export type CytoscapeValueParser = (raw: unknown, site: CanonSite) => StyleValue | null;
-/** Java's logical font names, which Cytoscape desktop writes, as the CSS generic families they stand for. */
-/** The family a Java logical font name is read as (`Dialog` is drawn as a sans-serif font). */
-export declare const JAVA_FONTS: ReadonlyMap<string, string>;
+export declare const arrowSizeParser: CytoscapeValueParser;
+/**
+ * The parser of an arrow's length or width as a fraction of its neutral shape's, from the arrow's name: 1 for every
+ * arrow Cytoscape draws in its shape's proportions, so a bypass over a short default draws the full shape again.
+ * @param side - which proportion
+ * @returns the parser; null for a name it does not know (the shape's parser notes it)
+ */
+export declare function arrowProportion(side: "length" | "width"): CytoscapeValueParser;
+/**
+ * The parser of how far an arrow stands off its node, as a multiple of its own length (`CY_ARROW_GAPS`), from the
+ * arrow's name: 0 for an arrow that touches the node.
+ * @param raw - the arrow's name
+ * @param site - where it was read
+ * @returns the gap; null for a name it does not know (the shape's parser notes it)
+ */
+export declare const arrowGap: CytoscapeValueParser;
+/**
+ * The faces Java draws its logical fonts in on Linux, where the oracles were drawn (the JDK's fontconfig maps
+ * SansSerif and Dialog to DejaVu Sans), each before the CSS generic family it stands for. A label wraps by its width
+ * in that face: a browser's own sans-serif (Liberation Sans) is 14 percent narrower, so its lines break later.
+ */
+export declare const JAVA_SANS = "DejaVu Sans, sans-serif";
+export declare const JAVA_SERIF = "DejaVu Serif, serif";
+export declare const JAVA_MONO = "DejaVu Sans Mono, monospace";
+/**
+ * A Java font name as the CSS family Cytoscape draws it with: a logical name as its generic family, and any other
+ * with Dialog's face after it, because Java draws a font it does not have as Dialog
+ * (`Calibri-Bold` on a machine without Calibri is drawn in Dialog's face and measured so when a label wraps).
+ * @param family - the Java font name, without its style suffix
+ * @returns the CSS family
+ */
+export declare function javaFamily(family: string): string;
+/**
+ * A Cytoscape label position, read whole: the point of the node (or the edge's middle) `node` and the point of the
+ * label's box `label` it is pinned to, each `[x, y]` with x right and y down as -1, 0 or 1, the justification of its
+ * lines, and the offset `[x, y]` in px, y down.
+ * @category Styles
+ */
+export interface CytoscapeLabelPlace {
+    readonly node: readonly [number, number];
+    readonly label: readonly [number, number];
+    readonly justify: string;
+    readonly offset: readonly [number, number];
+}
+/**
+ * Reads a label position: desktop's `C,C,c,0.00,0.00` (node anchor, label anchor, justification, x and y offsets)
+ * or CX2's `{ HORIZONTAL_ANCHOR, VERTICAL_ANCHOR, HORIZONTAL_ALIGN, VERTICAL_ALIGN, JUSTIFICATION, MARGIN_X,
+ * MARGIN_Y }` (for an edge's label `{ EDGE_ANCHOR, LABEL_ANCHOR, JUSTIFICATION, MARGIN_X, MARGIN_Y }`, the anchors
+ * as desktop's letters).
+ * @param raw - the value
+ * @param site - where a bad value is noted
+ * @returns the place, or null
+ * @category Styles
+ */
+export declare function cytoscapeLabelPlace(raw: unknown, site: CanonSite): CytoscapeLabelPlace | null;
+/**
+ * The neutral `labelPosition` a Cytoscape label position starts from: where the label's point is the node's own
+ * point on both axes (its center, or inside against a side or a corner), that position; anywhere else `center`,
+ * with the rest said by `labelOffsetX`/`Y` and `labelShiftX`/`Y` (see `cytoscapeLabelMove()`).
+ * @param place - the label position
+ * @returns the neutral position
+ * @category Styles
+ */
+export declare function cytoscapeLabelBase(place: CytoscapeLabelPlace): string;
+/**
+ * How far a Cytoscape label is moved from its `cytoscapeLabelBase()` position: the offset in px (y down), with the
+ * node's anchor point added when the base is `center` and the anchors differ, and the shift by the label's own
+ * size that pins the label's anchor point there.
+ * @param place - the label position
+ * @param width - the node's width (0 for an edge's middle)
+ * @param height - the node's height (0 for an edge's middle)
+ * @returns the offset and the shift, each `[x, y]`
+ * @category Styles
+ */
+export declare function cytoscapeLabelMove(place: CytoscapeLabelPlace, width: number, height: number): {
+    readonly offset: readonly [number, number];
+    readonly shift: readonly [number, number];
+};
+/**
+ * How far a label is shifted, as a fraction of its own size, to pin its point `side` (-1, 0 or 1) where its middle was.
+ * @param side - the label's point on one axis
+ * @returns the shift (0, never -0, for the middle)
+ * @category Styles
+ */
+export declare function halfBack(side: number): number;
 /**
  * The visual properties that set each neutral property, in the order Cytoscape prefers them: the first one a style
  * or any bypass mentions is the one read. Cytoscape draws a node's fill from `NODE_FILL_COLOR`; `NODE_PAINT` is its
@@ -27,6 +109,12 @@ export declare const NODE_SIZE_VP = "NODE_SIZE";
 export declare const sizeParser: CytoscapeValueParser;
 /** The parser of colors, for the network background and `arrowColorMatchesEdge`. */
 export declare const colorParser: CytoscapeValueParser;
+/**
+ * The parser of 0..255 transparencies (desktop) and 0..1 opacities (CX2), by visual property.
+ * @param vp - the visual property (`*_TRANSPARENCY` or `*_OPACITY`)
+ * @returns its parser
+ */
+export declare const opacityParser: (vp: string) => CytoscapeValueParser;
 /**
  * Whether a visual property is one no neutral property carries and that is worth a note.
  * @param vp - the visual property
@@ -46,4 +134,10 @@ export declare function isUncarriedVp(vp: string): boolean;
  * @category Styles
  */
 export declare function normalizeVisualProperties(target: StyleTarget, raw: unknown, notes?: StyleNotes): Map<string, unknown>;
+/**
+ * The step Cytoscape rounds an interpolated value of a visual property to.
+ * @param vp - the visual property
+ * @returns the step, or undefined for a property that holds fractions
+ */
+export declare function vpStep(vp: string): number | undefined;
 //# sourceMappingURL=lexicon.d.ts.map

package/dist/src/styles/cytoscape/lexicon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lexicon.d.ts","sourceRoot":"","sources":["../../../../src/styles/cytoscape/lexicon.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,KAAK,SAAS,EAAsB,MAAM,kBAAkB,CAAC;AAGtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG3D;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,KAAK,UAAU,GAAG,IAAI,CAAC;AAqQxF,6GAA6G;AAC7G,+FAA+F;AAC/F,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAOjD,CAAC;AA+DH;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CACpC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CA8G3G,CAAC;AAEH,oFAAoF;AACpF,eAAO,MAAM,YAAY,cAAc,CAAC;AAExC,iDAAiD;AACjD,eAAO,MAAM,UAAU,EAAE,oBAA6B,CAAC;AAEvD,oFAAoF;AACpF,eAAO,MAAM,WAAW,EAAE,oBAA4B,CAAC;AAcvD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAEjD;AAmID;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAcrH"}
+{"version":3,"file":"lexicon.d.ts","sourceRoot":"","sources":["../../../../src/styles/cytoscape/lexicon.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,KAAK,SAAS,EAAsB,MAAM,kBAAkB,CAAC;AAGtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG3D;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,KAAK,UAAU,GAAG,IAAI,CAAC;AAsBxF,eAAO,MAAM,eAAe,EAAE,oBAG7B,CAAC;AAiLF;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,oBAAoB,CAS9E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,EAAE,oBAOtB,CAAC;AA+JF;;;;GAIG;AACH,eAAO,MAAM,SAAS,4BAA4B,CAAC;AACnD,eAAO,MAAM,UAAU,wBAAwB,CAAC;AAChD,eAAO,MAAM,SAAS,gCAAgC,CAAC;AA8BvD;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjD;AAqCD;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9C;AAkBD;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,mBAAmB,GAAG,IAAI,CAkD7F;AAeD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,mBAAmB,GAAG,MAAM,CAGrE;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAC9B,KAAK,EAAE,mBAAmB,EAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACf;IAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAW3F;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7C;AAOD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CACpC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CA2J3G,CAAC;AAEH,oFAAoF;AACpF,eAAO,MAAM,YAAY,cAAc,CAAC;AAExC,iDAAiD;AACjD,eAAO,MAAM,UAAU,EAAE,oBAA6B,CAAC;AAEvD,oFAAoF;AACpF,eAAO,MAAM,WAAW,EAAE,oBAA4B,CAAC;AAEvD;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,IAAI,MAAM,KAAG,oBAA0E,CAAC;AActH;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAEjD;AAmID;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAcrH;AAcD;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAErD"}