# esri/esri-leaflet-geocoder architecture

> Architecture diagram of the GitHub repository esri/esri-leaflet-geocoder, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/esri/esri-leaflet-geocoder
- Repository: https://github.com/esri/esri-leaflet-geocoder

## Overview

Esri Leaflet Geocoder provides both a Leaflet search control and standalone geocoding tasks/services. The main workflow is user text entry, provider suggestions, selection, provider result lookup, and a results event that can fit the map to the returned bounds. Separate task APIs support forward geocoding, reverse geocoding, and suggestions. The excerpts show the control/core and several provider/task relationships; FeatureLayerProvider and some provider internals were not sampled, so their connections are left out where unverified.

Main entry points: [`src/Classes/GeosearchCore.js`](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Classes/GeosearchCore.js) (Search coordinator), [`src/Services/Geocode.js`](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Services/Geocode.js) (Geocode service), [`src/Providers/ArcgisOnlineGeocoder.js`](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/ArcgisOnlineGeocoder.js) (ArcGIS Online provider), [`src/Providers/GeocodeService.js`](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/GeocodeService.js) (Geocode service provider)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Search interface"]
  node_control["Geosearch control<br/>[Geosearch.js]"]
  node_core["Search coordinator<br/>[GeosearchCore.js]"]
end

subgraph group_providers["Search providers"]
  node_arcgis_provider["ArcGIS Online provider"]
  node_geocode_provider["Geocode service provider<br/>[GeocodeService.js]"]
  node_feature_provider["Feature layer provider<br/>[FeatureLayer.js]"]
  node_map_provider["Map service provider<br/>[MapService.js]"]
end

subgraph group_api["Geocoding API"]
  node_service["Geocode service<br/>[Geocode.js]"]
  node_geocode["Forward geocode task<br/>[Geocode.js]"]
  node_reverse["Reverse geocode task<br/>[ReverseGeocode.js]"]
  node_suggest["Suggestion task<br/>[Suggest.js]"]
end

node_user(("Map user"))
node_arcgis["ArcGIS geocoding service"]
node_map["Leaflet map"]

node_user -->|"enters search"| node_control
node_control -->|"delegates search"| node_core
node_core -->|"updates suggestions"| node_control
node_core -->|"dispatches requests"| node_arcgis_provider
node_core -->|"dispatches requests"| node_geocode_provider
node_core -->|"dispatches requests"| node_feature_provider
node_core -->|"dispatches requests"| node_map_provider
node_core -->|"fits result bounds"| node_map
node_arcgis_provider -->|"extends service"| node_service
node_geocode_provider -->|"extends service"| node_service
node_service -->|"creates task"| node_geocode
node_service -->|"creates task"| node_reverse
node_service -->|"creates task"| node_suggest
node_geocode -->|"requests candidates"| node_arcgis
node_reverse -->|"requests address"| node_arcgis
node_suggest -->|"requests suggestions"| node_arcgis
node_arcgis_provider -->|"runs geocode and suggest"| node_service
node_geocode_provider -->|"runs geocode and suggest"| node_service

click node_control "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Controls/Geosearch.js"
click node_core "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Classes/GeosearchCore.js"
click node_arcgis_provider "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/ArcgisOnlineGeocoder.js"
click node_geocode_provider "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/GeocodeService.js"
click node_feature_provider "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/FeatureLayer.js"
click node_map_provider "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/MapService.js"
click node_service "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Services/Geocode.js"
click node_geocode "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Tasks/Geocode.js"
click node_reverse "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Tasks/ReverseGeocode.js"
click node_suggest "https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Tasks/Suggest.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_control,node_core,node_user toneBlue
class node_arcgis_provider,node_geocode_provider,node_feature_provider,node_map_provider toneAmber
class node_service,node_geocode,node_reverse,node_suggest toneMint
class node_arcgis,node_map toneIndigo
```

## Components

### Search interface

- [Geosearch control](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Controls/Geosearch.js): `src/Controls/Geosearch.js`
- [Search coordinator](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Classes/GeosearchCore.js): `src/Classes/GeosearchCore.js`

### Search providers

- [ArcGIS Online provider](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/ArcgisOnlineGeocoder.js): `src/Providers/ArcgisOnlineGeocoder.js`
- [Geocode service provider](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/GeocodeService.js): `src/Providers/GeocodeService.js`
- [Feature layer provider](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/FeatureLayer.js): `src/Providers/FeatureLayer.js`
- [Map service provider](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Providers/MapService.js): `src/Providers/MapService.js`

### Geocoding API

- [Geocode service](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Services/Geocode.js): `src/Services/Geocode.js`
- [Forward geocode task](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Tasks/Geocode.js): `src/Tasks/Geocode.js`
- [Reverse geocode task](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Tasks/ReverseGeocode.js): `src/Tasks/ReverseGeocode.js`
- [Suggestion task](https://github.com/esri/esri-leaflet-geocoder/blob/master/src/Tasks/Suggest.js): `src/Tasks/Suggest.js`

### Other components

- **Map user**
- **ArcGIS geocoding service**
- **Leaflet map**

## Connections

- Map user → Geosearch control: enters search (evidence: `README.md`)
- Geosearch control → Search coordinator: delegates search (evidence: `src/Controls/Geosearch.js`)
- Search coordinator → Geosearch control: updates suggestions (evidence: `src/Classes/GeosearchCore.js`)
- Search coordinator → ArcGIS Online provider: dispatches requests (evidence: `src/Classes/GeosearchCore.js`)
- Search coordinator → Geocode service provider: dispatches requests (evidence: `src/Classes/GeosearchCore.js`)
- Search coordinator → Feature layer provider: dispatches requests (evidence: `src/Classes/GeosearchCore.js`)
- Search coordinator → Map service provider: dispatches requests (evidence: `src/Classes/GeosearchCore.js`)
- Search coordinator → Leaflet map: fits result bounds (evidence: `src/Classes/GeosearchCore.js`)
- ArcGIS Online provider → Geocode service: extends service (evidence: `src/Providers/ArcgisOnlineGeocoder.js`)
- Geocode service provider → Geocode service: extends service (evidence: `src/Providers/GeocodeService.js`)
- Geocode service → Forward geocode task: creates task (evidence: `src/Services/Geocode.js`)
- Geocode service → Reverse geocode task: creates task (evidence: `src/Services/Geocode.js`)
- Geocode service → Suggestion task: creates task (evidence: `src/Services/Geocode.js`)
- Forward geocode task → ArcGIS geocoding service: requests candidates (evidence: `src/Tasks/Geocode.js`)
- Reverse geocode task → ArcGIS geocoding service: requests address (evidence: `src/Tasks/ReverseGeocode.js`)
- Suggestion task → ArcGIS geocoding service: requests suggestions (evidence: `src/Tasks/Suggest.js`)
- ArcGIS Online provider → Geocode service: runs geocode and suggest (evidence: `src/Providers/ArcgisOnlineGeocoder.js`)
- Geocode service provider → Geocode service: runs geocode and suggest (evidence: `src/Providers/GeocodeService.js`)
