VenueMap

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 VenueMap class represents a venue map in a specific instance of a Map. The VenueMap provides functionality to toggle visibility and active floor. The VenueMap also exposes properties that can be leveraged for optimizing map view.

Methods

Below are the list of methods for VenueMap.

Name Return Type Description
dispose() Disposes the venue map instance, removing it from the map.
getActiveFloor() string Returns the name of the active floor of the venue map.
getVisible() boolean Returns true if the venue map is visible. Returns false otherwise.
hide() Hides the venue map if it is not already hidden.
setActiveFloor(floorName: string) Sets the active floor of the venue map to floorName.
show() Shows the venue map if it is not already displayed.

Properties

Below are the list of properties for VenueMap.

Name Type Description
bestMapView ViewOptions The best map view for the venue
bounds LocationRect The bounds of the venue.
center Location The centroid of the venue.
id string The id of the venue.
name string The name of the venue.

Events

Below are the list of events for VenueMap.

Name Arguments Description
activeFloorChanged string Triggered when the active floor is changed. Event arguments provides the name of the new floor.