Searching through your MapsIndoors data is an integral part of a great user experience with your maps. Users can look for places to go, or filter what is shown on the map.
Searches work on all MapsIndoors geodata. It is up to you to create a search experience that fits your use case. To aid you in this, there are a range of filters you can apply to the search queries to get the best results. E.g. you can filter by Categories, search only a specific part of the map or search near a Location.
All three return a list of Locations from your Solution matching the parameters they are given. The results are ranked upon the 3 following factors:
If a "near" parameter is set, how close is the origin point to the result?
How well does the search input text match the text of the result (using the "Levenshtein distance" algorithm)?
Which kind of geodata is the result (e.g. Buildings are ranked over POIs)?
This means that the first item in the search result list will be the one matching the 3 factors best and so forth.
See the full list of parameters:
Parameter
Description
Class
take
Max number of Locations to get
MPFilter
Skip
Skip the first number of entries
MPFilter
categories
A list of Categories to limit the search to
MPFilter
Parents
A list of Building or Venue IDs to limit the search to
MPFilter
Types
A list of Types to limit the search to
MPFilter
Bounds
Limits the result of Locations to a bounding area
MPFilter
Floor
Limits the result of Locations to be on a specific Floor
MPFilter
Near
Sorts the list of Locations on which Location is nearest the point given
MPQuery
Depth
The Depth property makes it possible to get "x" amount of descendants to the given parent. The default for this is 1 (eg. Building > Floor)
Example of Creating a Search Query
void findRestroom() {
//Here we will create an empty query because we are only interrested in getting locations that match a category. If you want to be more specific here where you can add a query text like "Unisex Restroom"
MPQuery mpQuery = new MPQuery
.Builder()
.build();
List<String> categories = new ArrayList<>();
categories.add("RESTROOMS");
// Init the filter builder and build a filter, the criteria in this case we want maximum 50 restrooms
MPFilter mpFilter = new MPFilter
.Builder()
.setCategories(categories)
.setTake(50)
.build();
MapsIndoors.getLocationsAsync(mpQuery, mpFilter, (locations, error) -> {
//Check if there is an error and iterate through the list to do what you need with the search
});
}
When displaying the search results it is helpful to filter the map to only show matching Locations. Matching Buildings and Venues will still be shown on the map, as they give context to the user, even if they aren't selectable on the map.
Example of Filtering the Map to Display Searched Locations on the Map
MapsIndoors.getLocationsAsync(mpQuery, mpFilter, (locations, error) -> {
if (locations != null && !locations.isEmpty()) {
//Query with the locations from the query result. Use default camera behavior
mMapControl.setFilter(locations, MPFilterBehavior.DEFAULT);
}
});
After displaying the search results on your map you can then clear the filter so that all Locations show up on the map again.
Example of Clearing Your Map Filter to Show All Locations Again
mMapControl.clearFilter();
Example of Creating a Search Query
fun findRestroom() {
//Here we will create an empty query because we are only interrested in getting locations that match a category. If you want to be more specific here where you can add a query text like "Unisex Restroom"
val mpQuery = MPQuery.Builder()
.build()
val categories: MutableList<String> = ArrayList()
categories.add("RESTROOMS")
// Init the filter builder and build a filter, the criteria in this case we want maximum 50 restrooms
val mpFilter = MPFilter.Builder()
.setCategories(categories)
.setTake(50)
.build()
MapsIndoors.getLocationsAsync(mpQuery, mpFilter) { locations: List<MPLocation?>?, error: MIError? ->
//Check if there is an error and iterate through the list to do what you need with the search
}
}
When displaying the search results it is helpful to filter the map to only show matching Locations. Matching Buildings and Venues will still be shown on the map, as they give context to the user, even if they aren't selectable on the map.
Example of Filtering the Map to Display Searched Locations on the Map
MapsIndoors.getLocationsAsync(mpQuery, mpFilter, (locations, error) -> {
//Query with the locations from the query result. Use default camera behavior
mMapControl.setFilter(locations, MPFilterBehavior.DEFAULT)
});
