Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ui.Button.onClick
Stay organized with collections
Save and categorize content based on your preferences.
Registers a callback that's fired when the button is clicked.
Returns an ID which can be passed to unlisten() to unregister the callback.
| Usage | Returns | Button.onClick(callback) | String |
| Argument | Type | Details | this: ui.button | ui.Button | The ui.Button instance. |
callback | Function | The callback to fire when the button is clicked. The callback is passed the button widget. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eonClick\u003c/code\u003e method registers a callback function that executes when the button is clicked.\u003c/p\u003e\n"],["\u003cp\u003eIt returns a unique ID that can be used with \u003ccode\u003eunlisten()\u003c/code\u003e to remove the registered callback.\u003c/p\u003e\n"],["\u003cp\u003eThe callback function receives the button widget as an argument when triggered.\u003c/p\u003e\n"]]],["The `Button.onClick` method registers a callback function to be executed upon a button click. It accepts a function as an argument, which will be passed the button widget when triggered. The method returns a unique string ID, used to unregister the callback later via `unlisten()`. The function callback is associated with the specific `ui.Button` instance where `onClick` is used.\n"],null,["# ui.Button.onClick\n\n\u003cbr /\u003e\n\nRegisters a callback that's fired when the button is clicked.\n\n\u003cbr /\u003e\n\nReturns an ID which can be passed to unlisten() to unregister the callback.\n\n| Usage | Returns |\n|----------------------------|---------|\n| Button.onClick`(callback)` | String |\n\n| Argument | Type | Details |\n|-------------------|-----------|--------------------------------------------------------------------------------------------|\n| this: `ui.button` | ui.Button | The ui.Button instance. |\n| `callback` | Function | The callback to fire when the button is clicked. The callback is passed the button widget. |"]]