You are here: Using SOAP > v2006.1 services > Map Image > Map Image v2006.1 methods

Map Image Web Service v2006.1 methods

To see Map Image Web Service in action, interact with a live sample of a Map Image client.

convertMapCoordsToPixelCoords(mapArea:MapArea, mapSize:MapImageSize, mapCoords:Point[], token:string):PixelCoord[]

convertPixelCoordsToMapCoords(mapArea:MapArea, mapSize:MapImageSize, mapClickPoints:PixelCoord[], token:string):Point[]

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

getBestMapArea(mapImageOptions:MapImageOptions, bufferPercent:double, token:string):MapArea

getCustomThematicMap(mapArea:MapArea, mapImageOptions:MapImageOptions, thematicData:ThematicData, thematicOptions:ThematicOptions, thematicColors:ThematicColors, token:string):MapImageInfo

getESRIThematicMap(mapArea:MapArea, mapImageOptions:MapImageOptions, thematicField:string, thematicOptions:ThematicOptions, thematicColors:ThematicColors, token:string):MapImageInfo

getFusedMapImage(mapFusionOptions:MapFusionOptions[], outputImageFormat:string, token:string):string

getMaps(mapAreas:MapArea[], mapImageOptions:MapImageOptions[], token:string):MapImageInfo[]

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

getSavedMap(savedMapID:string, token:string):MapImageInfo

getThematicFields(thematicDataSource:string, token:string):string[]

getValueMap(mapArea:MapArea, mapImageOptions:MapImageOptions, thematicData:ThematicData, codeColorValues:KeyValue[], thematicOptions:ThematicOptions, token:string):MapImageInfo

getVersion:string

saveMap(mapArea:mapArea, mapImageOptions:MapImageOptions, token:string):string

convertMapCoordsToPixelCoords

Converts x,y coordinates to image pixel coordinates.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapArea	MapArea	MapArea parameters
mapSize	MapImageSize	MapImageSize parameters
mapCoords	Point[]	Point parameters
token	string	Authentication token

Output

Code examples

convertPixelCoordsToMapCoords

Converts image pixel coordinates to x,y coordinates.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapArea	MapArea	MapArea parameters
mapSize	MapImageSize	MapImageSize parameters
mapClickPoints	PixelCoord[]	PixelCoord parameters
token	string	Authentication token

Output

Point[]

Code examples

getBestMap

Returns a map with the minimum extent that contains all the circles, polygons, lines, and markers specified in the object MapImageOptions. By default, there is a small buffer around all the objects. If you want the default extent of the data source, send a request without any circles, polygons, lines, or markers.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapImageOptions	MapImageOptions	MapImageOptions parameters
bufferPercent	double	Percentage to expand the minimum extent. For example, "110" expands the minimum extent by 110 percent. "100" is based on a recommended default that adds a small amount of padding to the minimum bounding box enclosing all the shapes. "0" gives no padding, and "200" gives twice as much padding as the 100 percent default.
token	string	Authentication token

Output

Code examples

getBestMapArea

Returns a map area with the minimum extent that contains all the circles, geometries, and markers specified in the object MapImageOptions. By default, there is a small buffer around all the objects.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapImageOptions	MapImageOptions	MapImageOptions parameters
bufferPercent	double	Percentage to expand the minimum extent. For example, "110" expands the minimum extent by 110 percent. "100" is based on a recommend default that adds a small amount of padding to the minimum bounding box enclosing all the shapes. "0" gives no padding, and "200" gives twice as much padding as the 100 percent default.
token	string	Authentication token

Output

Code examples

getCustomThematicMap

Returns a thematic map based on user-supplied data that match specific geography IDs. Coloring of each region is based on ESRI class breaks. See Map Image notes for more information on thematic mapping.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapArea	MapArea	MapArea parameters
mapImageOptions	MapImageOptions	MapImageOptions parameters. Must use one of the following thematic map data sources for the dataSource value: "ArcWeb:ESRI.CongDist109.US" "ArcWeb:ESRI.DemographicsByBlockGroup.US" "ArcWeb:ESRI.DemographicsByCounty.US" "ArcWeb:ESRI.DemographicsByState.US" "ArcWeb:ESRI.DemographicsByTract.US" "ArcWeb:ESRI.DemographicsByZipCode.US" See Service Finder for details about these data sources.
thematicData	ThematicData	ThematicData parameters
thematicOptions	ThematicOptions	ThematicOptions parameters
thematicColors	ThematicColors	ThematicColors parameters
token	string	Authentication token

Output

Code examples

getESRIThematicMap

Returns a thematic map based on ESRI-supplied variables. Coloring of each region is based on ESRI class breaks. See Map Image notes for more information on thematic mapping.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapArea	MapArea	MapArea parameters
mapImageOptions	MapImageOptions	MapImageOptions parameters. Must use one of the following thematic map data sources for the dataSource value: "ArcWeb:ESRI.DemographicsByBlockGroup.US" "ArcWeb:ESRI.DemographicsByCounty.US" "ArcWeb:ESRI.DemographicsByState.US" "ArcWeb:ESRI.DemographicsByTract.US" "ArcWeb:ESRI.DemographicsByZipCode.US" See Service Finder for details about these data sources.
thematicField	string	Use method getThematicFields for a list of valid values.
thematicOptions	ThematicOptions	ThematicOptions parameters
thematicColors	ThematicColors	ThematicColors parameters
token	string	Authentication token

Output

Code examples

getFusedMapImage

Returns a map URL based on two merged map images. The first map in your request appears as the bottom image, and the second map appears as the top image.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapFusionOptions	MapFusionOptions[]	MapFusionOptions parameters
outputImageformat	string	"png", "png8", "jpeg", or "gif"
token	string	Authentication token

Output

string

Code examples

getMaps

Returns map URLs for given map areas. The length of MapAreaand MapImageOptions arrays must match.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapAreas	MapArea[]	MapArea parameters
mapImageOptions	MapImageOptions[]	MapImageOptions parameters
token	string	Authentication token

Output

Code examples

getMarkerNames

Returns available icons for a given icon data source.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
iconDataSource	string	"ArcWeb:ESRI:Raster.Icons", "ArcWeb:ESRI.Simple.Icons", or "ArcWeb:User.Defined.Icons"
token	string	Authentication token

Output

string[]

Code examples

getSavedMap

Returns a map saved with method saveMap.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
savedMapID	string	ID of the saved map. The ID is returned from a successful method saveMap request.
token	string	Authentication token

Output

Code examples

getThematicFields

Returns a list of available fields for creating a thematic map with the method getESRIThematicMap. See Map Image notes for more information on thematic mapping.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
thematicDataSource	string	"ArcWeb:ESRI.DemographicsByBlockGroup.US" "ArcWeb:ESRI.DemographicsByCounty.US" "ArcWeb:ESRI.DemographicsByState.US" "ArcWeb:ESRI.DemographicsByTract.US" "ArcWeb:ESRI.DemographicsByZipCode.US" See Service Finder for details about these data sources.
token	string	Authentication token

Output

string[]

Code examples

getValueMap

Returns a value map based on user-supplied data that matches specific geography IDs. The user determines the color of each region. See Map Image notes for more information on thematic mapping.

Endpoint URL

http://www.arcwebservices.com/services/v2006_1/MapImage

Input

Name	Type	Valid values
mapArea	MapArea	MapArea parameters
mapImageOptions	MapImageOptions	MapImageOptions parameters. Must use one of the following thematic map data sources for the dataSource value: "ArcWeb:ESRI.Countries.World" "ArcWeb:ESRI.DemographicsByBlockGroup.US" "ArcWeb:ESRI.DemographicsByCBSA.US" "ArcWeb:ESRI.DemographicsByCongressionalDistrict.US" "ArcWeb:ESRI.DemographicsByCounty.US" "ArcWeb:ESRI.DemographicsByCountySubdivision.US" "ArcWeb:ESRI.DemographicsByPopulatedPlace.US" "ArcWeb:ESRI.DemographicsByState.US" "ArcWeb:ESRI.DemographicsByTract.US" "ArcWeb:ESRI.DemographicsByZipCode.US" See Service Finder for details about these data sources.
thematicData	ThematicData	ThematicData parameters
codeColorValues	KeyValue[]	key needs to match ThematicData.data value. value is any RGB color string.
thematicOptions	ThematicOptions	ThematicOptions parameters
token	string	Authentication token