API Reference: ArcGIS JavaScript Extension for Google Maps

Creates a new TiledMapServiceLayer from the ArcGIS Server REST resource identified by the url. The optional options argument is an object literal that specifies a set of TiledMapServiceLayerOptions.

Once it has finished loading the resource, the load event will be fired and the optional callback function will be invoked. Both the callback and the event handlers will receive a reference to this object that can be added to your map as a custom tile layer using the MapExtension.addToMap method.

Creates a new DynamicMapServiceLayer from the ArcGIS Server REST resource identified by the url. The optional parameters argument is an ImageParameters object that can be used to customize the image format, dpi and the layers to be shown. The opacity is given as a number between 0 and 1. If not given, the default is 1.

Once it has finished loading the resource, the load event will be fired and the optional callback function will be invoked. Both the callback and the event handlers will receive a reference to this object that can be added to your map using the GMap2.addOverlay method.

{
 "xmin" : <xmin>, "ymin" : <ymin>, "xmax" : <xmax>, "ymax" : <ymax>,
 "spatialReference" : { "wkid" : <wkid> }
}

However, if Config.geometryServiceUrl property is set, then it will be implicitly used to project the above extent to WGS 1984 Geographic Coordinate System (Well-Known ID = 4326).

Sends a request to the dynamic map service resource associated with this object to generate a map image using the ImageParameters specified in the parameters argument. (Since 1.2) If the parameters argument is not given, the generated map image will represent the current state of this layer.

On completion, the exportcomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a MapImage object.

var layerDefs = [];
layerDefs[0] = "POPULATION > 5000000";
layerDefs[5] = "AREA > 100000";
dynamicMapServiceLayer.setLayerDefinitions(layerDefs);

Note that the array indices 0 and 5 are valid layer IDs; POPULATION and AREA are valid attribute fields associated with the respective layers. Definition expressions for layers that are currently not visible will be ignored by the server. Use setVisibleLayers and setDefaultVisibleLayers methods to manipulate the visiblity of layers.

var imageParams = new esri.arcgis.gmaps.ImageParameters();
imageParams.layerDefinitions = [];
imageParams.layerDefinitions[0] = "POPULATION > 5000000";
imageParams.layerDefinitions[5] = "AREA > 100000";

Note that the array indices 0 and 5 are valid layer IDs; POPULATION and AREA are valid attribute fields associated with the respective layers. Definition expressions for layers that are not visible will be ignored by the server. Use layerIds and layerOption properties to manipulate the visiblity of layers.

Creates a new ImageServiceLayer from the ArcGIS Server REST resource identified by the url. The optional parameters argument is an ImageServiceParameters object that can be used to modify the image format, interpolation method, compression quality and band combination. The opacity is given as a number between 0 and 1. If not given, the default is 1.

Once it has finished loading the resource, the load event will be fired and the optional callback function will be invoked. Both the callback and the event handlers will receive a reference to this object that can be added to your map using the GMap2.addOverlay method.

{
 "xmin" : <xmin>, "ymin" : <ymin>, "xmax" : <xmax>, "ymax" : <ymax>,
 "spatialReference" : { "wkid" : <wkid> }
}

However, if Config.geometryServiceUrl property is set, then it will be implicitly used to project the above extent to WGS 1984 Geographic Coordinate System (Well-Known ID = 4326).

"esriImageServiceDataTypeElevation" - the elevation data type for elevation data.
"esriImageServiceDataTypeGeneric" - the generic data type for any data.
"esriImageServiceDataTypeRGB" - the RGB data type for RGB true color image.
"esriImageServiceDataTypeThematic" - the thematic data type for categorical data.

[
 {
   "min": <Number>,
   "max": <Number>,
   "mean": <Number>,
   "stddev": <Number>

 },
 ...
]

Sends a request to the image service resource associated with this object to generate a map image using the ImageServiceParameters specified in the parameters argument. If the parameters argument is not given, the generated map image will represent the current state of this layer.

On completion, the exportcomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a MapImage object.

"RSP_BilinearInterpolation" - resample pixel by bilinear interpolation.
"RSP_CubicConvolution" - resample pixel by cubic convolution.
"RSP_Majority" - resample pixel by majority value.
"RSP_NearestNeighbor" - resample pixel by nearest neighbor.

"RSP_BilinearInterpolation" - resample pixel by bilinear interpolation.
"RSP_CubicConvolution" - resample pixel by cubic convolution.
"RSP_Majority" - resample pixel by majority value.
"RSP_NearestNeighbor" - resample pixel by nearest neighbor.

Executes a query on the layer resource. The parameters argument is a Query object that specifies the attribute and spatial filters of the query.

On completion, the executecomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive the features matching your query in a FeatureSet object that gives you access to individual features in the resultset and their attributes and geometry. Instead, if you set the optional asGeoXml argument to true, a GGeoXml object representing the resultset in KML data format will be returned. Either way, you can add them to your map using MapExtension.addToMap method. However, with KML, you can view the matching features in the symbology set by the map author.

{
  "<fieldName1>" : "<fieldAlias1>",
  "<fieldName2>" : "<fieldAlias2>",
  "<fieldName3>" : "<fieldAlias3>"
}

For example,

{
  "ST" : "State Name",
  "POP2000" : "Population - 2000",
  "AREANAME" : "City Name"
}

esriGeometryPoint - A single element array of GMarker.
esriGeometryMultipoint - An array of GMarker objects.
esriGeometryPolyline - An array of GPolyline objects. Each element in the array represents a "path".
esriGeometryPolygon - An array of GPolygon objects. Each element in the array represents a "ring".

{
  "<fieldName1>" : <fieldValue1>,
  "<fieldName2>" : <fieldValue2>,
  "<fieldName3>" : <fieldValue3>

}

For example,

{
  "AREANAME" : "Lawrence",
  "STATE" : "KS",
  "CLASS" : "city",
  "AREALAND" : 28.111,
  "AREAWATER" : 0.586,
  "POP2000" : 80098,
  "MALES" : 39803,
  "FEMALES" : 40295
} 

Sends a request to the ArcGIS Server REST map service resource associated with this object to identify features based on the IdentifyParameters specified in the parameters argument.

On completion, the executecomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive an IdentifyResults object that gives you access to the features identified and the layers these features were found in. You can add the results to your map using MapExtension.addToMap method.

Sends a request to the ArcGIS Server REST map service resource associated with this object to perform a search based on the FindParameters specified in the parameters argument.

On completion, the executecomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a FindResults object that gives you access to the features (their attributes and geometry), layers and fields matching the search criteria. You can add the result collection to your map using MapExtension.addToMap method.

{
  Street: "380 New York Street",
  City: "Redlands",
  State: "CA",
  Zone: "92373"
}

The optional outFields argument specifies an array of attribute field names to be included in the returned resultset. For non-intersection addresses you can specify the candidate fields from the geocode service resource. For intersection addresses you can specify the intersection candidate fields from the geocode service resource. Note that the shape field is ignored. If this argument is not specified, then the resultset will not have any attribute fields.

On completion, the addresstolocationscomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive an AddressResults object that contains the candidates that matched the given address as well as their scores. Instead, if you set the optional asGeoXml argument to true, a GGeoXml object representing the candidates in KML data format will be returned. Either way, you can add them to your map using MapExtension.addToMap method.

Sends a request to the ArcGIS Server REST geocode resource associated with this locator to find the address closest to the given point, and within the specified search distance.

On completion, the locationtoaddresscomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive an AddressCandidate object that contains the address fields pertaining to the reverse geocoded address as well as its exact location. Instead, if you set the optional asGeoXml argument to true, a GGeoXml object representing the address in KML data format will be returned. Either way, you can add them to your map using MapExtension.addToMap method.

{
  "<fieldName1>" : <value1>,
  "<fieldName2>" : <value2>,
  "<fieldName3>" : <value3>

}

For example,

{
  "StreetName1" : "MARKET",
  "Type1" : "ST",
  "LeftZone1" : "94103",
  "StreetName2" : "STOCKTON",
  "Type2" : "ST",
  "LeftZone2" : "94108"
}

Performs a solve operation on the network layer resource associated with this object. The parameters argument is an instance of RouteParameters class that provides arguments to the solve route operation.

On completion, the solvecomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a RouteResults object.

• Features: Barrier geometries and attributes expressed as a feature set.
• Layer: Barriers reference a data layer in the map service.

For example, set impedanceAttribute to "Time" for the fastest route or "Length" for the shortest route, assuming the service has those two cost attributes.

• Features: Stop geometries and attributes expressed as a feature set. If you want to solve multiple routes, you can provide a RouteName attribute for each stop in such a way that stops belonging to a specific route have identical route names.
• Layer: Stops reference a data layer in the map service. Attribute and spatial filters can also be applied on the layer.

text - The direction text.
length - The length of the route segment.
time - The time to travel along the route segment.
ETA - The estimated time of arrival at the route segment, represented in milliseconds since midnight Jan 1, 1970 in the local time of the first stop.
maneuverType - The type of maneuver that the direction represents.

See here for the list of maneuver types.

Input_Points (GPFeatureRecordSetLayer)
Distance (GPLinearUnit)
Drive_Times_in_Minutes (GPString)
Contour_Interval (GPDouble)

The parameters argument for the above inputs is an object literal of the form:

{
 Input_Points: <FeatureSet>,
 Distance: <LinearUnit>,
 Drive_Times_in_Minutes: <String>,
 Contour_Interval: <Number>
}

On completion, the executecomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a GPResults object that gives you access to the result parameters and the task execution messages. Instead, if you set the optional asGeoXml argument to true, a GGeoXml object representing the resultset in KML data format will be returned. Either way, you can add them to your map using MapExtension.addToMap method. However, with KML, you can view the results in the symbology set by the map author.

Submits a job to the GP Task resource associated with this object for asynchronous processing. The parameters argument is an object literal that specifies the input parameters accepted by the task and their corresponding values. The structure of this argument is same as that described in execute() method.

Once the job is submitted and until it is completed, the jobstatusupdate event will be fired and the optional statusCallback function will be invoked at regular intervals, the duration of which is specified by the GeoprocessorOptions.statusUpdateInterval property. Both the statusCallback and event handlers will receive a JobInfo object that provides basic information about the job such as the job ID, status and messages.

On job completion, the jobcomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a JobInfo object. The task execution results can be retrieved using getResultData(), getResultImage() or getResultImageLayer() methods.

Sends a request to the GP Task resource associated with this object to get the current state of the job identified by jobId.

Upon receiving the response, the jobstatusupdate event will be fired and the optional callback function will be invoked with a JobInfo object that contains the status information.

Sends a request to the GP Task resource associated with this object to get the task result identified by jobId and resultParameterName.

On completion, the getresultdatacomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a ParameterValue whose structure is based on its data type. Instead, if you set the optional asGeoXml argument to true, a GGeoXml object representing the result in KML data format will be returned. Either way, you can add them to your map using MapExtension.addToMap method. However, with KML, you can view the results in the symbology set by the map author.

Sends a request to the GP Task resource associated with this object to get the task result identified by jobId and resultParameterName as an image. The optional parameters argument is an ImageParameters object that specifies the properties of the result image.

On completion, the getresultimagecomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a MapImage object.

The value of the parameter. The data structure of this value depends on the dataType.

Creates buffer polygons to a specified distance around the given geometries. A buffer is defined as the area within a specified distance around a geometry. The parameters argument is a BufferParameters object that specifies the input geometries, buffer distance and other options.

On completion, the buffercomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a BufferResults object that contains the buffer polygons. You can add them to your map using MapExtension.addToMap method.

Projects a set of geometries into a new spatial reference. The parameters argument is a ProjectParameters object that specifies the input geometries, in/out spatial references and other options.

On completion, the projectcomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a ProjectResults object that contains the projected geometries. You can add them to your map using MapExtension.addToMap method if parameters.outSpatialReference is 4326 (WGS 1984).

Alters the given geometries to make their definitions topologically legal with respect to their geometry type. The geometries argument is an array of array of GLatLng objects (GLatLng[ ][ ]) or an array of array of GPolyline objects (GPolyline[ ][ ]) or an array of array of GPolygon objects (GPolygon[ ][ ]).

On completion, the simplifycomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive a SimplifyResults object that contains the simplified geometries. You can add them to your map using MapExtension.addToMap method.

(Since 1.1) Calculates areas and perimeter lengths for the given polygons. The polygons argument is an array of array of GPolygon objects (GPolygon[ ][ ]) representing an array of ArcGIS Polygon geometry.

On completion, the areasandlengthscomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive an object that contains the areas (in square meters) and perimeter lengths (in meters) for each ArcGIS Polygon (see areasandlengthscomplete event for the more information on this object).

(Since 1.1) Calculates the lengths for the given polylines. The polylines argument is an array of array of GPolyline objects (GPolyline[ ][ ]) representing an array of ArcGIS Polyline geometry.

On completion, the lengthscomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive an object that contains the lengths (in meters) for each ArcGIS Polyline (see lengthscomplete event for the more information on this object).

(Since 1.2) Calculates an optimum, interior point for the given polygons that can be used for label placement. The polygons argument is an array of array of GPolygon objects (GPolygon[ ][ ]) representing an array of ArcGIS Polygon geometry.

On completion, the labelpointscomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive an object that contains the label points for each ArcGIS Polygon (see labelpointscomplete event for the more information on this object).

(Since 1.2) Determines the pairs of geometries from the input geometry arrays that participate in the specified spatial relation. The parameters argument is a RelationParameters object that specifies the arguments to the relation operation.

On completion, the relationcomplete event will be fired and the optional callback function will be invoked. Both the callback and event handlers will receive an object that contains the geometry pairs for which the specified relation is true (see relationcomplete event for the more information on this object).

{
  areas: [ <area1>, <area2>, ... ],
  lengths: [ <length1>, <length2>, ... ]
}

where the areas are measured in square meters and the lengths are measured in meters. The second argument is an Error object that will be available in case there was an error.

{
  lengths: [ <length1>, <length2>, ... ]
}

where the lengths are measured in meters. The second argument is an Error object that will be available in case there was an error.

{
  labelPoints: [ <GMarker1>, <GMarker2>, ... ]
}

The second argument is an Error object that will be available in case there was an error.

{
  relations: [
    { geometry1Index: <geometry1Index1>, geometry2Index: <geometry2Index1> },
    { geometry1Index: <geometry1Index2>, geometry2Index: <geometry2Index2> }
  ]
}

where geometry1Index is the index of the geometry in the base array and geometry2Index is the index of the geometry in the comparison array -- together they represent the geometry pair for which the specified relation is true. The second argument is an Error object that will be available in case there was an error.

[
 {
  "x" : <x>, "y" : <y>
 },
 ...
]

representing an array of points, or

[
 {
  "points" : [ [<x1>, <y1>], [<x2>, <y2>] ]
 },
 ...
]

representing an array of multipoints, or

[
 {
  "paths" : [ 
   [ [<x11>, <y11>], [<x12>, <y12>] ], 
   [ [<x21>, <y21>], [<x22>, <y22>] ]
  ]
 },
 ...
]

representing an array of polylines, or

[
 {
   "rings" : [ 
    [ [<x11>, <y11>], [<x12>, <y12>], ..., [<x11>, <y11>] ], 
    [ [<x21>, <y21>], [<x22>, <y22>], ..., [<x21>, <y21>] ]
   ]
 },
 ...
]

representing an array of polygons.

The geometries projected in the spatial reference specified when initiating the project operation. The value of this property depends on the type of geometries passed as input to the Geometry.project method (via ProjectParameters.geometries property), and the spatial reference to which the geometries are projected (specified via ProjectParameters.outSpatialReference).

[
 {
  "points" : [ [<x1>, <y1>], [<x2>, <y2>] ],
  "spatialReference" : { "wkid" : <wkid> }
 },
 ...
]

[
 {
  "paths" : [ 
   [ [<x11>, <y11>], [<x12>, <y12>] ], 
   [ [<x21>, <y21>], [<x22>, <y22>] ]
  ],
  "spatialReference" : { "wkid" : <wkid> }
 },
 ...
]

[
 {
  "rings" : [ 
   [ [<x11>, <y11>], [<x12>, <y12>], ..., [<x11>, <y11>] ], 
   [ [<x21>, <y21>], [<x22>, <y22>], ..., [<x21>, <y21>] ]
  ],
  "spatialReference" : { "wkid" : <wkid> }
 },
 ...
]

Note: 4326 is the Well-Known ID (wkid) of the Geographic Coordinate System that uses WGS 1984 datum.

The simplified (topologically legal) geometries as an array of array of GOverlays. Each element of the array can be a marker, polyline or polygon based on the geometries passed as input to the Geometry.simplify method.

Adds the overlays corresponding to the given ArcGIS features or results to the map. The results argument can be an instance of one of the following classes: FeatureSet, Feature, FindResults, FindResult, IdentifyResults, IdentifyResult, AddressResults, AddressCandidate, GPResults, ParameterValue, BufferResults, ProjectResults, SimplifyResults, TiledMapServiceLayer, GGeoXml.

The optional overlayOptions argument can be used to customize the user interface and other visual aspects of the overlays. By Default, the fill and stroke styles defined in Config are used.

The optional infoWindowOptions argument can be used to specify the content to be displayed in the infowindow when the overlays are clicked. By default, each overlay added to the map has an infowindow that displays all the attributes (and their values) pertaining to the associated ArcGIS feature or result.

This method returns an array of array of overlays that were added to the map, so that they can be later removed by calling the removeFromMap() method. Each element in the outer array represents an ArcGIS feature and each element in the inner array represents a part of that feature. For example, a polygon feature is made up of mulitple rings. Hawaii, for instance, is one feature that contains multiple islands (rings).

This string will appear as tooltip on the marker, i.e. it will work just as the title attribute on HTML elements. In addition, it can contain special embedded strings of the form {ATTRIBUTE_NAME} that will be substituted with values obtained from the ArcGIS feature or result associated with the marker.

For example, an attribute named WELLID with a value of 14 can be shown as a tooltip by providing this templated string:
Well ID: {WELLID}
The content that is displayed will be, Well ID: 14

Specifies the HTML content to be shown when the infowindow is displayed. It can contain special embedded strings of the form {ATTRIBUTE_NAME} that will be substituted with values obtained from the ArcGIS feature or result associated with the infowindow.

For example, an attribute named WELLID with a value of 14 can be shown in the infowindow by providing this templated string:
<b>Well ID:</b> {WELLID}
The content that is displayed in the infowindow will be, Well ID: 14

[
 {
   label:"tab 1 title", content:"tab 1 html content"
 },
 {
   label:"tab 2 title", content:"tab 2 html content"
 }
]

Each element in the array shown above is an object literal representation of the GInfoWindow class, and contains two properties: content defines the content of the infowindow when the tab is selected, and label defines the label of the tab. The properties can also have special embedded strings that will be substituted with attribute values from the associated ArcGIS feature or result.

If the web service supports query parameters, you should pass them using the optional parameters argument. It is an object literal of the form:

{
  parameterName1: "a string",
  parameterName2: true | false,
  parameterName3: <Number>,
  parameterName4: <Array>,
  parameterName5: {
    anotherParameter: "a string"
  }
}

Note that any parameter that has a value of undefined, null or "" (an empty string) will be ignored.
The options argument can be used to configure certain aspects of the request and as the name indicates, all properties are optional. It is simply an object literal that supports the following properties:

{
  callbackParamName: "<String>"
}

callbackParamName - specifies the query parameter name that will be used to send the name of the callback function. For ArcGIS Server REST services, the parameter name should be "callback". Default is "callback".