Share via

DrawingTools Class

  • 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.

The DrawingTools class exposes a set of tools for drawing and editing shapes on the map.

Constructor

DrawingTools(map: Map)

Methods

The DrawingTools class has the following methods.

Name Return Type Description
create(shapeType: ShapeType, created?: function(shape: IPrimitive)) Initializes the drawing layer and instructs it to create a new shape of a given type. A callback function can be provided which is invoked when the new shape as be initially created.
dispose() Disposes the instance of the DrawingTools class.
edit(shape: IPrimitive) Adds a shape to the drawing layer and puts it into edit mode.
finish(finished?: function(shape: IPrimitive)) Finishes any shape create / edit operation currently in progress, and returns the shape that was created or edited.
showDrawingManager(function(manager?: DrawingManager)) Creates a drawing manager which allows multi-shape editing and displays the toolbar.

Events

The DrawingTools class provides the following events.

Name Type Description
drawingChanged IPrimitive Occurs after the shape has had a change. For example, finished dragging a vertex to a new location.
drawingChanging IPrimitive Occurs when the shape is being actively manipulated. For example, this event will continuously fire when dragging a vertex of a shape.
drawingEnded IPrimitive Occurs when the user has finished drawing or editing a shape.
drawingModeChanged DrawingModeChangedData Occurs when the drawing mode has changed.
drawingStarted IPrimitive Occurs when the user has started drawing or editing a shape.