@smartmaps/smartmaps-gl / LanguageControl

Class: LanguageControl

Nur auf Englisch verfügbar

Diese Seite gehört zur technischen API-Referenz. Sie wird automatisch aus dem Quellcode erzeugt und liegt daher ausschließlich auf Englisch vor. Die einführenden Seiten und Leitfäden sind auf Deutsch verfügbar.

Use Language Control to switch languages dynamically.

Remarks

can be activated/disabled with the LanguageControl option MapOptions

Examples

languageControl: true

languageControl: {
    selectedLanguages: ['en', 'de', 'fr', 'es', 'ja'],
    controlLanguage: 'en'
}

map.addControl( new LanguageControl({
    selectedLanguages: ['de', 'en'],
    controlLanguage: 'de'
}));

Implements

IControl
LanguageObserver

Constructors

Constructor

new LanguageControl(options?): LanguageControl

Parameters

options?

LanguageControlOptions

the control's options

Returns

LanguageControl

Properties

languageManager

languageManager: LanguageManager | undefined

Implementation of

LanguageObserver.languageManager

name

name: LanguageObservers = LanguageObservers.LanguageControl

Implementation of

LanguageObserver.name

options

options: LanguageControlOptions

Implementation of

LanguageObserver.options

textElements

textElements: Map\<string, (newText) => void>

Implementation of

LanguageObserver.textElements

Methods

getDefaultPosition()

getDefaultPosition(): ControlPosition

Optionally provide a default position for this control. If this method is implemented and Map#addControl is called without the position parameter, the value returned by getDefaultPosition will be used as the control's position.

Returns

ControlPosition

a control position, one of the values valid in addControl.

Implementation of

IControl.getDefaultPosition

onAdd()

onAdd(map): HTMLElement

Register a control on the map and give it a chance to register event listeners and resources. This method is called by Map.addControl internally.

Parameters

map

Map

the Map this control will be added to

Returns

HTMLElement

The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.

Implementation of

IControl.onAdd

onRemove()

onRemove(): void

Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by Map.removeControl internally.

Returns

void

Implementation of

IControl.onRemove