feat: add sample for layout model

phodal · phodal · commit 17082909e678 · 2022-08-10T08:11:38.000+08:00
diff --git a/docs/feakin.uml b/docs/feakin.uml
@@ -117,4 +117,10 @@ interface Renderer {
 SvgRenderer --|> Renderer
 CanvasRenderer --|> Renderer
 
+interface Layer {
+}
+
+' paper can be a layer ??
+interface Paper {}
+
 @enduml
diff --git a/packages/exporter/src/model/algorithm.ts b/packages/exporter/src/model/algorithm.ts
@@ -1,3 +1,11 @@
-export interface LayoutAlgorithm {
+import { Graph } from "./element";
+
+/**
+ * Algorithm is a class that represents an algorithm for Graph objects.
+ * like: BreadthFirstSearch, DepthFirstSearch, PageRank, K-Clustering, etc.
+ */
+
+export interface Algorithm {
   name: string;
+  transform(graph: any): Graph;
 }
diff --git a/packages/exporter/src/model/element.ts b/packages/exporter/src/model/element.ts
@@ -16,9 +16,11 @@
 // http://js.cytoscape.org/#notation/functions
 // TypeScript Version: 2.3
 
-export interface ElementsDefinition {
-  nodes: NodeDefinition[];
-  edges: EdgeDefinition[];
+export type Graph = Elements;
+
+export interface Elements {
+  nodes: Node[];
+  edges: Edge[];
 }
 
 interface Position {
@@ -89,18 +91,20 @@ interface ElementDataDefinition {
   position?: Position | undefined;
 }
 
-export interface NodeDefinition extends ElementDefinition {
+export interface Node extends ElementDefinition {
   data: NodeDataDefinition;
 }
 
 export interface NodeDataDefinition extends ElementDataDefinition {
   id?: string | undefined;
   parent?: string | undefined;
+  // children's Node ids
+  children?: string[];
 
   [key: string]: any;
 }
 
-export interface EdgeDefinition extends ElementDefinition {
+export interface Edge extends ElementDefinition {
   data: EdgeDataDefinition;
 }
 
diff --git a/packages/exporter/src/model/layout.ts b/packages/exporter/src/model/layout.ts
@@ -1,4 +1,4 @@
-import { ElementsDefinition } from "./element";
+import { Elements } from "./element";
 
 export interface LayoutLifecycle {
   /**
@@ -8,7 +8,7 @@ export interface LayoutLifecycle {
   /**
    * transition layout.
    */
-  transform?: (element: ElementsDefinition) => void;
+  transform?: (element: Elements) => void;
   /**
    * Called when the layout is stopped.
    */
diff --git a/packages/exporter/src/model/renderer.ts b/packages/exporter/src/model/renderer.ts
@@ -1,4 +1,4 @@
-import { EdgeDataDefinition, ElementsDefinition, NodeDataDefinition } from "./element";
+import { EdgeDataDefinition, Elements, NodeDataDefinition } from "./element";
 
 export interface RendererContext {
   elementId?: string;
@@ -7,7 +7,7 @@ export interface RendererContext {
 // inspired by cytoscape.js
 export interface Renderer {
   arrowShapes: () => void;
-  drawingElements: (context: RendererContext, elements: ElementsDefinition) => void;
+  drawingElements: (context: RendererContext, elements: Elements) => void;
 
   drawingEdges: (edges: EdgeDataDefinition) => void;
   drawingNodes: (nodes: NodeDataDefinition[]) => void;
