Class Index | File Index

Classes


Class eniro.maps.Profile


Defined in: Profile.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Internal class that contains the profile properties loaded from the server.
Method Summary
Method Attributes Method Name and Description
 
get(key, defaultValue)
Returns the value for the given key defined in the profile.
 
Returns the id of the profile.
 
Returns the language code of the profile.
 
i18n(key, context)
Looks up a key from a dictionary based on the language defined in this profile.
 
mapZoomForSrsZoom(mapTypeId, The)
Returns the map (user visible) zoom for the given internal zoom.
 
mapZoomLevels(mapTypeId)
Returns an array of zoom levels available for the given map type id.
 
srsZoomForMapZoom(mapTypeId, mapZoom)
Returns the srs (internal, real) zoom for the given map zoom.
Class Detail
eniro.maps.Profile()
Internal class that contains the profile properties loaded from the server.
Method Detail
{string} get(key, defaultValue)
Returns the value for the given key defined in the profile.
Parameters:
{string} key
The key to look for.
{Mixed} defaultValue Optional, Default: undefined
A value to return if the value for the given key equals 'undefined'.
Returns:
{string} The value for the given key defined in the profile, or defaultValue if it is 'undefined'.

{string} getId()
Returns the id of the profile.
Returns:
{string} The id of the profile.

{string} getLangCode()
Returns the language code of the profile.
Returns:
{string} The language code of the profile.

{string} i18n(key, context)
Looks up a key from a dictionary based on the language defined in this profile.
Parameters:
{string} key
The key for an i18n string in the dictionary.
context
{Object} [context] The context object having replacements for ${xxx} place holders in the translation.
Returns:
{string} The translated string.

{number} mapZoomForSrsZoom(mapTypeId, The)
Returns the map (user visible) zoom for the given internal zoom.
Parameters:
{eniro.maps.MapTypeId} mapTypeId
The map to get zoom level for.
{number} The
(real) srs zoom.
Returns:
{number} The user friendly zoom.

{Array} mapZoomLevels(mapTypeId)
Returns an array of zoom levels available for the given map type id.
Parameters:
{eniro.maps.MapTypeId} mapTypeId
the map type id to get zoom levels for.
Returns:
{Array} array of (srs) zoom levels.

{number} srsZoomForMapZoom(mapTypeId, mapZoom)
Returns the srs (internal, real) zoom for the given map zoom.
Parameters:
{eniro.maps.MapTypeId} mapTypeId
The map to get zoom level for.
{number} mapZoom
The user/map zoom to translate to the internal srs zoom such as 1-14.
Returns:
{number} The (real) srs zoom for the give map zoom such as 4-17.

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Mar 30 2020 12:10:04 GMT+0200 (CEST)