- Legend to Symbols
-
Namespace
The namespace is really just an object where further objects and their methods and properties are attached bundling up all the functionality using a unique name.
Interface
The Interface is a contract by which the implementing class adheres. It describes a desired behavior and enforces adherence for any class that implements the interface.
Class
Classes define types of objects that will be used by the application.
Method
A function associated with a class or object.
Field
A variable associated with a class or object.
Inherited Method
A function inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Inherited Field
A variable inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Event
Events are actions that occur because of user interaction. They are normally used in combination with functions, and the function will not be executed before the event occurs.
Class nokia.maps.search.Manager
Class Summary
The Manager acts as a proxy to the search service and provides methods
for retrieving search results. We assume that only one search response is kept at a
time. If a new request is triggered, the old response is replaced.
Extends
nokia.maps.util.OObject.
new nokia.maps.search.Manager
()
Method Summary
addObserver
(key, callback, [context])
: nokia.maps.util.OObject
This method registers an observer for the property named by the caller.
clear
()
This method resets the stored search request and response.
geocode
(geocodeItem, spatialFilter)
This method performs geocoding using the back-end search service.
get
(key)
: Variant
This method retrieves the value of the property with the name provided by the caller.
getAvailableCategories
()
: Array
This method retrieves an array of strings containing the names of the available POI categories.
getErrorCause
()
: nokia.maps.search.ServiceError
This method retrieves an object containing the search error code and associated error message text.
placeSearch
(searchText, categories, spatialFilter)
This method performs a POI search using the back-end search service.
remove
(key)
: nokia.maps.util.OObject
This method removes the property with the name provided by the caller.
removeObserver
(key, callback, context)
: nokia.maps.util.OObject
This method removes the observer for the property named by the caller.
search
(searchText, spatialFilter)
This method performs a search based on the text input and the map view as hint.
set
(nameOrObject, [value, [force]])
: nokia.maps.util.OObject
This method sets property values, using the property names and values supplied by the caller.
Field Summary
nokia.maps.search.Location[]
locations
This property holds a read-only array of locations which were returned by a search or a geocoding operation.
Number
maxResults
This property represents the maximum number of search results to be returned by calls to geocode(), search(), or reverseGeocode().
nokia.maps.search.Place[]
places
This property holds a read-only array of places which were returned by a nokia.maps.search.Manager#search or nokia.maps.search.Manager#placeSearch.
String
state
This property is a read-only field that signals state changes in the manager.
Direct Inheritance
Constructor Detail
Method Detail
geocode
(geocodeItem, spatialFilter)
This method performs geocoding using the back-end search service.
Parameters:
| {String | nokia.maps.search.LocationFilter} | geocodeItem | A string that contains search text (unqualified search) or a location filter object (qualified address search) |
| {nokia.maps.geo.Proximity} | spatialFilter | A proximity object to be used to limit the result set to a certain geo-spatial area |
getAvailableCategories
()
: Array
This method retrieves an array of strings containing the names of the available POI categories.
Returns:
| {Array} | An array of strings containing the names of the available POI categories |
getErrorCause
()
: nokia.maps.search.ServiceError
This method retrieves an object containing the search error code and associated error message text.
Returns:
| {nokia.maps.search.ServiceError} | An object containing information about the search error |
placeSearch
(searchText, categories, spatialFilter)
This method performs a POI search using the back-end search service.
Parameters:
| {String} | searchText | Text (search terms) on the basis of which to run the search |
| {String[]} | categories |
An array of POI category names to be used to reduce the result set
(the returned results must belong to one or more of the named categories); see also
nokia.maps.search.Manager#getAvailableCategories() for
the list of available category names; if searchText is an empty string, a pure category
search is performed
|
| {nokia.maps.geo.Proximity} | spatialFilter | A proximity object to be used to limit the result set to a certain geo-spatial area |
search
(searchText, spatialFilter)
This method performs a search based on the text input and the map view as hint.
Parameters:
| {String} | searchText | Text (search terms) on the basis of which to run a search |
| {nokia.maps.geo.BoundingBox | nokia.maps.geo.Corridor | nokia.maps.geo.Proximity} | spatialFilter | A bounding box, a corridor or a proximity object to be used to limit the result set to a certain geo-spatial area |
Field Detail
nokia.maps.search.Location[]
locations
This property holds a read-only array of locations which were returned
by a search or a geocoding operation.
Number
maxResults
This property represents the maximum number of search results to be returned by calls
to geocode(), search(), or reverseGeocode().
nokia.maps.search.Place[]
places
This property holds a read-only array of places which were returned by
a nokia.maps.search.Manager#search or nokia.maps.search.Manager#placeSearch.
Places can contain multiple sublocations. Every sublocation is contained in the overall
location property, too.