@linkurious/ogma-linkurious-parser 4.1.13 → 4.2.0

package/dist/ogma/features/nodeGrouping.d.ts

@@ -1,8 +1,7 @@
-import { Transformation, NodeList, StyleRule, PixelSize, Point } from '@linkurious/ogma';
+import { NodeList, PixelSize, Point, Transformation } from '@linkurious/ogma';
 import { IVizNodeGroupInfo, LkEdgeData, LkNodeData, NodeGroupingRule } from '@linkurious/rest-client';
 import { LKOgma } from '../index';
 export declare const LKE_NODE_GROUPING_EDGE = "LKE_NODE_GROUPING_EDGE";
-export declare const LKE_NODE_GROUPING_NODE = "LKE_NODE_GROUPING_NODE";
 interface CircularLayoutOptions {
     radii: PixelSize[] | number[];
     cx?: number;
@@ -15,14 +14,17 @@ interface CircularLayoutOptions {
 export declare class NodeGroupingTransformation {
     transformation?: Transformation<LkNodeData, LkEdgeData>;
     groupRule?: NodeGroupingRule;
-    nodeGroupingStyleRule?: StyleRule<LkNodeData, LkEdgeData>;
+    private _nodeGroupingStyleRule?;
     private _ogma;
+    private _nodeGroupingCollapsedStyleRule?;
+    private _collapsedDefaultValue;
+    private _nodeGroupingAttributes;
     constructor(ogma: LKOgma);
     /**
      * Set the grouping rule
      * @param rule of grouping
      */
-    setGroupingRule(rule: NodeGroupingRule | undefined): void;
+    setGroupingRule(rule?: NodeGroupingRule): void;
     /**
      * create a node grouping transformation
      * It uses groupRule to define the rule
@@ -39,38 +41,46 @@ export declare class NodeGroupingTransformation {
      */
     initNodeGroupingStyle(): void;
     refreshNodeGroupingStyle(): Promise<void>;
-    /**
-     * run layout on all subnodes of virtual nodes
-     */
-    runLayoutOnAllSubNodes(): Promise<void>;
     /**
      * Run the layout on the subnodes of the virtual node
      * @param subNodes nodes part of a virtual node
      */
-    runSubNodesLayout(subNodes: NodeList<LkNodeData, LkEdgeData>): Promise<void>;
+    runSubNodesLayout(subNodes: NodeList<LkNodeData, LkEdgeData>): Promise<Point[] | undefined | void>;
     /**
      * Get the virtual nodes of the transformation
      * @private
      */
     getVirtualNodesOfTransformation(): NodeList<LkNodeData, LkEdgeData>;
     /**
-     * Set the node group pin
+     * Set node initial attributes
      * @param nodeGroups object containing the node group id and the layoutable attribute
      */
-    setNodeGroupPin(nodeGroups: IVizNodeGroupInfo[]): Promise<void>;
+    setNodeGroupingAttributes(nodeGroups: IVizNodeGroupInfo[]): void;
+    /**
+     * set collapse default value, this will be the state of newly created groups
+     */
+    setCollapseDefaultValue(value: boolean): void;
     /**
      * Return the caption of a virtual node
      * @param node reference to the virtual node
      */
     private _getNodeGroupingCaption;
+    private _getAdjacentEdgeNodeGroupingCaption;
+    private _getPropertyValueNodeGroupingCaption;
     /**
      * Run the circle pack layout on the subnodes
      * @param subNodes
      */
     private _runCirclePack;
+    /**
+     * return a grid layout when nodes are represented by multiple chains (a)-(b)-(c)-(d)
+     */
     private _runChainLayout;
     private _runForceLayout;
     private _isRuleNotApplicableToNode;
+    private _isRelationshipRuleNotApplicableToNode;
+    private hasEdgeOfType;
+    private _isPropertyRuleNotApplicableToNode;
     /**
      * Unpin list of nodes
      * @param nodes
@@ -87,8 +97,19 @@ export declare class NodeGroupingTransformation {
      * Return a hashed string that represents the group id
      */
     private _findNodeGroupId;
+    /**
+     * For a relation type grouping rule, return the central node from one of the nodes in the group
+     */
+    private static _getGroupCentralNode;
     _runCircularLayout({ radii, clockwise, cx, cy, startAngle, getRadius, distanceRatio }: CircularLayoutOptions): Point[];
     private _runTwoNodesLayout;
-    private isStar;
+    private _getPropertyValueGroupId;
+    private _getAdjacentEdgeGroupId;
+    /**
+     * Initialize the style for the intermediate group state, when transitioning from expanded to collapsed
+     */
+    private _initIntermediateGroupStyle;
+    private _getDefaultCollapsedState;
+    private _getDefaultLayoutableValue;
 }
 export {};

package/dist/ogma/features/reactive.d.ts

@@ -3,7 +3,7 @@ import { LkEdgeData, LkNodeData } from '@linkurious/rest-client';
 import { LKOgma } from '../index';
 import { OgmaStore } from './OgmaStore';
 export interface OgmaState {
-    selection: NodeList<LkNodeData, LkEdgeData> | EdgeList<LkEdgeData, LkNodeData>;
+    selection: NodeList<LkNodeData, LkEdgeData> | EdgeList<LkEdgeData, LkNodeData> | undefined;
     items: {
         node: Array<string | number>;
         edge: Array<string | number>;
@@ -41,7 +41,3 @@ export declare class RxViz {
      */
     private storeEdgeSelection;
 }
-export declare class DummyNodeList {
-    size: number;
-    isNode: boolean;
-}

package/dist/ogma/features/styles.d.ts

@@ -1,5 +1,5 @@
 import { IEdgeStyle, INodeStyle, IStyleRule, OgmaEdgeShape, OgmaNodeShape, TextOptions } from '@linkurious/rest-client';
-import { LKOgma, StyleRule as LKStyleRule, StyleType } from '../..';
+import { LKOgma, NodeAttributes, StyleRule as LKStyleRule, StyleType } from '../..';
 export interface StylesConfig {
     nodeColorStyleRules: Array<LKStyleRule>;
     nodeIconStyleRules: Array<LKStyleRule>;
@@ -9,6 +9,8 @@ export interface StylesConfig {
     edgeWidthStyleRules: Array<LKStyleRule>;
     edgeShapeStyleRules?: Array<LKStyleRule>;
 }
+export declare const DEFAULT_OGMA_FONT = "'roboto', sans-serif";
+export declare const CLEAR_FONT_COLOR = "#FFF";
 export declare const FILTER_OPACITY = 0.2;
 export declare class StylesViz {
     private _ogma;
@@ -42,6 +44,8 @@ export declare class StylesViz {
         };
         baseUrl?: string;
     });
+    get nodeAttributes(): NodeAttributes;
+    get nodeFont(): string | undefined;
     /**
      * Set nodes default styles based on the configuration
      */

package/dist/ogma/index.d.ts

@@ -11,13 +11,6 @@ interface AddItemOptions {
     batchSize?: number;
     virtual?: boolean;
 }
-export declare const FORCE_LAYOUT_CONFIG: {
-    steps: number;
-    alignSiblings: boolean;
-    charge: number;
-    theta: number;
-    duration: number;
-};
 export declare class LKOgma extends Ogma<LkNodeData, LkEdgeData> {
     private _configuration;
     LKStyles: StylesViz;

package/dist/tools/ogmaTool.d.ts

@@ -1,5 +1,13 @@
 import { Color, NodeList, Node, EdgeList, Edge, NodeId } from '@linkurious/ogma';
 import { LkEdgeData, LkNodeData } from '@linkurious/rest-client';
+export declare const FORCE_LAYOUT_CONFIG: {
+    steps: number;
+    alignSiblings: boolean;
+    charge: number;
+    theta: number;
+    duration: number;
+    gravity: number;
+};
 export declare class OgmaTools {
     /**
      * Get the amount of hidden neighbors from a list of nodes
@@ -23,6 +31,18 @@ export declare class OgmaTools {
     static isBright(color: Color): boolean;
     static isNode(item: Node<LkNodeData, LkEdgeData> | Edge<LkEdgeData, LkNodeData>): item is Node<LkNodeData, LkEdgeData>;
     static isNodeList(items: NodeList<LkNodeData, LkEdgeData> | EdgeList<LkEdgeData, LkNodeData>): items is NodeList<LkNodeData, LkEdgeData>;
-    static topologicalSort(nodes: NodeList): NodeId[];
+    /**
+     * Transform a nodelist to an array of node ids sorted by position in a chain and the length of the chain
+     * A chain is: (a)-(b)-(c)-(d)
+     */
+    static topologicalSort(nodes: NodeList): {
+        chain: NodeId[];
+        numberOfChain: number;
+    };
     static isStar(nodes: NodeList): false | Node<any, any>;
+    /**
+     * Return true if the group is collapsed
+     */
+    static isGroupCollapsed(node: Node): boolean;
+    static setCollapsedGroupProperty(node: Node<LkNodeData>, collapsed: boolean): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkurious/ogma-linkurious-parser",
-  "version": "4.1.13",
+  "version": "4.2.0",
   "author": "Linkurious SAS",
   "description": "Parse and load a Linkurious visualization in Ogma with one line of code ",
   "files": [
@@ -15,7 +15,7 @@
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "engines": {
-    "node": "20.18.2"
+    "node": "22.14.0"
   },
   "exports": {
     ".": {
@@ -58,11 +58,11 @@
     "sha1": "1.1.1"
   },
   "peerDependencies": {
-    "@linkurious/ogma": "5.1.1"
+    "@linkurious/ogma": "5.2.4"
   },
   "devDependencies": {
-    "@linkurious/ogma": "5.1.1",
-    "@linkurious/rest-client": "4.1.13",
+    "@linkurious/ogma": "5.2.4",
+    "@linkurious/rest-client": "~4.2.0-develop.14",
     "@types/chai": "4.2.17",
     "@types/lodash": "4.14.182",
     "@types/mocha": "5.2.7",