Stay organized with collectionsSave and categorize content based on your preferences.
Registers a callback that's fired when the map stops moving.
Returns an ID which can be passed to unlisten() to unregister the callback.
Usage
Returns
Map.onIdle(callback)
String
Argument
Type
Details
this:ui.map
ui.Map
The ui.Map instance.
callback
Function
The callback to fire when the map becomes idle. The callback is passed two parameters: an object containing the coordinates of the map center (with keys lon, lat, and zoom) and the map widget itself.
[[["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 2023-10-06 UTC."],[[["\u003cp\u003eRegisters a function to be executed when the map stops moving.\u003c/p\u003e\n"],["\u003cp\u003eProvides an ID to remove the registered function later using \u003ccode\u003eunlisten()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe registered function receives the map's center coordinates and the map object itself.\u003c/p\u003e\n"],["\u003cp\u003eThis functionality is accessed through the \u003ccode\u003eonIdle()\u003c/code\u003e method of the \u003ccode\u003eui.Map\u003c/code\u003e instance.\u003c/p\u003e\n"]]],[],null,["# ui.Map.onIdle\n\n\u003cbr /\u003e\n\nRegisters a callback that's fired when the map stops moving.\n\n\u003cbr /\u003e\n\nReturns an ID which can be passed to unlisten() to unregister the callback.\n\n| Usage | Returns |\n|------------------------|---------|\n| Map.onIdle`(callback)` | String |\n\n| Argument | Type | Details |\n|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `ui.map` | ui.Map | The ui.Map instance. |\n| `callback` | Function | The callback to fire when the map becomes idle. The callback is passed two parameters: an object containing the coordinates of the map center (with keys lon, lat, and zoom) and the map widget itself. |"]]
