Class ForwardGeocodeResource
A forward geocode request.
Inherited Members
Namespace:Mapbox.Geocoding
Assembly:Mapbox.Geocoding.dll
Syntax
public sealed class ForwardGeocodeResource : GeocodeResource<string>Constructors
ForwardGeocodeResource(String)
Initializes a new instance of the ForwardGeocodeResource class.
Declaration
public ForwardGeocodeResource(string query)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | query | Place name for forward geocoding. |
Properties
Autocomplete
Gets or sets the autocomplete option.
Declaration
public bool ? Autocomplete { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Bbox
Gets or sets the bounding box option. Bounding box is a rectangle within which to limit results, given as Bbox.
Declaration
public Vector2dBounds? Bbox { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<Vector2dBounds> |
Country
Gets or sets the country option. Country is an Array of ISO 3166 alpha 2 country codes. For all possible values, Mapbox.Geocoding.ForwardGeocodeResource.CountryCodes.
Declaration
public string[] Country { get; set; }Property Value
| Type | Description |
|---|---|
| System.String[] |
Proximity
Gets or sets the proximity option, which is a location around which to bias results, given as Vector2d.
Declaration
public Vector2d? Proximity { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<Vector2d> |
Query
Gets or sets the place name for forward geocoding.
Declaration
public override string Query { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Mapbox.Geocoding.GeocodeResource<System.String>.Query
Methods
GetUrl()
Builds a forward geocode URL string.
Declaration
public override string GetUrl()Returns
| Type | Description |
|---|---|
| System.String | A complete, valid forward geocode URL. |