Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
ui.Map.setLocked
Stay organized with collections
Save and categorize content based on your preferences.
Limits panning and zooming on the map.
- To lock both panning and zooming, set locked to true and nothing else.
- To allow panning and limit the min and max zoom, set locked to false and supply the minZoom and maxZoom parameters.
- To disallow panning and limit min and max zoom, set locked to true and supply the minZoom and maxZoom parameters.
- To reset the map to default, set locked to false and nothing else.
| Usage | Returns | Map.setLocked(locked, minZoom, maxZoom) | |
| Argument | Type | Details | this: ui.map | ui.Map | The ui.Map instance. |
locked | Boolean | Whether the map should be locked or not. |
minZoom | Number, optional | (optional) The minimum zoom for the map, between 0 and 24, inclusive. |
maxZoom | Number, optional | (optional) The maximum zoom for the map, between 0 and 24, inclusive. |
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.setLocked()\u003c/code\u003e controls the panning and zooming behavior of the map.\u003c/p\u003e\n"],["\u003cp\u003eSetting \u003ccode\u003elocked\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e restricts panning and, optionally, allows setting zoom limits with \u003ccode\u003eminZoom\u003c/code\u003e and \u003ccode\u003emaxZoom\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSetting \u003ccode\u003elocked\u003c/code\u003e to \u003ccode\u003efalse\u003c/code\u003e with no other parameters resets the map to default behavior.\u003c/p\u003e\n"],["\u003cp\u003eProviding \u003ccode\u003eminZoom\u003c/code\u003e and/or \u003ccode\u003emaxZoom\u003c/code\u003e along with \u003ccode\u003elocked\u003c/code\u003e sets zoom limitations, while the presence or absence of \u003ccode\u003elocked\u003c/code\u003e dictates panning restrictions.\u003c/p\u003e\n"]]],[],null,["# ui.Map.setLocked\n\n\u003cbr /\u003e\n\nLimits panning and zooming on the map.\n\n\u003cbr /\u003e\n\n- To lock both panning and zooming, set locked to true and nothing else.\n\n- To allow panning and limit the min and max zoom, set locked to false and supply the minZoom and maxZoom parameters.\n\n- To disallow panning and limit min and max zoom, set locked to true and supply the minZoom and maxZoom parameters.\n\n- To reset the map to default, set locked to false and nothing else.\n\n| Usage | Returns |\n|----------------------------------------------------|---------|\n| Map.setLocked`(locked, `*minZoom* `, `*maxZoom*`)` | |\n\n| Argument | Type | Details |\n|----------------|------------------|-----------------------------------------------------------------------|\n| this: `ui.map` | ui.Map | The ui.Map instance. |\n| `locked` | Boolean | Whether the map should be locked or not. |\n| `minZoom` | Number, optional | (optional) The minimum zoom for the map, between 0 and 24, inclusive. |\n| `maxZoom` | Number, optional | (optional) The maximum zoom for the map, between 0 and 24, inclusive. |"]]