Export Map
- URL:http:// <mapservice-url>/export
- Required Capability:Map
- Version Introduced:9.3
Description
The export operation is performed on a map service resource. The result of this operation is a map image resource. This resource provides information about the exported map image such as its URL, its width and height, extent and scale.
Apart from the usual response formats of html and json, users can also request a format called image while performing this operation. When users perform an export with the format of image, the server responds by directly streaming the image bytes to the client. One must note that with this approach you don't get any information associated with the exported map other than the actual image.
Note that the extent displayed in the exported map image may not exactly match the extent sent in the bbox parameter when the aspect ratio of the image size does not match the aspect ratio of thebbox. The aspect ratio is the height divided by the width. In these cases the extent is re-sized to prevent map images from appearing stretched. The exported map's extent is sent along with the json and html responses and may be used in client side calculations. So it is important that the client-side code update its extent based on the response.
New in 10.1
- Support for dynamic layers was added with the dynamicLayers parameter. If dynamicLayers is used in an export operation request, then layerDefs, layers, and layerTimeOptions (export operation) parameters are ignored. Instead, use definitionExpression and layerTimeOptions available within dynamicLayers to specify these values in the export operation. Only those layers that are defined in dynamicLayers are used in the export operation. Layer drawing order is based on the order of dynamicLayer elements in the dynamicLayers array, the first dynamicLayer is drawn on top of the second dynamicLayer.
- gdbVersion parameter was introduced. Use this parameter to specify the geodatabase version.
- mapScale parameter was introduced. Use this parameter to export a map image at a specific scale, with the map centered around the center of the specified bounding box (bbox).
- If map service resource lists hasLiveData to be true, export operations will default the value for time parameter to be [<current server time - defaultTimeWindow>, <current server time>].
New in 10.0
- Support for exporting maps based on time was added at 10.0. For time-aware map services, users can use the time parameter to specify the time instant or the time extent for which to export the map. Users can also control time-based behavior on a per-layer basis by using the layerTimeOptions parameter.
- layerDefs supports using JSON representation for layer defintions.
Users can provide arguments to the export operation as query parameters. These parameters include the request extent, size information, layer information, transparency etc. The parameter details are provided in the parameters table below.
Request Parameters
Parameter |
Details |
---|---|
f |
Description: The response format. The default response format is html. If the format is image, the image bytes are directly streamed to the client. Values: html | json | image | kmz |
bbox | Description: (Required) The extent (bounding box) of the exported image. Unless the bboxSR parameter has been specified, the bbox is assumed to be in the spatial reference of the map. Syntax: <xmin>, <ymin>, <xmax>, <ymax> Example: bbox=-104,35.6,-94.32,41 The bbox coordinates should always use a period as the decimal separator even in countries where traditionally a comma is used. |
size | Description: The size width *height) of the exported image in pixels. If the size is not specified, an image with a default size of 400 * 400 will be exported. Syntax: <width>, <height> Example: size=600,550 |
dpi | Description: The device resolution of the exported image (dots per inch). If the dpi is not specified, an image with a default DPI of 96 will be exported. Example: dpi=200 |
imageSR | Description: The spatial reference of the exported image. The spatial reference can be specified as either a well-known ID or as a spatial reference json object. If the imageSR is not specified, the image will be exported in the spatial reference of the map. |
bboxSR |
Description: The spatial reference of the bbox. The spatial reference can be specified as either a well-known ID or as a spatial reference json object. If the bboxSR is not specified, the bbox is assumed to be in the spatial reference of the map. |
format | Description: The format of the exported image. The default format is .png. Values: png | png8 | png24 | jpg | pdf | bmp | gif | svg | svgz | emf | ps | png32 Note: Support for the png32 format was added at 9.3.1. This format is only available for map services whose supportedImageFormatTypes property includes PNG32. |
layerDefs | Description: Allows you to filter the features of individual layers in the exported map by specifying definition expressions for those layers. Definition expression for a layer that is published with the service will be always honored. Simple Syntax: Syntax: layerId1:layerDef1;layerId2:layerDef2 Where layerId1, layerId2 are the layer ids returned by the map service resource. Example: 0:POP2000 > 1000000;5:AREA > 100000 JSON Syntax (new in 10.0): You can also use a JSON representation for Layer Definitions. Syntax: { "<layerId1>" : "<layerDef1>" , "<layerId2>" : "<layerDef2>" } Where layerId1, layerId2 are the layer ids returned by the map service resource. Example: {"0":"POP2000 > 1000000","5":"AREA > 100000"} |
layers | Description: Determines which layers appear on the exported map. There are four ways to specify which layers are shown:
Syntax: [show | hide | include | exclude]:layerId1,layerId2 Where layerId1, layerId2 are the layer ids returned by the map service resource. Example: layers=show:2,4,7 |
transparent | Description: If true, the image will be exported with the background color of the map set as its transparent color. The default is false. Only the .png and .gif formats support transparency. Internet Explorer 6 does not display transparency correctly for png24 image formats. Values: true | false |
time |
Description: The time instant or time extent of the exported map image. Time instant: Syntax: time=<timeInstant> Example: time=1199145600000 (1 Jan 2008 00:00:00 GMT) Time extent: Syntax: time=<startTime>, <endTime> Example: time=1199145600000, 1230768000000 (1 Jan 2008 00:00:00 GMT to 1 Jan 2009 00:00:00 GMT) A null value specified for start time or end time will represent infinity for start or end time respectively. |
layerTimeOptions | Description: The time options per layer. Users can indicate whether or not the layer should use the time extent specified by the time parameter or not, whether to draw the layer features cumulatively or not and the time offsets for the layer. Syntax:
Example:
|
dynamicLayers | //This option was added at 10.1. Description: Use dynamicLayers parameter to modify the layer drawing order, change layer drawing info, and change layer data source version for this request. New layers (dataLayer) can also be added to the dynamicLayers based on the map service registered workspaces. The order of dynamicLayers array defines the layer drawing order. The first element of the dynamicLayers array draws on top of all other layers. Note:
Syntax:
Example:
|
gdbVersion | //This option was added at 10.1. Description: Use this parameter to specify the geodatabase version. Syntax: gdbVersion=<geodatabase version> Example: gdbVersion=sde.USER1 |
mapScale | //This option was added at 10.1. Description: Use this parameter to export a map image at a specific scale, with the map centered around the center of the specified bounding box (bbox). Syntax: mapScale=<scale> Examples: mapScale=5000000, mapScale=5E6 |
Example Usage
Example 1: Export a map. Include only the bounding box.
Example 2: Export a map. Change imageSR to 102004 (USA_Contiguous_Lambert_Conformal_Conic projection):
Example 3: Export a map. Change imageSR to 102004 (USA_Contiguous_Lambert_Conformal_Conic projection), image size to a width and height of 800x600, format to .gif, and transparent to false.
Example 4: Export the same map as above but change the output format to pretty json (f=pjson).
Example 5: Export a map with dynamic layers. Update an existing map layer symbology.
JSON Response Syntax
{"href" : "<href>","width" : <width>,"height" : <height>,"extent" : {<envelope>},"scale" : <scale>}
JSON Response Example
{"href" : "http://atlantic/arcgisoutput/_ags_map42ef5eae899942a9b564138e184a55c9.png","width" : 400,"height" : 400,"extent" : { "xmin" : -109.55, "ymin" : 25.76, "xmax" : -86.39, "ymax" : 49.94, "spatialReference" : {"wkid" : 4326, "latestWkid" : 4326}},"scale" : 2.53E7}