ui.Map.getScale
Returns the approximate pixel scale of the current map view, in meters.
Usage | Returns |
---|
Map.getScale() | Number|String |
Argument | Type | Details |
---|
this: ui.map | ui.Map | The ui.Map instance. |
Examples
// 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."],[[["`Map.getScale()` returns the approximate pixel scale of the current map view in meters."],["The scale represents the ground distance in meters that corresponds to one pixel on the map at the current zoom level."],["This function can be used to estimate distances or sizes of features displayed on the map."],["It's called on a `ui.Map` object, such as the default `Map` in the Code Editor or a custom `ui.Map` you create."]]],["The core content describes retrieving the approximate pixel scale of a map view using `Map.getScale()`, which returns a number or string. The code demonstrates using this method on a `ui.Map` instance, named \"defaultMap\". It also showcases other map functionalities like creating a new map, centering it on a point, adding a layer, and fetching bounds, center, and zoom level. `Map.getScale()` is used to print the pixel scale.\n"]]