API Reference > imodeljs-I18N > AppAdministration > I18N > translate

translate Method

Return the translated value of a key.

translate(key: string | string[], options?: i18next.TranslationOptions): any

note The key includes the namespace, which identifies the particular localization file that contains the property, followed by a colon, followed by the property in the JSON file. For example:

const dataString: string = IModelApp.i18n.translate("iModelJs:BackgroundMap.BingDataAttribution");

assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.

Parameter Type Description
key string | string[] the key that matches a property in the JSON localization file.
options i18next.TranslationOptions  

Returns - any

Defined in

Last Updated: 13 June, 2024