- URL:https:// <schDiagramMap-url>/export
- Version Introduced:10.1
Description
The Schematic Export operation is performed on a schematic diagram map resource. The result of this operation is a map image that represents the <diagId> diagram specified in the URL.
You can provide arguments to the Schematic Export operation as query parameters. For a schematic diagram map, all of the export parameters are optional; moreover, the layers and layersDefparameters will always be ignored. The parameter details are provided in the parameters table below.
Request parameters
| Parameter | Details |
|---|---|
| f | 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 | 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. Note:When the bbox parameter is not specified, the extent of the diagram is the one used by default for the exported image. Syntax: bbox=<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 | 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: size=<width>, <height> Example: size=600,550 |
| dpi | 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 | 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 | 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 bboxis assumed to be in the spatial reference of the map. |
| format | The format of the exported image. The default format is png. Values: png | png8 | png24 | jpg | pdf | bmp | gif | svg | png32 |
| layerDefs | Parameter kept for compatibility reason with the standard Export Map operation, but this parameter is always ignored when the export is performed on a schematic diagram map. |
| layers | Parameter kept for compatibility reason with the standard Export Map operation, but this parameter is always ignored when the export is performed on a schematic diagram map. |
| transparent | 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 | 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 | 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 | Use dynamicLayers parameter to modify the layer drawing order, change layer renderer, define joins, change layer 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 dynamicLayersarray draws on top of all other layers. Note:
Syntax: Example: |
Example usage
The exported schematic diagram map related to the schematic diagram which id is '2-10' under the S1_Schematics public sample Schematics service:
https://servicesbeta6.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/diagrams/2-10/map/export?size=&dpi=&imageSR=&bboxSR=&format=&transparent=&time=&layerTimeOptions=&dynamicLayers=&bbox=&layerDefs=&layers=&f=htmlJSON Response syntax
{"href" : "<href>","width" : <width>,"height" : <height>,"extent" : {<envelope>},"scale" : <scale>}
JSON Response example
{
"href": "https://TAHITI:6080/arcgis/server/arcgisoutput/_ags_mape0a1ae3e0f794071aafec2720bf6a1f8.png",
"width": 400,
"height": 400,
"extent": {
"xmin": -37.479462999999996,
"ymin": -11.419442999999998,
"xmax": -37.012996999999999,
"ymax": -10.952976999999999,
"spatialReference": { "wkid": 4326, "latestWkid": 4326}
},
"scale": 490096.28531108255
}