SearchPreferences - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > SearchPreferences

SearchPreferences class

Search preferences

Places

Signature:

export declare class SearchPreferences extends GemAutoreleaseObject

Extends: GemAutoreleaseObject

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SearchPreferences class.

Properties

Property	Modifiers	Type	Description
allowFuzzyResults		boolean	Test if fuzzy search results are allowed Default is true
easyAccessOnlyResults		boolean	Test if easy access filter is enabled Default is false
estimateMissingHouseNumbers		boolean	Test if estimating house numbers not present in map data is allowed Default is true
exactMatch		boolean	Test if exact match is used. Default is false.
landmarks	`readonly`	LandmarkStoreCollection	Get access to the search target landmark stores collection
maxMatches		number	Get the max number of matches. Default is 40
overlays	`readonly`	OverlayMutableCollection	Get access to the search target overlays collection
pointerId	`readonly`	any
searchAddresses		boolean	Check if search through addresses is enabled. Default is true.
searchMapPOIs		boolean	Check if search through addresses is enabled. Default is true
searchOnlyOnboard		boolean	Get the flag for onboard search. Default is false
thresholdDistance		number	Get the threshold distance for the request. Default is the maximum value of int

Methods

Method	Modifiers	Description
create({ allowFuzzyResults, estimateMissingHouseNumbers, exactMatch, maxMatches, searchAddresses, searchMapPOIs, searchOnlyOnboard, thresholdDistance, easyAccessOnlyResults, }, input)	`static`	Creates a new SearchPreferences instance with default or specified values
dispose()