Class: OsmGeocoder

Extends

• module:nyc/Geocoder~Geocoder

Methods

---

off(eventName, evtHdlr [, hdlrScope])

Remove a previously connected event handler

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to which the handler will be connected
evtHdlr	function		The event handler function
hdlrScope	Object	<optional>	The scope in which to invoke the event handler

Inherited From:

• module:nyc/EventHandling~EventHandling#off

Overrides:

• module:nyc/Geocoder~Geocoder#off

Source:

• EventHandling.js, line 82

---

on(eventName, evtHdlr [, hdlrScope])

Connect a function to an event

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to which the handler will be connected
evtHdlr	function		The event handler function
hdlrScope	Object	<optional>	The scope in which to invoke the event handler

Inherited From:

• module:nyc/EventHandling~EventHandling#on

Overrides:

• module:nyc/Geocoder~Geocoder#on

Source:

• EventHandling.js, line 34

---

one(eventName, evtHdlr [, hdlrScope])

Connect a function to an event for a single invocation

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to which the handler will be connected
evtHdlr	function		The event handler function
hdlrScope	Object	<optional>	The scope in which to invoke the event handler

Inherited From:

• module:nyc/EventHandling~EventHandling#one

Overrides:

• module:nyc/Geocoder~Geocoder#one

Source:

• EventHandling.js, line 45

---

search(input)

Search for a location

Parameters:

Name	Type	Description
input	string	Input

Overrides:

• module:nyc/Geocoder~Geocoder#search

Source:

• OsmGeocoder.js, line 67

Returns:

The result of the search request

Type

Promise.<Object>

---

trigger(eventName [, data])

Trigger a named event with event data

Parameters:

Name	Type	Argument	Description
eventName	string		The name of the event to trigger
data	Object	<optional>	The event data

Inherited From:

• module:nyc/EventHandling~EventHandling#trigger

Overrides:

• module:nyc/Geocoder~Geocoder#trigger

Source:

• EventHandling.js, line 55

Type Definitions

---

Options

Constructor options for module:nyc/OsmGeocoder~OsmGeocoder

Type:

• Object

Properties:

Name	Type	Argument	Default	Description
countryCodes	Array.<string>	<optional>	['us']	The countries in which your events are located
viewBox	Array.<number>	<optional>		A restricting bounding box for the geocoder in EPSG:4326
projection	string	<optional>	EPSG:3857	The EPSG code of the projection for output coordinates

Source:

• OsmGeocoder.js, line 100