GeoNodeEditor Documentation

Overview

The GeoNodeEditor is a versatile component designed for editing geospatial nodes within the Vantage analytics platform. It serves as a shared editor for various geo-related workflow nodes, dynamically adjusting its controls and options based on the selected node type. The component supports three main geospatial operations: geocoding (both forward and reverse), calculating geodetic distances, and filtering by geographical parameters.

Purpose

The GeoNodeEditor allows users to configure specific geospatial tasks efficiently by providing an intuitive interface that adapts based on the selected node type (geocode, geoDistance, or geoFilter). This flexibility enhances the user experience by streamlining workflow setup for geographic data manipulation and analysis.

Data Expectations

The component expects the following props:

• selectedNode: The currently selected node, including its type and configuration.
• nodes: An array representing all available nodes in the workflow.
• edges: An array representing the connections between nodes.
• config: The current configuration settings for the selected node.
• updateField: A callback function to update specific fields in the node's configuration.

Settings

Common Settings

1. Mode

   • Input Type: Dropdown (string)
   • Description: Determines the operational mode of the geocoding process. Options include:
     • forward: Converts an address to latitude and longitude.
     • reverse: Converts latitude and longitude to an address.
   • Default Value: forward
   • Effect of Change: Changes the available fields in the editor. Selecting forward will prompt for an address column, while selecting reverse will prompt for latitude and longitude columns.

2. Address Column (when in forward mode) / Latitude and Longitude Columns (when in reverse mode)

   • Input Type: Dropdown or Text Input (string)
   • Description: Depending on the mode selected:
     • Forward Mode: Specifies the column that contains the addresses.
     • Reverse Mode: Specifies columns for latitude (latColumn) and longitude (lngColumn).
   • Default Value: None (requires user input)
   • Effect of Change: The selected value is used in subsequent API calls for geocoding operations.

3. Output Prefix

   • Input Type: Text Input (string)
   • Description: Specifies the prefix for generated output fields, allowing users to categorize the results based on the operation.
   • Default Value: geo_
   • Effect of Change: Alters the naming convention for output fields produced by the geocode node.

4. Output Column Name (geoDistance)

   • Input Type: Text Input (string)
   • Description: Names the output column that will contain the calculated distances between two points.
   • Default Value: distance
   • Effect of Change: Changes the name of the result field for easier identification in output data.

5. Unit (geoDistance)

   • Input Type: Dropdown (string)
   • Description: Specifies the measurement unit for distance calculations. Options include:
     • km: Kilometers
     • miles: Miles
   • Default Value: km
   • Effect of Change: Alters how distances are reported in the output.

6. Filter Type (geoFilter)

   • Input Type: Dropdown (string)
   • Description: Defines the type of geographical filtering operation. Options include:
     • radius: Filters data within a certain radius from a specified center point.
     • bbox: Filters data within a bounding box defined by coordinates.
   • Default Value: radius
   • Effect of Change: Depending on the selected type, different input fields will be displayed for further configuration (e.g., radius or bounding box coordinates).

Settings Specific to Radius Filter Type

1. Center Latitude (radius)

   • Input Type: Numeric Input (float)
   • Description: Specifies the latitude of the center point for the radius filter.
   • Default Value: 0
   • Effect of Change: Moves the central point from which the data will be filtered.

2. Center Longitude (radius)

   • Input Type: Numeric Input (float)
   • Description: Specifies the longitude of the center point for the radius filter.
   • Default Value: 0
   • Effect of Change: Moves the central point from which the data will be filtered.

3. Radius (km)

   • Input Type: Numeric Input (float)
   • Description: Defines the radius distance in kilometers for filtering data around the center point.
   • Default Value: 50
   • Effect of Change: Alters the extent of the filter, adjusting the area from which data points will be included.

Settings Specific to Bounding Box Filter Type

1. Bounding Box North

   • Input Type: Numeric Input (float)
   • Description: Specifies the northern boundary latitude for filtering.
   • Default Value: 90
   • Effect of Change: Moves the northernmost boundary for the data filter.

2. Bounding Box South

   • Input Type: Numeric Input (float)
   • Description: Specifies the southern boundary latitude for filtering.
   • Default Value: -90
   • Effect of Change: Moves the southernmost boundary for the data filter.

3. Bounding Box East

   • Input Type: Numeric Input (float)
   • Description: Specifies the eastern boundary longitude for filtering.
   • Default Value: 180
   • Effect of Change: Moves the easternmost boundary for the data filter.

4. Bounding Box West

   • Input Type: Numeric Input (float)
   • Description: Specifies the western boundary longitude for filtering.
   • Default Value: -180
   • Effect of Change: Moves the westernmost boundary for the data filter.

Use Cases & Examples

Use Case 1: Address Geocoding

A business aims to convert a batch of customer addresses into geographical coordinates for visualization on a map. Using the GeoNodeEditor, they would configure the node for forward geocoding by specifying the column containing addresses and optionally generating output columns prefixed with geo_.

Example Configuration:

{
  "mode": "forward",
  "addressColumn": "customer_address",
  "outputPrefix": "geo_"
}

Use Case 2: Measuring Distances

A logistics company needs to calculate the distance between multiple delivery points to optimize routes. The GeoNodeEditor is used to set up a distance calculation by specifying latitude and longitude columns for each point and selecting the output unit.

Example Configuration:

{
  "outputColumn": "delivery_distance",
  "lat1Column": "origin_lat",
  "lng1Column": "origin_lng",
  "lat2Column": "destination_lat",
  "lng2Column": "destination_lng",
  "unit": "miles"
}

Use Case 3: Geospatial Data Filtering

An environmental agency wants to analyze air quality data within a specific geographical area. They choose to implement a bounding box filter using the GeoNodeEditor to focus their analysis.

Example Configuration:

{
  "filterType": "bbox",
  "latColumn": "location_lat",
  "lngColumn": "location_lng",
  "bboxNorth": 45.0,
  "bboxSouth": 44.0,
  "bboxEast": -73.0,
  "bboxWest": -74.0
}

AI Integrations

This component does not directly integrate with AI functionalities; however, it may serve as a precursor component for feeding data into machine learning models that work with geospatial data. Data processed through the GeoNodeEditor can be further used for predictive analytics and location-based insights on Vantage.

Billing Impact

The GeoNodeEditor utilizes the publicly accessible Nominatim API for geocoding operations, which is free but has rate limitations. Users are limited to 1 request per second, and large datasets may incur delays. Careful planning of geocoding initiatives is recommended to manage API usage effectively and avoid hitting rate limits or incurring additional costs on paid services for increased throughput.

Users should monitor their implementation to ensure that it remains compliant with Nominatim's usage policies to avoid disruptions.