Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ee.ImageCollection.getMapId
Stay organized with collections
Save and categorize content based on your preferences.
An imperative function that returns a map ID via a synchronous AJAX call.
This mosaics the collection to a single image and return a map ID suitable for building a Google Maps overlay.
Returns returns a map ID and optional token, which may be passed to ee.data.getTileUrl or ui.Map.addLayer. Undefined if a callback was specified.
| Usage | Returns | ImageCollection.getMapId(visParams, callback) | MapId|Object |
| Argument | Type | Details | this: imagecollection | ImageCollection | The ImageCollection instance. |
visParams | Object, optional | The visualization parameters. |
callback | Function, optional | An async callback. If not supplied, the call is made synchronously. |
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-12-06 UTC.
[null,null,["Last updated 2023-12-06 UTC."],[[["\u003cp\u003eRetrieves a map ID for visualizing an ImageCollection as a single mosaicked image.\u003c/p\u003e\n"],["\u003cp\u003eThis ID can be used to create Google Maps overlays or retrieve tile URLs for the mosaic.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetMapId\u003c/code\u003e can be called synchronously or asynchronously by omitting or providing a callback function, respectively.\u003c/p\u003e\n"],["\u003cp\u003eVisualization parameters can be customized using the optional \u003ccode\u003evisParams\u003c/code\u003e argument.\u003c/p\u003e\n"]]],["This document details the `getMapId` function for ImageCollection, which returns a map ID for creating Google Maps overlays. It mosaics an ImageCollection into a single image. The function can be called synchronously or asynchronously using an optional callback. It accepts visualization parameters (`visParams`) and returns a MapId or an object containing the map ID and token, which can be used with `ee.data.getTileUrl` or `ui.Map.addLayer`. The return will be `undefined` if a callback is specified.\n"],null,["# ee.ImageCollection.getMapId\n\n\u003cbr /\u003e\n\nAn imperative function that returns a map ID via a synchronous AJAX call.\n\n\u003cbr /\u003e\n\nThis mosaics the collection to a single image and return a map ID suitable for building a Google Maps overlay.\n\nReturns returns a map ID and optional token, which may be passed to ee.data.getTileUrl or ui.Map.addLayer. Undefined if a callback was specified.\n\n| Usage | Returns |\n|----------------------------------------------------------|---------------|\n| ImageCollection.getMapId`(`*visParams* `, `*callback*`)` | MapId\\|Object |\n\n| Argument | Type | Details |\n|-------------------------|--------------------|---------------------------------------------------------------------|\n| this: `imagecollection` | ImageCollection | The ImageCollection instance. |\n| `visParams` | Object, optional | The visualization parameters. |\n| `callback` | Function, optional | An async callback. If not supplied, the call is made synchronously. |"]]