Map.setControlVisibility
Sets the visibility of the controls on the map.
Returns this ui.Map.
| Usage | Returns |
|---|
Map.setControlVisibility(all, layerList, zoomControl, scaleControl, mapTypeControl, fullscreenControl, drawingToolsControl) | ui.Map |
| Argument | Type | Details |
|---|
all | Boolean, optional | Whether to show all controls. False hides all controls; true shows all controls. Overridden by individually set parameters. Note that setting this explicitly will affect any additional controls added in the future. |
layerList | Boolean, optional | When false, hides the layer list panel or, when true, allows the layer list panel's visibility to be determined by the presence of layers in the list. The default is to show the list. |
zoomControl | Boolean, optional | Whether the zoom control is visible. Defaults to true. |
scaleControl | Boolean, optional | Whether to show the control which indicates the scale at the map's current zoom level. Defaults to true. |
mapTypeControl | Boolean, optional | Whether to show the control that allows the user to change the base map. Defaults to true. |
fullscreenControl | Boolean, optional | Whether to show the control that allows the user to make the map full-screen. Defaults to true. |
drawingToolsControl | Boolean, optional | Whether to show the control that allows the user to add or edit the geometry drawing tools. Defaults to true. |
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.setControlVisibility()` allows customization of the visibility of map controls, such as zoom, scale, layer list, map type, fullscreen, and drawing tools."],["Control visibility can be set individually for each control or globally using the `all` parameter, with individual settings overriding the global setting."],["By default, all map controls are visible; setting `all` to `false` will hide all controls, while setting it to `true` will show all."],["The layer list's visibility is influenced by the presence of layers and can be further customized using the `layerList` parameter."]]],["The `Map.setControlVisibility` function sets the visibility of map controls. It accepts boolean arguments: `all`, `layerList`, `zoomControl`, `scaleControl`, `mapTypeControl`, `fullscreenControl`, and `drawingToolsControl`. `all` toggles all controls, while the others manage individual controls. Defaults for all controls except the layer list are set to show, the default for the layer list is to show if layers are present. The function returns the `ui.Map` object.\n"]]