new ReverseGeocodingRequest(optionsopt)
BeNomad BeMap JavaScript API - ReverseGeocodingRequest
Typed request for `bemap.ReverseGeocoder.revGeo(request)` and for the
convenience alias `bemap.Geocoder.reverseGeocode(coord, radius, opts)`.
Wire shape mirrors the BeMap server contract (cross-checked against
`bemap-flutter-api/lib/service/reverse_geocoding/model/request/rev_geo_request.dart`).
Endpoint: `POST service/geocoding/1.0/reverse`.
Required wire fields: `coordinateSat`, `radius`.
Note on wire spelling: the server field is `maximunResult` (with the
typo). The JS API exposes the constructor field as the typo-free
`maxResult` for ergonomics and translates at serialisation time.
Parameters:
| Name |
Type |
Attributes |
Description |
options |
Object
|
<optional>
|
Properties
| Name |
Type |
Attributes |
Default |
Description |
coordinate |
bemap.CoordinateSat
|
bemap.Coordinate
|
Object
|
<optional>
|
|
Mandatory in practice. |
radius |
Number
|
<optional>
|
50
|
Search radius in metres. |
transportMode |
String
|
<optional>
|
|
One of `bemap.TransportMode.*`. Defaults to CAR. |
maxResult |
Number
|
<optional>
|
1
|
Maximum number of items returned. |
language |
String
|
<optional>
|
|
ISO 639-1 language code. |
options |
Array.<String>
|
<optional>
|
|
Subset of `bemap.RevGeocodingOptions.*` (sent as JSON array). |
geoserver |
String
|
<optional>
|
|
|
switchIndex |
Number
|
<optional>
|
|
|
|
- Since:
- Source: