Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ui.Map.getZoom
Stay organized with collections
Save and categorize content based on your preferences.
Returns the current zoom level of the map.
Usage | Returns | Map.getZoom() | Number |
Argument | Type | Details | this: ui.map | ui.Map | The ui.Map instance. |
Examples
Code Editor (JavaScript)
// The default map in the Code Editor is a built-in ui.Map object called "Map".
// Let's refer to it as "defaultMap" for clarity.
var defaultMap = Map;
// ui.Map objects can be constructed. Here, a new map is declared.
var newMap = ui.Map({
center: {lat: 0, lon: 0, zoom: 1},
style: {position: 'bottom-right', width: '400px'}
});
// Add the newMap to the defaultMap.
defaultMap.add(newMap);
// You can set the viewport of a ui.Map to be centered on an object.
// Here, the defaultMap is centered on a point with a selected zoom level.
var geom = ee.Geometry.Point(-122.0841, 37.4223);
defaultMap.centerObject(geom, 18);
defaultMap.addLayer(geom, {color: 'orange'}, 'Googleplex');
// Map extent can be fetched using the ui.Map.getBounds method.
print('defaultMap bounds as a list',
defaultMap.getBounds());
print('defaultMap bounds as a dictionary',
ee.Dictionary.fromLists(['w', 's', 'e', 'n'], defaultMap.getBounds()));
print('defaultMap bounds as GeoJSON',
defaultMap.getBounds({asGeoJSON: true}));
// Map center point can be fetched using the ui.Map.getCenter method.
print('defaultMap center as a Point geometry', defaultMap.getCenter());
// Map zoom level can be fetched using the ui.Map.getZoom method.
print('defaultMap zoom level', defaultMap.getZoom());
// Map scale can be fetched using the ui.Map.getScale method.
print('defaultMap approximate pixel scale', defaultMap.getScale());
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\u003e\u003ccode\u003eMap.getZoom()\u003c/code\u003e returns the current zoom level of the map as a number.\u003c/p\u003e\n"],["\u003cp\u003eThis function can be used with any \u003ccode\u003eui.Map\u003c/code\u003e object, including the default map named "Map" in the Code Editor.\u003c/p\u003e\n"],["\u003cp\u003eZoom level is a property of the map's viewport and determines the scale of the displayed imagery or data.\u003c/p\u003e\n"],["\u003cp\u003eThe provided example demonstrates retrieving the zoom level alongside other map properties like bounds, center, and scale.\u003c/p\u003e\n"]]],[],null,["# ui.Map.getZoom\n\n\u003cbr /\u003e\n\nReturns the current zoom level of the map.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|-----------------|---------|\n| Map.getZoom`()` | Number |\n\n| Argument | Type | Details |\n|----------------|--------|----------------------|\n| this: `ui.map` | ui.Map | The ui.Map instance. |\n\nExamples\n--------\n\n### Code Editor (JavaScript)\n\n```javascript\n// The default map in the Code Editor is a built-in ui.Map object called \"Map\".\n// Let's refer to it as \"defaultMap\" for clarity.\nvar defaultMap = Map;\n\n// ui.Map objects can be constructed. Here, a new map is declared.\nvar newMap = ui.Map({\n center: {lat: 0, lon: 0, zoom: 1},\n style: {position: 'bottom-right', width: '400px'}\n});\n\n// Add the newMap to the defaultMap.\ndefaultMap.add(newMap);\n\n// You can set the viewport of a ui.Map to be centered on an object.\n// Here, the defaultMap is centered on a point with a selected zoom level.\nvar geom = ee.Geometry.Point(-122.0841, 37.4223);\ndefaultMap.centerObject(geom, 18);\ndefaultMap.addLayer(geom, {color: 'orange'}, 'Googleplex');\n\n// Map extent can be fetched using the ui.Map.getBounds method.\nprint('defaultMap bounds as a list',\n defaultMap.getBounds());\nprint('defaultMap bounds as a dictionary',\n ee.Dictionary.fromLists(['w', 's', 'e', 'n'], defaultMap.getBounds()));\nprint('defaultMap bounds as GeoJSON',\n defaultMap.getBounds({asGeoJSON: true}));\n\n// Map center point can be fetched using the ui.Map.getCenter method.\nprint('defaultMap center as a Point geometry', defaultMap.getCenter());\n\n// Map zoom level can be fetched using the ui.Map.getZoom method.\nprint('defaultMap zoom level', defaultMap.getZoom());\n\n// Map scale can be fetched using the ui.Map.getScale method.\nprint('defaultMap approximate pixel scale', defaultMap.getScale());\n```"]]