描述
esri.Map类创建一个容器和为增加图层，图形，信息窗口和其它导航控制所必需的DOM结构。地图通常使用DIV增加到页面。地图的宽度和高度被初始化为DIV容器的宽度和高度。第一个图层增加到地图后，Map.onLoad事件被触发。此时地图是全功能的。Map.onLoad处理函数用于增加内容和该白地图行为。
构造函数
|
构造函数
|
描述
|
| esri.Map(divId,options?) |
在给定的HTML容器中创建地图，HTML容器通常是DIV。地图大小和容器大小一致。地图的构造函数也能包含选项参数。这些选项参数能包容任意顺序。 |
属性表
| 属性 |
类型 |
描述 |
| attribution |
Attribution |
当地图属性激活的时候，参考地图创建的属性微件。 |
| autoResize |
Boolean |
当浏览器窗口或者面板微件关闭的时候，地图自适应的调整大小，该值为true。 |
| basemapLayerIds |
String[] |
与构成底图图层一致的ID数组 |
| extent |
Extent |
地图的当前范围。该属性是只读的。 |
| fadeOnZoom |
Boolean |
缩放时，指示地图逐渐消失是否生效。 |
| geographicExtent |
Extent |
地图在地理坐标系中的范围。 |
| graphics |
GraphicsLayer |
从GraphicsLayer中增加删除图形。 |
| graphicsLayerIds |
String[] |
地图里当前GraphicsLayers的数组。 |
| height |
Number |
地图的当前高度，高度单位是屏幕像数 |
| id |
String |
地图位于页面的HTML DIV或其他元素的引用。该属性在地图构造函数里设置。 |
| infoWindow |
InfoWindow |
在地图上显示信息窗口 |
| isClickRecenter |
Boolean |
当属性为true，按shift+click键重定义地图中心点。 |
| isDoubleClickZoom |
Boolean |
当属性为true，双击放大地图可用，允许用户使用鼠标双击放大和重定义地图中心点。 |
| isKeyboardNavigation |
Boolean |
当属性为true，键盘导航可用。该属性允许用户用箭头键移动地图，用+和-键缩放地图。 |
| isPan |
Boolean |
当属性为true，可以使用鼠标移动地图。 |
| isPanArrows |
Boolean |
当属性为true，在地图边缘显示移动箭头。 |
| isRubberBandZoom |
Boolean |
当属性为true，伸缩线可用。允许用户使用鼠标画一个边界框缩放区域。 |
| isScrollWheelZoom |
Boolean |
当属性为true，可用鼠标滚动缩放地图 |
| isShiftDoubleClickZoom |
Boolean |
当属性为true，可用shift键+双击鼠标放大地图。这允许用户使用shift + 鼠标双击去放大和重定向地图中心。 |
| isZoomSlider |
Boolean |
当属性为true，地图上显示缩放滑动条。 |
| layerIds |
String[] |
加到地图里的当前TiledMapServiceLayers和DynamicMapServiceLayers的数组 |
| loaded |
Boolean |
第一个图层被加载后，属性值被设置为true |
| position |
Point |
该屏幕坐标的点几何体代表地图容器的左上角。这个坐标也担当了地图和GraphicsLayer事件返回的所有屏幕坐标的原点。 |
| spatialReference |
SpatialReference |
地图的空间参考。支持的空间参考列表，见投影坐标系统和地理坐标系统。 |
| visible |
Boolean |
指示地图是否可见。 |
| width |
Number |
地图当前宽度，宽度单位是屏幕像数。 |
方法表
地图功能：
| 方法 |
返回值 |
描述 |
| addLayer(layer,index?) |
Layer |
增加ESRI图层到地图。 |
| getInfoWindowAnchor(screenCoords) |
String |
设置调用InfoWindow.show方法时信息窗口的定位点。 |
| getLayer(id) |
Layer |
返回地图一个单独的图层。 |
| getLevel() |
Number |
获得当前地图的级别ID。仅仅ArcGISTiledMapService有效。 |
| removeAllLayers() |
none |
从地图上删除所有图层。当图层被删除是，已定义的地图范围，空间参考，切片模式不会修改。当下一个图层被加到地图，图层以相同的范围和空间参考显示。 |
| removeLayer(layer) |
none |
删除地图的指定图层。 |
| reorderLayer(layer, index) |
none |
修改地图里图层顺序。 |
| reposition() |
none |
在页面上重新放置地图DIV。当地图已经被重新放置后需要使用这个方法。 |
| resize() |
none |
调整地图DIV。当重新调整map DIV大小后这个方法要被使用。 |
| setExtent(extent, fit?) |
none |
设置地图范围。范围必需参照和地图一样的空间参考 |
| setLevel(level) |
none |
设置地图到指定级别ID。基于当前地图中心点缩放到新的级别。仅仅对ArcGISTiledMapService图层有效。 |
| setMapCursor(cursor) |
none |
设置地图默认指针。除了拖拽地图进行移动或使用SHIFT+拖拽放大地图时外，鼠标位于地图上时该指针总被显示。如果没有设置，地图使用系统默认指针，通常使用箭头。 |
| toMap(screenPoint) |
Point |
转换单个屏幕点坐标或屏幕点坐标数组为地图坐标。 |
| toScreen(mapPoint) |
Point |
转换单个地图点坐标或地图点坐标的数组为屏幕坐标。 |
地图导航：
| 方法 |
返回值 |
描述 |
| centerAndZoom(mapPoint,levelOrFactor) |
Deferred |
地图居中并缩放。 |
| centerAt(mapPoint) |
Deferred |
以指定地图坐标作为中心点坐标重定位地图。 |
| disableClickRecenter() |
none |
不允许单击地图来重定位地图中心点。 |
| disableDoubleClickZoom() |
none |
不允许双击地图来放大地图一个级别并重定位地图中心点 |
| disableMapNavigation() |
none |
除了滑动条和移动箭头，不允许其它所有地图导航。 |
| disablePan() |
none |
不允许用鼠标移动地图。 |
| disableRubberBandZoom() |
none |
不允许使用边界框放大或缩小地图。 |
| disableScrollWheelZoom() |
none |
不允许使用鼠标滚动滑轮放大或缩小地图。 |
| disableShiftDoubleClickZoom() |
none |
不允许shift键+鼠标双击放大地图并重定位地图中心点。 |
| disbleKeyboardNavigation() |
none |
不允许使用键盘移动和缩放地图。 |
| enableClickRecenter() |
none |
允许用户单击地图来重定位中心点。 |
| enableDoubleClickZoom() |
none |
允许用户双击地图放大一个级别并重定位地图中心点。 |
| enableKeyboardNavigation() |
none |
允许用户使用键盘移动和缩放地图。 |
| enableMapNavigation() |
none |
允许所有地图导航。 |
| enablePan() |
none |
允许使用鼠标移动地图。 |
| enableRubberBandZoom() |
none |
允许使用划定边界框放大或缩小地图。 |
| enableScrollWheelZoom() |
none |
允许用户用鼠标滑轮放大或缩小地图。 |
| enableShiftDoubleClickZoom() |
none |
允许用使用shift+双击鼠标去放大地图一个级别并重定位地图中心点。 |
| hidePanArrows() |
none |
隐藏地图移动指针。 |
| hideZoomSlider() |
none |
隐藏地图缩放滚动条。 |
| panDown() |
Deferred |
向南移动地图。 |
| panLeft() |
Deferred |
向西移动地图。 |
| panLowerLeft() |
Deferred |
向西南移动地图。 |
| panLowerRight() |
Deferred |
向东南移动地图。 |
| panRight() |
Deferred |
向东移动地图。 |
| panUp() |
Deferred |
向北移动地图。 |
| panUpperLeft() |
Deferred |
向西北移动地图。 |
| panUpperRight() |
Deferred |
向东北移动地图。 |
| showPanArrows() |
none |
显示地图移动指针。 |
| showZoomSlider() |
none |
显示缩放滚动条。 |
事件
| 事件 |
描述 |
| onBasemapChange(event) |
当用户切换底图时触发。 |
| onBeforeUnload(map) |
地图部署好之前触发。 |
| onClick(event) |
当用户使用鼠标单击地图且鼠标在HTML页面的地图范围内时触发。 |
| onDblClick(event) |
当用户在地图上双击鼠标且鼠标在html页面的地图范围内时触发该事件 |
| onExtentChange(extent,delta, levelChange, lod) |
当地图范围已经修改触发该事件。 |
| onKeyDown(keyEvent) |
当键盘某键被按下时触发该事件 |
| onKeyUp(keyEvent) |
当键盘某键被释放时触发该事件。 |
| onLayerAdd(layer) |
图层被增加到地图时触发该事件。 |
| onLayerRemove(layer) |
图层已经被删除后触发事件 |
| onLayerReorder(layer, index) |
当地图图顺序已经被改变时触发事件。 |
| onLayersRemoved() |
所有图层被删除后触发事件 |
| onLayersReordered(layerIds) |
所有图层被重新排序是触发事件。 |
| onLoad(map) |
第一个或基础图层被成功增加到地图时触发事件。 |
| onMouseDown(event) |
当鼠标按钮被按下且鼠标指针在HTML页面的地图范围里时触发事件。 |
| onMouseDrag(event) |
鼠标被拖转直到鼠标按钮被释放时触发事件。 |
| onMouseDragEnd(event) |
当鼠标按钮被释放并且用户停止拖拽鼠标时触发事件。 |
| onMouseDragStart(event) |
当鼠标按钮被按下并用户开始拖拽鼠标时触发事件。 |
| onMouseMove(event) |
鼠标指针在地图范围上移动时触发事件。通常该事件用于用户移动鼠标指针时显示当前地图x,y坐标。 |
| onMouseOut(event) |
当鼠标移出HTML页的地图范围时触发事件。 |
| onMouseOver(event) |
鼠标移入HTML页面的地图范围时触发事件。 |
| onMouseUp(event) |
当地图按钮被释放并且鼠标指针在HTML页面的地图范围内时触发事件。 |
| onMouseWheel(event) |
鼠标滚轮滚动时触发事件。 |
| onPan(extent, delta) |
地图移动过程中触发事件。 |
| onPanEnd(extent, endPoint) |
移动完成时触发事件。 |
| onPanStart(extent, startPoint) |
用户开始移动时触发事件。 |
| onReposition(x, y) |
地图DIV被重新定位时触发事件。 |
| onResize(extent, height, width) |
包含地图的DIV已经被调整大小时触发事件。 |
| onUnload(map) |
刷新页面时触发事件。 |
| onZoom(extent, zoomFactor, anchor) |
缩放过程中触发事件。 |
| onZoomEnd(extent, zoomFactor, anchor, level) |
缩放完成时触发事件。 |
| onZoomStart(extent, zoomFactor, anchor, level) |
用户开始缩放时触发事件。 |
描述
边界框的最大和最小的x坐标和y坐标。
构造函数
|
构造函数
|
描述
|
| esri.geometry.Extent(xmin, ymin, xmax, ymax, spatialReference) |
创建一个范围对象。坐标表示边界框左下角和右上角的坐标。空间参考也是必需的。 |
| esri.geometry.Extent(json) |
使用JSON对象创建一个范围对象。 |
属性表
| 属性 |
类型 |
描述 |
| xmax |
Number |
范围框右上角x坐标值 |
| xmin |
Number |
范围框左下角x坐标。 |
| ymax |
Number |
范围框右上角y坐标。 |
| ymin |
Number |
范围框左下角y坐标。 |
方法表
| 方法 |
返回值 |
描述 |
| centerAt(point) |
Extent |
一个以参数点为中心的同样宽度和高度的范围被返回。 |
| contains(point) |
Boolean |
当返回值为true，参数点包含在当前范围内。 |
| expand(factor) |
Extent |
通过给定因素扩张范围。例如，1.5表示将增大50%。 |
| getCenter() |
Point |
返回范围的地图单位的中心点。 |
| getHeight() |
Number |
最大y坐标和最小y坐标的距离。 |
| getWidth() |
Number |
最大x坐标和最小x坐标的距离。 |
| intersects(geometry) |
Extent|Boolean |
当返回值是true,参数中的范围与当前范围相交。 |
| offset(dx, dy) |
Extent |
偏移当前范围。单位是地图单位。 |
| union(extent) |
Extent |
扩张当前范围来包含参数的范围。 |
| update(xmin, xmin, xmax, ymax, spatialReference) |
Extent |
通过制定参数修改当前范围。 |
描述
通过x坐标和y坐标定义的位置。可以是地图单位或屏幕单位。
构造函数
| 构造函数 |
描述 |
| esri.geometry.Point(x, y, spatialReference) |
使用x，y和空间参考创建点对象。 |
| esri.geometry.Point([x,y], spatialReference) |
使用包含x,y坐标值和空间参考的数组创建点对象。 |
| esri.geometry.Point(json) |
使用JSON对象创建点坐标。 |
属性表
| 属性 |
类型 |
描述 |
| x |
Number |
点的地图单位的x坐标。 |
| y |
Number |
点的地图单位的y坐标。 |
方法表
| 方法 |
返回值 |
描述 |
| offset(dx, dy) |
Point |
偏移点到x和y的方向。单位是地图单位。 |
| setX(x) |
Point |
设置点的x坐标。 |
| setY(y) |
Point |
设置点的y坐标。 |
| update(x, y) |
Point |
更新点。 |
描述
环形的数组，每个环形都是一个点数组。环形的第一个点和最后一个点必须是一样的。
构造函数
|
构造函数
|
描述
|
| esri.geometry.Polygon(spatialReference) |
创建一个新的Polygon对象。 |
| esri.geometry.Polygon(json) |
创建一个新的Polygon对象。使用JSON对象。 |
属性表
|
构造函数
|
类型
|
描述
|
| rings |
Number[][][] |
环形数组。每个环形是由三个或多个点组成。 |
方法表
| 方法 |
返回值 |
描述 |
| addRing(points or ring or pointJson) |
Polygon |
增加环形到Polygon。环形能使下面的形式：数字数组，点数组，JSON对象。增加时环形的索引会递增一个。 |
| contains(point) |
Boolean |
客户端检查指定点是否在polygon里面。polygon线上的点被认为是在里面的。 |
| getExtent() |
Extent |
返回polygon的范围。 |
| getPoint(ringIndex, pointIndex) |
Point |
返回通过环形和路径中的点指定的点。 |
| insertPoint(ringIndex, pointIndex, point) |
Polygon |
插入新的点到polygon。 |
| removeRing(ringIndex) |
Point[] |
从Polygon里面删除一个环形。索引指定了要删除的环形。 |
| setPoint(ringIndex, pointIndex, point) |
Polygon |
更新polygon里的一个点。 |
描述
路径数组，每个路径是一个点的数组。
构造函数
|
构造函数
|
描述
|
| esri.geometry.Polyline(spatialReference) |
创建一个新的Polyline对象。 |
| esri.geometry.Polyline(json) |
创建一个新的Polyline对象。使用JSON对象。 |
属性表
|
构造函数
|
类型
|
描述
|
| paths |
Number[][][] |
路径数组。每个路径由两个或多个点的数组构成。 |
方法表
| 方法 |
返回值 |
描述 |
| addPath(points or ring or pointJson) |
Polyline |
增加路径到Polyline。路径能够是下列类型之一：数字数组，点的数组，JSON对象。当增加时路径索引递增一。 |
| getExtent() |
Extent |
返回Polyline的范围。 |
| getPoint(pathIndex, pointIndex) |
Point |
返回通过路径和路径里的点指定的点。 |
| insertPoint(pathIndex, pointIndex, point) |
Polyline |
插入一个新的点到polyline。 |
| removePath(pathIndex) |
Point[] |
从Polyline删除一个路径。索引指定的路径将删除。 |
| setPoint(pathIndex, pointIndex, point) |
Polyline |
在polyline中更新点。 |
描述
线符号用于绘画图形图层上的线型的要素。
属性表
|
属性
|
类型
|
描述
|
| width |
Number |
线符号的宽度（单位：像素）。 |
方法表
|
方法
|
返回值
|
描述
|
| setWidth(width) |
LineSymbol |
设置LineSymbol宽度。 |
描述
标记符号用于绘出图形图层上的points或multipoints。
属性表
|
属性
|
类型
|
描述
|
| angle |
Number |
图片的角度。0是指向右侧并且值是顺时针。 |
| size |
Number |
标记的大小（单位：像素）。 |
| xoffset |
Number |
x轴上的偏移量（单位：像素）。 |
| yoffset |
Number |
y轴上的偏移量（单位：像素）。 |
方法表
|
方法
|
返回值
|
描述
|
| setAngle(angle) |
MarkerSymbol |
设置标记的角度。 |
| setOffset(x, y) |
MarkerSymbol |
设置标记的x和y的偏移量（单位：屏幕单位）。 |
| setSize(size) |
MarkerSymbol |
设置标记的大小（单位：像素）。 |
方法表
填充符号用于在图形图层上绘制多边形要素。填充物可以指定为实心的，阴影的或图片。此外，符号还能有一个可选的轮廓线，轮廓线通过线符号定义。
属性表
|
属性
|
类型
|
描述
|
| outline |
SimpleLineSymbol |
多边形的轮廓线。 |
方法表
|
方法
|
返回值
|
描述
|
| setOutline(outline) |
FillSymbol |
设置多边形符号的轮廓线。 |
描述
InfoWindow是一个HTML弹出消息。信息窗口通常包含Graphic的属性。在图形上的默认行为是单击图形后显示信息窗口。为了单击显示信息窗口， InfoTemplate是必须的。另外，信息窗口能够被用于在地图上显示自定义内容。
属性表
|
属性
|
类型
|
描述
|
| anchor |
String |
关于图形的信息窗口的位置。参数值见常量表。 |
| coords |
Point |
信息窗口屏幕坐标的参照点。 |
| fixedAnchor |
String |
信息窗口总是在指定位置显示。参数值见常量表。 |
| isShowing |
Boolean |
确定当前信息窗口是否被显示在地图上。 |
常量
|
常量
|
描述
|
| ANCHOR_LOWERLEFT |
信息窗口位于点的左下方。 |
| ANCHOR_LOWERRIGHT |
信息窗口位于点的右下方。 |
| ANCHOR_UPPERLEFT |
信息窗口位于点的左上方。 |
| ANCHOR_UPPERRIGHT |
信息窗口位于点的右上方。 |
方法表
|
方法
|
返回值
|
描述
|
| hide() |
none |
隐藏信息窗口。 |
| move(point) |
none |
移动信息窗口到指定屏幕点。 |
| resize(width, height) |
none |
修改信息窗口大小为指定的像数高和宽。 |
| setContent(stringOrDOMNode) |
InfoWindow |
设置信息窗口中的内容。 |
| setFixedAnchor(anchor) |
none |
设置信息窗口固定位置。有效值在常量表内列出。 |
| setTitle(title) |
InfoWindow |
设置信息窗口标题。 |
| show(point, anchor) |
none |
在指定的屏幕点和固定点方向显示信息窗口。有效值在常量表中列出。 |
事件
|
事件
|
描述
|
| onHide() |
当信息窗口被隐藏时触发。 |
| onShow() |
当信息窗口被可见时触发。 |
描述
支持如平移和缩放等基本导航的工具栏。
构造函数
|
构造函数
|
描述
|
| esri.toolbars.Navigation(map) |
创建新的Navigation对象。地图是一个必需的参数。 |
常量
|
常量
|
描述
|
| PAN |
地图被平移。 |
| ZOOM_IN |
地图放大。 |
| ZOOM_OUT |
地图缩小。 |
方法表
|
方法
|
返回值
|
描述
|
| activate(navType) |
none |
激活地图导航工具栏。激活的工具栏覆盖默认地图导航。 |
| deactivate() |
none |
禁用工具栏并重新激活地图导航。 |
| isFirstExtent() |
Boolean |
当是"true"，地图在第一个范围。 |
| isLastExtent() |
Boolean |
当是true，地图在最后一个范围。 |
| zoomToFullExtent() |
none |
缩放到基本图层的全部范围。 |
| zoomToNextExtent() |
none |
缩放到范围历史中的下一个范围。 |
| zoomToPrevExtent() |
none |
缩放到范围历史中的上一个范围。 |
事件
|
事件
|
描述
|
| onExtentHistoryChange() |
当范围历史改变时触发。 |
描述
所有可以加到地图里的图层的基础类。
属性表
| 属性 |
类型 |
描述 |
| id |
String |
图层ID。如果没有指定，esri.Map指定值。 默认情况下，图层ID是"layer"+数字。ID仅仅能在图层构造函数中被用户定义。 |
| loaded |
Boolean |
当图层被加载时，值变为true，图层属性可以被访问。onLoad事件也被触发。 |
| opacity |
Number |
图层的不透明或透明度。属性值范围从0.0到1.0，当值是0.0时，100%透明，当值为1.0时，不透明。 |
| url |
String |
指向ArcGIS Server REST地图服务资源的URL。 使用Services Directory获得URL。 |
| visible |
Boolean |
图层的可见性。 |
方法表
|
方法
|
返回值
|
描述
|
| hide() |
none |
设置图层的可见性。设置为false，图层没有删除，但是从视窗隐藏。 |
| setOpacity(opacity) |
none |
设置图层不透明度。 值范围从0.0到1.0，0.0是100%透明，1.0是不透明。 |
| show() |
none |
设置图层的可见性为"true"。 |
事件
| 事件 |
描述 |
| onError(error) |
当接收图层出现问题时触发该事件。 |
| onLoad(layer) |
图层的属性成功填充后触发事件。图层加到地图以前该事件必须是成功的。 |
| onOpacityChange(opacity) |
当图层不透明度被修改时触发，返回不透明度的值。 |
| onUpdate() |
图层完成加载或自身修改的时候触发事件。 对于ArcGISTiledMapServiceLayer，已经接收并显示所有请求的切片时触发事件。 对于ArcGISDynamicMapServiceLayer 或 ArcGISImageServiceLayer，地图图像已经接收并显示时触发事件。对于GraphicsLayer，当移动或缩放后所有图形已经被变形时触发事件。 |
| onVisibilityChange(visbility) |
当图层可见性已经被修改时触发，返回新的可见性。 |
描述
包含关于地图服务里每个图层的信息。
属性表
| 属性 |
类型 |
描述 |
| defaultVisibility |
Boolean |
地图服务中默认图层的可见性。 |
| id |
Number |
ArcGIS Server为图层分配的图层ID。 顶层图层是0，每个图层ID是连续地递增。 如果图层从原地图文档中被增加或删除，ID值会跟着移动。 |
| name |
String |
在地图服务里定义的图层名称。 |
| parentLayerId |
Number |
如果图层是一组图层的一部分，图层会包含这组图层的父ID。 否则，该属性值是-1。 如果图层从原地图文档中被增加或删除，ID值会跟着移动。 |
| subLayerIds |
Number[] |
如果图层是父图层，图层将有包含在数组里的一到多个子图层。否则，该属性值是null。 如果图层从原地图文档中被增加或删除，ID值会跟着移动。 |
描述
可以使用ArcGIS Server REST API提供的动态地图服务资源。动态地图服务联机生成图像。
构造函数
|
构造函数
|
描述
|
| esri.layers.ArcGISDynamicMapServiceLayer(url, options?) |
创建新的ArcGISDynamicMapServiceLayer对象。URL是必需的参数。这个图层接受一些可选参数。这些可选参数可以包容任意顺序。 |
属性表
| 属性 |
类型 |
描述 |
| copyright |
String |
地图服务定义的版权字符串。 |
| description |
String |
地图服务定义的地图描述。 |
| disableClientCaching |
Boolean |
当值为true时，图片总是从服务器上获取，忽略浏览器的缓存。这将被用于地图服务的数据时常修改的情况。 |
| dpi |
Number |
动态地图服务层的输出dpi。 |
| imageFormat |
String |
输出图片类型。自ArcGIS Server9.3.1起，支持的图片格式列表被包含在服务目录里地图服务描述的“支持的图片格式类型”下。另外，自ArcGIS Server9.3.1起，优化的地图服务能支持真PNG32图片。 |
| imageTransparency |
Boolean |
|
| layerDefinitions |
String[] |
|
| layerInfos |
LayerInfo[] |
|
| units |
String |
|
| useMapImage |
Boolean |
useMapImage设置。 |
| visibleLayers |
Number[] |
获得导出地图的可见图层。 |
方法表
| 方法 |
返回值 |
描述 |
| exportMapImage(imageParameters?, callback?) |
none |
使用ImageParameters指定的值导出地图。结束时，返回MapImage。 |
| setDefaultLayerDefinitions() |
none |
重设服务上所有定义的图层的定义。 |
| setDefaultVisibleLayers() |
none |
清除setVisibleLayers定义的可见图层，重置可见图层为地图服务的默认图层。 |
| setDisableClientCaching(disable) |
none |
设置图片是否总是从服务上获得并忽略浏览器缓存。当地图服务支持数据经常改变时被用到。 |
| setDPI(dpi) |
none |
设置导出地图的dip。默认值为96。 |
| setImageFormat(imageFormat) |
none |
设置导出地图的图片格式。 |
| setImageTransparency(transparent) |
none |
设置动态图片的背景是否透明。 |
| setLayerDefinitions(layerDefinitions) |
none |
设置图层定义用于过滤地图服务里个别的图层的要素。 layerDefinitions参数是图层定义表达式数组，如下面的代码片段：
var layerDefinitions = [];
layerDefinitions[0] = "POPULATION > 5000000";
layerDefinitions[5] = "AREA > 100000";
dynamicMapServiceLayer.setLayerDefinitions(layerDefinitions);
注意这个数组目录0和5是有效图层ID，POPULATION和AREA是各自图层相关的属性字段。当前不可见的图层的定义表达式会被服务器忽略。 |
| setVisibleLayers(ids,doNotRefresh?) |
none |
设置导出地图的可见的图层。默认情况下，可视的图层通过LayerInfo的默认可见性定义。 |
事件
| 事件 |
描述 |
| onMapImageExport(mapImage) |
当图层导出完成时触发。 |
描述
可以用ArcGIS Server REST API提供的图像地图服务资源工作。
构造函数
|
构造函数
|
描述
|
| esri.layers.ArcGISImageServiceLayer(url, options?) |
创建新的ArcGISImageServiceLayer对象。URL是必需的参数，也接受一些可选参数。这些可选参数可以是任意顺序。 |
属性表
| 属性 |
类型 |
描述 |
| bandCount |
Number |
ArcGISImageServiceLayer里波段的数量。 |
| bandIds |
Number[] |
当前波段选择的数组。 |
| bands |
Object[] |
光栅数据集组成的光栅波段和统计信息。数组长度给出波段的数量，数组索引代表波段ID。 |
| compressionQuality |
Number |
当前压缩质量值。压缩质量控制了有多少损失的图片。仅仅对JPG图片类型有效。 |
| copyrightText |
String |
图像服务定义的版权字符串。 |
| Description |
String |
图像服务定义的描述。 |
| disableClientCaching |
Boolean |
当值为true时，图片总是从服务器上获取，忽略浏览器的缓存。这将被用于地图服务的数据时常修改的情况。 |
| format |
String |
输出图像类型。 |
| interpolation |
String |
当前插值方法。插值方法影响当栅格数据集变形或改变坐标空间时，栅格数据集如何变换。 |
| pixelSizeX |
Number |
X方向的像素大小。 |
| pixelSizeY |
Number |
Y方向的像素大小。 |
| pixelType |
Number |
图像服务像素类型。保存在光栅图里面的值的类型，例如有符号整数，无符号整数，或浮点数。整数全是数字，而浮点数有小数位。 |
方法表
| 方法 |
返回值 |
描述 |
| exportMapImage(imageServiceParameters?,callback?) |
none |
用通过ImageServiceParameters指定的值导出地图。完成时，返回MapImage。 |
| setBandIds(bandIds,doNotRefresh?) |
none |
设置导出图像的R,G,B为合适的ImageService波段ID。BandIds是0基准。 |
| setCompressionQuality(quality) |
none |
设置导出图片的压缩质量。仅仅对JPG图片格式有效。 |
| setDisableClientCaching(disable) |
none |
设置图片是否总是从服务器获取，忽略浏览器缓存。当地图服务提供数据经常修改时使用。 |
| setInterpolation(interpolation) |
none |
设置插值方法。插值方法影响当栅格数据集变形或改变坐标空间时，栅格数据集如何变换。 |
事件
| 事件 |
描述 |
| onMapImageExport(mapImage) |
当当地图导出完成时触发。 |
描述
使用ArcGIS Server REST API提供的缓存地图服务资源工作。缓存服务访问的是高速缓存切片，而不是动态渲染图图片。
构造函数
|
构造函数
|
描述
|
| esri.layers.ArcGISTiledMapServiceLayer(url, options?) |
创建新的ArcGISTiledMapServiceLayer对象。URL是必需的参数，还接受一些可选参数。这些可选参数可以是任意顺序。 |
属性表
| 属性 |
类型 |
描述 |
| copyright |
String |
地图服务定义的版权字符串。 |
| description |
String |
地图服务定义的地图描述。 |
| layerInfos |
LayerInfo[] |
返回服务里的有效图层和默认可见性。 |
| units |
String |
由服务定义的图层默认单位。如果图层是地图底图，地图是一样的单位。 |
描述
ArcGIS Server 动态地图服务的基础类。
属性表
| 属性 |
类型 |
描述 |
| fullExtent |
Extent |
地图服务定义的完整的范围。 |
| initialExtent |
Extent |
地图服务定义的初始范围。 |
| spatialReference |
LayerInfo[] |
地图服务的空间参考。 支持的空间参考列表，见投影坐标系统和地理坐标系统。 |
方法表
| 方法 |
返回值 |
描述 |
| getImageUrl(extent, width, height, callback) |
String |
当扩展DynamicMapServiceLayer时方法将执行。 更多详细信息，见创建自定义图层类型。 |
| refresh() |
none |
通过建立新的到服务器的请求刷新地图。为了以这种方式刷新图层，setDisableClientCaching必需是true。这保证了地图图片不是客户端的缓存。 |
描述
支持绘制几何体的功能的工具栏。
构造函数
|
构造函数
|
描述
|
| esri.toolbars.Draw(map) |
创建新的Draw对象。地图是一个必需的参数。 |
属性表
| 属性 |
类型 |
描述 |
| fillSymbol |
SimpleFillSymbol |
符号被用于绘制Polygon或Extent。 |
| lineSymbol |
SimpleLineSymbol |
符号被用于绘制Polyline。 |
| markerSymbol |
SimpleMarkerSymbol |
符号被用于绘制Point或Multipoint。 |
| respectDrawingVertexOrder |
Boolean |
当设置为false，几何体被修改为拓扑正确性。当设置为true，输入几何体不被修改。 |
常量
|
常量
|
描述
|
| EXTENT |
绘制一个extent box。 |
| FREEHAND_POLYGON |
绘制一个freehand polygon。 |
| FREEHAND_POLYLINE |
绘制一个freehand polyline。 |
| LINE |
绘制一个line。 |
| MULTI_POINT |
绘制一个Multipoint。 |
| POINT |
绘制一个point。 |
| POLYGON |
绘制一个polygon。 |
| POLYLINE |
绘制一个polyline。 |
方法表
| 方法 |
返回值 |
描述 |
| activate(geometryType) |
none |
为绘制几何体激活工具栏。激活工具条禁用地图导航。 |
| deactivate() |
none |
禁用工具栏并激活地图导航。 |
| setFillSymbol(fillSymbol) |
none |
设置填充符号。 |
| setLineSymbol(lineSymbol) |
none |
设置线段符号。 |
| setMarkerSymbol(markerSymbol) |
none |
设置标记符号。 |
| setRespectDrawingVertexOrder(set) |
none |
设置多边形几何体是否修改为拓扑正确的。 |
事件
| 事件 |
描述 |
| onDrawEnd(geometry) |
绘制完成时触发。 |
描述
表示ArcGIS Server REST API提供的一个几何服务资源。用于在几何体上执行各种的操作，例如投影，简化，缓存和空间关系。
构造函数
|
构造函数
|
描述
|
| esri.tasks.GeometryService(url) |
创建一个新的GeometryService对象. URL是一个必需的参数。 |
属性表
| 属性 |
类型 |
描述 |
| url |
String |
表示ArcGIS Server REST资源的定位器服务的URL。 使用Services Directory获得URL。 |
常量
| 常量 |
描述 |
| SPATIAL_REL_COINCIDENCE |
几何体的边框必须有一个交叉点，但是不考虑内部的关系（两者可以覆盖，一个包含在另一个里面，或者内部可能是不相交的）。这个关系应用于多段线和多边形。 |
| SPATIAL_REL_CROSS |
如果两个多段线有唯一的共同点，并且至少其中一个不是终端，则多段线交叉。如果一个多线段和一个多边形在多边形内部共有一个多线段，并且共有的多线段不等于全部多线段，则多线段和多边形交叉。如果其中一个几何体是空的，则几何体不交叉。 |
| SPATIAL_REL_DISJOINT |
如果两个几何体的交集是空，则是不相交的。如果disjoint是false，则两个几何体相交。 |
| SPATIAL_REL_IN |
如果基本的几何体是两个几何体的交集并且两个几何体内部的交集不是空的，那么这个基本几何体在另一个几何体的内部。除非另一个集合体是空的，一个空的几何体才会在另一个几何体的内部。 |
| SPATIAL_REL_INTERIORINTERSECTION |
几何体相交不包括边界线接触。 |
| SPATIAL_REL_INTERSECTION |
几何体内部相交或边界接触，等同于“不是不相交的”。 |
| SPATIAL_REL_LINETOUCH |
两个几何体是接触的，几何体的交集是非空的，但是几何体内部的交集为空。这估计接触是否沿着边界线发生（不是点）。多边形有效。 |
| SPATIAL_REL_OVERLAP |
两个多段线共享相同的支线，或两个多线段共享相同的子区。两个空的几何体不会重叠。 |
| SPATIAL_REL_POINTTOUCH |
当两个几何体交集是非空时两个几何体被称之为接触，但是几何体的内部交集是空的。这估计接触是否发生在点上（不是边界线上）。 |
| SPATIAL_REL_RELATION |
允许任何使用Shape Comparison Language的关系定义规范。 |
| SPATIAL_REL_TOUCH |
esriGeometryRelationPointTouch和esriGeometryRelationLineTouch的联合。当几何体交集是非空的但是他们的内部的交集是空的，两个几何体被称之为接触。例如，点接触是一个多段线只有唯一一个点和多线段端点之一一样。如果两个几何体中的一个是空的，几何体不会是接触的。 |
| SPATIAL_REL_WITHIN |
与esriGeometryRelationIn一致，但是也认可完全在多边形边界线上的多段线被视为在多边形内。 |
方法表
| 方法 |
返回值 |
描述 |
| areasAndLengths(areasAndLengthsParameters,callback?, errback?) |
dojo.Deferred |
当几何体类型是Polygon时获得Graphic[]的面积和长度。 |
| buffer(bufferParameters, callback?, errback?) |
dojo.Deferred |
在给定的几何体周边指定距离创建缓冲区多边形。完成时，onBufferComplete事件被触发并且可选的callback函数被调用。callback函数和事件处理器接收包含缓冲区几何体的Graphic数组。 |
| labelPoints(polygons, callback?, errback?) |
dojo.Deferred |
为每个多边形计算内部点。这些内部点能用于在客户端标识多边形。 |
| lengths(lengthsParameter,callback?, errback?) |
dojo.Deferred |
当几何体类型是Polyline时获得Graphic[]长度。 |
| project(params, outSpatialReference, callback?, errback?) |
dojo.Deferred |
将空间数据投影到另一个空间参考系中。完成时，onProjectComplete事件被触发并且可选的callback函数被调用。callback函数和事件处理器收到包含头投影几何体的Graphic数组。 |
| relation(relationParameters,callback?, errback?) |
dojo.Deferred |
计算graphics1和graphics2所属的空间关系。连个数组被认为用同一个空间参考。关系是2D的。Z坐标没有使用。数组内的几何体不能是混合的。 |
| simplify(geometries,callback?, errback?) |
dojo.Deferred |
改变给定几何体使他们拓扑定义和几何类型相符。完成时，onSimplifyComplete事件被触发并且可选的callback函数被调用。callback函数和事件处理器收到包含简化几何体的Graphic数组。 |
事件
| 事件 |
描述 |
| onAreasAndLengthsComplete(areasAndLengths) |
当areasAndLengths操作完成时触发该事件。 |
| onBufferComplete(geometries) |
当缓冲操作完成时触发该事件。 |
| onError(error) |
当执行任务发生错误时触发该事件。 |
| onLabelPointsComplete(labelPoints) |
当labelPoints操作完成时触发该事件。 |
| onLengthsComplete(lengths) |
当长度操作完成时触发该事件。 |
| onProjectComplete(geometries) |
当投影操作完成时触发该事件。 |
| onRelationComplete(relationships) |
当关系操作完成时触发该事件。 |
| onSimplifyComplete(geometry) |
当简化操作完成时触发该事件。 |
描述
这个数据对象被用于IdentifyTask.execute方法的identifyParameters参数。指定用于标识要素的条件。
构造函数
|
构造函数
|
描述
|
| esri.tasks.IdentifyParameters() |
创建一个新的IdentifyParameters对象. 构造函数没有参数。 |
属性表
| 属性 |
类型 |
描述 |
| dpi |
Number |
当前地图视图的分辨率。 |
| geometry |
Geometry |
几何体用于在Identify期间选择要素。几何体类型通过 Geometry type指定。最常用的标识几何体是Point。 |
| height |
Number |
当前被查看的地图高度（单位：像素）。 |
| layerIds |
Number[] |
执行查找操作的图层。图层通过逗号分隔的图层ID列表指定。图层id列表在ArcGISMapServiceLayer layerInfos中返回。 |
| layerOption |
String |
指定那些图层用于Identify。 可用值见常量表。 |
| mapExtent |
Extent |
当前查看的地图范围或地图边界框。除非sr被指定，否则mapExtent属性被视为用地图的空间参考。
mapExtent, height, width, 和dpi的值被用于确定在当前范围内的可见图层。也用于基于tolerance在地图上计算搜索距离。 |
| returnGeometry |
Boolean |
如果是true， 结果集包含和每个结果相关的几何体。默认值是false。 |
| spatialReference |
SpatialReference |
输入和输出的几何体的空间参考和mapExtent的空间参考一致。如果sr没有指定，几何体和范围被视为用地图的空间参考，输出几何体也用地图的空间参考。支持的空间参考列表，见投影坐标系统和地理坐标系统。 |
| tolerance |
Number |
在到指定几何体的距离内，identify可以被执行，距离单位是屏幕像数。 |
| width |
Number |
当前被查看的地图宽度（单位：像素）。 |
常量
| 常量 |
描述 |
| LAYER_OPTION_ALL |
identity所有图层，即使图层是不可见的。性能注意：如果服务有很多图层，使用这个选项，请求不会很好的执行。 一个可见的图层意味着你可以在地图上的当前范围内看到它。如果一个图层被关闭或不在设置的分辨率范围内，该图层不能被identity。 |
| LAYER_OPTION_TOP |
仅仅identity最顶层可见图层。 |
| LAYER_OPTION_VISIBLE |
identity所以可见的图层。 |
Identifyresult
描述
表示identity操作的结果。
属性表
| 属性 |
类型 |
描述 |
| displayFieldName |
String |
图层的主要显示字段的名称。属性的值和feature的其中一个字段的名称。 |
| feature |
Graphic |
一个标识的要素。 |
| layerId |
Number |
包含feature的图层的唯一ID。 |
| layerName |
String |
包含feature的图层名称。 |
Identifytask
描述
通过ArcGIS Server REST API提供的地图服务资源的图层执行一个identity操作。
构造函数
|
构造函数
|
描述
|
| esri.tasks.IdentifyTask(url,options?) |
创建一个新的IdentifyTask对象. URL是一个必需的参数。 |
属性表
| 属性 |
类型 |
描述 |
| url |
String |
指向ArcGIS Server REST地图服务资源的URL。使用Services Directory获得URL。 |
方法表
| 方法 |
返回值 |
描述 |
| execute(identifyParameters, callback?, errback?) |
dojo.Deferred |
发送一个请求到ArcGIS REST地图服务资源来基于IdentifyParameters指定的参数执行identify要素的操作。完成时，onComplete时间被触发并且可选的callback函数被调用。 |
事件
| 事件 |
描述 |
| onComplete(identifyResults) |
identify操作完成时触发该事件。 |
| onError(error) |
当执行任务发生错误时触发该事件。 |
描述
这个数据对象被用来做FindTask.execute方法的findParameters参数。该参数指定查找操作的搜索条件。
构造函数
|
构造函数
|
描述
|
| esri.tasks.FindParameters() |
创建一个新的FindParameters对象. 构造函数没有参数。 |
属性表
| 属性 |
类型 |
描述 |
| contains |
Boolean |
如果是false， 操作搜索完全匹配searchText字符串的值。 否则, 搜索包含提供的searchText字符串的值。 默认值是true。 |
| layerIds |
Number[] |
执行查找操作的图层。图层通过逗号分隔的图层ID列表指定。图层id列表在ArcGISMapServiceLayer layerInfos中返回。 |
| outSpatialReference |
SpatialReference |
输出几何体的空间参考。 如果outSR没有指定，输出几何体用地图的空间参考返回。 支持的空间参考列表，见投影坐标系统和地理坐标系统。 |
| returnGeometry |
Boolean |
如果是true，结果集包括和每个结果有关系的几何体。默认值是false。 |
| searchFields |
String[] |
用于搜索的图层字段的名称。字段通过逗号分隔的字段名称列表指定。如果参数没有指定，搜索所有字段。 |
| searchText |
String |
搜索字符串文版被用于搜索图层和在图层中指定的字段以及searchFields参数。 |
Findresult
描述
表示查找操作结果的类。
属性表
| 属性 |
类型 |
描述 |
| displayFieldName |
String |
图层的主要显示字段的名称。属性的值和feature的其中一个字段的名称。 |
| feature |
Graphic |
查找的要素。 |
| foundFieldName |
String |
包含搜索文本的字段的名称。 |
| layerId |
Number |
包含feature的图层的唯一ID。 |
| layerName |
String |
包含feature的图层名称。 |
Findtask
描述
ArcGIS Server REST API提供的基于字符串搜索地图服务。搜索能够在单个图层的单个字段，一个图层的多个字段以及多个图层的多个字段上进行。
构造函数
|
构造函数
|
描述
|
| esri.tasks.FindTask(url) |
创建一个新的FindTask对象. URL是一个必需的参数。 |
属性表
| 属性 |
类型 |
描述 |
| url |
String |
指向ArcGIS Server REST地图服务资源的URL。使用Services Directory获得URL。 |
方法表
| 方法 |
返回值 |
描述 |
| execute(findParameters, callback?, errback?) |
dojo.Deferred |
发送一个请求到ArcGIS REST地图服务资源来执行一个基于FindParameters的搜索。完成时，onComplete时间被触发并且可选的callback函数被调用。 |
事件
| 事件 |
描述 |
| onComplete(findResults) |
当查找操作完成时触发该事件。结果是一个FindResult数组。如果可选的callback函数被指定，返回一样的信号。 |
| onError(error) |
当执行任务发生错误时触发该事件。 |
描述
表示ArcGIS Server REST API提供的地理编码服务资源。用于生成地址的候选位置。也被用来查找指定位置的地址。
构造函数
|
构造函数
|
描述
|
| esri.tasks.Locator(url) |
创建一个新的Locator对象。 |
属性表
| 属性 |
类型 |
描述 |
| url |
String |
指向ArcGIS Server REST地图服务资源的URL。使用Services Directory获得URL。 |
方法表
| 方法 |
返回值 |
描述 |
| addressToLocations(address, outFields?,callback?,errback?) |
dojo.Deferred |
发送请求到ArcGIS REST地理编码资源，去查找指定在address参数中的一个单独的地址的候选位置。完成时，onAddressToLocationsComplete 事件被触发，可选的callback 函数被调用。 |
| locationToAddress(location, distance, callback?, errback?) |
dojo.Deferred |
基于给定的点定位一个地址。 |
事件
| 事件 |
描述 |
| onAddressToLocationsComplete(addressCandidates) |
当Locator.addressToLocation() 完成的时候触发，结果是一个AddressCandidate数组。如果指定可选的callback |
| onError(error) |
执行任务遇到错误的时候触发。 |
| onLocationToAddressComplete(addressCandidate) |
当Locator.locationToAddress()完成的时候触发。结果是一个AddressCandidate。如果指定可选的callback ，返回同样的签名。 |
描述
Query类是QueryTask的输入。不是所有的查询属性都是执行查询任务必需的。查询定义需要下列属性之一：queryGeometry, text, 或 where。可选的属性包括 outFields, outSpatialReference 和 returnGeometry。
构造函数
|
构造函数
|
描述
|
| esri.tasks.Query() |
创建新的QueryTask对象用于通过URL在图层资源上执行一个查询。 |
属性表
| 属性 |
类型 |
描述 |
| geometry |
Geometry |
几何体应用于空间过滤。执行查询期间，spatialRelationship指定的空间关系被应用到这个几何体。有效的几何体类型是Extent, Point, Multipoint, Polyline或Polygon. |
| outFields |
String[] |
属性字段包含在FeatureSet里。字段必须在地图图层中存在。必须列出实际字段而不是别名。返回的字段也是实际字段名称。然而，当显示结果时可以使用字段别名。用户能够在地图文档和管理器中设置字段别名。当指定了输出字段，指定的字段应该是在查询或者结果中用到的字段，包含越少的字段响应速度会越快。
每个查询必须访问图层的Shape和Objectid字段，但是字段列表不必包含这些字段。 |
| outSpatialReference |
SpatialReference |
返回几何体的空间参考。如果没有指定，返回几何体用地图的空间参考。支持的空间参考列表，见投影坐标系统 and 地理坐标系统。 |
| returnGeometry |
Boolean |
如果是"true"，每个FeatureSet的要素包含几何体。如果不计划在地图上包含高亮要素设置为"false"(默认值)。 |
| spatialRelationship |
String |
执行查询期间，空间关系将被用于输入几何体。有效值在常量表中列出。 |
| text |
String |
使用"like"where子句缩写。使用的字段是定义在地图文档中的显示字段。能在服务目录中确定一个图层的显示字段是什么。 |
| where |
String |
查询的where子句。允许任何合法的操作层中字段的SQLwhere子句。 |
常量
| 常量 |
描述 |
| SPATIAL_REL_CONTAINS |
要素类1的部分或全部要素包含在要素类2的要素中。 |
| SPATIAL_REL_CROSSES |
要素类1的要素跨越要素类2中的要素。 |
| SPATIAL_REL_ENVELOPEINTERSECTS |
要素类1中的envelope与要素类2中的envelope相交。 |
| SPATIAL_REL_INDEXINTERSECTS |
查询要素类的envelope和目标要素类的索引目录相交。 |
| SPATIAL_REL_INTERSECTS |
要素1中的部分要素被包含在要素2的要素中。 |
| SPATIAL_REL_OVERLAPS |
要素类1中的要素和要素类2中的要素重合。 |
| SPATIAL_REL_TOUCHES |
要素类1中的要素接触要素类2中的一个要素的边框。 |
| SPATIAL_REL_WITHIN |
要素类1中的要素完全被要素类2中的要素包含。 |
描述
在ArcGIS Server REST API提供的地图服务图层资源上执行一个查询操作。
构造函数
|
构造函数
|
描述
|
| esri.tasks.QueryTask(url) |
创建一个在图层资源的url上执行查询的QueryTask对象。 |
属性表
| 属性 |
类型 |
描述 |
| url |
String |
表示一个地图服务图层的ArcGIS Server REST资源的URL。为了获得URL，使用 Services Directory。 |
方法表
| 方法 |
返回值 |
描述 |
| execute(parameters, callback?, errback?) |
dojo.Deferred |
在ArcGIS Server地图图层上执行查询。返回结果是FeatureSet。如果查询成功，用户指定的callback函数被调用。FeatureSet包含Graphic数组要素，可以通过Map.graphics.add()加到地图里面。如果没有找到结果，这个数组不会被填充。 |
事件
| 事件 |
描述 |
| onComplete(featureSet) |
QueryTask.execute()方法执行完成，该事件被触发。结果是一个FeatureSet。如果可选的callback函数被指定，返回相同的信号。 |
| onError(error) |
执行任务遇到错误的时候触发。 |
构造函数
|
构造函数
|
描述
|
| esri.tasks.RouteParameters() |
创建一个新的RouteParameters对象。 |
属性表
| 属性 |
类型 |
描述 |
| accumulateAttributes |
String[] |
网络属性名称的列表将被分析累计，例如，那些应该作为响应的一部分被返回的属性。 |
| barriers |
Object |
在分析期间, 加载的一组障碍物。 |
| directionsLanguage |
String |
计算方向时使用的语言。 |
| directionsLengthUnits |
String |
当计算方向时候使用的长度单位. |
| directionsTimeAttribute |
String |
计算方向时，用于驾驶时间的网络属性的名称。默认定义在用于RouteTask指定的路径网络图层中。 |
| doNotLocateOnRestrictedElements |
Boolean |
如果是true，避免通过barriers限制网络元素或因为限制条件被指定在restrictionAttributes中。 |
| findBestSequence |
Boolean |
如果是true考虑preserveFirstStop和preserveLastStop优化路线中站点的顺序。 |
| ignoreInvalidLocations |
Boolean |
在routes中, stop没有在网络上定位,或者stop不能被得到，结果将会取决于ignoreInvalidLocations的值.
当值为flase的时候, 如果有一个特定的stop被定为为或者得到, 这个solve 操作会失败.
当值为true时, 至少两个合法的stops 已经通过route被连接, 一个有效的结果被返回. 如果多个routes 在一个单一的请求中被处理, 只要一个route被建立, 一个有效的结果被返回.不能被解释的routes列表包含在RouteTask.onSolveComplete的参数消息中 |
| impedanceAttribute |
String |
在分析中被用作阻抗属性的网络属性名. 默认是定义在RouteTask中使用的特定的routing网络层 |
| outputGeometryPrecision |
Number |
泛化之后输出几何体的精确度。 |
| outputGeometryPrecisionUnits |
String |
输出几何体精确度的单位. |
| outputLines |
String |
在结果中生成的输出线的类型. 默认是在RouteTask中的指定的路线网络层中定义的. 可能的值, 查看NAOutputLine. |
| outSpatialReference |
SpatialReference |
返回带有分析结果的几何体的空间参考的WKID,几何体在空间参考的地图中被返回. |
| preserveFirstStop |
Boolean |
如果是true, 当findBestSequence 设置成true的时候,保持第一端点固定。只有findBestSequence是true是可用的。 |
| preserveLastStrop |
Boolean |
如果是true，当findBestSequence 是true的时候, 保持最后一个端点在序列中固定不变。只有findBestSequence是true的时候可用。 |
| restrictionAttributes |
String[] |
用于分析限制的网络属性列表。 |
| restrictUTurns |
String |
指定如何处理掉头。 |
| returnBarriers |
Boolean |
如果是true,障碍物作为RouteTask.onSolveComplete的第二个参数返回. |
| returnDirections |
Boolean |
如果是true, 在每一个结果的directions 属性中, 生成方向并返回.更多的信息可以查看Getting driving directions. |
| returnRoutes |
Boolean |
如果是true,在每一个RouteResult 的route属性中,生成并返回路线。 |
| returnStops |
Boolean |
如果是true, 在每一个RouteResult的stops的属性中返回端点。 |
| startTime |
Date |
路线开始的时间. 如果没有指定,默认是在路线服务中指定的时间. |
| stops |
Object |
在分析期间,加载的一组端点的网络位置。 |
| useHierarchy |
Boolean |
如果是true,网络的层次属性被用于分析. |
| useTimeWindows |
Boolean |
如果是true,时间窗口会被用于分析. |
Routeresult
描述
路线任务的结果。RouteResult属性依赖RouteParameter 输入。
属性表
| 属性 |
类型 |
描述 |
| directions |
DirectionsFeatureSet |
如果RouteParameters.returnDirections设置为true，路线方向被返回。更多信息，见Getting driving directions。 |
| route |
Graphic |
如果RouteParameters.returnRoutes设置为true，路线图形被返回。路线相关的属性列表，见Finding the best route的"路线属性"部分。 |
| routeName |
String |
路线名称。 |
| stops |
Graphic[] |
端点数组。仅在RouteParameters.returnStops设置为true时被返回。关于每个端点的属性列表，见Finding the best route中的“端点属性”部分。 |
Routetask
描述
ArcGIS Server REST API提供的网络分析服务的路线图层资源上解答一个路线。
构造函数
|
构造函数
|
描述
|
| esri.tasks.RouteTask(url) |
创建一个新的RouteTask对象。 |
属性表
| 属性 |
类型 |
描述 |
| url |
String |
ArcGIS Server REST资源表示的网路分析服务的URL。为了获得URL，使用Services Directory。 |
方法表
| 方法 |
返回值 |
描述 |
| solve(params, callback?, errback?) |
dojo.Deferred |
依赖路线图层及路线参数解答路线。 |
事件
| 事件 |
描述 |
| onSolveComplete(routeResults) |
RouteTask.solve()结束时触发。如果可选得callback函数被指定，返回和callback函数一样的信号。 |
| onError(error) |
执行任务遇到错误的时候触发。 |
Geoprocessor
描述
表示ArcGIS Server REST API提供的GP任务资源。一个地理处理任务资源代表地理处理服务的单个任务，支持如下操作：
"execute" - 当执行类型是同步时在地理处理任务资源上执行。
"submitJob" - 在一个异步的地理处理服务资源上执行。
构造函数
|
构造函数
|
描述
|
| esri.tasks.Geoprocessor(url) |
通过定义的地理处理任务的URL创建一个Geoprocessor对象。 |
属性表
| 属性 |
类型 |
描述 |
| outputSpatialReference |
SpatialReference |
输出几何体的空间参考。 如果没有指定，输出几何体用输入几何体的空间参考。如果processSpatialReferencew被指定而outputSpatialReference没有指定，输出几何体用outputSpatialReference指定的空间参考。 支持的空间参考列表，见投影坐标系统和地理坐标系统。 |
| processSpatialReference |
SpatialReference |
空间参考是用于执行几何操作的模型。如果processSpatialReference被指定outputSpatialReference没有指定，输出几何体用processSpatialReference指定的空间参考。 支持的空间参考列表，见投影坐标系统和地理坐标系统。 |
| updateDelay |
Number |
每个发送给一个异步GP任务的工作状态间的时间间隔（单位：毫秒）。 |
| url |
String |
接收地理处理请求的ArcGIS Server Rest API资源端点。 |
方法表
| 方法 |
返回值 |
描述 |
| cancelJobStatusUpdates(jobId) |
none |
取消一个定期的工作状态更新。用户仍然可以通过调用checkStatus()获得这个工作的状态。 |
| checkJobStatus(jobId,callback?,errback?) |
none |
发送一个请求给GP任务来得到指定jobId的当前状态。根据收到的响应，onStatusUpdate事件被触发并且可选的callback函数被调用。 |
| execute(inputParameters, callback?, errback?) |
dojo.Deferred |
发送一个请求到服务器端来执行一个同步的GP任务。完成时，onExecuteComplete事件被调用并且可选的callback函数被执行。 |
| getResultData(jobId, parameterName,callback?, errback?) |
dojo.Deferred |
发送一个请求给GP任务来获的通过jobID和resultParameterName指定的任务结果。完成时，getresultdatacomplete会被触发，可选的callback函数会被调用。 |
| getResultImage(jobId, parameterName,imageParameters,callback?, errback?) |
dojo.Deferred |
发送一个请求到GP任务来获得任务结果的图片。 |
| getResultImageLayer(jobId, parameterName?,imageParameters?,callback?) |
ArcGISDynamicMapServiceLayer |
获得GP任务的ArcGISDynamicMapServiceLayer结果。 |
| setOutputSpatialReference(spatialReference) |
none |
设置输出几何体的空间参考的WKID。 |
| setProcessSpatialReference(spatialReference) |
none |
设置用于执行几何操作的空间参考的WKID。 |
| setUpdateDelay(delay) |
none |
设置每个发送给一个异步GP任务的工作状态间的时间间隔（单位：毫秒）。 |
| submitJob(inputParameters, callback?,statusCallback?, errback?) |
none |
通过GP任务为异步处理提交一个工作到服务器。一旦工作被提交，直到工作结束，onStatusUpdate事件被定期触发并且可选的statusCallback()函数被定期调用，时间间隔通过updateDelay属性设置。工作完成，onJobComplete事件被触发，callback函数被调用。任务执行结果可以使用getResultData(), getResultImage() 或getResultImageLayer()方法接收。 |
事件
| 事件 |
描述 |
| onError(error) |
当执行任务发生错误时触发该事件。 |
| onExecuteComplete(results, messages) |
当同步地理处理任务完成时触发该事件。 |
| onGetResultDataComplete(result) |
当异步地理处理任务执行的结果是可用的时触发该事件。 |
| onGetResultImageComplete(mapImage) |
通过调用getResultImage()方法生产一个地图图像时触发该事件。 |
| onGetResultImageLayerComplete(ArcGISDynamicMapServiceLayer) |
getResultImageLayer()完成时触发该事件。 |
| onJobComplete(status) |
使用submitJob执行的异步地理处理任务完成时触发该事件。 |
| onStatusUpdate(status) |
当工作状态更新是可用的时触发该事件。 |
GPMessage
描述
表示地理处理任务的执行期间的信息。包含信息如何时开始处理，什么参数值被使用，任务进度，可能的问题的警告和错误信息。由信息类型和描述组成。
属性表
| 属性 |
类型 |
描述 |
| description |
SpatialReference |
地理处理信息的描述。 |
| type |
String |
地理处理信息类型。可以是下列值之一： "esriJobMessageTypeInformative", "esriJobMessageTypeWarning", "esriJobMessageTypeError", "esriJobMessageTypeEmpty" and "esriJobMessageTypeAbort", "esriGPMessageTypeInformative", "esriGPMessageTypeWarning", "esriGPMessageTypeError", "esriGPMessageTypeEmpty" and "esriGPMessageTypeAbort". |