googlemaps-v3-utility-library
Version:
Google Maps API V3 Utility Library
4,788 lines • 175 kB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>ArcGIS Server Link for Google Maps JavaScript API V3 v1.0 Reference</title>
<link rel="stylesheet" type="text/css" href="http://code.google.com/css/codesite.css"></link>
<link rel="stylesheet" type="text/css" href="../../util/docs/template/local_extensions.css"></link>
</head>
<body>
<h1>ArcGIS Server Link for Google Maps JavaScript API V3</h1>
<p>
<p><a href="examples.html">Examples</a>
</p>
<p>This library lets you add map resources accessible via
<a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/index.html'>
ESRI ArcGIS Server™ REST API</a> into <a
href='http://code.google.com/apis/maps/documentation/javascript/'>
Google Maps API V3</a> and provide some additional support for map tiles created
with different spatial reference and tiling scheme.</p>
</p>.
<table>
<tr>
<td style = 'width:200px'>
<code><a href="reference.html#TileLayer">TileLayer</a></code><br/>
<code><a href="reference.html#TileLayerOptions">TileLayerOptions</a></code><br/>
<code><a href="reference.html#MapType">MapType</a></code><br/>
<code><a href="reference.html#MapTypeOptions">MapTypeOptions</a></code><br/>
<code><a href="reference.html#MapOverlay">MapOverlay</a></code><br/>
<code><a href="reference.html#MapOverlayOptions">MapOverlayOptions</a></code><br/>
<code><a href="reference.html#Projection">Projection</a></code><br/>
</td>
<td style = 'width:200px'>
<code><a href="reference.html#Catalog">Catalog</a></code><br/>
<code><a href="reference.html#MapService">MapService</a></code><br/></b>
<code><a href="reference.html#Layer">Layer</a></code><br/>
<code><a href="reference.html#GeocodeService">GeocodeService</a></code><br/>
<code><a href="reference.html#GeometryService">GeometryService</a></code><br/>
<code><a href="reference.html#GPService">GPService</a></code><br/>
<code><a href="reference.html#GPTask">GPTask</a></code><br/>
<code><a href="reference.html#RouteTask">RouteTask</a></code><br/>
<br/></td>
<td style = 'width:200px'>
<code><a href="reference.html#SpatialReference">SpatialReference</a></code><br/>
<code><a href="reference.html#Geographic">Geographic</a></code><br/>
<code><a href="reference.html#LambertConformalConic">LambertConformalConic</a></code><br/>
<code><a href="reference.html#TransverseMercator">TransverseMercator</a></code><br/>
<code><a href="reference.html#SphereMercator">SphereMercator</a></code><br/>
<code><a href="reference.html#Albers">Albers</a></code><br/>
<code><a href="reference.html#SpatialRelationship">SpatialRelationship</a></code><br/>
</td>
<td style = 'width:200px'>
<code><a href="reference.html#Util">Util</a></code> <br/>
<code><a href="reference.html#Config">Config</a></code> <br/>
<code><a href="reference.html#Error">Error</a></code> <br/>
</td>
</tr></table>
<p> There are many objects used in the REST API that do not require
a constructor and can be
used just as object literal in the operation:</p>
<table><tr>
<td style = 'width:200px'>
<code><a href="reference.html#Field">Field</a></code><br/>
<code><a href="reference.html#TileInfo">TileInfo</a></code><br/>
<code><a href="reference.html#LOD">LOD</a></code><br/>
<code><a href="reference.html#ExportMapOptions">ExportMapOptions</a></code><br/>
<code><a href="reference.html#MapImage">MapImage</a></code><br/>
<code><a href="reference.html#IdentifyOptions">IdentifyOptions</a></code><br/>
<code><a href="reference.html#IdentifyResults">IdentifyResults</a></code><br/>
<code><a href="reference.html#IdentifyResult">IdentifyResult</a></code><br/>
<br/></td>
<td style = 'width:200px'>
<code><a href="reference.html#QueryOptions">QueryOptions</a></code><br/>
<code><a href="reference.html#ResultSet">ResultSet</a></code><br/>
<code><a href="reference.html#FindOptions">FindOptions</a></code><br/>
<code><a href="reference.html#FindResults">FindResults</a></code><br/>
<code><a href="reference.html#FindResult">FindResult</a></code><br/>
<code><a href="reference.html#Feature">Feature</a></code><br/>
</td>
<td style = 'width:200px'>
<code><a href="reference.html#GeocodeOptions">GeocodeOptions</a></code><br/>
<code><a href="reference.html#GeocodeResults">GeocodeResults</a></code><br/>
<code><a href="reference.html#GeocodeResult">GeocodeResult</a></code><br/>
<code><a href="reference.html#ReverseGeocodeOptions">ReverseGeocodeOptions</a></code><br/>
<code><a href="reference.html#ReverseGeocodeResult">ReverseGeocodeResult</a></code><br/>
<code><a href="reference.html#BufferOptions">BufferOptions</a></code><br/>
<code><a href="reference.html#BufferResults">BufferResults</a></code><br/>
<code><a href="reference.html#ProjectOptions">ProjectOptions</a></code><br/>
<code><a href="reference.html#ProjectResults">ProjectResults</a></code><br/>
</td>
<td style = 'width:200px'>
<code><a href="reference.html#RouteOptions">RouteOptions</a></code><br/>
<code><a href="reference.html#RouteResults">RouteResults</a></code><br/>
</td>
</tr></table></p>
<p>For a description and examples of how to use this library, check out the <a href="examples.html">how-to</a>.</p>
<h2><a name="Albers"></a>class Albers</h2>
<p>This class (<code>Albers</code>) represents a Spatial Reference System based on <a target=wiki href = 'http://en.wikipedia.org/wiki/Albers_projection'>Albers Projection</a>. This class extends <code><a href="reference.html#SpatialReference">SpatialReference</a></code>.</p>
<h3>Constructor</h3>
<table summary="class Albers - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>Albers(<span class="type">params:Object</span>)</code></td>
<td>Create a Albers Equal-Area Conic Projection based Spatial Reference. The <code>params</code> passed in construction should
include the following properties:<code>
<br/>-wkid: well-known id
<br/>-semi_major: ellipsoidal semi-major axis in meter
<br/>-unit: meters per unit
<br/>-inverse_flattening: inverse of flattening of the ellipsoid where 1/f = a/(a - b)
<br/>-standard_parallel_1: phi1, latitude of the first standard parallel
<br/>-standard_parallel_2: phi2, latitude of the second standard parallel
<br/>-latitude_of_origin: phi0, latitude of the false origin
<br/>-central_meridian: lamda0, longitude of the false origin (with respect to the prime meridian)
<br/>-false_easting: FE, false easting, the Eastings value assigned to the natural origin
<br/>-false_northing: FN, false northing, the Northings value assigned to the natural origin
</code>
<br/> e.g.
<code> var albers = new Albers({wkid:9999, semi_major: 6378206.4,inverse_flattening: 294.9786982,
standard_parallel_1: 29.5, standard_parallel_2: 45.5,
central_meridian: -96.0, latitude_of_origin: 23,false_easting: 0,
'false_northing': 0, unit: 1 }); </code></td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class Albers - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>forward(<span class="type">lnglat:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="even">
<td><code>getCircum()</code></td>
<td><code>number</code></td>
<td>See <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="odd">
<td><code>inverse(<span class="type">coords:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="BufferOptions"></a>class BufferOptions</h2>
<p>This class represent the parameters needed in an buffer operation
for a <code><a href="reference.html#GeometryService">GeometryService</a></code>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class BufferOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>bufferSpatialReference</code></td>
<td><code>SpatialReference</code></td>
<td>The well-known ID of or the <code><a href="reference.html#SpatialReference">SpatialReference</a></code> of the buffer geometries</td>
</tr>
<tr class="even">
<td><code>distances</code></td>
<td><code>Array.number</code></td>
<td>The distances the input geometries are buffered.</td>
</tr>
<tr class="odd">
<td><code>geometries</code></td>
<td><code>Array.OverlayView|Array.object</code></td>
<td>Array of <code>google.maps.LatLng</code>, <code>Polyline</code>, <code>Polygon</code>, or ESRI Geometry format to buffer.</td>
</tr>
<tr class="even">
<td><code>overlayOptions</code></td>
<td><code>OverlayOptions</code></td>
<td>how to render result overlay. See <code><a href="reference.html#OverlayOptions">OverlayOptions</a></code></td>
</tr>
<tr class="odd">
<td><code>unionResults</code></td>
<td><code>Boolean</code></td>
<td>If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array.</td>
</tr>
<tr class="even">
<td><code>unit</code></td>
<td><code>Number</code></td>
<td>see <a href='http://resources.esri.com/help/9.3/ArcGISDesktop/ArcObjects/esriGeometry/esriSRUnitType.htm'>esriSRUnitType Constants </a> .</td>
</tr>
</tbody>
</table>
<h2><a name="BufferResults"></a>class BufferResults</h2>
<p>This class represent the parameters needed in an project operation
for a <code><a href="reference.html#GeometryService">GeometryService</a></code>.
There is no constructor, use JavaScript object literal.</p>
<h3>Properties</h3>
<table summary="class BufferResults - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>geometries</code></td>
<td><code>Array.OverlayView|Array.object</code></td>
<td>Array of <code>google.maps.LatLng, Polyline, Polygon</code>, or ESRI Geometry format to project.</td>
</tr>
</tbody>
</table>
<h2><a name="Catalog"></a>class Catalog</h2>
<p>The catalog resource is the root node and initial entry point into an ArcGIS Server host.
This resource represents a catalog of folders and services published on the host.</p>
<h3>Constructor</h3>
<table summary="class Catalog - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>Catalog(<span class="type">url:String</span>)</code></td>
<td>Create a ArcGIS service catalog instance using it's url:<code> http://<host>/<instance>/rest/services</code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table summary="class Catalog - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>currentVersion</code></td>
<td><code>String</code></td>
<td>currentVersion</td>
</tr>
<tr class="even">
<td><code>folders</code></td>
<td><code>Array.string</code></td>
<td>folders list</td>
</tr>
<tr class="odd">
<td><code>services</code></td>
<td><code>Array.string</code></td>
<td>list of services. Each has <code>name, type</code> property.</td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="class Catalog - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>load</code></td>
<td><code>None</code></td>
<td>This event is fired when the catalog info is loaded.</td>
</tr>
</tbody>
</table>
<h2><a name="Config"></a>class Config</h2>
<p>This is an object literal that sets common configuration values used across the lib.</p>
<h3>Properties</h3>
<table summary="class Config - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>alwaysUseProxy</code></td>
<td><code>Boolean</code></td>
<td>whether to always use proxy page when send request to server.</td>
</tr>
<tr class="even">
<td><code>proxyUrl</code></td>
<td><code>String</code></td>
<td>The URL to the web proxy page used in case the length of the URL request to an ArcGIS Server REST resource exceeds 2000 characters.</td>
</tr>
</tbody>
</table>
<h2><a name="CopyrightControl"></a>class CopyrightControl</h2>
<p>put a copyright notice at bottom rigth corner.</p>
<h3>Constructor</h3>
<table summary="class CopyrightControl - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>CopyrightControl(<span class="type">map:google.maps.Map</span>)</code></td>
<td>Creates a copyright control</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class CopyrightControl - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>refresh()</code></td>
<td><code>None</code></td>
<td>refresh copyright text</td>
</tr>
</tbody>
</table>
<h2><a name="Error"></a>class Error</h2>
<p>Error returned from Server.
Syntax:
<pre>
{
"error" :
{
"code" : 500,
"message" : "Object reference not set to an instance of an object.",
"details" : [
"'geometry' parameter is invalid"
]
}
}
</pre></p>
<h2><a name="ExportMapOptions"></a>class ExportMapOptions</h2>
<p>This class represent the parameters needed in an exportMap operation for a <code><a href="reference.html#MapService">MapService</a></code>.
<br/>For more info see <a href='http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/export.html'>Export Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class ExportMapOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>bounds</code></td>
<td><code>google.maps.LatLngBounds</code></td>
<td>bounds of map</td>
</tr>
<tr class="even">
<td><code>dpi</code></td>
<td><code>Number</code></td>
<td>The dpi of the exported image, default 96</td>
</tr>
<tr class="odd">
<td><code>endTime</code></td>
<td><code>Date</code></td>
<td>The end time instant the exported map image if the service supports time (since AGS10).
time=<timeInstant> or time=<startTime>, <endTime>, e.g. time=1199145600000, 1230768000000 (1 Jan 2008 00:00:00 GMT to 1 Jan 2009 00:00:00 GMT)</td>
</tr>
<tr class="even">
<td><code>format</code></td>
<td><code>String</code></td>
<td>The format of the exported image. png | png8 | png24 | jpg | pdf | bmp | gif | svg The default value is <code> png</code>.</td>
</tr>
<tr class="odd">
<td><code>height</code></td>
<td><code>Number</code></td>
<td>height of image, in pixel;</td>
</tr>
<tr class="even">
<td><code>imageSR</code></td>
<td><code>SpatialReference</code></td>
<td>The well-known ID of the spatial reference of the exported image or instance of <code><a href="reference.html#SpatialReference">SpatialReference</a></code>.</td>
</tr>
<tr class="odd">
<td><code>layerDefinitions</code></td>
<td><code>Object</code></td>
<td>Allows you to filter the features of individual layers in the exported map by specifying
definition expressions for those layers. Syntax: { "<layerId1>" : "<layerDef1>" , "<layerId2>" : "<layerDef2>" }
key is layerId returned by server, value is definition for that layer.</td>
</tr>
<tr class="even">
<td><code>layerIds</code></td>
<td><code>Array.number</code></td>
<td>list of layer ids. If not specified along with layerOptions, show list of visible layers.</td>
</tr>
<tr class="odd">
<td><code>layerOptions</code></td>
<td><code>String</code></td>
<td>show | hide | include | exclude. If not specified with along layerIds, show list of visible layers.</td>
</tr>
<tr class="even">
<td><code>layerTimeOptions</code></td>
<td><code>Object</code></td>
<td>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: <pre>
{
"<layerId1>" : {
//If true, use the time extent specified by the time parameter
"useTime" : < true | false >,
//If true, draw all the features from the beginning of time for that data
"timeDataCumulative" : < true | false >,
//Time offset for this layer so that it can be overlaid on the top of a previous or future time period
"timeOffset" : <timeOffset1>,
"timeOffsetUnits" : "<esriTimeUnitsCenturies | esriTimeUnitsDays | esriTimeUnitsDecades |
esriTimeUnitsHours | esriTimeUnitsMilliseconds | esriTimeUnitsMinutes |
esriTimeUnitsMonths | esriTimeUnitsSeconds | esriTimeUnitsWeeks | esriTimeUnitsYears |
esriTimeUnitsUnknown>"
},
"<layerId2>" : {
"useTime" : < true | false >,
"timeDataCumulative" : < true | false >,
"timeOffsetOffset" : <timeOffset2>,
"timeOffsetUnits" : "<timeOffsetUnits2>"
}
}
</pre></td>
</tr>
<tr class="odd">
<td><code>time</code></td>
<td><code>Date</code></td>
<td>The time instant the exported map image if the service supports time (since AGS10).</td>
</tr>
<tr class="even">
<td><code>transparent</code></td>
<td><code>Boolean</code></td>
<td>If true, the image will be exported with
the background color of the map set as its transparent color. note the REST API default value is false. The default value is <code> true</code>.</td>
</tr>
<tr class="odd">
<td><code>width</code></td>
<td><code>Number</code></td>
<td>width of image, in pixel;</td>
</tr>
</tbody>
</table>
<h2><a name="Feature"></a>class Feature</h2>
<p>This class represent JSON feature object as returned by the REST API.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/feature.html'>Feature Object</a>.
Syntax:
<pre>
{
"geometry" : <overlays>,
"attributes" : {
"name1" : <value1>,
"name2" : <value2>,
}
}
</pre></p>
<h3>Properties</h3>
<table summary="class Feature - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>attributes</code></td>
<td><code>Object</code></td>
<td>attributes as name-value JSON object.</td>
</tr>
<tr class="even">
<td><code>geometry</code></td>
<td><code>Array.OverlayView</code></td>
<td>geometries. Array of Marker, Polyline or Polygon.</td>
</tr>
</tbody>
</table>
<h2><a name="Field"></a>class Field</h2>
<p>This class represents a field in a <code><a href="reference.html#Layer">Layer</a></code>. It is accessed from
the <code> fields</code> property. There is no constructor for this class,
use Object Literal.</p>
<h3>Properties</h3>
<table summary="class Field - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>alias</code></td>
<td><code>String</code></td>
<td>field alias.</td>
</tr>
<tr class="even">
<td><code>domain</code></td>
<td><code>Domain</code></td>
<td>domain</td>
</tr>
<tr class="odd">
<td><code>length</code></td>
<td><code>Int</code></td>
<td>length.</td>
</tr>
<tr class="even">
<td><code>name</code></td>
<td><code>String</code></td>
<td>field Name</td>
</tr>
<tr class="odd">
<td><code>type</code></td>
<td><code>String</code></td>
<td>field type (esriFieldTypeOID|esriFieldTypeString|esriFieldTypeInteger|esriFieldTypeGeometry}.</td>
</tr>
</tbody>
</table>
<h2><a name="FindOptions"></a>class FindOptions</h2>
<p>This class represent the parameters needed in an find operation for a <code><a href="reference.html#MapService">MapService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/find.html'>Find Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class FindOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>contains</code></td>
<td><code>Boolean</code></td>
<td>If false, the operation searches for an exact match of
the searchText string. An exact match is case sensitive.
Otherwise, it searches for a value that contains the searchText provided.
This search is not case sensitive. The default is true. The default value is <code> true</code>.</td>
</tr>
<tr class="even">
<td><code>layerIds</code></td>
<td><code>Array.number</code></td>
<td>The layer Ids to perform the find operation on. The layers to perform the find operation on.</td>
</tr>
<tr class="odd">
<td><code>maxAllowableOffset</code></td>
<td><code>Number</code></td>
<td>This option can be used to specify the maximum allowable offset to be used for generalizing
geometries returned by the find operation</td>
</tr>
<tr class="even">
<td><code>returnGeometry</code></td>
<td><code>Boolean</code></td>
<td>If true, the resultset will include the geometries associated with each result. The default value is <code> true</code>.</td>
</tr>
<tr class="odd">
<td><code>searchFields</code></td>
<td><code>Array.string</code></td>
<td>The names of the fields to search.
If this parameter is not specified, all fields are searched.</td>
</tr>
<tr class="even">
<td><code>searchText</code></td>
<td><code>String</code></td>
<td>The search string. This is the text that is searched across the layers and the fields that the user specifies.</td>
</tr>
</tbody>
</table>
<h2><a name="FindResult"></a>class FindResult</h2>
<p>This class represent one entry in the results of a find operation for a <code><a href="reference.html#MapService">MapService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/find.html'>Find Operation</a>.</p>
<h3>Properties</h3>
<table summary="class FindResult - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>displayFieldName</code></td>
<td><code>String</code></td>
<td>displayFieldName</td>
</tr>
<tr class="even">
<td><code>feature</code></td>
<td><code>Feature</code></td>
<td><code><a href="reference.html#Feature">Feature</a></code></td>
</tr>
<tr class="odd">
<td><code>foundFieldName</code></td>
<td><code>String</code></td>
<td>foundFieldName</td>
</tr>
<tr class="even">
<td><code>geometryType</code></td>
<td><code>String</code></td>
<td>esriGeometryPoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope</td>
</tr>
<tr class="odd">
<td><code>layerId</code></td>
<td><code>Number</code></td>
<td>layerId</td>
</tr>
<tr class="even">
<td><code>layerName</code></td>
<td><code>String</code></td>
<td>layerName</td>
</tr>
<tr class="odd">
<td><code>value</code></td>
<td><code>String</code></td>
<td>value of the display field</td>
</tr>
</tbody>
</table>
<h2><a name="FindResults"></a>class FindResults</h2>
<p>This class represent the results of a find operation for a <code><a href="reference.html#MapService">MapService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/find.html'>Find Operation</a>.</p>
<h3>Properties</h3>
<table summary="class FindResults - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>results</code></td>
<td><code>Array.FindResult</code></td>
<td>The find results as an array of <code><a href="reference.html#FindResult">FindResult</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="GeocodeOptions"></a>class GeocodeOptions</h2>
<p>This class represent the parameters needed in a find address candidate operation
on a <code><a href="reference.html#GeocodeService">GeocodeService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/candidates.html'>Find Adddress Candidates Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class GeocodeOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>inputs</code></td>
<td><code>Object</code></td>
<td>an object literal with name-value pair of input values.</td>
</tr>
<tr class="even">
<td><code>outFields</code></td>
<td><code>Array.string</code></td>
<td>The list of fields to be included in the returned resultset.</td>
</tr>
<tr class="odd">
<td><code>outSR</code></td>
<td><code>int|SpatialReference</code></td>
<td>output SR, see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="GeocodeResult"></a>class GeocodeResult</h2>
<p>This class represent one entry in the results of a find address operation for a
<code><a href="reference.html#GeocodeService">GeocodeService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/candidates.html'>Find Adddress Candidates Operation</a>.</p>
<h3>Properties</h3>
<table summary="class GeocodeResult - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>address</code></td>
<td><code>String</code></td>
<td>matched address</td>
</tr>
<tr class="even">
<td><code>attributes</code></td>
<td><code>Object</code></td>
<td>attributes as name-value JSON object.</td>
</tr>
<tr class="odd">
<td><code>location</code></td>
<td><code>google.maps.LatLng</code></td>
<td>matched location</td>
</tr>
<tr class="even">
<td><code>score</code></td>
<td><code>Number</code></td>
<td>matching score</td>
</tr>
</tbody>
</table>
<h2><a name="GeocodeResults"></a>class GeocodeResults</h2>
<p>This class represent the results of an find address candidate operation for a
<code><a href="reference.html#GeocodeService">GeocodeService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/candidates.html'>Find Adddress Candidates Operation</a>.</p>
<h3>Properties</h3>
<table summary="class GeocodeResults - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>candidates</code></td>
<td><code>Array.GeocodeResult</code></td>
<td>The find address results as
an array of <code><a href="reference.html#GeocodeResult">GeocodeResult</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="GeocodeService"></a>class GeocodeService</h2>
<p>This class (<code>GeocodeService</code>) represent an ArcGIS <a href="http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/geocodeserver.html">GeocodeServer</a>
service.</p>
<h3>Constructor</h3>
<table summary="class GeocodeService - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>GeocodeService(<span class="type">url:String</span>)</code></td>
<td>Creates a GeocodeService class.
Params:<li><code>url</code>: URL of service, syntax:<code> http://{catalogurl}/{serviceName}/GeocodeServer</code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table summary="class GeocodeService - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>addressFields</code></td>
<td><code>Array.Field</code></td>
<td>input fields.
Each entry is an object of type <code><a href="reference.html#Field">Field</a></code>, plus <code>required(true|false)</code></td>
</tr>
<tr class="even">
<td><code>candidateFields</code></td>
<td><code>Array.Field</code></td>
<td>candidate Fields.
Each entry is an object of type <code><a href="reference.html#Field">Field</a></code></td>
</tr>
<tr class="odd">
<td><code>intersectionCandidateFields</code></td>
<td><code>Array.Field</code></td>
<td>intersectionCandidateFields
Each entry is an object of type <code><a href="reference.html#Field">Field</a></code></td>
</tr>
<tr class="even">
<td><code>locatorProperties</code></td>
<td><code>Object</code></td>
<td>an object with key-value pair that is specific to Locator type.</td>
</tr>
<tr class="odd">
<td><code>serviceDescription</code></td>
<td><code>String</code></td>
<td>serviceDescription</td>
</tr>
<tr class="even">
<td><code>spatialReference</code></td>
<td><code>SpatialReference</code></td>
<td>spatialReference</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class GeocodeService - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>findAddressCandidates(<span class="type">params:GeocodeOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>The findAddressCandidates operation is performed on a geocode service
resource. The result of this operation is a resource representing
the list of address candidates. This resource provides information
about candidates including the address, location, and score.
param is an instance of <code><a href="reference.html#GeocodeOptions">GeocodeOptions</a></code>. An instance of
<code><a href="reference.html#GeocodeResults">GeocodeResults</a></code> will be passed into callback function.</td>
</tr>
<tr class="even">
<td><code>geocode(<span class="type">params:GeocodeOptions</span>, <span class="type">callback:Function</span>)</code></td>
<td><code>None</code></td>
<td>Alias of <code>GeocodeService.findAddressCandidates</code>;</td>
</tr>
<tr class="odd">
<td><code>reverseGeocode(<span class="type">params:ReverseGeocodeOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>The reverseGeocode operation is The reverseGeocode operation is performed on a geocode service resource.
The result of this operation is a inverse geocoded address resource.
param is an instance of <code><a href="reference.html#ReverseGeocodeOptions">ReverseGeocodeOptions</a></code>. An instance of
<code><a href="reference.html#ReverseGeocodeResult">ReverseGeocodeResult</a></code> will be passed into callback function.</td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="class GeocodeService - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>load</code></td>
<td><code>None</code></td>
<td>This event is fired when the service and it's service info is loaded.</td>
</tr>
</tbody>
</table>
<h2><a name="Geographic"></a>class Geographic</h2>
<p>This class (<code>Geographic</code>) will simply retuns same LatLng as Coordinates.
The <code>param</code> should have wkid property. Any Geographic Coordinate Systems (eg. WGS84(4326)) can
use this class As-Is.
<br/>Note:<b> This class does not support datum transformation</b>. This class extends <code><a href="reference.html#SpatialReference">SpatialReference</a></code>.</p>
<h3>Constructor</h3>
<table summary="class Geographic - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>Geographic(<span class="type">params:Object</span>)</code></td>
<td>Creates a Geographic Coordinate System. e.g.:<br/>
<code> var g2 = new Geographic({wkid:4326});
</code></td>
</tr>
</tbody>
</table>
<h2><a name="GeometryService"></a>class GeometryService</h2>
<p>This class (<code>GeometryService</code>) represent an ArcGIS
<a href="http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/geometryserver.html">Geometry</a>
service.</p>
<h3>Constructor</h3>
<table summary="class GeometryService - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>GeometryService(<span class="type">url:String</span>)</code></td>
<td>Creates an GeometryService class.
Params:<li><code>url</code>: URL of service, syntax:<code> http://{catalogurl}/{serviceName}/GeometryServer</code></td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class GeometryService - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>buffer(<span class="type">params:BufferOptions</span>, <span class="type">callback.:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>This resource projects an array of input geometries from an input spatial reference
to an output spatial reference. Result of type <code><a href="reference.html#BufferResults">BufferResults</a></code> is passed in callback function.</td>
</tr>
<tr class="even">
<td><code>project(<span class="type">params:ProjectOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>This resource projects an array of input geometries from an input spatial reference
to an output spatial reference. Result of type <code><a href="reference.html#ProjectResults">ProjectResults</a></code> is passed in callback function.</td>
</tr>
</tbody>
</table>
<h2><a name="GeometryType"></a>class GeometryType</h2>
<p>List of Geometry type supported by ArcGIS server.</p>
<h3>Properties</h3>
<table summary="class GeometryType - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>ENVELOPE</code></td>
<td><code>String</code></td>
<td>esriGeometryEnvelope</td>
</tr>
<tr class="even">
<td><code>MULTIPOINT</code></td>
<td><code>String</code></td>
<td>esriGeometryMultipoint</td>
</tr>
<tr class="odd">
<td><code>POINT</code></td>
<td><code>String</code></td>
<td>esriGeometryPoint</td>
</tr>
<tr class="even">
<td><code>POLYGON</code></td>
<td><code>String</code></td>
<td>esriGeometryPolygon</td>
</tr>
<tr class="odd">
<td><code>POLYLINE</code></td>
<td><code>String</code></td>
<td>esriGeometryPolyline</td>
</tr>
</tbody>
</table>
<h2><a name="GPService"></a>class GPService</h2>
<p>GPService</p>
<h3>Properties</h3>
<table summary="class GPService - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>executionType</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>resultMapServerName</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="odd">
<td><code>serviceDescription</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>tasks</code></td>
<td><code>Array.string</code></td>
<td></td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="class GPService - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>load</code></td>
<td><code>None</code></td>
<td>This event is fired when the service and it's service info is loaded.</td>
</tr>
</tbody>
</table>
<h2><a name="GPTask"></a>class GPTask</h2>
<p>GPTask</p>
<h3>Properties</h3>
<table summary="class GPTask - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>category</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>displayName</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="odd">
<td><code>executionType</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>helpUrl</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="odd">
<td><code>name</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>name</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="odd">
<td><code>name</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>parameters</code></td>
<td><code>Array.GPParameter</code></td>
<td>see <code><a href="reference.html#_global_#GPParameter">GPParameter</a></code></td>
</tr>
<tr class="odd">
<td><code>resultMapServerName</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>tasks</code></td>
<td><code>Array.string</code></td>
<td></td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class GPTask - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>execute(<span class="type">p:GPOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>execute a GeoProcessing task</td>
</tr>
</tbody>
</table>
<h2><a name="IdentifyOptions"></a>class IdentifyOptions</h2>
<p>This class represent the parameters needed in an identify operation for a <code><a href="reference.html#MapService">MapService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/identify.html'>Identify Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class IdentifyOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>bounds</code></td>
<td><code>google.maps.LatLngBounds</code></td>
<td>The bounding box of the map currently being viewed.</td>
</tr>
<tr class="even">
<td><code>dpi</code></td>
<td><code>Number</code></td>
<td>dpi of image, default 96;</td>
</tr>
<tr class="odd">
<td><code>geometry</code></td>
<td><code>Geometry</code></td>
<td>The geometry to identify on, <code>google.maps.LatLng</code>, <code>Polyline</code>, or <code>Polygon</code>.</td>
</tr>
<tr class="even">
<td><code>height</code></td>
<td><code>Number</code></td>
<td>height of image in pixel</td>
</tr>
<tr class="odd">
<td><code>layerIds</code></td>
<td><code>Array.number</code></td>
<td>The layers to perform the identify operation on.</td>
</tr>
<tr class="even">
<td><code>layerOption</code></td>
<td><code>String</code></td>
<td>The layers to perform the identify operation on. 'top|visible|all'.</td>
</tr>
<tr class="odd">
<td><code>maxAllowableOffset</code></td>
<td><code>Number</code></td>
<td>This option can be used to specify the maximum allowable offset to be used for generalizing geometries returned by the identify operation</td>
</tr>
<tr class="even">
<td><code>overlayOptions</code></td>
<td><code>OverlayOptions</code></td>
<td>how results should be rendered. See <code><a href="reference.html#OverlayOptions">OverlayOptions</a></code></td>
</tr>
<tr class="odd">
<td><code>returnGeometry</code></td>
<td><code>Boolean</code></td>
<td>If true, the resultset will include the geometries associated with each result. The default value is <code> true</code>.</td>
</tr>
<tr class="even">
<td><code>tolerance</code></td>
<td><code>Number</code></td>
<td>The distance in screen pixels from the specified geometry within which the identify should be performed</td>
</tr>
<tr class="odd">
<td><code>width</code></td>
<td><code>Number</code></td>
<td>width of image in pixel</td>
</tr>
</tbody>
</table>
<h2><a name="IdentifyResult"></a>class IdentifyResult</h2>
<p>This class represent one entry in the results of an identify operation for a <code><a href="reference.html#MapService">MapService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/identify.html'>Identify Operation</a>.</p>
<h3>Properties</h3>
<table summary="class IdentifyResult - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>displayFieldName</code></td>
<td><code>String</code></td>
<td>displayFieldName</td>
</tr>
<tr class="even">
<td><code>feature</code></td>
<td><code>Feature</code></td>
<td><code><a href="reference.html#Feature">Feature</a></code></td>
</tr>
<tr class="odd">
<td><code>layerId</code></td>
<td><code>Number</code></td>
<td>layerId</td>
</tr>
<tr class="even">
<td><code>layerName</code></td>
<td><code>String</code></td>
<td>layerName</td>
</tr>
<tr class="odd">
<td><code>value</code></td>
<td><code>String</code></td>
<td>value of the display field</td>
</tr>
</tbody>
</table>
<h2><a name="IdentifyResults"></a>class IdentifyResults</h2>
<p>This class represent the results of an identify operation for
a <code><a href="reference.html#MapService">MapService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/identify.html'>Identify Operation</a>.</p>
<h3>Properties</h3>
<table summary="class IdentifyResults - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>results</code></td>
<td><code>Array.IdentifyResult</code></td>
<td>The identify results as an array of <code><a href="reference.html#IdentifyResult">IdentifyResult</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="LambertConformalConic"></a>class LambertConformalConic</h2>
<p>This class (<code>LambertConformalConic</code>) represents a Spatial Reference System based on <a target = wiki href = 'http://en.wikipedia.org/wiki/Lambert_conformal_conic_projection'>Lambert Conformal Conic Projection</a>. This class extends <code><a href="reference.html#SpatialReference">SpatialReference</a></code>.</p>
<h3>Constructor</h3>
<table summary="class LambertConformalConic - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>LambertConformalConic(<span class="type">params:Object</span>)</code></td>
<td>Create a Lambert Conformal Conic Projection based Spatial Reference. The <code>params</code> passed in construction should
include the following properties:<code>
<br/>-wkid: well-known id
<br/>-semi_major: ellipsoidal semi-major axis in meter
<br/>-unit: meters per unit
<br/>-inverse_flattening: inverse of flattening of the ellipsoid where 1/f = a/(a - b)
<br/>-standard_parallel_1: phi1, latitude of the first standard parallel
<br/>-standard_parallel_2: phi2, latitude of the second standard parallel
<br/>-latitude_of_origin: phi0, latitude of the false origin
<br/>-central_meridian: lamda0, longitude of the false origin (with respect to the prime meridian)
<br/>-false_easting: FE, false easting, the Eastings value assigned to the natural origin
<br/>-false_northing: FN, false northing, the Northings value assigned to the natural origin
</code>
<br/> e.g. North Carolina State Plane NAD83 Feet: <br/>
<code> var ncsp82 = new LambertConformalConic({wkid:2264, semi_major: 6378137.0,inverse_flattening: 298.257222101,
standard_parallel_1: 34.33333333333334, standard_parallel_2: 36.16666666666666,
central_meridian: -79.0, latitude_of_origin: 33.75,false_easting: 2000000.002616666,
'false_northing': 0, unit: 0.3048006096012192 }); </code></td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class LambertConformalConic - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>forward(<span class="type">lnglat:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="even">
<td><code>getCircum()</code></td>
<td><code>number</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="odd">
<td><code>inverse(<span class="type">coords:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="Layer"></a>class Layer</h2>
<p>This class (<code>Layer</code>) The layer / table(v10+)
resource represents a single layer / table in a map of a map service
published by ArcGIS Server.</p>
<h3>Constructor</h3>
<table summary="class Layer - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>Layer(<span class="type">url:String</span>)</code></td>
<td>Create a ArcGIS map Layer using it's url (http://[mapservice-url]/[layerId])</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table summary="class Layer - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>copyrightText</code></td>
<td><code>String</code></td>
<td>copyrightText, only available after load.</td>
</tr>
<tr class="even">
<td><code>defaultVisibility</code></td>
<td><code>Boolean</code></td>
<td>defaultVisibility</td>
</tr>
<tr class="odd">
<td><code>definitionExpression</code></td>
<td><code>String</code></td>
<td>Layer definition.</td>
</tr>
<tr class="even">
<td><code>description</code></td>
<td><code>String</code></td>
<td>description</td>
</tr>
<tr class="odd">
<td><code>drawingInfo</code></td>
<td><code>DrawingInfo</code></td>
<td>rendering info See <code>DrawingInfo</code></td>
</tr>
<tr class="even">
<td><code>fields</code></td>
<td><code>Array.Field</code></td>
<td>fields, only available after load. See <code><a href="reference.html#Field">Field</a></code></td>
</tr>
<tr class="odd">
<td><code>geometryType</code></td>
<td><code>String</code></td>
<td>geometryType type(esriGeometryPoint|..), only available after load.</td>
</tr>
<tr class="even">
<td><code>hasAttachments</code></td>
<td><code>Boolean</code></td>
<td>hasAttachments</td>
</tr>
<tr class="odd">
<td><code>id</code></td>
<td><code>Number</code></td>
<td>layer ID</td>
</tr>
<tr class="even">
<td><code>maxScale</code></td>
<td><code>Number</code></td>
<td>maxScale</td>
</tr>
<tr class="odd">
<td><code>minScale</code></td>
<td><code>Number</code></td>
<td>minScale</td>
</tr>
<tr class="even">
<td><code>name</code></td>
<td><code>String</code></td>
<td>layer Name</td>
</tr>
<tr class="odd">
<td><code>parentLayer</code></td>
<td><code>Layer</code></td>
<td>parent Layer <code><a href="reference.html#Layer">Layer</a></code></td>
</tr>
<tr class="even">
<td><code>relationships</code></td>
<td><code>Array.String</code></td>
<td>relationships (id, name, relatedTableId)</td>
</tr>
<tr class="odd">
<td><code>subLayers</code></td>
<td><code>Array.Layer</code></td>
<td>sub Layers. <code><a href="reference.html#Layer">Layer</a></code>.</td>
</tr>
<tr class="even">
<td><code>timeInfo</code></td>
<td><code>TimeInfo</code></td>
<td>timeInfo</td>
</tr>
<tr class="odd">
<td><code>type</code></td>
<td><code>String</code></td>
<td>Feature Layer|Image Layer</td>
</tr>
<tr class="even">
<td><code>typeIdField</code></td>
<td><code>String</code></td>
<td>typeIdField</td>
</tr>
<tr class="odd">
<td><code>types</code></td>
<td><code>Array.String</code></td>
<td>subtypes: id, name, domains.</td>
</tr>
<tr class="even">
<td><code>visibility</code></td>
<td><code>Boolean</code></td>
<td>Visibility of this layer</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class Layer - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>isInScale(<span class="type">scale:Number</span>)</code></td>
<td><code>Boolean</code></td>
<td>Whether the layer is viewable at given scale</td>
</tr>
<tr class="even">
<td><code>query(<span class="type">params:QueryOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>The query operation is performed on a layer resource. The result of this operation is a resultset resource that will be
passed in the callback function. param is an instance of <code><a href="reference.html#QueryOptions">QueryOptions</a></code>
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/query.html'>Query Operation</a>.</td>
</tr>
<tr class="odd">
<td><code>queryRelatedRecords(<span class="type">params:QueryRelatedRecordsParameters</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>The query related records operation is performed on a layer / table resource.
The result of this operation are featuresets grouped by source layer / table
object IDs. Each featureset contains Feature objects including the values for
the fields requested by the user. For related layers, if you request geometry
information, the geometry of each feature is also returned in the featureset.
For related tables, the featureset does not include geometries.</td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="class Layer - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>load</code></td>
<td><code>None</code></td>
<td>This event is fired when layer's service info is loaded.</td>
</tr>
</tbody>
</table>
<h2><a name="LOD"></a>class LOD</h2>
<p>This class contains information about one "Level Of Detail" for a cached map service.
It is the type of <code>lods</code> property of <code><a href="reference.html#TileInfo">TileInfo</a></code>
<br/>There is no constructor for this class. Use as object literal.</p>
<h3>Properties</h3>
<table summary="class LOD - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>level</code></td>
<td><code>Number</code></td>
<td>zoom level.</td>
</tr>
<tr class="even">
<td><code>resolution</code></td>
<td><code>Number</code></td>
<td>map unit per pixel</td>
</tr>
<tr class="odd">
<td><code>scale</code></td>
<td><code>Number</code></td>
<td>actual map scale. e.g a value of 5000 means 1:5000 scale.</td>
</tr>
</tbody>
</table>
<h2><a name="MapImage"></a>class MapImage</h2>
<p>This is the result of <code><a href="reference.html#MapService">MapService</a></code>.exportMap operation.
There is no constructor, use as JavaScript object literal.</p>
<h3>Properties</h3>
<table summary="class MapImage - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>bounds</code></td>
<td><code>google.maps.LatLngBounds</code></td>
<td>The bounding box of the exported image.</td>
</tr>
<tr class="even">
<td><code>height</code></td>
<td><code>Number</code></td>
<td>height of the exported image.</td>
</tr>
<tr class="odd">
<td><code>href</code></td>
<td><code>String</code></td>
<td>URL of image</td>
</tr>
<tr class="even">
<td><code>scale</code></td>
<td><code>Number</code></td>
<td>scale of the exported image.</td>
</tr>
<tr class="odd">
<td><code>width</code></td>
<td><code>Number</code></td>
<td>width of the exported image.</td>
</tr>
</tbody>
</table>
<h2><a name="MapOverlay"></a>class MapOverlay</h2>
<p>This class (<code>MapOverlay</code>) extends the Google Maps API's
<a href = http://code.google.com/apis/maps/documentation/reference.html#OverlayView>OverlayView</a>
that draws map images from data source on the fly. It is also known as "<b>Dynamic Maps</b>".
It can be added to the map via <code>setMap(map) </code> method.
The similar class in the core Map API is <a href = http://code.google.com/apis/maps/documentation/javascript/reference.html#GroundOverlay>google.maps.GroundOverlay</a>,
however, the instance of this class always cover the viewport exactly, and will redraw itself as map moves.</p>
<h3>Constructor</h3>
<table summary="class MapOverlay - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>MapOverlay(<span class="type">service:String|MapService</span>, <span class="type">opt_overlayOpts:MapOverlayOptions</span>)</code></td>
<td>Creates an Map Overlay using <code>url</code> of the map service and optional <code><a href="reference.html#MapOverlayOptions">MapOverlayOptions</a></code>.
<li/> <code> service</code> (required) is url of the underline <code><a href="reference.html#MapService">MapService</a></code> or the MapService itself.
<li/> <code>opt_overlayOpts</code> (optional) is an instance of <code><a href="reference.html#MapOverlayOptions">MapOverlayOptions</a></code>.</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class MapOverlay - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>draw()</code></td>
<td><code>None</code></td>
<td>Called by API not by app code.
See OverlayView.draw in core API docs.</td>
</tr>
<tr class="even">
<td><code>getMapService()</code></td>
<td><code>MapService</code></td>
<td>Gets underline <code><a href="reference.html#MapService">MapService</a></code>.</td>
</tr>
<tr class="odd">
<td><code>getOpacity()</code></td>
<td><code>Number</code></td>
<td>Gets Image Opacity. return <code>opacity</code> between 0-1.</td>
</tr>
<tr class="even">
<td><code>hide()</code></td>
<td><code>None</code></td>
<td>Hide the overlay</td>
</tr>
<tr class="odd">
<td><code>isHidden()</code></td>
<td><code>Boolean</code></td>
<td>Check if the overlay is visible, and within zoomzoom range and current map bounds intersects with it's fullbounds.</td>
</tr>
<tr class="even">
<td><code>onAdd()</code></td>
<td><code>None</code></td>
<td>Called by API not by app code.
Handler when overlay is added. Interface method.
This will be called after setMap(map) is called.</td>
</tr>
<tr class="odd">
<td><code>onRemove()</code></td>
<td><code>None</code></td>
<td>Called by API not by app code.
Handler when overlay is removed.</td>
</tr>
<tr class="even">
<td><code>refresh()</code></td>
<td><code>None</code></td>
<td>Refresh the map image in current view port.</td>
</tr>
<tr class="odd">
<td><code>setOpacity(<span class="type">opacity:Number</span>)</code></td>
<td><code>None</code></td>
<td>Sets Image Opacity. parameter <code>opacity</code> between 0-1.</td>
</tr>
<tr class="even">
<td><code>show()</code></td>
<td><code>None</code></td>
<td>Makes the overlay visible.</td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="class MapOverlay - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>drawend</code></td>
<td><code>None</code></td>
<td>This event is fired after the the drawing request was returned by server.</td>
</tr>
<tr class="even">
<td><code>drawstart</code></td>
<td><code>None</code></td>
<td>This event is fired before the the drawing request was sent to server.</td>
</tr>
</tbody>
</table>
<h2><a name="MapOverlayOptions"></a>class MapOverlayOptions</h2>
<p>Instance of this class are used in the <code>opt_ovelayOpts</code> argument
to the constructor of the <code><a href="reference.html#MapOverlay">MapOverlay</a></code> class. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class MapOverlayOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>exportOptions</code></td>
<td><code>ExportMapOptions</code></td>
<td>See <code><a href="reference.html#ExportMapOptions">ExportMapOptions</a></code></td>
</tr>
<tr class="even">
<td><code>map</code></td>
<td><code>google.maps.Map</code></td>
<td>map to attach to.</td>
</tr>
<tr class="odd">
<td><code>opacity</code></td>
<td><code>Number</code></td>
<td>Opacity of map image from 0.0 (invisible) to 1.0 (opaque) The default value is <code> 1.0</code>.</td>
</tr>
</tbody>
</table>
<h2><a name="MapSerivceOptions"></a>class MapSerivceOptions</h2>
<p>provides options to construct a <code><a href="reference.html#MapService">MapService</a></code> There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class MapSerivceOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>delayLoad</code></td>
<td><code>Number</code></td>
<td>number of seconds to delay loading meta data on construction.</td>
</tr>
</tbody>
</table>
<h2><a name="MapService"></a>class MapService</h2>
<p>This class (<code>MapService</code>) is the core class for all map service operations.
It represents an ArcGIS Server map service that offer access to map and layer content</p>
<h3>Constructor</h3>
<table summary="class MapService - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>MapService(<span class="type">url:String</span>)</code></td>
<td>Creates a MapService objects that can be used by UI components.
<ul><li> <code> url</code> (required) is the URL of the map servive, e.g. <code>
http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer</code>.
<ul/> Note the spatial reference of the map service must already exists
in the <code>spatialReferences_</code> if actual coordinates transformation is needed.</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table summary="class MapService - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>copyrightText</code></td>
<td><code>String</code></td>
<td>copyrightText</td>
</tr>
<tr class="even">
<td><code>description</code></td>
<td><code>String</code></td>
<td>description</td>
</tr>
<tr class="odd">
<td><code>documentInfo</code></td>
<td><code>Object</code></td>
<td>Object with the folloing properties: <code>Title, Author,Comments,Subject,Category,Keywords</code></td>
</tr>
<tr class="even">
<td><code>layers</code></td>
<td><code>Array.Layer</code></td>
<td>array of <code><a href="reference.html#Layer">Layer</a></code>s.</td>
</tr>
<tr class="odd">
<td><code>mapName</code></td>
<td><code>String</code></td>
<td>map frame Name inside the map document</td>
</tr>
<tr class="even">
<td><code>serviceDescription</code></td>
<td><code>String</code></td>
<td>serviceDescription</td>
</tr>
<tr class="odd">
<td><code>singleFusedMapCache</code></td>
<td><code>Boolean</code></td>
<td>if map cache is singleFused</td>
</tr>
<tr class="even">
<td><code>spatialReference</code></td>
<td><code>SpatialReference</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="odd">
<td><code>supportedImageFormatTypes</code></td>
<td><code>String</code></td>
<td>supportedImageFormatTypes, comma delimited list.</td>
</tr>
<tr class="even">
<td><code>tables</code></td>
<td><code>Array.Layer</code></td>
<td>array of Tables of type <code><a href="reference.html#Layer">Layer</a></code>.</td>
</tr>
<tr class="odd">
<td><code>tileInfo</code></td>
<td><code>TileInfo</code></td>
<td>See <code><a href="reference.html#TileInfo">TileInfo</a></code></td>
</tr>
<tr class="even">
<td><code>timeInfo</code></td>
<td><code>TimeInfo</code></td>
<td>see <code>TimeInfo</code></td>
</tr>
<tr class="odd">
<td><code>units</code></td>
<td><code>String</code></td>
<td>unit</td>
</tr>
<tr class="even">
<td><code>url</code></td>
<td><code>String</code></td>
<td>map service URL</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class MapService - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>exportMap(<span class="type">params:ExportMapOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>String|None</code></td>
<td>Export an image with given parameters.
For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/export.html'>Export Operation</a>.
<br/> The <code>params</code> is an instance of <code><a href="reference.html#ExportMapOptions">ExportMapOptions</a></code>.
The following properties will be set automatically if not specified:...
<br/> The <code>callback</code> is the callback function with argument of
an instance of <code><a href="reference.html#MapImage">MapImage</a></code>.</td>
</tr>
<tr class="even">
<td><code>find(<span class="type">opts:FindOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>Find features using the <code><a href="reference.html#FindOptions">FindOptions</a></code> and process <code><a href="reference.html#FindResults">FindResults</a></code>
using the <code>callback</code> function.
For more info see <a
href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/find.html'>Find Operation</a>.</td>
</tr>
<tr class="odd">
<td><code>getFullBounds()</code></td>
<td><code>google.maps.LatLngBounds</code></td>
<td>get full bounds of the map serivce</td>
</tr>
<tr class="even">
<td><code>getInitialBounds()</code></td>
<td><code>google.maps.LatLngBounds</code></td>
<td>get initial bounds of the map serivce</td>
</tr>
<tr class="odd">
<td><code>getLayer(<span class="type">nameOrId:String|Number</span>)</code></td>
<td><code>Layer</code></td>
<td>Get a map layer by it's name(String) or id (Number), return <code><a href="reference.html#Layer">Layer</a></code>.</td>
</tr>
<tr class="even">
<td><code>hasLoaded()</code></td>
<td><code>Boolean</code></td>
<td>If the map service meta info is loaded</td>
</tr>
<tr class="odd">
<td><code>identify(<span class="type">params:IdentifyOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>Identify features on a particular Geographic location, using <code><a href="reference.html#IdentifyOptions">IdentifyOptions</a></code> and
process <code><a href="reference.html#IdentifyResults">IdentifyResults</a></code> using the <code>callback</code> function.
For more info see <a
href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/identify.html'>Identify Operation</a>.</td>
</tr>
<tr class="even">
<td><code>loadServiceInfo()</code></td>
<td><code>None</code></td>
<td>Load serviceInfo</td>
</tr>
<tr class="odd">
<td><code>queryLayer(<span class="type">layerNameOrId:Number|String</span>, <span class="type">params:QueryOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>Query a layer with given id or name using the <code><a href="reference.html#QueryOptions">QueryOptions</a></code> and process <code><a href="reference.html#ResultSet">ResultSet</a></code>
using the <code>callback</code> function.
See <code><a href="reference.html#Layer">Layer</a></code>.
For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/query.html'>Query Layer Operation</a>.</td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="class MapService - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>load</code></td>
<td><code>None</code></td>
<td>This event is fired when the service and it's service info is loaded.</td>
</tr>
</tbody>
</table>
<h2><a name="MapType"></a>class MapType</h2>
<p>This class implements the Google Maps API's
<a href = http://code.google.com/apis/maps/documentation/javascript/reference.html#MapType>GMapType</a>.
It holds a list of <code><a href="reference.html#TileLayer">TileLayer</a></code>s.
<p> Note: all tiled layer in the same map type must use same spatial reference and tile scheme.</p></p>
<h3>Constructor</h3>
<table summary="class MapType - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>MapType(<span class="type">tileLayers:Array.TileLayer|String</span>, <span class="type">opt_typeOpts:MapTypeOptions</span>)</code></td>
<td>Creates a MapType, with a array of <code><a href="reference.html#TileLayer">TileLayer</a></code>s, or a single URL as shortcut.</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class MapType - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>getOpacity()</code></td>
<td><code>Number</code></td>
<td>get opacity</td>
</tr>
<tr class="even">
<td><code>getTileLayers()</code></td>
<td><code>Array.TileLayer</code></td>
<td>get list of <code><a href="reference.html#TileLayer">TileLayer</a></code> in this map type</td>
</tr>
<tr class="odd">
<td><code>setOpacity(<span class="type">op:Number</span>)</code></td>
<td><code>None</code></td>
<td>Set Opactity</td>
</tr>
</tbody>
</table>
<h2><a name="MapTypeOptions"></a>class MapTypeOptions</h2>
<p>Instance of this class are used in the <code>opt_typeOpts</code> argument
to the constructor of the <code><a href="reference.html#MapType">MapType</a></code> class. See
<a href=http://code.google.com/apis/maps/documentation/javascript/reference.html#MapType>google.maps.MapType</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class MapTypeOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>alt</code></td>
<td><code>String</code></td>
<td>Alt text to display when this MapType's button is hovered over in the MapTypeControl. Optional.</td>
</tr>
<tr class="even">
<td><code>maxZoom</code></td>
<td><code>Number</code></td>
<td>The maximum zoom level for the map when displaying this MapType. Required for base MapTypes, ignored for overlay MapTypes.</td>
</tr>
<tr class="odd">
<td><code>minZoom</code></td>
<td><code>Number</code></td>
<td>The minimum zoom level for the map when displaying this MapType. Optional; defaults to 0.</td>
</tr>
<tr class="even">
<td><code>name</code></td>
<td><code>String</code></td>
<td>map type name</td>
</tr>
<tr class="odd">
<td><code>projection</code></td>
<td><code>Projection</code></td>
<td>an instance of <code><a href="reference.html#Projection">Projection</a></code>.</td>
</tr>
<tr class="even">
<td><code>tileSize</code></td>
<td><code>google.maps.Size</code></td>
<td>The dimensions of each tile.</td>
</tr>
</tbody>
</table>
<h2><a name="NetworkService"></a>class NetworkService</h2>
<p>NetworkService</p>
<h3>Properties</h3>
<table summary="class NetworkService - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>closestFacilityLayers</code></td>
<td><code>Array.string</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>routeLayers</code></td>
<td><code>Array.string</code></td>
<td></td>
</tr>
<tr class="odd">
<td><code>serviceAreaLayers</code></td>
<td><code>Array.string</code></td>
<td></td>
</tr>
<tr class="even">
<td><code>serviceDescription</code></td>
<td><code>String</code></td>
<td></td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="class NetworkService - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>load</code></td>
<td><code>None</code></td>
<td>This event is fired when the service and it's service info is loaded.</td>
</tr>
</tbody>
</table>
<h2><a name="OverlayOptions"></a>class OverlayOptions</h2>
<p>Instance of this classes that specify how
the geometry features returned by ArcGIS server should be rendered in the browser. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class OverlayOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>fillColor</code></td>
<td><code>String</code></td>
<td>The fill color in HTML hex style, ie. "#FFAA00"</td>
</tr>
<tr class="even">
<td><code>fillOpacity</code></td>
<td><code>Number</code></td>
<td>The fill opacity between 0.0 and 1.0</td>
</tr>
<tr class="odd">
<td><code>icon</code></td>
<td><code>String|google.maps.MarkerImage</code></td>
<td>Icon for the foreground</td>
</tr>
<tr class="even">
<td><code>markerOptions</code></td>
<td><code>google.maps.MarkerOptions</code></td>
<td>style option for points.</td>
</tr>
<tr class="odd">
<td><code>polygonOptions</code></td>
<td><code>google.maps.PolygonOptions</code></td>
<td>style option for polygons. <a href=http://code.google.com/apis/maps/documentation/javascript/reference.html#PolygonOptions>PolygonOptions</a></td>
</tr>
<tr class="even">
<td><code>polylineOptions</code></td>
<td><code>google.maps.PolylineOptions</code></td>
<td>style option for polylines. <a href=http://code.google.com/apis/maps/documentation/javascript/reference.html#PolylineOptions>PolylineOptions</a></td>
</tr>
<tr class="odd">
<td><code>shadow</code></td>
<td><code>String|google.maps.MarkerImage</code></td>
<td>Shadow image</td>
</tr>
<tr class="even">
<td><code>strokeColor</code></td>
<td><code>String</code></td>
<td>The stroke color in HTML hex style, ie. "#FFAA00"</td>
</tr>
<tr class="odd">
<td><code>strokeOpacity</code></td>
<td><code>Number</code></td>
<td>The stroke opacity between 0.0 and 1.0</td>
</tr>
<tr class="even">
<td><code>strokeWeight</code></td>
<td><code>Number</code></td>
<td>The stroke width in pixels.</td>
</tr>
<tr class="odd">
<td><code>zIndex</code></td>
<td><code>Number</code></td>
<td>The zIndex compared to other overlays.</td>
</tr>
</tbody>
</table>
<h2><a name="Projection"></a>class Projection</h2>
<p>This class (<code>Projection</code>) implements a custom
<a href = 'http://code.google.com/apis/maps/documentation/javascript/reference.html#Projection'>google.maps.Projection</a>
from the core Google Maps API.
It includes a real <code><a href="reference.html#SpatialReference">SpatialReference</a></code> object to convert LatLng from/to
map coordinates, and tiling scheme informations to convert
map coordinates from/to pixel coordinates.</p>
<h3>Constructor</h3>
<table summary="class Projection - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>Projection(<span class="type">tileInfo:TileInfo</span>)</code></td>
<td>Creates an ArcGIS Map Tiling Reference System.
<ul>
<li><code>tileInfo</code> tiling information. An instance of <code><a href="reference.html#TileInfo">TileInfo</a></code>
</ul>Applications normally do not create instances of this class directly.</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class Projection - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>fromLatLngToPoint(<span class="type">gLatLng:LatLng</span>, <span class="type">opt_point:Point</span>)</code></td>
<td><code>Point</code></td>
<td>See <a href = 'http://code.google.com/apis/maps/documentation/javascript/reference.html#Projection'>google.maps.Projection</a>.</td>
</tr>
<tr class="even">
<td><code>fromPointToLatLng(<span class="type">pixel:Point</span>, <span class="type">opt_nowrap:Boolean</span>)</code></td>
<td><code>LatLng</code></td>
<td>See <a href = 'http://code.google.com/apis/maps/documentation/javascript/reference.html#Projection'>google.maps.Projection</a>.</td>
</tr>
<tr class="odd">
<td><code>getScale(<span class="type">zoom:Number</span>)</code></td>
<td><code>Number</code></td>
<td>Get the scale at given level;</td>
</tr>
</tbody>
</table>
<h2><a name="ProjectOptions"></a>class ProjectOptions</h2>
<p>This class represent the parameters needed in an project operation
for a <code><a href="reference.html#GeometryService">GeometryService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/project.html'>Project Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class ProjectOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>geometries</code></td>
<td><code>Array.OverlayView|Array.object</code></td>
<td>Array of <code>google.maps.LatLng, Polyline, Polygon</code>, or ESRI Geometry format to project.</td>
</tr>
<tr class="even">
<td><code>geometryType</code></td>
<td><code>GeometryType</code></td>
<td>esriGeometryPoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope</td>
</tr>
<tr class="odd">
<td><code>inSpatialReference</code></td>
<td><code>SpatialReference</code></td>
<td>The well-known ID of or the <code><a href="reference.html#SpatialReference">SpatialReference</a></code> of the input geometries</td>
</tr>
<tr class="even">
<td><code>outSpatialReference</code></td>
<td><code>SpatialReference</code></td>
<td>The well-known ID of or the <code><a href="reference.html#SpatialReference">SpatialReference</a></code> of the out geometries</td>
</tr>
</tbody>
</table>
<h2><a name="ProjectResults"></a>class ProjectResults</h2>
<p>This class represent the parameters needed in an project operation
for a <code><a href="reference.html#GeometryService">GeometryService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/project.html'>Project Operation</a>.</p>
<h3>Properties</h3>
<table summary="class ProjectResults - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>geometries</code></td>
<td><code>Array.OverlayView|Array.object</code></td>
<td>Array of <code>google.maps.LatLng, Polyline, Polygon<code>, or ESRI Geometry format to project.</td>
</tr>
</tbody>
</table>
<h2><a name="QueryOptions"></a>class QueryOptions</h2>
<p>This class represent the parameters needed in an query operation for a <code><a href="reference.html#Layer">Layer</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/query.html'>Query Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class QueryOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>geometry</code></td>
<td><code>OverlayView|Array.OverlayView</code></td>
<td>The geometry to apply as the spatial filter.</td>
</tr>
<tr class="even">
<td><code>maxAllowableOffset</code></td>
<td><code>Number</code></td>
<td>This option can be used to specify the maximum allowable offset to be used for generalizing geometries returned by the query operation</td>
</tr>
<tr class="odd">
<td><code>objectIds</code></td>
<td><code>Array.number</code></td>
<td>The object IDs of this layer / table to be queried</td>
</tr>
<tr class="even">
<td><code>outFields</code></td>
<td><code>Array.string</code></td>
<td>The list of fields to be included in the returned resultset.</td>
</tr>
<tr class="odd">
<td><code>overlayOptions</code></td>
<td><code>OverlayOptions</code></td>
<td>See <code><a href="reference.html#OverlayOptions">OverlayOptions</a></code></td>
</tr>
<tr class="even">
<td><code>returnGeometry</code></td>
<td><code>Boolean</code></td>
<td>If true, If true, the resultset will include the geometries associated with each result.</td>
</tr>
<tr class="odd">
<td><code>returnIdsOnly</code></td>
<td><code>Boolean</code></td>
<td>If true, the response only includes an array of object IDs. Otherwise the response is a feature set. The default is false.</td>
</tr>
<tr class="even">
<td><code>spatialRelationship</code></td>
<td><code>SpatialRelationship</code></td>
<td>The spatial relationship to be applied on the
input geometry while performing the query. The supported spatial relationships
include intersects, contains, envelope intersects, within, etc.
The default spatial relationship is intersects. See <code><a href="reference.html#SpatialRelationship">SpatialRelationship</a></code></td>
</tr>
<tr class="odd">
<td><code>text</code></td>
<td><code>String</code></td>
<td>A literal search text. If the layer has a display field
associated with it, the server searches for this text in this field.
This parameter is a short hand for a where clause of:
where [displayField]like '%[text]%'. The text is case sensitive.
This parameter is ignored if the where parameter is specified.</td>
</tr>
<tr class="even">
<td><code>where</code></td>
<td><code>String</code></td>
<td>A where clause for the query filter. Any legal SQL where clause operating on the fields in the layer is allowed.</td>
</tr>
</tbody>
</table>
<h2><a name="QueryRelatedRecordsOptions"></a>class QueryRelatedRecordsOptions</h2>
<p>This class represent the parameters needed in an query related records operation for a <code><a href="reference.html#Layer">Layer</a></code>.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/queryrelatedrecords.html'>Query Related Records Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class QueryRelatedRecordsOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>definitionExpression</code></td>
<td><code>String</code></td>
<td>The definition expression to be applied to the related table / layer. From the list of objectIds, only those records that conform to this expression will be returned.</td>
</tr>
<tr class="even">
<td><code>Number</code></td>
<td><code></code></td>
<td>[maxAllowableOffset] This option can be used to specify the maximum allowable offset to be used for generalizing geometries returned by the query operation</td>
</tr>
<tr class="odd">
<td><code>objectIds</code></td>
<td><code>Array.number</code></td>
<td>The object IDs of this layer / table to be queried</td>
</tr>
<tr class="even">
<td><code>outFields</code></td>
<td><code>Array.string</code></td>
<td>The list of fields to be included in the returned resultset. This list is a comma delimited list of field names.</td>
</tr>
<tr class="odd">
<td><code>outSR</code></td>
<td><code>Number</code></td>
<td>The well-known ID of or the <code><a href="reference.html#SpatialReference">SpatialReference</a></code> of the output geometries</td>
</tr>
<tr class="even">
<td><code>relatioshipId</code></td>
<td><code>Int</code></td>
<td>The ID of the relationship to be queried</td>
</tr>
<tr class="odd">
<td><code>returnGeometry</code></td>
<td><code>Boolean</code></td>
<td>If true, the resultset will include the geometries associated with each result. The default value is <code> true</code>.</td>
</tr>
</tbody>
</table>
<h2><a name="RelatedRecord"></a>class RelatedRecord</h2>
<p>This class represent the result of an query related records operation for a <code><a href="reference.html#Layer">Layer</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/queryrelatedrecords.html'>Query Operation</a>.</p>
<h3>Properties</h3>
<table summary="class RelatedRecord - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>objectId</code></td>
<td><code>int</code></td>
<td>objectid of original record</td>
</tr>
<tr class="even">
<td><code>relatedRecords</code></td>
<td><code>Array.feature</code></td>
<td>list of <code><a href="reference.html#Feature">Feature</a></code>s.</td>
</tr>
</tbody>
</table>
<h2><a name="RelatedRecords"></a>class RelatedRecords</h2>
<p>This class represent the results of an query related records operation for a <code><a href="reference.html#Layer">Layer</a></code>.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/queryrelatedrecords.html'>Query Operation</a>.</p>
<h3>Properties</h3>
<table summary="class RelatedRecords - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>displayFieldName</code></td>
<td><code>String</code></td>
<td>display Field Name for layer</td>
</tr>
<tr class="even">
<td><code>geometryType</code></td>
<td><code>String</code></td>
<td>esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolygon | esriGeometryPolyline</td>
</tr>
<tr class="odd">
<td><code>relatedRecordGroups</code></td>
<td><code>Array.object</code></td>
<td>list of related records</td>
</tr>
<tr class="even">
<td><code>spatialReference</code></td>
<td><code>Object</code></td>
<td><code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="ResultSet"></a>class ResultSet</h2>
<p>This class represent the results of an query operation for a <code><a href="reference.html#Layer">Layer</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/query.html'>Query Operation</a>.</p>
<h3>Properties</h3>
<table summary="class ResultSet - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>displayFieldName</code></td>
<td><code>String</code></td>
<td>display Field Name for layer</td>
</tr>
<tr class="even">
<td><code>features</code></td>
<td><code>Array.feature</code></td>
<td>result as array of <code><a href="reference.html#Feature">Feature</a></code></td>
</tr>
<tr class="odd">
<td><code>fieldAliases</code></td>
<td><code>Object</code></td>
<td>Field Name's Aliases. key is field name, value is alias.</td>
</tr>
<tr class="even">
<td><code>geometryType</code></td>
<td><code>GemetryType</code></td>
<td>esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolygon | esriGeometryPolyline</td>
</tr>
<tr class="odd">
<td><code>objectIdFieldName</code></td>
<td><code>String</code></td>
<td>objectIdFieldName when returnIdsOnly=true</td>
</tr>
<tr class="even">
<td><code>objectIds</code></td>
<td><code>Array.int</code></td>
<td>objectIds when returnIdsOnly=true</td>
</tr>
</tbody>
</table>
<h2><a name="ReverseGeocodeOptions"></a>class ReverseGeocodeOptions</h2>
<p>This class represent the parameters needed in a reverseGeocode operation
on a <code><a href="reference.html#GeocodeService">GeocodeService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/inverse.html'>Reverse Geocode Operation</a>. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class ReverseGeocodeOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>distance</code></td>
<td><code>Number</code></td>
<td>The distance in meters from the given location within which
a matching address should be searched.</td>
</tr>
<tr class="even">
<td><code>location</code></td>
<td><code>google.maps.LatLng</code></td>
<td>an object literal of LatLng.</td>
</tr>
</tbody>
</table>
<h2><a name="ReverseGeocodeResult"></a>class ReverseGeocodeResult</h2>
<p>This class represent one entry in the results of a find address operation for a
<code><a href="reference.html#GeocodeService">GeocodeService</a></code>.
There is no constructor, use JavaScript object literal.
<br/>For more info see <a href = 'http://sampleserver3.arcgisonline.com/ArcGIS/SDK/REST/inverse.html'>Reverse Geocode Operation</a>.</p>
<h3>Properties</h3>
<table summary="class ReverseGeocodeResult - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>address</code></td>
<td><code>Object</code></td>
<td>matched address, object literal with name-value address parts.</td>
</tr>
<tr class="even">
<td><code>location</code></td>
<td><code>google.maps.LatLng</code></td>
<td>matched location</td>
</tr>
</tbody>
</table>
<h2><a name="RouteOptions"></a>class RouteOptions</h2>
<p>intance that specify how a route should be solved. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class RouteOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>barriers</code></td>
<td><code>Array.google.maps.LatLng|Array.Marker</code></td>
<td>the locations the route must avoid</td>
</tr>
<tr class="even">
<td><code>findBestSequence</code></td>
<td><code>Boolean</code></td>
<td>If true, the solver should resequence the route in the optimal order. The default is as defined in the network layer.</td>
</tr>
<tr class="odd">
<td><code>preserveFirstStop</code></td>
<td><code>Boolean</code></td>
<td>If true, the solver should resequence the route in the optimal order. The default is as defined in the network layer.</td>
</tr>
<tr class="even">
<td><code>preserveLastStop</code></td>
<td><code>Boolean</code></td>
<td>If true, the solver should resequence the route in the optimal order. The default is as defined in the network layer.</td>
</tr>
<tr class="odd">
<td><code>returnDirections</code></td>
<td><code>Boolean</code></td>
<td>If true, directions will be generated and returned with the analysis results. Default is true</td>
</tr>
<tr class="even">
<td><code>returnRoutes</code></td>
<td><code>Boolean</code></td>
<td>If true, routes will be returned with the analysis results. Default is true.</td>
</tr>
<tr class="odd">
<td><code>stops</code></td>
<td><code>Array.google.maps.LatLng|Array.Marker</code></td>
<td>the locations the route must pass</td>
</tr>
</tbody>
</table>
<h2><a name="RouteResults"></a>class RouteResults</h2>
<p>intance that specify the results of the solve operation.</p>
<h3>Properties</h3>
<table summary="class RouteResults - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>stops</code></td>
<td><code>Array.google.maps.LatLng</code></td>
<td></td>
</tr>
</tbody>
</table>
<h2><a name="RouteTask"></a>class RouteTask</h2>
<p>This class (<code>RouteTask</code>) represent a Network Layer resource deployed in a NetWorkService.
It can solve a route based on stops, barrier</p>
<h3>Constructor</h3>
<table summary="class RouteTask - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>RouteTask(<span class="type">url:String</span>)</code></td>
<td>Create a route task with the URL of the routing server resource.</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class RouteTask - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>solve(<span class="type">opt_Route:RouteOptions</span>, <span class="type">callback:Function</span>, <span class="type">errback:Function</span>)</code></td>
<td><code>None</code></td>
<td>Solve a route based on inputs such as stops and barriers. Result of type <code><a href="reference.html#RouteResults">RouteResults</a></code>
is passed to Function callback, and error of type <code><a href="reference.html#Error">Error</a></code> is passed to Function errback.</td>
</tr>
</tbody>
</table>
<h2><a name="SpatialReference"></a>class SpatialReference</h2>
<p>This class (<code>SpatialReference</code>) is for coordinate systems that converts value
between geographic and real-world coordinates. The following classes extend this class:
<code><a href="reference.html#Geographic">Geographic</a></code>, <code><a href="reference.html#SphereMercator">SphereMercator</a></code>, <code><a href="reference.html#LambertConformalConic">LambertConformalConic</a></code>, and <code><a href="reference.html#TransverseMercator">TransverseMercator</a></code>.</p>
<h3>Constructor</h3>
<table summary="class SpatialReference - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>SpatialReference(<span class="type">params:Object</span>)</code></td>
<td>Create A Generic Spatial Reference Object
The <code>params </code> passed in constructor is a javascript object literal and depends on
the type of Coordinate System to construct.</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table summary="class SpatialReference - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>wkid</code></td>
<td><code>Number</code></td>
<td>well-known coodinate system id (EPSG code)</td>
</tr>
<tr class="even">
<td><code>wkt</code></td>
<td><code>String</code></td>
<td>well-known coodinate system text</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class SpatialReference - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>forward(<span class="type">lnglat:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>Convert Lat Lng to real-world coordinates.
Note both input and output are array of [x,y], although their values in different units.</td>
</tr>
<tr class="even">
<td><code>getCircum()</code></td>
<td><code>number</code></td>
<td>Get the map the periodicity in x-direction, in map units NOT pixels</td>
</tr>
<tr class="odd">
<td><code>inverse(<span class="type">coords:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>Convert real-world coordinates to Lat Lng.
Note both input and output are are array of [x,y], although their values are different.</td>
</tr>
<tr class="even">
<td><code>toJSON()</code></td>
<td><code></code></td>
<td>To JSON String</td>
</tr>
</tbody>
</table>
<h2><a name="SpatialRelationship"></a>class SpatialRelationship</h2>
<p>This is actually a list of constants that represent spatial
relationship types.</p>
<h3>Properties</h3>
<table summary="class SpatialRelationship - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>CONTAINS</code></td>
<td><code>String</code></td>
<td>esriSpatialRelContains</td>
</tr>
<tr class="even">
<td><code>CROSSES</code></td>
<td><code>String</code></td>
<td>esriSpatialRelCrosses</td>
</tr>
<tr class="odd">
<td><code>ENVELOPE_INTERSECTS</code></td>
<td><code>String</code></td>
<td>esriSpatialRelEnvelopeIntersects</td>
</tr>
<tr class="even">
<td><code>INDEX_INTERSECTS</code></td>
<td><code>String</code></td>
<td>esriSpatialRelIndexIntersects</td>
</tr>
<tr class="odd">
<td><code>INTERSECTS</code></td>
<td><code>String</code></td>
<td>esriSpatialRelIntersects</td>
</tr>
<tr class="even">
<td><code>OVERLAPS</code></td>
<td><code>String</code></td>
<td>esriSpatialRelOverlaps</td>
</tr>
<tr class="odd">
<td><code>TOUCHES</code></td>
<td><code>String</code></td>
<td>esriSpatialRelTouches</td>
</tr>
<tr class="even">
<td><code>WITHIN</code></td>
<td><code>String</code></td>
<td>esriSpatialRelWithin</td>
</tr>
</tbody>
</table>
<h2><a name="SphereMercator"></a>class SphereMercator</h2>
<p>This class (<code>SphereMercator</code>) is the Projection Default Google Maps uses. It is a special form of Mercator. This class extends <code><a href="reference.html#SpatialReference">SpatialReference</a></code>.</p>
<h3>Constructor</h3>
<table summary="class SphereMercator - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>SphereMercator(<span class="type">params:Object</span>)</code></td>
<td>Creates a Spatial Reference based on Sphere Mercator Projection.
The <code>params</code> passed in constructor should have the following properties:
<code><br/>-wkid: wkid
<br/>-semi_major: ellipsoidal semi-major axis
<br/>-unit: meters per unit
<br/>-central_meridian: lamda0, longitude of the false origin (with respect to the prime meridian)
</code>
<br/>e.g. The "Web Mercator" used in ArcGIS Server:<br/>
<code> var web_mercator = new SphereMercator({wkid: 102113, semi_major:6378137.0, central_meridian:0, unit: 1 });
</code></td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class SphereMercator - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>forward(<span class="type">lnglat:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>See <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="even">
<td><code>getCircum()</code></td>
<td><code>Number</code></td>
<td>See <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="odd">
<td><code>inverse(<span class="type">coords:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>See <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="TileInfo"></a>class TileInfo</h2>
<p>This class contains information about map tile infornation for a cached map service.
<br/>There is no constructor for this class.</p>
<h3>Properties</h3>
<table summary="class TileInfo - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>cols</code></td>
<td><code>Number</code></td>
<td>tile cols size, e.g. 512, must be same as rows</td>
</tr>
<tr class="even">
<td><code>compressionQuality</code></td>
<td><code>Number</code></td>
<td>JPEG only.0-100.</td>
</tr>
<tr class="odd">
<td><code>dpi</code></td>
<td><code>Number</code></td>
<td>dot per inch for map tiles.</td>
</tr>
<tr class="even">
<td><code>format</code></td>
<td><code>String</code></td>
<td>PNG8 | PNG24 | PNG32 | GIF | JPEG</td>
</tr>
<tr class="odd">
<td><code>lods</code></td>
<td><code>Array.LOD</code></td>
<td>Array of Level of Details. See <code><a href="reference.html#LOD">LOD</a></code></td>
</tr>
<tr class="even">
<td><code>origin</code></td>
<td><code>Point</code></td>
<td>origin of tile system of type</td>
</tr>
<tr class="odd">
<td><code>rows</code></td>
<td><code>Number</code></td>
<td>tile row size, e.g. 512, must be same as cols</td>
</tr>
<tr class="even">
<td><code>spatialReference</code></td>
<td><code>SpatialReference</code></td>
<td>spatial reference. <b>wkid info only</b>.</td>
</tr>
</tbody>
</table>
<h2><a name="TileLayer"></a>class TileLayer</h2>
<p>This class (<code>TileLayer</code>) provides access to a cached ArcGIS Server
map service. There is no <code>GTileLayer</code> class in Google Maps API V3, this class is kept to allow
finer control of zoom levels for each individual tile sets within a map type, such as zoom level range and opacity.</p>
<h3>Constructor</h3>
<table summary="class TileLayer - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>TileLayer(<span class="type">service:MapService</span>, <span class="type">opt_layerOpts:TileLayerOptions</span>)</code></td>
<td>Creates a tile layer from a cached by ArcGIS map service.
<br/> <code> service</code> (required) is the underline <code><a href="reference.html#MapService">MapService</a></code>
<br/> <code>opt_layerOpts</code> (optional) is an instance of <code><a href="reference.html#TileLayerOptions">TileLayerOptions</a></code>.</td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class TileLayer - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>getMapService()</code></td>
<td><code>MapService</code></td>
<td>get the underline <code><a href="reference.html#MapService">MapService</a></code></td>
</tr>
<tr class="even">
<td><code>getOpacity()</code></td>
<td><code>Number</code></td>
<td>get the opacity (0-1) of the tile layer</td>
</tr>
<tr class="odd">
<td><code>setOpacity(<span class="type">op:Number</span>)</code></td>
<td><code>None</code></td>
<td>set Opacity</td>
</tr>
</tbody>
</table>
<h2><a name="TileLayerOptions"></a>class TileLayerOptions</h2>
<p>Instances of this class are used in the <code>opt_layerOpts</code> argument
to the constructor of the <code><a href="reference.html#TileLayer">TileLayer</a></code> class. There is no constructor for this class. Instead, this class is instantiated as a javascript object literal.</p>
<h3>Properties</h3>
<table summary="class TileLayerOptions - Properties" width="90%">
<tbody>
<tr>
<th>Properties</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>hosts</code></td>
<td><code>String</code></td>
<td>host pattern of tile servers if they are numbered. Most browser
has default restrictions on how many concurrent connections can be made to
a single host. One technique to workaround this is to create multiple hosts and rotate them when
loading tiles.
The syntax is <code>prefix[<i>numberOfHosts</i>]suffix</code>, for example, <code>"mt[4].google.com"</code> means
rotate hosts in <code>mt0.google.com, mt1.google.com, mt2.google.com, mt3.google.com</code> (4 hosts).</td>
</tr>
<tr class="even">
<td><code>maxZoom</code></td>
<td><code>Number</code></td>
<td>max zoom level.</td>
</tr>
<tr class="odd">
<td><code>minZoom</code></td>
<td><code>Number</code></td>
<td>min zoom level.</td>
</tr>
<tr class="even">
<td><code>opacity</code></td>
<td><code>Number</code></td>
<td>opacity (0-1).</td>
</tr>
</tbody>
</table>
<h2><a name="TransverseMercator"></a>class TransverseMercator</h2>
<p>This class (<code>TransverseMercator</code>) represents a Spatial Reference System based on
<a target = wiki href = 'http://en.wikipedia.org/wiki/Transverse_Mercator_projection'>Transverse Mercator Projection</a> This class extends <code><a href="reference.html#SpatialReference">SpatialReference</a></code>.</p>
<h3>Constructor</h3>
<table summary="class TransverseMercator - Constructor" width="90%">
<tbody>
<tr>
<th>Constructor</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>TransverseMercator(<span class="type">params:Object</span>)</code></td>
<td>Create a Transverse Mercator Projection. The <code>params</code> passed in constructor should contain the
following properties: <br/>
<code>
<br/>-wkid: well-known id
<br/>-semi_major: ellipsoidal semi-major axis in meters
<br/>-unit: meters per unit
<br/>-inverse_flattening: inverse of flattening of the ellipsoid where 1/f = a/(a - b)
<br/>-Scale Factor: scale factor at origin
<br/>-latitude_of_origin: phi0, latitude of the false origin
<br/>-central_meridian: lamda0, longitude of the false origin (with respect to the prime meridian)
<br/>-false_easting: FE, false easting, the Eastings value assigned to the natural origin
<br/>-false_northing: FN, false northing, the Northings value assigned to the natural origin
</code>
<br/>e.g. Georgia West State Plane NAD83 Feet:
<br/><code> var gawsp83 = new TransverseMercator({wkid: 102667, semi_major:6378137.0,
inverse_flattening:298.257222101,central_meridian:-84.16666666666667, latitude_of_origin: 30.0,
scale_factor:0.9999, false_easting:2296583.333333333, false_northing:0, unit: 0.3048006096012192});
</code></td>
</tr>
</tbody>
</table>
<h3>Methods</h3>
<table summary="class TransverseMercator - Methods" width="90%">
<tbody>
<tr>
<th>Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>forward(<span class="type">lnglat:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="even">
<td><code>getCircum()</code></td>
<td><code></code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
<tr class="odd">
<td><code>inverse(<span class="type">coords:Array.number</span>)</code></td>
<td><code>Array.number</code></td>
<td>see <code><a href="reference.html#SpatialReference">SpatialReference</a></code></td>
</tr>
</tbody>
</table>
<h2><a name="Util"></a>namespace Util</h2>
<p>
A set of utilities ((<code>Util</code>)
for commonly used functions.</p>
<h3>Static Methods</h3>
<table summary="namespace Util - Static Methods" width="90%">
<tbody>
<tr>
<th>Static Methods</th>
<th>Return Value</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>addToMap(<span class="type">map:google.maps.Map</span>, <span class="type">overlays:Array.OverlayView</span>)</code></td>
<td><code>None</code></td>
<td>Add a list of overlays to map</td>
</tr>
<tr class="even">
<td><code>getJSON(<span class="type">url:String</span>, <span class="type">params:Object</span>, <span class="type">callbackName:String</span>, <span class="type">callbackFn:Function</span>)</code></td>
<td><code>String</code></td>
<td>Make Cross Domain Calls. This function returns the
script ID which can be used to track the requests. parameters:
<ul>
<li>url: url of server resource
<li>params: an object with name,value pairs. value must be string
<li>callbackName: Callback parameter name the server is expecting.e.g:'callback'
<li>callbackFn: the actual callback function.
</ul></td>
</tr>
<tr class="odd">
<td><code>registerSR(<span class="type">wkid/wkt:Number|String</span>, <span class="type">wktOrSR:Object</span>)</code></td>
<td><code>SpatialReference</code></td>
<td><b> static</b> method. Call with Syntax <code>SpatialReference.register(..)</code>.
Add A Spatial Reference to the internal collection of Spatial References.
the <code>wktOrSR</code> parameter can be String format of "well-known text" of the
Spatial Reference, or an instance of <code><a href="reference.html#SpatialReference">SpatialReference</a></code>.
<br/><li> If passes in String WKT format, to be consistent, it should use the same format as listed
in <a href = 'http://edndoc.esri.com/arcims/9.2/elements/pcs.htm'>
ESRI documentation</a>. For example, add NC State Plane NAD83 as String:
<br/><code>
SpatialReference.register(2264,'PROJCS["NAD_1983_StatePlane_North_Carolina_FIPS_3200_Feet",
GEOGCS["GCS_North_American_1983",
DATUM["D_North_American_1983",
SPHEROID["GRS_1980",6378137.0,298.257222101]],
PRIMEM["Greenwich",0.0],
UNIT["Degree",0.0174532925199433]],
PROJECTION["Lambert_Conformal_Conic"],
PARAMETER["False_Easting",2000000.002616666],
PARAMETER["False_Northing",0.0],
PARAMETER["Central_Meridian",-79.0],
PARAMETER["Standard_Parallel_1",34.33333333333334],
PARAMETER["Standard_Parallel_2",36.16666666666666],
PARAMETER["Latitude_Of_Origin",33.75],
UNIT["Foot_US",0.3048006096012192]]');
<br/></code>
Note: only <b>Lambert Conformal Conic</b> and <b>Transverse Mercator</b> Projection
based Spatial References are supported if added via WKT String.
<br/><li> If passes in an instance of <code><a href="reference.html#SpatialReference">SpatialReference</a></code>, it can be one of the
built in classes, or a class that extends SpatialReference. For example, add NC State Plane NAD83 as SR:
<br/><code>
SpatialReferences.register(2264: new LambertConformalConic({
wkid: 2264,
semi_major: 6378137.0,
inverse_flattening: 298.257222101,
standard_parallel_1: 34.33333333333334,
standard_parallel_2: 36.16666666666666,
central_meridian: -79.0,
latitude_of_origin: 33.75,
'false_easting': 2000000.002616666,
'false_northing': 0,
unit: 0.3048006096012192
});
<br/></code></td>
</tr>
<tr class="even">
<td><code>removeFromMap(<span class="type">overlays:Array.OverlayView</span>, <span class="type">clearArray:Boolean</span>)</code></td>
<td><code>None</code></td>
<td>Add a list of overlays to map</td>
</tr>
</tbody>
</table>
<h3>Events</h3>
<table summary="namespace Util - Events" width="90%">
<tbody>
<tr>
<th>Events</th>
<th>Arguments</th>
<th>Description</th>
</tr>
<tr class="odd">
<td><code>jsonpend</code></td>
<td><code><span class="type">scriptID:String</span></code></td>
<td>This event is fired after a REST JSONP response was returned by server.</td>
</tr>
<tr class="even">
<td><code>jsonpstart</code></td>
<td><code><span class="type">scriptID:String</span></code></td>
<td>This event is fired before a REST request sent to server.</td>
</tr>
</tbody>
</table>
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script type="text/javascript">
_uacct = "UA-964209-4";
urchinTracker();
</script>
</body>
</html>