Mapspace API Reference

Class: GraphFinder

Mapspace.street. GraphFinder

new GraphFinder(equalsFunc, hashFunc)

Parameters:
Name Type Description
equalsFunc function

Node equality function.
hashFunc function

Node hash function.
Source:
mapspace-street/graphfinder.js

Extends

  • ol.Object

Methods

next()

Return the next node for the current search, or null if no more nodes.

Source:
mapspace-street/graphfinder.js
Returns:

Next node to search or null if ended.

Type
Object

reset()

Reset search state, aborting any search already in progress.

Source:
mapspace-street/graphfinder.js

start(firstNode, neighborsFunc, exploreFunc)

Start a breadth-first search beginning at firstNode.

Parameters:
Name Type Description
firstNode Object

Node.
neighborsFunc function

Function that receives a node and returns a list of neighbors for a node.
exploreFunc function

Function that receives a node and returns whether a node should be explored.
Source:
mapspace-street/graphfinder.js