FRAMES | NO FRAMES | Description | Parameters | Examples | Response |
URL | http://<mapservice-url>/export |
---|---|
Parent Resource | Map Service |
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
the bbox
. 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.
Support for exporting maps based on time was added at 10.
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.
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.
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 | Required Description: 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 | 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):You can also use a JSON representation for Layer Definitions.Syntax: { "<layerId1>" : "<layerDef1>" , "<layerId2>" : "<layerDef2>" } 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
resourceExample: 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 the 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: { "<layerId1>" : { //If { "0" : { "useTime" : true, "timeDataCumulative" : false, "timeOffset" : 1, "timeOffsetUnits" : "esriTimeUnitsYears" }, "3" : { "useTime" : false } } |
Example 1: Export a map. Include only the bounding box:
http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/export?bbox=-127.8,15.4,-63.5,60.5Example 2: Export a map. Change imageSR to 102004 (USA_Contiguous_Lambert_Conformal_Conic projection):
http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/export?bbox=-127.8,15.4,-63.5,60.5&bboxSR=&layers=&size=&imageSR=102004&format=&transparent=false&dpi=&f=htmlExample 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 true.
http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/export?bbox=-115.8,30.4,-85.5,50.5&bboxSR=&layers=&size=800,600&imageSR=102004&format=gif&transparent=false&dpi=&f=htmlExample 4: Export the same map as above but change the output format to pretty json (f=pjson).
http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer/export?bbox=-115.8,30.4,-85.5,50.5&bboxSR=&layers=&size=800,600&imageSR=102004&format=gif&transparent=false&dpi=&f=pjson{
"href" : "<href>",
"width" : <width>,
"height" : <height>,
"extent" : {<envelope>},
"scale" : <scale>
}
{
"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}
},
"scale" : 2.53E7
}