A geocoder interface
- Source:
Extends
Members
(static) Accuracy :number
Enumeration for Geocoder accuracy
Type:
- number
Properties:
| Name | Type | Description |
|---|---|---|
HIGH |
number | High accuracy |
MEDIUM |
number | Medium accuracy |
LOW |
number | Low accuracy |
ZIP_CODE |
number | ZIP Code accuracy |
- Source:
Methods
(abstract) accuracyDistance(accuracy) → {number}
Get a distance for an accuracy enumerator based on the projections
Parameters:
| Name | Type | Description |
|---|---|---|
accuracy |
nyc.Geocoder.Accuracy |
- Source:
Returns:
- Type
- number
off(eventName, evtHdlr, hdlrScopeopt)
Remove a previously connected event handler
Parameters:
| Name | Type | Attributes | 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:
- Source:
on(eventName, evtHdlr, hdlrScopeopt)
Connect a function to an event
Parameters:
| Name | Type | Attributes | 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:
- Source:
one(eventName, evtHdlr, hdlrScopeopt)
Connect a function to an event for a single invocation
Parameters:
| Name | Type | Attributes | 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:
- Source:
(abstract) search(input)
Geocode an input string representing a location
Parameters:
| Name | Type | Description |
|---|---|---|
input |
string | The value to geocode |
- Source:
trigger(eventName, dataopt)
Trigger a named event with event data
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
eventName |
string | The name of the event to trigger | |
data |
Object |
<optional> |
The event data |
- Inherited From:
- Source: