Maps API for JavaScript Developer's Guide

H.ui.UI.Options

Type Definition Summary

Optional parameters to be passed to the UI constructor.

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

unitSystem

An optional value indicating the distance measurement system for the UI, the default is H.ui.UnitSystem.METRIC

zoom

A value indicating the zoom level

zoomrectangle

An object containing ZoomRectangle initialization options

mapsettings

An object containing MapSettingControl initialization options

scalebar

An object containing ScaleBar initialization options

panorama

An object containing panorama initialization options

distancemeasurement

An object containing DistanceMeasurement initialization options

locale

Defines the language in which UI is to be rendered. It can be a predefined H.ui.i18n.Localization object with a custom translation map, or one of following strings, 'en-US', 'de-DE', 'es-ES', 'fi-FI', 'fr-FR', 'it-IT', 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'tr-TR', 'zh-CN'. If the property is not specified, the UI uses 'en-US' by default

Type Definition Description

Optional parameters to be passed to the UI constructor.

Property Details

unitSystem: {H.ui.UnitSystem=} [optional]

An optional value indicating the distance measurement system for the UI, the default is H.ui.UnitSystem.METRIC

zoom: {(H.ui.ZoomControl.Options | boolean)=} [optional]

A value indicating the zoom level

zoomrectangle: {(H.ui.ZoomRectangle.Options | boolean)=} [optional]

An object containing ZoomRectangle initialization options

mapsettings: {(H.ui.MapSettingsControl.Options | boolean)=} [optional]

An object containing MapSettingControl initialization options

scalebar: {(H.ui.ScaleBar.Options | boolean)=} [optional]

An object containing ScaleBar initialization options

panorama: {(H.ui.Pano.Options | boolean)=} [optional]

An object containing panorama initialization options

distancemeasurement: {(H.ui.DistanceMeasurement.Options | boolean)=} [optional]

An object containing DistanceMeasurement initialization options

locale: {(H.ui.i18n.Localization | string)=} [optional]

Defines the language in which UI is to be rendered. It can be a predefined H.ui.i18n.Localization object with a custom translation map, or one of following strings, 'en-US', 'de-DE', 'es-ES', 'fi-FI', 'fr-FR', 'it-IT', 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'tr-TR', 'zh-CN'. If the property is not specified, the UI uses 'en-US' by default