@html-graph/html-graph 2.5.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -49,7 +49,10 @@ function createNode({ name, x, y, frontPortId, backPortId }) {
49
49
  };
50
50
  }
51
51
 
52
+ const element = document.getElementById("canvas");
53
+
52
54
  const canvas = new CanvasBuilder()
55
+ .setElement(element)
53
56
  .setDefaults({
54
57
  edges: {
55
58
  shape: {
@@ -59,17 +62,9 @@ const canvas = new CanvasBuilder()
59
62
  })
60
63
  .enableUserDraggableNodes()
61
64
  .enableUserTransformableViewport()
62
- .enableVirtualScroll({
63
- nodeContainingRadius: {
64
- horizontal: 25,
65
- vertical: 25,
66
- },
67
- })
68
- .enableResizeReactiveNodes()
69
65
  .build();
70
66
 
71
67
  canvas
72
- .attach(document.getElementById("canvas"))
73
68
  .addNode(
74
69
  createNode({
75
70
  name: "Node 1",
@@ -112,19 +112,6 @@ export declare class Canvas {
112
112
  */
113
113
  readonly viewport: Viewport;
114
114
  constructor(element: HTMLElement, controller: CanvasController, options: CanvasDefaults);
115
- /**
116
- * @deprecated
117
- * use CanvasBuilder.attach instead
118
- * attaches canvas to given element
119
- * detaches element first when canvas is attached
120
- */
121
- attach(element: HTMLElement): Canvas;
122
- /**
123
- * @deprecated
124
- * attach canvas once instead, then reattach wrapper element
125
- * detaches canvas from element when attached
126
- */
127
- detach(): Canvas;
128
115
  /**
129
116
  * adds node to graph
130
117
  */
@@ -194,16 +181,11 @@ export declare class CanvasBuilder {
194
181
  private hasTransformableViewport;
195
182
  private hasResizeReactiveNodes;
196
183
  private boxRenderingTrigger;
197
- attach(element: HTMLElement): CanvasBuilder;
184
+ setElement(element: HTMLElement): CanvasBuilder;
198
185
  /**
199
186
  * specifies default values for graph entities
200
187
  */
201
188
  setDefaults(defaults: CanvasDefaults): CanvasBuilder;
202
- /**
203
- * @deprecated
204
- * use setDefaults instead
205
- */
206
- setOptions(options: CanvasDefaults): CanvasBuilder;
207
189
  /**
208
190
  * enables nodes draggable by user
209
191
  */
@@ -231,14 +213,6 @@ export declare class CanvasBuilder {
231
213
  declare interface CanvasController {
232
214
  readonly graph: Graph;
233
215
  readonly viewport: Viewport;
234
- /**
235
- * @deprecated
236
- */
237
- attach(element: HTMLElement): void;
238
- /**
239
- * @deprecated
240
- */
241
- detach(): void;
242
216
  addNode(node: AddNodeRequest_3): void;
243
217
  updateNode(nodeId: unknown, request: UpdateNodeRequest_3): void;
244
218
  removeNode(nodeId: unknown): void;
@@ -254,7 +228,7 @@ declare interface CanvasController {
254
228
  destroy(): void;
255
229
  }
256
230
 
257
- declare interface CanvasDefaults {
231
+ export declare interface CanvasDefaults {
258
232
  /**
259
233
  * nodes related behavior
260
234
  */
@@ -292,8 +266,6 @@ declare interface CanvasDefaults {
292
266
  readonly priority?: Priority;
293
267
  };
294
268
  }
295
- export { CanvasDefaults }
296
- export { CanvasDefaults as CoreOptions }
297
269
 
298
270
  export declare type CenterFn = (width: number, height: number) => Point;
299
271
 
@@ -368,40 +340,15 @@ export declare class EventSubject<T> implements EventEmitter<T>, EventHandler<T>
368
340
  export declare class Graph {
369
341
  private readonly graphStore;
370
342
  readonly onAfterNodeAdded: EventHandler<unknown>;
371
- /**
372
- * @deprecated
373
- * use onAfterNodeUpdated instead
374
- */
375
- readonly onAfterNodeCoordinatesUpdated: EventHandler<unknown>;
376
343
  readonly onAfterNodeUpdated: EventHandler<unknown>;
377
344
  readonly onAfterNodePriorityUpdated: EventHandler<unknown>;
378
345
  readonly onBeforeNodeRemoved: EventHandler<unknown>;
379
346
  readonly onAfterPortMarked: EventHandler<unknown>;
380
- /**
381
- * @deprecated
382
- * use onAfterPortMarked instead
383
- */
384
- readonly onAfterPortAdded: EventHandler<unknown>;
385
347
  readonly onAfterPortUpdated: EventHandler<unknown>;
386
- /**
387
- * @deprecated
388
- * use onAfterPortUpdated instead
389
- */
390
- readonly onAfterPortDirectionUpdated: EventHandler<unknown>;
391
348
  readonly onBeforePortUnmarked: EventHandler<unknown>;
392
- /**
393
- * @deprecated
394
- * use onBeforePortUnmarked instead
395
- */
396
- readonly onBeforePortRemoved: EventHandler<unknown>;
397
349
  readonly onAfterEdgeAdded: EventHandler<unknown>;
398
350
  readonly onAfterEdgeShapeUpdated: EventHandler<unknown>;
399
351
  readonly onAfterEdgeUpdated: EventHandler<unknown>;
400
- /**
401
- * @deprecated
402
- * use onAfterEdgeUpdated instead
403
- */
404
- readonly onAfterEdgeAdjacentPortsUpdated: EventHandler<unknown>;
405
352
  readonly onAfterEdgePriorityUpdated: EventHandler<unknown>;
406
353
  readonly onBeforeEdgeRemoved: EventHandler<unknown>;
407
354
  readonly onBeforeClear: EventHandler<void>;
@@ -411,11 +358,6 @@ export declare class Graph {
411
358
  getPort(portId: unknown): GraphPort | null;
412
359
  getAllPortIds(): readonly unknown[];
413
360
  getNodePortIds(nodeId: unknown): readonly unknown[] | null;
414
- /**
415
- * @deprecated
416
- * use graph.getPort()?.nodeId ?? null instead
417
- */
418
- getPortNodeId(portId: unknown): unknown | null;
419
361
  getAllEdgeIds(): readonly unknown[];
420
362
  getEdge(edgeId: unknown): GraphEdge | null;
421
363
  getPortIncomingEdgeIds(portId: unknown): readonly unknown[] | null;