ui.Map.setLocked
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."],[[["`Map.setLocked()` controls the panning and zooming behavior of the map."],["Setting `locked` to `true` restricts panning and, optionally, allows setting zoom limits with `minZoom` and `maxZoom`."],["Setting `locked` to `false` with no other parameters resets the map to default behavior."],["Providing `minZoom` and/or `maxZoom` along with `locked` sets zoom limitations, while the presence or absence of `locked` dictates panning restrictions."]]],[]]