Stay organized with collectionsSave and categorize content based on your preferences.
Registers a callback that's fired when a drawing mode shape is changed.
Returns an ID which can be passed to unlisten() to unregister the callback.
Usage
Returns
DrawingTools.onShapeChange(callback)
String
Argument
Type
Details
this:ui.map.drawingtools
ui.Map.DrawingTools
The ui.Map.DrawingTools instance.
callback
Function
The callback to fire when the shape is changed. The callback is passed two parameters: the drawing mode shape as a string (or null for cancel) and the ui.Map.DrawingTools widget that the event listener is bound to. The shape values are:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-02-20 UTC."],[[["\u003cp\u003eAllows registration of a callback function triggered when a drawing mode shape is altered.\u003c/p\u003e\n"],["\u003cp\u003eProvides a unique ID to unregister the callback using the \u003ccode\u003eunlisten()\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAccepts a callback function with two parameters: shape (point, line, polygon, rectangle, or null) and the DrawingTools widget.\u003c/p\u003e\n"],["\u003cp\u003eThe callback is invoked, providing the current drawing mode shape and the associated DrawingTools widget, whenever the shape changes.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eDrawingTools.onShapeChange(callback)\u003c/code\u003e method to register the callback and returns a unique ID.\u003c/p\u003e\n"]]],[],null,["# ui.Map.DrawingTools.onShapeChange\n\n\u003cbr /\u003e\n\nRegisters a callback that's fired when a drawing mode shape is changed.\n\n\u003cbr /\u003e\n\nReturns an ID which can be passed to unlisten() to unregister the callback.\n\n| Usage | Returns |\n|----------------------------------------|---------|\n| DrawingTools.onShapeChange`(callback)` | String |\n\n| Argument | Type | Details |\n|-----------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `ui.map.drawingtools` | ui.Map.DrawingTools | The ui.Map.DrawingTools instance. |\n| `callback` | Function | The callback to fire when the shape is changed. The callback is passed two parameters: the drawing mode shape as a string (or null for cancel) and the ui.Map.DrawingTools widget that the event listener is bound to. The shape values are: - point - line - polygon - rectangle - null |"]]
