Share via

MouseEventArgs Object

  • Article

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.

A MouseEventArgs object is returned by many the mouse event handlers.

Methods

Name Return Type Description
getX() number Returns the x-value of the pixel coordinate, relative to the map, of the mouse
getY() number Returns the y-value of the pixel coordinate, relative to the map, of the mouse

Properties

Name Type Description
eventName string The event that occurred.
isPrimary boolean A boolean indicating if the primary button, such as the left mouse button or a tap on a touch screen, was used during a mouse down or up event.
isSecondary boolean A boolean indicating if the secondary mouse button, such as the right mouse button, was used during a mouse down or up event.
layer Layer If the target is a shape, this will be the layer that the shape is in.
location Location The map location of where the event occurred.
pageX number The x-value of the pixel coordinate on the page of the mouse cursor.
pageY number The y-value of the pixel coordinate on the page of the mouse cursor.
point Point The pixel coordinate of the mouse cursor relative to the top left corner of the map div.
target Map or IPrimitive The object that triggered the event.
targetType string The type of the object that the event is attached to. Valid values include the following: ‘map’, 'layer', ‘polygon’, ‘polyline’, or ‘pushpin’
wheelDelta number The number of units that the mouse wheel has changed.