2.3.0
Module for getting color/color palette-specific data from points.
Build a url request for a google street view image.
(String)
Latitude of location.
(String)
Longitude of location.
(String)
Direction of google street view image (between 0 to 360).
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
String
:
A url for google maps.
Get the color palette of the image from google street view at the given lat, long, and orientation.
(String)
Latitude of location.
(String)
Longitude of location.
(number)
Direction of google street view image (between 0 to 360).
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Object
:
A collection of Objects containing color palette data.
Get the color palette of a location as names of primary colors from google street view at the given lat, long, and orientation. Views will be taken at 0, 90 and 180 degrees around the central point.
(String)
Latitude of location.
(String)
Longitude of location.
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Object
:
A collection of Objects containing color palette data.
Get a percentage of "greenery" visible (dominant in the image color palette) in a 360 panorama taken at the given latitude/longitude.
(String)
Latitude of location.
(String)
Longitude of location.
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Number>
:
A decimal percentage of the prevalence of green in the field of view.
Field of view analysis for nature/greenery.
Build a url request for a google street view image.
(String)
Latitude of location.
(String)
Longitude of location.
(String)
Direction of google street view image (between 0 to 360).
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
String
:
A url for google maps.
Get the color palette of the image from google street view at the given lat, long, and orientation.
(String)
Latitude of location.
(String)
Longitude of location.
(number)
Direction of google street view image (between 0 to 360).
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Object
:
A collection of Objects containing color palette data.
Get the color palette of a location as names of primary colors from google street view at the given lat, long, and orientation. Views will be taken at 0, 90 and 180 degrees around the central point.
(String)
Latitude of location.
(String)
Longitude of location.
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Object
:
A collection of Objects containing color palette data.
Get a percentage of "greenery" visible (dominant in the image color palette) in a 360 panorama taken at the given latitude/longitude.
(String)
Latitude of location.
(String)
Longitude of location.
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Number>
:
A decimal percentage of the prevalence of green in the field of view.
Module for getting Turf.js geometry and helpers.
Get a collection of random points which fall within a given bounding radius from an origin lat/long point.
(Number)
Latitude of location.
(Number)
Longitude of location.
(Number)
The radius of the bounding geometry from the given lat/long origin.
(Number)
How many points to return
FeatureCollection<Point, any>
:
A collection of Turf.JS points.
Get a collection of points in a gird which fall within a given bounding radius from an origin lat/long point.
(Number)
Latitude of location.
(Number)
Longitude of location.
(Number)
The radius of the bounding geometry from the given lat/long origin.
(Number)
How far apart the points should be in the point grid.
Array<Point>
:
A collection of Turf.JS points.
Turf.js data and geometry helpers
Get a collection of random points which fall within a given bounding radius from an origin lat/long point.
(Number)
Latitude of location.
(Number)
Longitude of location.
(Number)
The radius of the bounding geometry from the given lat/long origin.
(Number)
How many points to return
FeatureCollection<Point, any>
:
A collection of Turf.JS points.
Get a collection of points in a gird which fall within a given bounding radius from an origin lat/long point.
(Number)
Latitude of location.
(Number)
Longitude of location.
(Number)
The radius of the bounding geometry from the given lat/long origin.
(Number)
How far apart the points should be in the point grid.
Array<Point>
:
A collection of Turf.JS points.
Module for getting weather-specific data from a place.
Get graph data from the points which are walkable given an origin lat/long, radius, and distance between points for creation of a grid.
(Array<Point>)
A grid of Turf.js points
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Array>
:
A ngraph.graph object.
Get graph object representing the points which are walkable given an origin lat/long, radius, and distance between points for creation of a grid.
(Array<Point>)
A grid of Turf.js points containing 'properties' objects which contain the data
needed (greenScore, parkScore, etc.) to compute the weighted graph.
(Number)
The minimum distance between points to be considered a 'link'.
Graph
:
A ngraph.graph object.
ngraph.graph helper functions for weighted graph computation
Get graph data from the points which are walkable given an origin lat/long, radius, and distance between points for creation of a grid.
(Array<Point>)
A grid of Turf.js points
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Array>
:
A ngraph.graph object.
Get graph object representing the points which are walkable given an origin lat/long, radius, and distance between points for creation of a grid.
(Array<Point>)
A grid of Turf.js points containing 'properties' objects which contain the data
needed (greenScore, parkScore, etc.) to compute the weighted graph.
(Number)
The minimum distance between points to be considered a 'link'.
Graph
:
A ngraph.graph object.
Module for getting nearby parks and other green public spaces.
Get a collection of public parks from Google Maps within the given radius from the origin lat/long point.
(Number)
Latitude of location.
(Number)
Longitude of location.
(Number)
The radius of the bounding geometry from the given lat/long origin.
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Array>
:
A collection of nearby parks.
Yelp-related data for analysis.
Get a collection of public parks from Google Maps within the given radius from the origin lat/long point.
(Number)
Latitude of location.
(Number)
Longitude of location.
(Number)
The radius of the bounding geometry from the given lat/long origin.
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Array>
:
A collection of nearby parks.
Module for computing the actual routes.
Find a path between two nodes on the graph, weighted by the 'Green Score' weight of the nodes along the potential path.
(Graph)
A ngraph.graph object with the nature-score data properties applied.
(String)
Node ID of start point.
(String)
Node ID of end point.
Object
:
A ngraph.path object.
Compute all possible paths within the graph which start from the given start point.
(Graph)
A ngraph.graph object with the nature-score data properties applied.
(Number)
Latitude of start location.
(Number)
Longitude of start location.
Promise<Array>
:
An array of all possible paths;
Compute all possible looping paths within the graph which start and end at the given lat/long.
(Graph)
A ngraph.graph object with the nature-score data properties applied.
(Number)
Latitude of start location.
(Number)
Longitude of start location.
Promise<Array>
:
An array of all possible paths;
Get graph data from the points which are walkable given an origin lat/long, radius, and distance between points for creation of a grid. Sort with the top nature walks first.
(Object)
The raw path output of PathsAll().
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Array>
:
A list of paths, sorted from most exposed to nature to least.
Route-related data for analysis.
Find a path between two nodes on the graph, weighted by the 'Green Score' weight of the nodes along the potential path.
(Graph)
A ngraph.graph object with the nature-score data properties applied.
(String)
Node ID of start point.
(String)
Node ID of end point.
Object
:
A ngraph.path object.
Compute all possible paths within the graph which start from the given start point.
(Graph)
A ngraph.graph object with the nature-score data properties applied.
(Number)
Latitude of start location.
(Number)
Longitude of start location.
Promise<Array>
:
An array of all possible paths;
Compute all possible looping paths within the graph which start and end at the given lat/long.
(Graph)
A ngraph.graph object with the nature-score data properties applied.
(Number)
Latitude of start location.
(Number)
Longitude of start location.
Promise<Array>
:
An array of all possible paths;
Get graph data from the points which are walkable given an origin lat/long, radius, and distance between points for creation of a grid. Sort with the top nature walks first.
(Object)
The raw path output of PathsAll().
(String
= process.env.GMAPS_KEY
)
(Optional) GoogleMaps API Key for the request. If none is provided, a process
environment variable 'GMAPS_KEY' will be queried for the value.
Promise<Array>
:
A list of paths, sorted from most exposed to nature to least.
Module for getting weather-specific data from a place.
Weather-related data for analysis.