Class: VETiledLayerE-mail This Topic Printable Version Give Us Feedback

Description

Class added v1.4.

Bing Maps tiled layer.

Class hierarchy

esri.layers.Layer
  |_ esri.layers.TiledMapServiceLayer
        |_ esri.virtualearth.VETiledLayer

Constructor

Constructor Description
esri.virtualearth.VETiledLayer(options) Creates a new VETiledLayer object. The parameters can be included in any order. Either tokenURL or serverToken and clientToken are required in the constructor. All other parameters are optional.

Properties

Property Type Description
clientToken String The Bing Maps Web services token used by the browser to make Bing Maps tile requests.
culture String Specifies the culture in which to return results. The default value is "en-US". For a list of supported cultures, see http://msdn.microsoft.com/en-us/library/cc981048.aspx.
environment String The Bing Maps server environment, use either "staging" or "production".
mapStyle String Bing Maps style. See Constants table for valid values.
serverToken String The Bing Maps Web services token used by the ArcGIS VEAdapter to make Bing Maps imagery service metadata requests.
tokenDuration String Duration of the Bing Maps token in minutes. The minimum is 15, and the maximum is 480 (8 hours).
tokenUrl String The root URL of the "Get Virtual Earth Token" page. For more information, see Getting started with Bing Maps in the ArcGIS JavaScript API.

Constants

Constant Description
MAP_STYLE_AERIAL Bing Maps Aerial layer.
MAP_STYLE_AERIAL_WITH_LABELS Bing Maps Aerial with Labels layer.
MAP_STYLE_ROAD Bing Maps Roads layer.

Methods

Method Return Value Description
setClientToken(clientToken) none Updates client token.
setCulture(culture) none Sets the culture in which to return results.
setMapStyle(style) none Sets the Bing Maps style.
setServerToken(serverToken) none Updates server token.
Constructor Detail

esri.virtualearth.VETiledLayer(options)

Creates a new VETiledLayer object. The parameters can be included in any order. Either tokenURL or serverToken and clientToken are required in the constructor. All other parameters are optional.
Parameters:
<Object> options Required See options list for parameters.
Options:
<String> clientToken Note: Either tokenURL or serverToken and clientToken are required in the constructor.

The Bing Maps Web services token used by the browser to make Bing Maps tile requests.
<String> culture Specifies the culture in which to return results. The default value is "en-US". For a list of supported cultures, see http://msdn.microsoft.com/en-us/library/cc981048.aspx.
<String> environment The Bing Maps server environment, use either "staging" or "production".
<String> mapStyle Bing Maps style. See Constants table for valid values.
<String> serverToken Note: Either tokenURL or serverToken and clientToken are required in the constructor.

The Bing Maps Web services token used by the ArcGIS VEAdapter to make Bing Maps imagery service metadata requests.
<String> tokenDuration The duration of the token in minutes. The minimum value is 15 and the maximum value is 480 (8 hours).
<String> tokenUrl Note: Either tokenURL or serverToken and clientToken are required in the constructor.

The root URL of the "Get Virtual Earth Token" page. For more information, see Getting started with Bing Maps in the ArcGIS JavaScript API.
Properties Detail

<String> clientToken

The Bing Maps Web services token used by the browser to make Bing Maps tile requests.
See also:
setClientToken  

<String> culture

Specifies the culture in which to return results. The default value is "en-US". For a list of supported cultures, see http://msdn.microsoft.com/en-us/library/cc981048.aspx.
Default value: en-US
See also:
setCulture  

<String> environment

The Bing Maps server environment, use either "staging" or "production".
Known values: staging | production
Default value: staging

<String> mapStyle

Bing Maps style. See Constants table for valid values.
Default value: MAP_STYLE_ROAD
See also:
setMapStyle  

<String> serverToken

The Bing Maps Web services token used by the ArcGIS VEAdapter to make Bing Maps imagery service metadata requests.
See also:
setServerToken  

<String> tokenDuration

Duration of the Bing Maps token in minutes. The minimum is 15, and the maximum is 480 (8 hours).
Default value: 480

<String> tokenUrl

The root URL of the "Get Virtual Earth Token" page. For more information, see Getting started with Bing Maps in the ArcGIS JavaScript API.
Methods Detail

setClientToken(clientToken)

Updates client token.
Return value: none
Input Parameters:
<String> clientToken Required The new token to update with.
See also:
clientToken  

setCulture(culture)

Sets the culture in which to return results.
Return value: none
Input Parameters:
<String> culture Required The culture value. The default value is "en-US". For a list of supported cultures, see http://msdn.microsoft.com/en-us/library/cc981048.aspx.
See also:
culture  

setMapStyle(style)

Sets the Bing Maps style.
Return value: none
Input Parameters:
<String> style Required Bing Maps style. See Constants table for valid values.
See also:
mapStyle  

setServerToken(serverToken)

Updates server token.
Return value: none
Input Parameters:
<String> serverToken Required The new token to update with.
See also:
serverToken