@deck.gl-community/graph-layers 9.0.2 → 9.1.0-beta.3

package/src/core/base-layout.ts

@@ -1,154 +0,0 @@
-// deck.gl-community
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import isEqual from 'lodash.isequal';
-import {EDGE_TYPE, LAYOUT_STATE} from './constants';
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface BaseLayoutOptions {}
-
-/**
- * All the layout classes are extended from this base layout class.
- */
-export class BaseLayout extends EventTarget {
-  /** Name of the layout. */
-  protected readonly _name: string = 'BaseLayout';
-  /** Extra configuration options of the layout. */
-  protected _options: BaseLayoutOptions;
-
-  public version = 0;
-  public state = LAYOUT_STATE.INIT;
-
-  /**
-   * Constructor of BaseLayout
-   * @param  {Object} options extra configuration options of the layout
-   */
-  constructor(options: BaseLayoutOptions = {}) {
-    super();
-    this._options = options;
-  }
-
-  /**
-   * @fires BaseLayout#onLayoutStart
-   * @protected
-   */
-  _onLayoutStart(): void {
-    this._updateState(LAYOUT_STATE.CALCULATING);
-
-    /**
-     * Layout calculation start.
-     *
-     * @event BaseLayout#onLayoutChange
-     * @type {CustomEvent}
-     */
-    this.dispatchEvent(new CustomEvent('onLayoutStart'));
-  }
-
-  /**
-   * @fires BaseLayout#onLayoutChange
-   * @protected
-   */
-  _onLayoutChange(): void {
-    this._updateState(LAYOUT_STATE.CALCULATING);
-
-    /**
-     * Layout calculation iteration.
-     *
-     * @event BaseLayout#onLayoutChange
-     * @type {CustomEvent}
-     */
-    this.dispatchEvent(new CustomEvent('onLayoutChange'));
-  }
-
-  /**
-   * @fires BaseLayout#onLayoutDone
-   * @protected
-   */
-  _onLayoutDone(): void {
-    this._updateState(LAYOUT_STATE.DONE);
-
-    /**
-     * Layout calculation is done.
-     *
-     * @event BaseLayout#onLayoutDone
-     * @type {CustomEvent}
-     */
-    this.dispatchEvent(new CustomEvent('onLayoutDone'));
-  }
-
-  /**
-   * @fires BaseLayout#onLayoutError
-   * @protected
-   */
-  _onLayoutError(): void {
-    this._updateState(LAYOUT_STATE.ERROR);
-
-    /**
-     * Layout calculation went wrong.
-     *
-     * @event BaseLayout#onLayoutError
-     * @type {CustomEvent}
-     */
-    this.dispatchEvent(new CustomEvent('onLayoutError'));
-  }
-
-  /**
-   * Check the equality of two layouts
-   * @param  {Object} layout The layout to be compared.
-   * @return {Bool}   True if the layout is the same as itself.
-   */
-  equals(layout: BaseLayout): boolean {
-    if (!layout || !(layout instanceof BaseLayout)) {
-      return false;
-    }
-    return this._name === layout._name && isEqual(this._options, layout._options);
-  }
-
-  /** virtual functions: will be implemented in the child class */
-
-  // first time to pass the graph data into this layout
-  initializeGraph(graph) {}
-  // update the existing graph
-  updateGraph(graph) {}
-  // start the layout calculation
-  start() {}
-  // update the layout calculation
-  update() {}
-  // resume the layout calculation
-  resume() {}
-  // stop the layout calculation
-  stop() {}
-  // access the position of the node in the layout
-  getNodePosition(node: Node): [number, number] {
-    return [0, 0];
-  }
-  // access the layout information of the edge
-  getEdgePosition(edge) {
-    return {
-      type: EDGE_TYPE.LINE,
-      sourcePosition: [0, 0],
-      targetPosition: [0, 0],
-      controlPoints: []
-    };
-  }
-
-  /**
-   * Pin the node to a designated position, and the node won't move anymore
-   * @param  {Object} node Node to be locked
-   * @param  {Number} x    x coordinate
-   * @param  {Number} y    y coordinate
-   */
-  lockNodePosition(node, x, y) {}
-
-  /**
-   * Unlock the node, the node will be able to move freely.
-   * @param  {Object} node Node to be unlocked
-   */
-  unlockNodePosition(node) {}
-
-  _updateState(state) {
-    this.state = state;
-    this.version += 1;
-  }
-}