Class Graph

constructor

• new Graph(nodes, edges): Graph

• Construct a graph object (no initializing)

  Parameters

  • nodes: Map<number, _Node>

    Map of all the nodes associated with the graph

  • edges: Map<number, Edge>

    Map of all the edges assocaiated with the graph

  Returns Graph

edges

nodes

add_edge

• add_edge(start, end, data): void

• Add an edge to the graph

  Parameters

  • start: number

    Starting index of the edge

  • end: number

    The end index of the edge

  • data: any

    data associated with the edge

  Returns void

add_node

• add_node(nodeID, data): void

• Add a noce to the graph

  Parameters

  • nodeID: number

    the node ID

  • data: _Node

    data associated with the node

  Returns void

apply_drawing_maps

• apply_drawing_maps(layout): void

• Applies all the maps to the graph

  Parameters

  • layout: {
        emap: Map<number, Line>;
        pmap: Map<number, Point>;
    }

    Applies an object of maps associated with with a graph is made up of {pmap:(the position map), emap:{the edge map}}

    • emap: Map<number, Line>

    • pmap: Map<number, Point>

  Returns void

apply_edge_pos_maps

• apply_edge_pos_maps(data): void

• Apply an line map to a graph

  Parameters

  • data: Map<number, Line>

    Line data that has to be applied to the graph

  Returns void

apply_position_map

• apply_position_map(data): void

• Apply a position map based on some data

  Parameters

  • data: Map<number, Point>

    the position map that has to be applied to the graph

  Returns void

constructAdjacencyList

• constructAdjacencyList(): Promise<void>

• Constructs the adjacency associated with the graph

  Returns Promise<void>

get_adjacency

• get_adjacency(): Map<number, number[]>

• Returns Map<number, number[]>

  Get the adjaceny (adjacency lists) associated with the graph

get_edge_map

• get_edge_map(): Map<number, Line>

• get the current edge map

  Returns Map<number, Line>

  The current set of edges associated with the graph

get_map

• get_map(): {
      emap: Map<number, Line>;
      pmap: Map<number, Point>;
  }

• Gets the position map and the edge map respectively

  Returns {
      emap: Map<number, Line>;
      pmap: Map<number, Point>;
  }

  the positon map and the edge map as pmap and emap

  • emap: Map<number, Line>

  • pmap: Map<number, Point>

get_position_map

• get_position_map(): Map<number, Point>

• get the postion of the nodes in the graph

  Returns Map<number, Point>

  the position map

initialize

• initialize(): Promise<void>

• Initializes the graph and constructs a node adajaceny list list

  Returns Promise<void>

printData

• printData(): void

• Prints out a snapshot of data associated with this graph like how many nodes and how many edges

  Returns void

Static create

• create(nodes, edges): Promise<Graph>

• This is the official create method to make a graph based on a set of nodes and edges It also auto initializes the graph and sets all the adjaceny lists in the memory

  Parameters

  • nodes: Map<number, _Node>

    map of nodes

  • edges: Map<number, Edge>

    map of edges

  Returns Promise<Graph>