AutosuggestManager Class
Note
Bing Maps Web Control SDK retirement
Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.
Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.
The AutosuggestManager is the primary class in the Autosuggest module.
Constructor
AutosuggestManager(options?: AutosuggestOptions)
Methods
| Name | Return Type | Description |
|---|---|---|
attachAutosuggest(suggestionBoxId: string, suggestionContainerId: string, selectedSuggestionCallback: function(result:SuggestionResult)) |
Attaches the Autosuggest functionality to an input box. • suggestionBoxId – The HTML element identifier of the input box.• suggestionContainerId – The Id of container where suggestions will be displayed.• selectedSuggestionCallback – A reference to a callback function that will be called when a user selects a suggestion from the Autosuggest UI. |
|
detachAutosuggest() |
Detaches the autosuggest functionality from the input box, freeing any resources it has or events it has tied to. | |
dispose() |
Disposes the Autosuggest object, freeing any resources it has or events it has tied to. | |
getOptions() |
AutosuggestOptions | Gets the options currently used by the autosuggest manager. |
getSuggestions(query: string, callback: function(suggestions: SuggestionResult[], query: string)) |
Programmatically retrieves suggestions for queries without the need to attach a textbox to the AutosuggestManager. Currently the suggestions returned by this function do not have their bestView property set and address suggestions do not have location coordinates. These suggestions can easily be enriched by using the Search module to geocode the suggestion. | |
setOptions(options?: AutosuggestOptions) |
Sets the options currently used by the autosuggest manager. |