Class: GeoSearchInfo

(abstract) bemap.GeoSearchInfo(options)

Base class for geocoding search information.

Constructor

(abstract) new GeoSearchInfo(options)

Parameters:
Name Type Description
options object see below the available values.
Properties
Name Type Description
state String
city String
country String
countryCode String
county String
district String
street String
streetNumber String
postalCode String
searchType String Defines all the possible types of research that can be applied to a textual pattern. Available values: CONTAINS, FUZZY, KEY_SEARCH, STRICT, STRICT_BEGINNING, WORD_BEGINNING
language String Define the language that will be used to perform the address lookup.
maxResult Int The maximum number of items used to perform the research and returned items by the server. Default is 1.
boundingBox bemap.BoundingBox the bounding box that will limit the research to a specific area.
Source:

Members

(protected) bbox :bemap.BoundingBox

Type:
Source:

(protected) city :String

Type:
  • String
Source:

(protected) country :String

Type:
  • String
Source:

(protected) countryCode :String

Type:
  • String
Source:

(protected) county :String

Type:
  • String
Source:

(protected) district :String

Type:
  • String
Source:

(protected) language :String

Type:
  • String
Source:

(protected) maxResult :int

Type:
  • int
Source:

(protected) postalCode :String

Type:
  • String
Source:

(protected) searchType :String

Type:
  • String
Source:

(protected) state :String

Type:
  • String
Source:

(protected) street :String

Type:
  • String
Source:

(protected) streetNumber :String

Type:
  • String
Source:

Methods

getBoundingBox() → {String}

Get the street number maximum of result.
Source:
Returns:
bbox.
Type
String

getCity() → {String}

Get the city information.
Source:
Returns:
city.
Type
String

getCountry() → {String}

Get the country information.
Source:
Returns:
country
Type
String

getCountryCode() → {String}

Get the country information.
Source:
Returns:
country
Type
String

getCounty() → {String}

Get the county information.
Source:
Returns:
county.
Type
String

getDistrict() → {String}

Get the district information.
Source:
Returns:
district.
Type
String

getLanguage() → {String}

Get the language information.
Source:
Returns:
language.
Type
String

getMaxResult() → {String}

Get the number maximum of result.
Source:
Returns:
maxResult.
Type
String

getPostalCode() → {String}

Get the postal code information.
Source:
Returns:
postalCode.
Type
String

getSearchType() → {String}

Get the search type information.
Source:
Returns:
searchType.
Type
String

getState() → {String}

Get state informations.
Source:
Returns:
state.
Type
String

getStreet() → {String}

Get the street information.
Source:
Returns:
street.
Type
String

getStreetNumber() → {String}

Get the street number information.
Source:
Returns:
streetNumber.
Type
String

setBoundingBox(bbox) → {bemap.GeoSearchInfo}

Set the street number maximum of result.
Parameters:
Name Type Description
bbox String the boundingBox new to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setCity(city) → {bemap.GeoSearchInfo}

Set the city information.
Parameters:
Name Type Description
city String the new city to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setCountry(country) → {bemap.GeoSearchInfo}

Set the country information.
Parameters:
Name Type Description
country String the new country to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setCountryCode(countryCode) → {bemap.GeoSearchInfo}

Set the country information.
Parameters:
Name Type Description
countryCode String the new country to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setCounty(county) → {bemap.GeoSearchInfo}

Set the county information.
Parameters:
Name Type Description
county String the new county to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setDistrict(district) → {bemap.GeoSearchInfo}

Set the district information.
Parameters:
Name Type Description
district String the new district to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setLanguage(language) → {bemap.GeoSearchInfo}

Set the language information.
Parameters:
Name Type Description
language String the new language to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setMaxResult(maxResult) → {bemap.GeoSearchInfo}

Set the number maximum of result.
Parameters:
Name Type Description
maxResult Int the new maximal result to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setPostalCode(postalCode) → {bemap.GeoSearchInfo}

Set the postal code information.
Parameters:
Name Type Description
postalCode String the new postal code to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setSearchType(searchType) → {bemap.GeoSearchInfo}

Set the search type information.
Parameters:
Name Type Description
searchType String the new search type to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setState(state) → {bemap.GeoSearchInfo}

Set state informations.
Parameters:
Name Type Description
state String the new state to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setStreet(street) → {bemap.GeoSearchInfo}

Set the street information.
Parameters:
Name Type Description
street String the new street to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo

setStreetNumber(streetNumber) → {bemap.GeoSearchInfo}

Set the street number information.
Parameters:
Name Type Description
streetNumber String the new street number to set.
Source:
Returns:
this.
Type
bemap.GeoSearchInfo