Announcement: All noncommercial projects registered to use Earth Engine before April 15, 2025 must verify noncommercial eligibility to maintain Earth Engine access.
The visualization parameters. For Images and ImageCollection, see ee.data.getMapId for valid parameters. For Features and FeatureCollections, the only supported key is "color", as a 6-character hex string in the RRGGBB format.
name
String, optional
The name of the layer. Defaults to "Layer N".
shown
Boolean, optional
A flag indicating whether the layer should be on by default.
opacity
Number, optional
The layer's opacity represented as a number between 0 and 1. Defaults to 1.
[[["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\u003e\u003ccode\u003eMap.addLayer()\u003c/code\u003e overlays Earth Engine objects like images and features onto the map as a new layer.\u003c/p\u003e\n"],["\u003cp\u003eVisualization parameters can be customized for images and features, controlling aspects like color, opacity, and stretch.\u003c/p\u003e\n"],["\u003cp\u003eThis function accepts Earth Engine objects (Image, Feature, Geometry, Collections) and styling options to control their visual representation.\u003c/p\u003e\n"],["\u003cp\u003eLayers can be named and controlled for initial visibility.\u003c/p\u003e\n"],["\u003cp\u003eThe function returns the added layer as a \u003ccode\u003eui.Map.Layer\u003c/code\u003e object for further manipulation.\u003c/p\u003e\n"]]],[],null,["# ui.Map.addLayer\n\n\u003cbr /\u003e\n\nAdds a given EE object to the map as a layer.\n\n\u003cbr /\u003e\n\nReturns the new map layer.\n\n| Usage | Returns |\n|------------------------------------------------------------------------------|--------------|\n| Map.addLayer`(eeObject, `*visParams* `, `*name* `, `*shown* `, `*opacity*`)` | ui.Map.Layer |\n\n| Argument | Type | Details |\n|----------------|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| this: `ui.map` | ui.Map | The ui.Map instance. |\n| `eeObject` | Collection\\|Feature\\|Image\\|MapId | The object to add to the map. |\n| `visParams` | FeatureVisualizationParameters\\|ImageVisualizationParameters, optional | The visualization parameters. For Images and ImageCollection, see ee.data.getMapId for valid parameters. For Features and FeatureCollections, the only supported key is \"color\", as a 6-character hex string in the RRGGBB format. |\n| `name` | String, optional | The name of the layer. Defaults to \"Layer N\". |\n| `shown` | Boolean, optional | A flag indicating whether the layer should be on by default. |\n| `opacity` | Number, optional | The layer's opacity represented as a number between 0 and 1. Defaults to 1. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// Define a ui.Map widget and add it to the cleared ui.root.\nvar map = ui.Map();\nui.root.clear();\nui.root.add(map);\nmap.setCenter(-121.87, 37.44, 9);\n\n// A Sentinel-2 surface reflectance image.\nvar image = ee.Image('COPERNICUS/S2_SR/20210109T185751_20210109T185931_T10SEG');\n\n// Set multi-band RGB image visualization parameters. If the \"bands\" parameter\n// is not defined, the first three bands are used.\nvar rgbVis = {\n bands: ['B11', 'B8', 'B3'],\n min: 0,\n max: 3000\n};\nmap.addLayer(image, rgbVis, 'Multi-band RGB image');\n\n// Set band-specific \"min\" and \"max\" properties.\nvar rgbVisBandSpec = {\n bands: ['B11', 'B8', 'B3'],\n min: [0, 75, 150],\n max: [3500, 3000, 2500]\n};\nmap.addLayer(image, rgbVisBandSpec, 'Band-specific min/max');\n\n// If you don't specify \"min\" and \"max\" properties, they will be determined\n// from the data type range, often resulting in an ineffective color stretch.\nmap.addLayer(image.select('B8'), null, 'Default visParams');\n\n// If an image layer has already been styled, set \"visParams\" as null.\nvar imageRgb = image.visualize(rgbVis);\nmap.addLayer(imageRgb, null, 'Pre-styled image');\n\n// Use the \"palette\" parameter with single-band image inputs to define the\n// linear color gradient to stretch between the \"min\" and \"max\" values.\nvar singleBandVis = {\n min: 0,\n max: 3000,\n palette: ['blue', 'yellow', 'green']\n};\nmap.addLayer(image.select('B8'), singleBandVis, 'Single-band palette');\n\n// Images within ImageCollections are automatically mosaicked according to mask\n// status and image order. The last image in the collection takes priority,\n// invalid pixels are filled by valid pixels in preceding images.\nvar imageCol = ee.ImageCollection('COPERNICUS/S2_SR')\n .filterDate('2021-03-01', '2021-04-01');\nmap.addLayer(imageCol, rgbVis, 'ImageCollection mosaic');\n\n// FeatureCollection, Feature, and Geometry objects can be styled using the\n// \"color\" parameter.\nvar featureCol = ee.FeatureCollection('WCMC/WDPA/current/polygons');\nmap.addLayer(featureCol, {color: 'purple'}, 'FeatureCollection');\n```"]]