Export (Network Diagrams)

URL:
https://<root>/<serviceName>/NetworkDiagramServer/diagrams/<diagramName>/map/export
Methods:
POST
Version Introduced:
10.6

Description

The export operation exports a map image that represents the diagram. It is performed on a Diagram Map resource. The result of this operation is a map image that represents the diagram specified in the URL.

Request parameters

ParameterDetails

gdbVersion

The name of the geodatabase version.

Syntax: gdbVersion=<version>

Example: gdbVersion=ABV1

moment

The session moment.

Syntax: moment=<moment>

Example: moment=1490867969324

size


(Required)

The size (width * height) of the exported image in pixels.

Syntax: size=<width>,<height>

Example: size=600,600

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.

Syntax: size=<width>,<height>

Example: size=600,600

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 bbox is not specified, the bbox is assumed to be in the spatial reference of the map.

format

The format of the exported image. The default format is .png.

Syntax: format=< PNG32 | PNG24 | PNG | JPG | DIB | TIFF | EMF | PS | PDF | GIF | SVG | SVGZ | BMP>

Example: format=pdf

transparent

A boolean statement that determines whether to export the image background with a transparent color.

  • true—The image will be exported with the background color of the map set as its transparent color.
  • false—This is the default. Only the .png and .gif formats support transparency. Internet Explorer 6 does not display transparency correctly for png24 image formats.

Syntax: transparent=< true | false>

Example: transparent=true

mapScale

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>

Example: mapScale=5000000

rotation

Use this parameter to export a map image rotated at a specific angle, with the map centered around the center of the specified bounding box (bbox). It could be a positive or negative number.

Syntax: rotation=<degree>

Example: rotation=90

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.

The bbox coordinates should always use a period as the decimal separator, even in countries where traditionally a comma is used.

Syntax: bbox= <xmin>,<ymin>,<xmax>,<ymax>

Example: bbox= -104,35.6,-94.32,41

f

The response format. The default response format is html.

Values: <html | json>

Example usage

Exporting the diagram map related to the DiagramTest1 diagram in version ABV1 into a .pdf file; that is:

  • URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/map/export

  • Parameters:

    Use dark colors for code blocksCopy
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    gdbVersion=ABV1
    moment=
    size=600,600
    dpi=
    imageSR=
    bboxSR=
    format=PDF
    transparent=
    mapScale=
    rotation=
    bbox=
    mapExtent=
    f=pjson
  • Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/map/export?gdbVersion=ABV1&moment=&size=600%2C600&dpi=&imageSR=&bboxSR=&format=PDF&transparent=&mapScale=&rotation=&bbox=&mapExtent=&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
 "href" : "< href >",
 "width" : < width >,
 "height" : < height >,
 "extent" : {
  <envelope>
 },
 "scale" : < scale >}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
 "href": "https://myserver.esri.com/server/rest/directories/arcgisoutput/Naperville/_ags_mapfbd81ca42315478dae1e746ae4cc6283.pdf",
 "width": 600,
 "height": 600,
 "extent": {
  "xmin": 1034202.2703259999,
  "ymin": 1871285.6644444999,
  "xmax": 1035043.9497449999,
  "ymax": 1872127.3438634998,
  "spatialReference": {
   "wkid": 102671,
   "latestWkid": 3435
  }
 },
 "scale": 1616.0244844798747
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.