Maps API for JavaScript Developer's Guide

H.ui.MapSettingsControl.Options

Type Definition Summary

This typedef defines the configuration options (initialization options) for the MapSettingsControl. Entries of the baseLayers property are rendered first in the control and selecting any of them changes the map base layer, whereas entries from the layers list are rendered afterwards and are added/removed from the map as a separate layers.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

alignment

The layout alignment which should be applied to the given control object, the default is H.ui.LayoutAlignment.BOTTOM_RIGHT.

baseLayers

The list of base layers to be shown in the map settings control. Selecting an entry changes map base layer.

layers

The list of layers to be shown in the map settings control after the baseLayers list. Selecting an entry adds a layer to the map.

Type Definition Description

This typedef defines the configuration options (initialization options) for the MapSettingsControl. Entries of the baseLayers property are rendered first in the control and selecting any of them changes the map base layer, whereas entries from the layers list are rendered afterwards and are added/removed from the map as a separate layers.

For example normal map and satellite can be good candidates for passing as layers entries, and traffic incidents as layers entry, because it can be shown regardless of a base layer type.

Property Details

alignment: {H.ui.LayoutAlignment=} [optional]

The layout alignment which should be applied to the given control object, the default is H.ui.LayoutAlignment.BOTTOM_RIGHT.

baseLayers: {Array<H.ui.MapSettingsControl.Entry>=} [optional]

The list of base layers to be shown in the map settings control. Selecting an entry changes map base layer.

layers: {Array<H.ui.MapSettingsControl.Entry>=} [optional]

The list of layers to be shown in the map settings control after the baseLayers list. Selecting an entry adds a layer to the map.