Map.setControlVisibility

  • Map.setControlVisibility sets the visibility of controls on the map and returns the ui.Map object.

  • Arguments allow for controlling the visibility of all controls, the layer list, zoom, scale, map type, fullscreen, and drawing tools controls individually or collectively.

  • The all argument can show or hide all controls but is overridden by individual settings and affects future controls.

  • Default settings generally show zoom, scale, map type, and fullscreen controls, while the layer list depends on the presence of layers, and drawing tools default to being visible.

Sets the visibility of the controls on the map.

Returns this ui.Map.

UsageReturns
Map.setControlVisibility(all, layerList, zoomControl, scaleControl, mapTypeControl, fullscreenControl, drawingToolsControl)ui.Map
ArgumentTypeDetails
allBoolean, optionalWhether 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.
layerListBoolean, optionalWhen 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.
zoomControlBoolean, optionalWhether the zoom control is visible. Defaults to true.
scaleControlBoolean, optionalWhether to show the control which indicates the scale at the map's current zoom level. Defaults to true.
mapTypeControlBoolean, optionalWhether to show the control that allows the user to change the base map. Defaults to true.
fullscreenControlBoolean, optionalWhether to show the control that allows the user to make the map full-screen. Defaults to true.
drawingToolsControlBoolean, optionalWhether to show the control that allows the user to add or edit the geometry drawing tools. Defaults to true.