Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ui.Chart.onClick
Stay organized with collections
Save and categorize content based on your preferences.
Registers a callback that's fired when the chart is clicked.
Returns an ID which can be passed to unlisten() to unregister the callback.
Usage | Returns | Chart.onClick(callback) | String |
Argument | Type | Details | this: ui.chart | ui.Chart | The ui.Chart instance. |
callback | Function | The callback to fire when the chart is clicked. The callback is passed three arguments: the x-value, the y-value, and the series name. Time values are represented in UTC epoch milliseconds, like "system:time_start" values on assets. If the user clicks on a legend entry to select an entire series, the x- and y-values are null. If the user clicks an already-selected point, all arguments are null, indicating the selection was cleared. |
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\u003eChart.onClick()\u003c/code\u003e method registers a callback function that is triggered when a user clicks on a chart.\u003c/p\u003e\n"],["\u003cp\u003eThis function 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 x-value, y-value, and series name as arguments, providing information about the clicked point on the chart.\u003c/p\u003e\n"],["\u003cp\u003eClicking on a legend entry to select a series results in null x and y values, while clicking an already-selected point results in all null arguments indicating selection clearance.\u003c/p\u003e\n"]]],[],null,["# ui.Chart.onClick\n\n\u003cbr /\u003e\n\nRegisters a callback that's fired when the chart 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| Chart.onClick`(callback)` | String |\n\n| Argument | Type | Details |\n|------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `ui.chart` | ui.Chart | The ui.Chart instance. |\n| `callback` | Function | The callback to fire when the chart is clicked. The callback is passed three arguments: the x-value, the y-value, and the series name. Time values are represented in UTC epoch milliseconds, like \"system:time_start\" values on assets. If the user clicks on a legend entry to select an entire series, the x- and y-values are null. If the user clicks an already-selected point, all arguments are null, indicating the selection was cleared. |"]]