geojson-path-finder
GeoJSON Path Finder
18 | 19 |
Find shortest path through a network of GeoJSON.
21 |Given a network of GeoJSON LineStrings, GeoJSON Path Finder will find the shortest path between two points in the network. This might be useful for automatic route searches in smaller networks, where setting up a real route planner like OSRM is too much work,
22 | or you simply need to do everything on the client.
See the GeoJSON Path Finder demo.
24 | 25 | 26 |Installing
27 | 28 |npm install --save geojson-path-finder
29 | API
33 | 34 |Create a path finding object:
35 |var PathFinder = require('geojson-path-finder'),
geojson = require('./network.json');
var pathFinder = new PathFinder(geojson);
36 | The GeoJSON object should be a FeatureCollection of LineString features. The network will be built
38 | into a topology, so that lines that start and end, or cross, at the same coordinate are joined such that
39 | you can find a path from one feature to the other.
To find the shortest path between two coordinates:
41 |var path = pathFinder.findPath(start, finish);
42 | Where start and finish are two GeoJSON point features.
If a route can be found, an object with two properties: path and weight is returned, where path
45 | is the coordinates the path runs through, and weight is the total weight (distance in kilometers, if you use the default weight function) of the path.
PathFinder options
49 |
50 | The PathFinder constructor takes an optional seconds parameter containing options that you can
51 | use to control the behaviour of the path finder. Available options:
-
53 |
weightFncontrols how the weight (or cost) of travelling between two vertices is calculated; 54 | by default, the geographic distance between the coordinates is calculated and used as weight; 55 | see Weight functions below for details
56 | precision(default1e-5) controls the tolerance for how close vertices in the GeoJSON can be 57 | before considered being the same vertice; you can say that coordinates closer than this will be 58 | snapped together into one coordinate
59 | edgeDataReduceFncan optionally be used to store data present in the GeoJSON on each edge of 60 | the routing graph; typically, this can be used for storing things like street names; if specified, 61 | the reduced data is present on found paths under theedgeDatasproperty
62 | edgeDataSeedis the seed used when reducing edge data with theedgeDataReduceFnabove
63 |
Weight functions
67 | 68 |By default, the cost of going from one node in the network to another is determined simply by
69 | the geographic distance between the two nodes. This means that, by default, shortest paths will be found.
70 | You can however override this by providing a cost calculation function through the weightFn option:
var pathFinder = new PathFinder(geojson, {
weightFn: function(a, b, props) {
var dx = a[0] - b[0];
var dy = a[1] - b[1];
return Math.sqrt(dx * dx + dy * dy);
}
});
72 | The weight function is passed two coordinate arrays (in GeoJSON axis order), as well as the feature properties 74 | that are associated with this feature, and should return either:
75 |-
76 |
- a numeric value for the cost of travelling between the two coordinates; in this case, the cost is assumed
77 | to be the same going from
atobas going frombtoa
78 | - an object with two properties:
forwardandbackward; in this case, 79 |forwarddenotes the cost of going fromatob, and 80 |backwardthe cost of going frombtoa; setting either 81 | to0,nullorundefinedwill prevent taking that direction, 82 | the segment will be a oneway.
83 |
Edge from A to B, containing its vertex keys and associated properties
21 |