公告:凡是在
2025 年 4 月 15 日前註冊使用 Earth Engine 的非商業專案,都必須
驗證非商業用途資格,才能繼續存取 Earth Engine。
事件
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
事件會在使用者與小工具互動或對小工具進行程式變更時觸發。如要在事件發生時執行某些動作,請使用 onClick()
(適用於 ui.Map
或 ui.Button
) 或 onChange()
(其他所有情況) 在小工具上註冊回呼函式。您也可以在建構函式中指定回呼。事件回呼的參數會因小工具和事件類型而異。舉例來說,ui.Textbox
會將目前輸入的字串值傳遞至「點擊」事件回呼函式。請查看「Docs」分頁中的 API 參考資料,瞭解傳遞至各小工具回呼函式的參數類型。
以下範例說明單一使用者指定要顯示的圖片時,會產生多個事件。當使用者選取圖片時,另一個選取小工具會更新圖片的頻帶,並在地圖中顯示第一個頻帶:
程式碼編輯器 (JavaScript)
// Load some images.
var dem = ee.Image('NASA/NASADEM_HGT/001');
var veg = ee.Image('NOAA/VIIRS/001/VNP13A1/2022_06_02')
.select(['EVI', 'EVI2', 'NDVI']);
// Make a drop-down menu of bands.
var bandSelect = ui.Select({
placeholder: 'Select a band...',
onChange: function(value) {
var layer = ui.Map.Layer(imageSelect.getValue().select(value));
// Use set() instead of add() so the previous layer (if any) is overwritten.
Map.layers().set(0, layer);
}
});
// Make a drop down menu of images.
var imageSelect = ui.Select({
items: [
{label: 'NASADEM', value: dem},
{label: 'VIIRS Veg', value: veg}
],
placeholder: 'Select an image...',
onChange: function(value) {
// Asynchronously get the list of band names.
value.bandNames().evaluate(function(bands) {
// Display the bands of the selected image.
bandSelect.items().reset(bands);
// Set the first band to the selected band.
bandSelect.setValue(bandSelect.items().get(0));
});
}
});
print(imageSelect);
print(bandSelect);
請注意,當使用者選取圖片時,圖片的頻帶名稱清單會載入至 bandSelect
小工具,第一個頻帶會設為目前的值,而 bandSelect
的 onChange
函式會自動觸發。請注意,evaluate()
會使用 bandNames()
傳回的 ComputedObject
值,以非同步方式取得該值。詳情請參閱「非同步事件」一節。
取消收聽
unlisten()
方法可移除在小工具上註冊的回呼函式。這項功能可避免觸發只會發生一次或在特定情況下發生的事件。onClick()
或 onChange()
的傳回值是可傳遞至 unlisten()
的 ID,可讓小工具停止呼叫函式。如要註銷所有事件或特定類型的事件,請分別呼叫 unlisten()
並傳遞無參數或事件類型 (例如 'click'
或 'change'
) 參數。以下範例說明 unlisten()
如何協助開啟及關閉面板:
程式碼編輯器 (JavaScript)
// Create a panel, initially hidden.
var panel = ui.Panel({
style: {
width: '400px',
shown: false
},
widgets: [
ui.Label('Click on the map to collapse the settings panel.')
]
});
// Create a button to unhide the panel.
var button = ui.Button({
label: 'Open settings',
onClick: function() {
// Hide the button.
button.style().set('shown', false);
// Display the panel.
panel.style().set('shown', true);
// Temporarily make a map click hide the panel
// and show the button.
var listenerId = Map.onClick(function() {
panel.style().set('shown', false);
button.style().set('shown', true);
// Once the panel is hidden, the map should not
// try to close it by listening for clicks.
Map.unlisten(listenerId);
});
}
});
// Add the button to the map and the panel to root.
Map.add(button);
ui.root.insert(0, panel);
請注意,unlisten()
會停止 Map
監聽點擊事件,以便在面板已關閉時關閉面板。
非同步事件
如果要在小工具中使用 Earth Engine 結果 (例如縮減作業的數值輸出結果),就必須從伺服器取得值。(如要進一步瞭解 Earth Engine 中的用戶端與伺服器,請參閱這個頁面)。如要避免在計算該值時讓整個 UI 掛起,您可以使用 evaluate()
函式以非同步方式取得該值。evaluate()
函式會開始要求值,並在值就緒時呼叫回呼函式,以便使用結果執行某些動作。舉例來說,假設應用程式要取得某個時間點的 NDVI 時間序列平均值:
程式碼編輯器 (JavaScript)
// Load and display an NDVI image.
var ndvi = ee.ImageCollection('LANDSAT/COMPOSITES/C02/T1_L2_8DAY_NDVI')
.filterDate('2014-01-01', '2015-01-01');
var vis = {min: 0, max: 1, palette: ['99c199', '006400']};
Map.addLayer(ndvi.median(), vis, 'NDVI');
// Configure the map.
Map.setCenter(-94.84497, 39.01918, 8);
Map.style().set('cursor', 'crosshair');
// Create a panel and add it to the map.
var inspector = ui.Panel([ui.Label('Click to get mean NDVI')]);
Map.add(inspector);
Map.onClick(function(coords) {
// Show the loading label.
inspector.widgets().set(0, ui.Label({
value: 'Loading...',
style: {color: 'gray'}
}));
// Determine the mean NDVI, a long-running server operation.
var point = ee.Geometry.Point(coords.lon, coords.lat);
var meanNdvi = ndvi.reduce('mean');
var sample = meanNdvi.sample(point, 30);
var computedValue = sample.first().get('NDVI_mean');
// Request the value from the server.
computedValue.evaluate(function(result) {
// When the server returns the value, show it.
inspector.widgets().set(0, ui.Label({
value: 'Mean NDVI: ' + result.toFixed(2),
}));
});
});
使用者點選地圖上的某個點時,伺服器就會觸發 reduceRegion()
呼叫。這項作業可能需要一段時間。為避免應用程式在 Earth Engine 運算期間遭到封鎖,這個範例會將回呼函式註冊至結果,具體來說是 computedValue.evaluate()
。運算完成後,系統會顯示結果。同時,系統會顯示訊息,指出運算程序正在進行中。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[[["\u003cp\u003eEvents in the Earth Engine Code Editor are triggered by user interactions or programmatic changes to widgets, allowing you to execute specific actions in response.\u003c/p\u003e\n"],["\u003cp\u003eRegister callback functions to widgets using \u003ccode\u003eonClick()\u003c/code\u003e for ui.Map or ui.Button interactions and \u003ccode\u003eonChange()\u003c/code\u003e for other widgets to define actions upon event occurrence.\u003c/p\u003e\n"],["\u003cp\u003eUtilize \u003ccode\u003eunlisten()\u003c/code\u003e to remove registered callback functions, preventing events from triggering when no longer necessary, as demonstrated in the panel open/close example.\u003c/p\u003e\n"],["\u003cp\u003eFor operations involving Earth Engine results that require server-side computation, employ \u003ccode\u003eevaluate()\u003c/code\u003e to asynchronously retrieve values, ensuring a smooth user experience while preventing UI blocking.\u003c/p\u003e\n"]]],[],null,["# Events are fired by user interaction with a widget or a programmatic change to a\nwidget. To do something when the event occurs, register a callback function on the\nwidget with either `onClick()` (for `ui.Map` or\n`ui.Button`) or `onChange()` (everything else). You can also\nspecify a callback in the constructor. The parameters to event callbacks vary\ndepending on the widget and event type. For example, a `ui.Textbox` passes\nthe currently entered string value to its 'click' event callback functions. Check\nthe API reference in the **Docs** tab for the type of parameter passed to\nthe callback functions of each widget.\n\nThe following example demonstrates multiple events originating from a single user\naction of specifying an image to display. When the user selects an image, another\nselect widget is updated with the bands of the image and displays the first band\nin the map:\n\n### Code Editor (JavaScript)\n\n```javascript\n// Load some images.\nvar dem = ee.Image('NASA/NASADEM_HGT/001');\nvar veg = ee.Image('NOAA/VIIRS/001/VNP13A1/2022_06_02')\n .select(['EVI', 'EVI2', 'NDVI']);\n\n// Make a drop-down menu of bands.\nvar bandSelect = ui.Select({\n placeholder: 'Select a band...',\n onChange: function(value) {\n var layer = ui.Map.Layer(imageSelect.getValue().select(value));\n // Use set() instead of add() so the previous layer (if any) is overwritten.\n Map.layers().set(0, layer);\n }\n});\n\n// Make a drop down menu of images.\nvar imageSelect = ui.Select({\n items: [\n {label: 'NASADEM', value: dem},\n {label: 'VIIRS Veg', value: veg}\n ],\n placeholder: 'Select an image...',\n onChange: function(value) {\n // Asynchronously get the list of band names.\n value.bandNames().evaluate(function(bands) {\n // Display the bands of the selected image.\n bandSelect.items().reset(bands);\n // Set the first band to the selected band.\n bandSelect.setValue(bandSelect.items().get(0));\n });\n }\n});\n\nprint(imageSelect);\nprint(bandSelect);\n```\n\nNote that when the user selects an image, the list of the image's band names is loaded\ninto the `bandSelect` widget, the first band is set to the current value,\nand the `onChange` function of `bandSelect` is fired\nautomatically. Also note the use of `evaluate()` to asynchronously get the\nvalue of the `ComputedObject` returned by `bandNames()`. Learn\nmore in the [Asynchronous Events section](/earth-engine/guides/ui_events#asynchronous-events).\n\nUnlistening\n-----------\n\nThe `unlisten()` method provides the ability to remove callback functions\nregistered on a widget. This is useful to prevent triggering events that should only\noccur once, or under certain circumstances. The return value of `onClick()`\nor `onChange()` is an ID that can be passed to `unlisten()` in\norder to make the widget stop calling the function. To unregister all events or events\nof a specific type, call `unlisten()` with no arguments or an event type (e.g.\n`'click'` or `'change'`) argument, respectively. The following\nexample demonstrates `unlisten()` to facilitate opening and closing of a panel:\n\n### Code Editor (JavaScript)\n\n```javascript\n// Create a panel, initially hidden.\nvar panel = ui.Panel({\n style: {\n width: '400px',\n shown: false\n },\n widgets: [\n ui.Label('Click on the map to collapse the settings panel.')\n ]\n});\n\n// Create a button to unhide the panel.\nvar button = ui.Button({\n label: 'Open settings',\n onClick: function() {\n // Hide the button.\n button.style().set('shown', false);\n // Display the panel.\n panel.style().set('shown', true);\n\n // Temporarily make a map click hide the panel\n // and show the button.\n var listenerId = Map.onClick(function() {\n panel.style().set('shown', false);\n button.style().set('shown', true);\n // Once the panel is hidden, the map should not\n // try to close it by listening for clicks.\n Map.unlisten(listenerId);\n });\n }\n});\n\n// Add the button to the map and the panel to root.\nMap.add(button);\nui.root.insert(0, panel);\n```\n\nObserve that `unlisten()` is used to stop `Map` from listening\nfor click events to close the panel when the panel is already closed.\n\nAsynchronous Events\n-------------------\n\nIf you use an Earth Engine result (such the numerical output from a reduction) in a\nwidget, you will need to get the value from the server. (See the\n[this page](https://developers.google.com/earth-engine/client_server) for\ndetails about client vs. server in Earth Engine). To keep from hanging the entire UI\nwhile that value is computed, you can use the `evaluate()` function to\nget the value asynchronously. The `evaluate()` function begins a request\nfor a value, and when the value is ready calls a callback function to do something\nwith the result. For example, consider an application to get the mean value of an\nNDVI time series at a point:\n\n### Code Editor (JavaScript)\n\n```javascript\n// Load and display an NDVI image.\nvar ndvi = ee.ImageCollection('LANDSAT/COMPOSITES/C02/T1_L2_8DAY_NDVI')\n .filterDate('2014-01-01', '2015-01-01');\nvar vis = {min: 0, max: 1, palette: ['99c199', '006400']};\nMap.addLayer(ndvi.median(), vis, 'NDVI');\n\n// Configure the map.\nMap.setCenter(-94.84497, 39.01918, 8);\nMap.style().set('cursor', 'crosshair');\n\n// Create a panel and add it to the map.\nvar inspector = ui.Panel([ui.Label('Click to get mean NDVI')]);\nMap.add(inspector);\n\nMap.onClick(function(coords) {\n // Show the loading label.\n inspector.widgets().set(0, ui.Label({\n value: 'Loading...',\n style: {color: 'gray'}\n }));\n\n // Determine the mean NDVI, a long-running server operation.\n var point = ee.Geometry.Point(coords.lon, coords.lat);\n var meanNdvi = ndvi.reduce('mean');\n var sample = meanNdvi.sample(point, 30);\n var computedValue = sample.first().get('NDVI_mean');\n\n // Request the value from the server.\n computedValue.evaluate(function(result) {\n // When the server returns the value, show it.\n inspector.widgets().set(0, ui.Label({\n value: 'Mean NDVI: ' + result.toFixed(2),\n }));\n });\n});\n```\n\nWhen the user clicks a point on this map, a `reduceRegion()` call is triggered\non the server. This operation might take a while. To prevent the application from\nblocking while Earth Engine is computing, this example registers a callback function\nto the result, specifically `computedValue.evaluate()`. When the computation\nis finished, the result is displayed. In the meantime, a message is displayed to\nindicate that the computation is in progress."]]