Map Image Web Service methods

convertMapCoordToPixelCoord(viewExtent:Envelope, mapImageSize:MapImageSize, mapCoord:Point):PixelCoord

convertPixelCoordToMapCoord(viewExtent:Envelope, mapImageSize:MapImageSize, mapClickPoint:PixelCoord):Point

getBestMap(mapImageOptions:MapImageOptions, token:string):MapImageInfo

getBestMapEnvelope(mapImageOptions:MapImageOptions):Envelope

getLayerInfo(dataSource:string):Layer[]

getLayerInfoForExtent(dataSource:string, mapImageSize:MapImageSize, mapExtent:Envelope):Layer[]

getMap(mapExtent:Envelope, mapImageOptions:MapImageOptions, token:string):MapImageInfo

getMarkerNames(iconDataSource:string):string[]

getMyMarkerNames(iconDataSource:string, token:string):string[]

getThematicFields(thematicDataSource:string):string[]

getThematicGeographiesForExtent(thematicDataSource:string, mapImageSize:MapImageSize, mapExtent:Envelope):string[]

getThematicMap(mapExtent:Envelope, mapImageOptions:MapImageOptions, thematicField:string, thematicOptions:ThematicOptions, token:string):MapImageInfo

getThematicMap(mapExtent:Envelope, mapImageOptions:MapImageOptions, thematicData:KeyValue[], thematicOptions:ThematicOptions, token:string):MapImageInfo

getVersion:string

 

Method Name convertMapCoordToPixelCoord
Description Converts x,y coordinate to image pixel coordinates.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
viewExtent Envelope
mapImageSize MapImageSize
mapCoord Point
Valid Arguments
viewExtent Envelope of the map.
mapImageSize Height and width, in pixels, of map image.
mapCoord x,y coordinates, in decimal degrees, of the map image.
Output Parameter
Result PixelCoord
Example (Java)

IMapImage myMapImage = MapImageHelper.bind();

PixelCoord myPixelCoord = myMapImage.convertMapCoordToPixelCoord(myEnvelope,myMapImageSize,myPoint);

For myEnvelope, see Envelope.

For myMapImageSize, see MapImageSize.

For myPoint, see Point.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myPixelCoord As New PixelCoord()
myPixelCoord = myMapImage.convertMapCoordToPixelCoord(myenvelope, myMapImageSize, myPoint)

For myEnvelope, see Envelope.

For myMapImageSize, see MapImageSize.

For myPoint, see Point.

Example (C#.NET)

MapImage myMapImage = new MapImage();
PixelCoord myPixelCoord = myMapImage.convertMapCoordToPixelCoord(myEnvelope,myMapImageSize,myPoint);

For myEnvelope, see Envelope.

For myMapImageSize, see MapImageSize.

For myPoint, see Point.

 

Method Name convertPixelCoordToMapCoord
Description Converts image pixel coordinates to x,y coordinates.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
viewExtent Envelope
mapImageSize MapImageSize
mapClickPoint PixelCoord
Valid Arguments
viewExtent Envelope of the map.
mapImageSize Height and width, in pixels, of the map image.
mapClickPoint x,y coordinate, in pixels, of the map image.
Output Parameter
Result Point
Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
Point myPoint = myMapImage.convertPixelCoordToMapCoord(myEnvelope,myMapImageSize,myPixelCoord);

For myEnvelope, see Envelope.

For myMapImageSize, see MapImageSize.

For myPixelCoord, see PixelCoord.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myPoint As New Point()
myPoint = myMapImage.convertPixelCoordToMapCoord(myenvelope, myMapImageSize, myPixelCoord)

For myEnvelope, see Envelope.

For myMapImageSize, see MapImageSize.

For myPixelCoord, see PixelCoord.

Example (C#.NET)

MapImage myMapImage = new MapImage();
Point myPoint = myMapImage.convertPixelCoordToMapCoord(myEnvelope,myMapImageSize,myPixelCoord);

For myEnvelope, see Envelope.

For myMapImageSize, see MapImageSize.

For myPixelCoord, see PixelCoord.

 

Method Name getBestMap
Description Returns the minimum map that contains all circles, geometry, and markers.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
mapImageOptions MapImageOptions
token string
Valid Arguments
mapImageOptions

See parameter descriptions in MapImageOptions. You must define at least one circle, line, or polygon or two markers.

token Authentication token
Output Parameter
Result MapImageInfo
Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
MapImageInfo myMapImageInfo = myMapImage.getBestMap(myMapImageOptions,token);

For myMapImageOptions, see MapImageOptions.

For token, see getToken.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myMapImageInfo As New MapImageInfo()
myMapImageInfo = myMapImage.getBestMap(myMapImageOptions,token)

For myMapImageOptions, see MapImageOptions.

For token, see getToken.

Example (C#.NET)

MapImage myMapImage = new MapImage();
MapImageInfo myMapImageInfo = myMapImage.getBestMap(myMapImageOptions,token);

For myMapImageOptions, see MapImageOptions.

For token, see getToken.

 

Method Name getBestMapEnvelope
Description Returns the minimum Envelope of all the circles, geometry, and markers.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
mapImageOptions MapImageOptions
Valid Arguments
mapImageOptions

See parameter descriptions in MapImageOptions. You must define at least one circle, line, or polygon or two markers.

Output Parameter
Result Envelope
Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
Envelope myEnvelope = myMapImage.getBestMapEnvelope(myMapImageOptions);

For myMapImageOptions, see MapImageOptions.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myEnvelope As New Envelope()
myEnvelope = myMapImage.getBestMapEnvelope(myMapImageOptions)

For myMapImageOptions, see MapImageOptions.

Example (C#.NET)

MapImage myMapImage = new MapImage();
Envelope myEnvelope = myMapImage.getBestMapEnvelope(myMapImageOptions);

For myMapImageOptions, see MapImageOptions.

 

Method Name getLayerInfo
Description Returns a list of layers for a given data source.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
dataSource string
Valid Arguments
dataSource

See Data sources and credits.

Output Parameter
Result Layer[]
Example (Java)

IMapImage myMapImage = MapImageHelper.bind() ;
Layer[] myLayers = myMapImage.getLayerInfo("GDT.Streets.US") ;

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myLayers() As Layer
myLayers = myMapImage.getLayerInfo("GDT.Streets.US")

Example (C#.NET)

myMapImage = new MapImage();
Layer[] myLayers = myMapImage.getLayerInfo("GDT.Streets.US");

 

Method Name getLayerInfoForExtent
Description Returns a list of available layers for a given extent.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
dataSource string
mapImageSize

MapImageSize  

mapextent Envelope
Valid Arguments
dataSource

See Data sources and credits.

mapImageSize Height and width, in pixels, of map image.   
mapExtent Envelope of the map.
Output Parameter
Result Layer[]
Example (Java)

IMapImage myMapImage = MapImageHelper.bind() ;
Layer[] myLayers = myMapImage.getLayerInfoForExtent("GDT.Streets.US", myMapImageSize,myEnvelope) ;

For myMapImageSize, see MapImageSize.

For myEnvelope, see Envelope.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myLayers() As Layer
myLayers = myMapImage.getLayerInfoForExtent("GDT.Streets.US", myMapImageSize, myEnvelope)

For myMapImageSize, see MapImageSize.

For myEnvelope, see Envelope.

Example (C#.NET)

myMapImage = new MapImage();
Layer[] myLayers = myMapImage.getLayerInfoForExtent("GDT.Streets.US", myMapImageSize, myEnvelope);

For myMapImageSize, see MapImageSize.

For myEnvelope, see Envelope.

 

Method Name getMap
Description Gets the map for the particular envelope.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
mapExtent Envelope
mapImageOptions MapImageOptions
token string
Valid Arguments
mapExtent Envelope of the map.
mapImageOptions See parameter descriptions in MapImageOptions.  
token Authentication token
Output Parameter
Result MapImageInfo
Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
MapImageInfo myMapImageInfo = myMapImage.getMap(myEnvelope,myMapImageOptions,token);

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For token, see getToken.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myMapImageInfo As New MapImageInfo()
myMapImageInfo = myMapImage.getMap(myEnvelope,myMapImageOptions,token)

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For token, see getToken.

Example (C#.NET)

MapImage myMapImage = new MapImage();
MapImageInfo myMapImageInfo = myMapImage.getMap(myEnvelope,myMapImageOptions,token);

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For token, see getToken.

 

Method Name getMarkerNames
Description Returns the markers available for a given data source.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
iconDataSource string
Valid Arguments
iconDataSource "ESRI.Simple.Icons" or "ESRI.Raster.Icons"
Output Parameter
Result string array of available icons.
Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
string markers[] = myMapImage.getMarkerNames("ESRI.Simple.Icons");

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim markers() As String
markers = myMapImage.getMarkerNames("ESRI.Simple.Icons")

Example (C#.NET)

MapImage myMapImage = new MapImage();
string [] markers = myMapImage.getMarkerNames("ESRI.Simple.Icons");

 

Method Name getMyMarkerNames
Description Returns the markers that you have uploaded. There is no credit charge for using this method.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
iconDataSource string
token string
Valid Arguments
iconDataSource "User.Defined.Icons"
token Authentication token
Output Parameter
Result string array of available icons.
Example (Java)

IMapImage myMapImage = MapImageHelper.bind();
string myMarkers[] = myMapImage.getMyMarkerNames("User.Defined.Icons",token);

For token, see getToken.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myMarkers() As String
myMarkers = myMapImage.getMyMarkerNames("User.Defined.Icons", token)

For token, see getToken.

Example (C#.NET)

MapImage myMapImage = new MapImage();
string [] myMarkers = myMapImage.getMyMarkerNames("User.Defined.Icons", token);

For token, see getToken.

 

Method Name getThematicFields
Description Returns a list of available fields that you can use to create a thematic map with the basic getThematicMap method. See Thematic fields for descriptions of field names.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
thematicDataSource string
Valid Arguments
thematicDataSource

See Data sources and credits.

Output Parameter
Result string []
Example (Java)

IMapImage myMapImage = MapImageHelper.bind() ;
String[] myThematicFields = myMapImage.getThematicFields("ESRI.Demographics.US");

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myThematicFields() As String
myThematicFields = myMapImage.getThematicFields("ESRI.Demographics.US")

Example (C#.NET)

myMapImage = new MapImage();
String[] myThematicFields = myMapImage.getThematicFields("ESRI.Demographics.US");

 

Method Name getThematicGeographiesForExtent
Description Returns a list of available geographies (e.g., ZIP Codes, BlockGroups) for a particular data source and extent.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
thematicDataSource string
mapImageSize

MapImageSize  

Mapextent Envelope
Valid Arguments
thematicDataSource See Data sources and credits.
MapImageSize Height and width, in pixels, of map image.   
extent Envelope of the map.
Output Parameter
Result

string array of valid geography names.

Example (Java)

IMapImage myMapImage = MapImageHelper.bind() ;
String[] myThematicGeographiesForExtent = myMapImage.getThematicGeographiesForExtent("ESRI.Demographics.US", myMapImageSize, myEnvelope);

For myMapImageSize, see MapImageSize.

For myEnvelope, see Envelope.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myThematicGeographiesForExtent() As String
Dim i as integer
myThematicGeographiesForExtent = myMapImage.getThematicGeographiesForExtent("Demographic.Thematic.US", myMapImageSize, myEnvelope)
For i = 0 to (myThematicGeographiesForExtent.Length - 1)
Console.WriteLine(myThematicGeographiesForExtent(i))
Next

For myMapImageSize, see MapImageSize.

For myEnvelope, see Envelope.

Example (C#.NET)

myMapImage = new MapImage();
int i;
String[] myThematicGeographiesForExtent =
myMapImage.getThematicGeographiesForExtent("Demographic.Thematic.US",
myMapImageSize, myEnvelope);
for (i = 0; i < myThematicGeographiesForExtent.Length; i++)
{
Console.WriteLine(myThematicGeographiesForExtent[i]);
}

For myMapImageSize, see MapImageSize.

For myEnvelope, see Envelope.

 

Method Name getThematicMap
Description

Returns a thematic map based on an ESRI demographic variable. Use getThematicFields to get back a list of available thematic variable names to use with thematicField. See Thematic variables for descriptions of the names.

Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
mapExtent Envelope
mapImageOptions MapImageOptions
thematicField string
thematicOptions

ThematicOptions

token string
Valid Arguments
mapExtent Envelope of the map.
mapImageOptions See parameter descriptions in MapImageOptions. dataSource value must be "ESRI.Demographics.US".
thematicField Returned value from getThematicFields method.
thematicOptions

See parameter descriptions in ThematicOptions.

token Authentication token for accessing Map Image Web Service.
Output Parameter
Result MapImageInfo
Example (Java)

getThematicMap(myEnvelope, myMapImageOptions, myThematicField, myThematicOptions, token);

IMapImage myMapImage = MapImageHelper.bind() ;
MapImageInfo myMapImageInfo = myMapImage.getThematicMap(myEnvelope, myMapImageOptions, myThematicField, myThematicOptions, token);

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For myThematicOptions, see ThematicOptions.

For myThematicField, see getThematicFields.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myMapImageInfo As New MapImageInfo()
myMapImageInfo = myMapImage.getThematicMap(myEnvelope, myMapImageOptions, myThematicField, myThematicOptions, token)

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For myThematicOptions, see ThematicOptions.

For myThematicField, see getThematicFields.

Example (C#.NET)

myMapImage = new MapImage();
myMapImageInfo = new MapImageInfo();
myMapImageInfo = myMapImage.getThematicMap(myEnvelope, myMapImageOptions, myThematicField, myThematicOptions, token);

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For myThematicOptions, see ThematicOptions.

For myThematicField, see getThematicFields.

 

Method Name getThematicMap
Description Returns a thematic map based on values you have defined for the data in the map.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Input Parameters
mapExtent Envelope
mapImageOptions MapImageOptions
thematicData

KeyValue[]

thematicOptions

ThematicOptions

token string
Valid Arguments
mapExtent Envelope of the map.
mapImageOptions See parameter descriptions in MapImageOptions. dataSource value must be "ESRI.Thematic.US".
thematicData

key/value pair for geographic FIPS code and value. See Map Image Notes for more information about the geographic codes.

thematicOptions

See parameter descriptions in ThematicOptions.

token Authentication token
Output Parameter
Result MapImageInfo
Example (Java)

KeyValue myThematicData[] = new KeyValue[2];

IMapImage myMapImage = MapImageHelper.bind() ;
MapImageInfo myMapImageInfo = myMapImage.getThematicMap(myEnvelope, myMapImageOptions, myThematicaData, myThematicOptions, token);

For myThematicData, see KeyValue.

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For myThematicOptions, see ThematicOptions.

Example (VB.NET)

Dim myMapImage As New MapImage()
Dim myMapImageInfo As New MapImageInfo()
Dim myThematicData() As KeyValue
myMapImageInfo = myMapImage.getThematicMap(myEnvelope, myMapImageOptions, myThematicaData, myThematicOptions, token)

For myThematicData, see KeyValue.

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For myThematicOptions, see ThematicOptions.

Example (C#.NET)

MapImage myMapImage = new MapImage();

KeyValue myThematicData[] = new KeyValue[2];

MapImageInfo myMapImageInfo = myMapImage.getThematicMap(myEnvelope, myMapImageOptions, myThematicaData, myThematicOptions, token);

For myThematicData, see KeyValue.

For myEnvelope, see Envelope.

For myMapImageOptions, see MapImageOptions.

For myThematicOptions, see ThematicOptions.

 

Method Name getVersion
Description Returns the version number of Map Image Web Service.
Endpoint URL http://arcweb.esri.com/services/v2/MapImage
Output Parameter
Result string
Example (Java)

Image myMapImage = MapImageHelper.bind();

string version = myMapImage.getVersion();

Example (VB.NET)

MapImage myMapImage = New MapImage();
Dim version As String
version = myMapImage.getVersion

Example (C#.NET)

MapImage myMapImage = new MapImage();
string version = myMapImage.getVersion();

 
 

See also

Map Image overview

Map Image data sources and credits

SOAP samples

Object model