天地图 JavaScript API接口文档V2.1.3


JavaScript API 接口文档 V2.1.3 天地图有限公司 2014 年 1 月 天地图有限公司 文档说明 本文档包含所有的内容除说明以外,版权均属天地图有限公司所有,受《中华人 民共和国著作权法》保护及相关法律法规和中国加入的所有知识产权方面的国际条 约的保护。未经本公司书面许可,任何单位和个人不得以任何方式翻印和转载本文 档的任何内容,否则视为侵权,天地图有限公司保留已发追究其法律责任的权利。 本文档是天地图 Java Script API 的用户使用参考手册,详细阐述了 API 提供用户 的类和方法,以及可以实现的功能介绍。天地图 Java Script API 让您可以将地图嵌 入您自己的网页中。API 提供了许多方法与地图进行交互,以及一系列向地图添加 内容的服务,从而使您可以在自己的网站上创建稳定的地图应用程序。 本文档分为地图主类、控件类、工具类、叠加物、右键菜单类、实体类、事件类 7 个大章节。以类(描述、属性、构造函数、方法)为索引讲述接口用法。 用户在阅读下面的文档时,可以根据需求对文档进行查询或跳跃式阅读。从而更 好地应用 API 类服务于自己的领域。 I 目录 JavaScript API 接口文档 V2.1.3 ................................................................................................................................ I 1 地图主类....................................................................................................................................................................... 6 1.1 TMapOptions 类 ........................................................................................................................................... 6 1.1.1 属性 ....................................................................................................................................................... 6 1.2 TMap 类 ........................................................................................................................................................ 6 1.2.1 构造函数 ............................................................................................................................................... 6 1.2.2 配置方法 ............................................................................................................................................... 6 1.2.3 地图状态方法 ....................................................................................................................................... 7 1.2.4 修改地图状态方法 ............................................................................................................................... 7 1.2.5 坐标变换 ............................................................................................................................................... 8 1.2.6 覆盖物方法 ........................................................................................................................................... 8 1.2.7 控件 ....................................................................................................................................................... 8 1.2.8 地图类型 ............................................................................................................................................... 8 1.2.9 地图图层方法 ....................................................................................................................................... 9 1.2.10 事件方法 ............................................................................................................................................... 9 1.3 TMapTypeOptions 类 ................................................................................................................................. 10 1.3.1 属性 ..................................................................................................................................................... 10 1.4 TMapType 类 ............................................................................................................................................. 10 1.4.1 构造函数 ............................................................................................................................................. 11 1.4.2 方法 ..................................................................................................................................................... 11 1.4.3 常量 ..................................................................................................................................................... 11 1.5 TTileLayerOptions 类 ................................................................................................................................. 11 1.5.1 属性 ..................................................................................................................................................... 11 1.6 TTileLayer 类 ............................................................................................................................................. 12 1.6.1 构造函数 ............................................................................................................................................. 12 1.6.2 方法 ..................................................................................................................................................... 12 1.6.3 事件 ..................................................................................................................................................... 13 1.7 TTileLayerWMSOptions 类 ....................................................................................................................... 13 1.7.1 属性 ..................................................................................................................................................... 13 1.8 TTileLayerWMS 类 .................................................................................................................................... 13 1.8.1 构造函数 ............................................................................................................................................. 13 1.8.2 方法 ..................................................................................................................................................... 14 2 控件类 ........................................................................................................................................................................ 14 2.1 TControl 类 ................................................................................................................................................. 14 2.1.1 方法 ..................................................................................................................................................... 14 2.2 TNavigationControlOptions 类 ................................................................................................................... 15 2.2.1 属性 ..................................................................................................................................................... 15 2.3 TNavigationControl 类 ............................................................................................................................... 15 2.3.1 构造函数 ............................................................................................................................................. 15 2.4 TOverviewMapControlOptions 类 ............................................................................................................. 16 2.4.1 属性 ..................................................................................................................................................... 16 2.5 TOverviewMapControl 类 .......................................................................................................................... 16 2.5.1 构造函数 ............................................................................................................................................. 16 2.5.2 方法 ..................................................................................................................................................... 16 II 2.5.3 事件 ..................................................................................................................................................... 17 2.6 TScaleControl 类 ........................................................................................................................................ 17 2.6.1 构造函数 ............................................................................................................................................. 17 2.6.2 方法 ..................................................................................................................................................... 17 2.7 TCopyrightControl 类 ................................................................................................................................. 17 2.7.1 方法 ..................................................................................................................................................... 17 2.8 TCopyright 类 ............................................................................................................................................. 18 2.8.1 属性 ..................................................................................................................................................... 18 2.9 THtmlElementControl 类............................................................................................................................ 18 2.9.1 构造函数 ............................................................................................................................................. 18 2.10 TMapTypeControlOptions 类 ..................................................................................................................... 18 2.10.1 属性 ..................................................................................................................................................... 18 2.11 TMapTypeControl 类 .................................................................................................................................. 18 2.11.1 构造函数 ............................................................................................................................................. 19 3 叠加物 ........................................................................................................................................................................ 19 3.1 TOverlay 类 ................................................................................................................................................ 19 3.1.1 属性 ..................................................................................................................................................... 19 3.1.2 方法 ..................................................................................................................................................... 19 3.2 TLabelOptions 类 ....................................................................................................................................... 20 3.2.1 属性 ..................................................................................................................................................... 20 3.3 TLabel 类 .................................................................................................................................................... 20 3.3.1 构造函数 ............................................................................................................................................. 20 3.3.2 方法 ..................................................................................................................................................... 20 3.3.3 事件 ..................................................................................................................................................... 22 3.4 TMarkerOptions 类 ..................................................................................................................................... 22 3.4.1 属性 ..................................................................................................................................................... 22 3.5 TMarker 类 ................................................................................................................................................. 22 3.5.1 构造函数 ............................................................................................................................................. 23 3.5.2 方法 ..................................................................................................................................................... 23 3.5.3 事件 ..................................................................................................................................................... 24 3.6 TIconOptions 类 ......................................................................................................................................... 24 3.6.1 属性 ..................................................................................................................................................... 24 3.7 TIcon 类 ...................................................................................................................................................... 25 3.7.1 构造函数 ............................................................................................................................................. 25 3.7.2 方法 ..................................................................................................................................................... 25 3.8 TPolylineOptions 类 ................................................................................................................................... 25 3.8.1 属性 ..................................................................................................................................................... 25 3.9 TPolyline 类 ................................................................................................................................................ 26 3.9.1 构造函数 ............................................................................................................................................. 26 3.9.2 方法 ..................................................................................................................................................... 26 3.9.3 事件 ..................................................................................................................................................... 26 3.10 TPolygonOptions 类 ................................................................................................................................... 27 3.10.1 属性 ..................................................................................................................................................... 27 3.11 TPolygon 类 ................................................................................................................................................ 27 3.11.1 构造函数 ............................................................................................................................................. 27 3.11.2 方法 ..................................................................................................................................................... 27 III 3.11.3 事件 ..................................................................................................................................................... 28 3.12 TInfoWindowOptions 类 ............................................................................................................................ 28 3.12.1 属性 ..................................................................................................................................................... 28 3.13 TInfoWindow 类 ......................................................................................................................................... 28 3.13.1 构造函数 ............................................................................................................................................. 28 3.13.2 方法 ..................................................................................................................................................... 29 3.13.3 事件 ..................................................................................................................................................... 29 3.14 TRectOptions 类 ......................................................................................................................................... 30 3.14.1 属性 ..................................................................................................................................................... 30 3.15 TRect 类 ...................................................................................................................................................... 30 3.15.1 构造函数 ............................................................................................................................................. 30 3.15.2 方法 ..................................................................................................................................................... 30 3.15.3 事件 ..................................................................................................................................................... 31 3.16 TCircleOptions 类 ....................................................................................................................................... 31 3.16.1 属性 ..................................................................................................................................................... 31 3.17 TCircle 类 ................................................................................................................................................... 31 3.17.1 构造函数 ............................................................................................................................................. 31 3.17.2 方法 ..................................................................................................................................................... 32 3.17.3 事件 ..................................................................................................................................................... 32 3.18 TEllipseOptions 类 ..................................................................................................................................... 32 3.18.1 属性 ..................................................................................................................................................... 33 3.19 TEllipse 类 .................................................................................................................................................. 33 3.19.1 构造函数 ............................................................................................................................................. 33 3.19.2 方法 ..................................................................................................................................................... 33 3.19.3 事件 ..................................................................................................................................................... 34 4 工具类 ........................................................................................................................................................................ 34 4.1 TMarkToolOptions 类 ................................................................................................................................. 34 4.1.1 属性 ..................................................................................................................................................... 34 4.2 TMarkTool 类 ............................................................................................................................................. 34 4.2.1 构造函数 ............................................................................................................................................. 34 4.2.2 方法 ..................................................................................................................................................... 34 4.2.3 事件 ..................................................................................................................................................... 35 4.3 TPolygonToolOptions 类 ............................................................................................................................ 35 4.3.1 属性 ..................................................................................................................................................... 35 4.4 TPolygonTool 类 ......................................................................................................................................... 35 4.4.1 构造函数 ............................................................................................................................................. 35 4.4.2 方法 ..................................................................................................................................................... 36 4.4.3 事件 ..................................................................................................................................................... 36 4.5 TPolylineToolOptions 类 ............................................................................................................................ 36 4.5.1 属性 ..................................................................................................................................................... 36 4.6 TPolylineTool 类 ......................................................................................................................................... 37 4.6.1 构造函数 ............................................................................................................................................. 37 4.6.2 方法 ..................................................................................................................................................... 37 4.6.3 事件 ..................................................................................................................................................... 37 4.7 TRectToolOptions 类 .................................................................................................................................. 38 4.7.1 属性 ..................................................................................................................................................... 38 IV 4.8 TRectTool 类 ............................................................................................................................................... 38 4.8.1 构造函数 ............................................................................................................................................. 38 4.8.2 方法 ..................................................................................................................................................... 38 4.8.3 事件 ..................................................................................................................................................... 38 4.9 TCircleToolOptions 类 ............................................................................................................................... 39 4.9.1 属性 ..................................................................................................................................................... 39 4.10 TCircleTool 类 ............................................................................................................................................ 39 4.10.1 构造函数 ............................................................................................................................................. 39 4.10.2 方法 ..................................................................................................................................................... 39 4.10.3 事件 ..................................................................................................................................................... 39 5 右键菜单类................................................................................................................................................................. 40 5.1 TContextMenu 类 ....................................................................................................................................... 40 5.1.1 构造函数 ............................................................................................................................................. 40 5.1.2 方法 ..................................................................................................................................................... 40 5.1.3 事件 ..................................................................................................................................................... 40 5.2 TMenuItem 类 ............................................................................................................................................. 40 5.2.1 构造函数 ............................................................................................................................................. 41 5.2.2 属性 ..................................................................................................................................................... 41 5.3 TContextMenuOptions 类 ........................................................................................................................... 41 5.3.1 属性 ..................................................................................................................................................... 41 6 实体类 ........................................................................................................................................................................ 41 6.1 TLngLat 类 ................................................................................................................................................. 41 6.1.1 构造函数 ............................................................................................................................................. 41 6.1.2 方法 ..................................................................................................................................................... 41 6.2 TBounds 类 ................................................................................................................................................. 42 6.2.1 构造函数 ............................................................................................................................................. 42 6.2.2 方法 ..................................................................................................................................................... 42 6.3 TPixel 类 ..................................................................................................................................................... 43 6.3.1 属性 ..................................................................................................................................................... 43 6.3.2 构造函数 ............................................................................................................................................. 43 6.3.3 方法 ..................................................................................................................................................... 43 6.4 TSize 类 ...................................................................................................................................................... 43 6.4.1 属性 ..................................................................................................................................................... 43 6.4.2 方法 ..................................................................................................................................................... 43 7 事件类 ........................................................................................................................................................................ 43 7.1 TEvent 类 .................................................................................................................................................... 44 7.1.1 静态方法 ............................................................................................................................................. 44 7.1.2 事件 ..................................................................................................................................................... 44 8 服务类 ........................................................................................................................................................................ 44 8.1 搜索 ............................................................................................................................................................. 45 8.1.1 TLocalSearchOptions .......................................................................................................................... 45 8.1.1.1 属性 ..................................................................................................................................... 45 8.1.2 TLocalSearch ...................................................................................................................................... 45 8.1.2.1 构造函数 ............................................................................................................................. 45 8.1.2.2 方法 ..................................................................................................................................... 45 8.1.3 TLocalSearchResult ............................................................................................................................ 47 V 8.1.3.1 方法 ..................................................................................................................................... 47 8.2 公交 ............................................................................................................................................................. 50 8.2.1 TTransitRouteOptions ......................................................................................................................... 51 8.2.1.1 属性 ..................................................................................................................................... 51 8.2.2 TTransitRoute...................................................................................................................................... 51 8.2.2.1 构造函数 ............................................................................................................................. 51 8.2.2.2 方法 ..................................................................................................................................... 51 8.2.3 TTransitRouteResult ........................................................................................................................... 52 8.2.3.1 方法 ..................................................................................................................................... 52 8.2.4 TTransitRoutePlan .............................................................................................................................. 52 8.2.4.1 方法 ..................................................................................................................................... 52 8.2.5 TTransitRouteLine .............................................................................................................................. 53 8.2.5.1 方法 ..................................................................................................................................... 53 8.2.6 TBusLineSearchOptions ..................................................................................................................... 54 8.2.6.1 属性 ..................................................................................................................................... 54 8.2.7 TBusLineSearch .................................................................................................................................. 54 8.2.7.1 构造函数 ............................................................................................................................. 54 8.2.7.2 方法 ..................................................................................................................................... 54 8.2.8 TBusListResult .................................................................................................................................... 54 8.2.8.1 方法 ..................................................................................................................................... 55 8.2.9 TBusLine ............................................................................................................................................. 55 8.2.9.1 属性 ..................................................................................................................................... 55 8.2.9.2 方法 ..................................................................................................................................... 56 8.3 驾车 ............................................................................................................................................................. 56 8.3.1 TDrivingRouteOptions ........................................................................................................................ 56 8.3.1.1 属性 ..................................................................................................................................... 56 8.3.2 TDrivingRoute .................................................................................................................................... 56 8.3.2.1 构造函数 ............................................................................................................................. 56 8.3.2.2 方法 ..................................................................................................................................... 57 8.3.3 TDrivingRouteResult .......................................................................................................................... 57 8.3.3.1 方法 ..................................................................................................................................... 57 8.3.4 TRoutePlan .......................................................................................................................................... 58 8.3.4.1 方法 ..................................................................................................................................... 58 8.3.5 TRoute ................................................................................................................................................. 58 8.3.5.1 方法 ..................................................................................................................................... 58 8.3.6 TStep ................................................................................................................................................... 58 8.3.6.1 方法 ..................................................................................................................................... 58 天地图有限公司 6 1 地图主类 1.1 TMapOptions 类 此类代表 TMap 接口的可选参数。它没有构造函数,但可实例化为对象常量。 1.1.1 属性 属性 类型 说明 projection string 指定地图的投影方式,目前支持的地图投影方式有:EPSG:900913(墨 卡托投影),EPSG:4326(大地平面投影)。 minResolution number 地图允许展示的最小级别。 maxResolution number 地图允许展示的最大级别。 errorImg string 当没有图块时所显示的错误图片地址。默认为透明图。 1.2 TMap 类 此类是天地图地图 API 的基础类,是地图实例化的基础函数。 1.2.1 构造函数 构造函数 说明 TMap(container:String|HTMLElement[, opts:TMapOptions]) 在指定的容器内创建地图实例,之后需要调用 TMap.centerAndZoom()方法 对地图进行初始化。未进行初始化的地图将不能进行任何操作。 container 参数用于显示地图的 DIV 对象。 opts 参数用于初始化地图,具体设置请参 考 TMapOptions。 1.2.2 配置方法 方法 返回值 说明 enableDrag() none 启用地图拖拽,默认启用。 disableDrag() none 禁用地图拖拽。 isDrag() boolean 是否启用地图拖拽,true 表示启用,false 表示禁止。 enableHandleMouseScroll() none 启用滚轮放大缩小,默认禁用。 disableDragHandleMouseScroll() none 禁用滚轮放大缩小。 isHandleMouseScroll() boolean 是否启用滚轮放大缩小,true 表示启用,false 表示禁止。 enableDoubleClickZoom() none 启用双击放大,默认禁止。 disableDoubleClickZoom() none 禁用双击放大。 isDoubleClickZoom() boolean 是否启用双击放大,true 表示启用,false 表示禁止。 enableHandleKeyboard() none 启用键盘操作,默认禁用。 天地图有限公司 7 键盘的上、下、左、右键可连续移动地图。同时按下其中两个键可使 地图进行对角移动。 PgUp、PgDn、Home 和 End 键会使地图平移其 1/2 的大小。 +、-会使地图放大或缩小一级。 disableHandleKeyboard() none 禁用键盘操作。 isHandleKeyboard() boolean 是否启用键盘操作,true 表示启用,false 表示禁止。 enableInertia() none 启用地图惯性拖拽,默认禁用。 disableInertia() none 禁用地图惯性拖拽。 isInertia() boolean 是否启用地图惯性拖拽,true 表示启用,false 表示禁止。 setMapCursor(default:String, move:String) none 设置鼠标在地图上的样式。参数 cursor 应符合 CSS 的 cursor 属性规 范。 1.2.3 地图状态方法 方法 返回值 说明 getBounds() TBounds 返回地图可视区域,以地理坐标表示。 getCenter() TLngLat 返回地图当前中心点。 getViewSize() TSize 返回地图视图的大小,以像素表示。 getZoom() number 返回地图当前缩放级别。 getZoomUnits() number 返回当前地图中心点的比例尺,即一个像素代表的实际距离,单位为 米。 getViewport(view:Array) json 根据提供的地理区域或坐标获得最佳的地图视野,返回的对象中包含 center 和 zoom 属性,分别表示地图的中心点和级别。 1.2.4 修改地图状态方法 方法 返回值 说明 centerAndZoom(lnglat:TLngLat, zoom:Number) none 初始化定位地图。 lnglat 参数指定地图的中心点地理坐标。 zoom 参数指定地图的比例尺级别。 panTo(lnglat:TLngLat[,zoom:Nu mber]) none 将地图的中心点变换到指定的地理坐标,如果移动范围不大,则执行 一个滑动过程,如果同时指定了缩放等级,则同时滑动到指定的等级。 panBy(position: TSize) none 将地图缓动指定的像素单位,例如参数为 new TSize(100,100)则代表 地图向右、下方向分别滑动 100 个像素单位,参数为 TSize(-100,0) 代表地图向左滑动 100 个像素单位。 position 参数指定的滑动的像素。 setCenterAtLngLat(lnglat:TLngL at) none 将地图的中心点直接变换到指定的地理坐标,不执行滑动过程。 setViewport(view:Array< TLngLat >) none 根据提供的坐标点数组设置地图视野,调整后的视野会保证包含提供 的坐标点。 setZoom(zoom:Number) none 将视图缩放到指定的缩放等级,中心点坐标不变。 zoomIn() none 放大一级视图。 zoomOut() none 缩小一级视图。 checkResize() none 通知地图其容器大小已更改。在更改了容器对象的大小后调用此方 天地图有限公司 8 法,以便地图能够调整自己适合于新的大小。 setZoomLevels(level:Array) none 设置地图有哪些缩放级别。level 参数指定地图等级范围。 savePosition() none 存储当前的地图位置和缩放级别,以便 returnToSavedPosition ()调用。 returnToSavedPosition () none 将地图重新定位到上次 savePosition()保存的位置。 1.2.5 坐标变换 方法 返回值 说明 fromContainerPixelToLngLat(pi xel: TPixel) TLngLat 将地图上相对于 container 的像素坐标转化为地理坐标,参数是 TPixel,返回值类型是 TLngLat。 Pixel 参数是像素对象。 fromLngLatToContainerPixel(ln glat: TLngLat) TPixel 将地理坐标转化为地图上点的像素坐标,相对于 container 左上角, 参数是 TLngLat,返回值是 TPixel。 fromLngLatToDivPixel(lnglat:T LngLat) TPixel 类似于 fromLngLatToContainerPixel 方法,将地理坐标转化为地图上 点的像素坐标(此坐标相对于放置标注的层),自定义标注的时候会 用到此方法,返回值是数组 TPixel 对象。 fromDivPixelToLngLat(pixel:TP ixel) TLngLat 将地图上点的像素坐标(此坐标相对于放置标注的层)转化为地理坐 标,自定义标注的时候会用到此方法,返回值是 TLngLat 对象。 1.2.6 覆盖物方法 方法 返回值 说明 addOverLay(overlay:TOverLay) none 将覆盖物添加到地图中,一个覆盖物实例只能向地图中添加一次。 removeOverLay(overlay:TOverLay) none 从地图中移除覆盖物。如果覆盖物从未被添加到地图中,则该移除 不起任何作用。 clearOverLays() none 清除地图上所有覆盖物。 1.2.7 控件 方法 返回值 说明 addControl(control:TControl) none 将控件添加到地图,一个控件实例只能向地图中添加一次。 removeControl(control:TControl ) none 从地图中移除控件。如果控件从未被添加到地图中,则该移除不起任 何作用。 getContainer() HTMLElem ent 返回地图的容器元素。当创建用户自定义控件时,需要自行实现 Control.initialize()方法,并将控件的容器元素添加到地图上,通过此 方法可获得地图容器。 1.2.8 地图类型 方法 返回值 说明 天地图有限公司 9 setMapType(mapType:TMapTyp e) none 设置地图类型。 参数说明: mapType:已经通过 addMapType 方法添加的地图类型。默认地 图类型有 TMAP_NORMAL_MAP , TMAP_SATELLITE_MAP , TMAP_HYBRID_MAP,TMAP_TERRAIN_MAP , TMAP_TERRAIN_HYBRID_MAP 。 addMapType(mapType:TMapTy pe) none 向地图类型中增加新的地图类型。 removeMapType(mapType:TMa pType) none 移除已增加的地图类型。 getMapType() TMapType 获得当前的地图类型 getMapTypes() array 获得当前地图的所有地图类型。 1.2.9 地图图层方法 方法 返回值 说明 getLayers() array 获取所有叠加层对象,可以自己判断需要移除哪些叠加层。 addLayer(layer:TTileLayer) none 给地图添加一个叠加层对象。 Layer 参数是叠加层对象。 removeLayer(layer:TTileLayer[, depose:Boolean]) none 移除一个叠加层对象。 depose 参数配置图层是否要彻底清除,清除以后不能再被添加,默认 为 false(可选)。 clearLayers(depose:Boolean) none 移除所有叠加层对象。 depose 参数配置图层是否要彻底清除,清除以后不能再被添加,默认 为 false(可选)。 setGetTileUrl(handle:Function) string 设置地图的取图函数。例如: function(x,y,z){return some_url+x+y+z;},x,y,z 为地图的块号,返回值为 图片的路径。 resetImages() none 重新加载地图图片,比如 setGetTileUrl 函数调用以后。 1.2.10 事件方法 事件 说明 init() 在地图完成初始化准备开始下载图片时触发事件。 resize (viewSize:TSize) 在地图大小改变时触发,参数是新的地图大小。 click (pixel:TPixel,button:Number) 鼠标在地图上点击时触发事件。 button 鼠标键编号(Number 定义 1 鼠标左键;2 鼠标右键) dblclick (pixel:TPixel) 在地图被双击时触发事件,参数为相对于地图左上角的像素坐标。 move(centerPoint:TLngLat[,flag: Boolean]) 在地图中心点变化时触发事件。 centerPoint 参数配置移动的中心点坐标。 flag 参数配置标注层是否被重新设置位置,是否需要重新定位标注,这个参数只 有自定义叠加层的时候才会使用。 天地图有限公司 10 movestart(centerPoint:TLngLat) 在地图中心点开始移动时触发事件,有三种情况: 按下鼠标开始拖动地图时;按下键盘方向键开始移动地图时;使用 panTo 方法定 位地图时。(当前没有区分这些情况) moveend (centerPoint:TLngLat) 在地图中心点移动完成时触发事件。 mousedown(pixel:TPixel,button: Number) 鼠标在地图上按下时触发事件。 mousedrag(pixel:TPixel,button: Number) 鼠标在地图上拖拽时持续触发事件。 mouseup(pixel:TPixel,button:Nu mber) 鼠标在地图上释放时触发事件。 zoom (oldZoom:Number,newZoom:Nu mber) 在地图缩放等级变化后触发事件。 oldZoom 参数配置变化前的缩放等级,如果是地图初始化过程,则为 0。 newZoom 参数配置变化后的缩放等级。 zoomstart(oldZoom:Number,new Zoom:Number) 在地图缩放开始时触发事件。 oldZoom 变化前的缩放等级,如果是地图初始化过程,则为 0。 newZoom 变化后的缩放等级。 zoomend (newZoom:Number) 在地图缩放完成后触发事件。 newZoom 参数用于配置滑动完成后的缩放等级。 levelschange (level:Array) 调用 setZoomLevels 时会触发此事件。 addtilelayer(obj:TTileLayer) 添加一个自定义地图图层时触发此事件。 Obj 参数用于指定地图图层对象。 removetilelayer(obj:TTileLayer) 移除一个自定义地图图层时触发此事件。 maptypechange(obj:TMapType) 地图类型发生变化时触发此事件。 1.3 TMapTypeOptions 类 此类代表 TMapType 接口的可选参数。它没有构造函数,但可实例化为对象常量。 1.3.1 属性 属性 类型 说明 minResolution number 地图允许展示的最小级别。 maxResolution number 地图允许展示的最大级别。 errorImg string 当没有图块时所显示的错误图片地址。默认为透明图。 1.4 TMapType 类 此类表示一种地图类型,您可以通过实例化此类自定义地图类型。 天地图有限公司 11 1.4.1 构造函数 构造函数 说明 TMapType(layers:Array, name:String[,opts: TMapTypeOptions]) 创建 TMapType 对象实例。 1.4.2 方法 方法 返回值 说明 getName() string 返回地图类型名称。 getTileLayers() Array 返回地图类型对应的图层。 getMinResolution() number 返回地图类型允许的最小级别。 getMaxResolution() number 返回地图类型允许的最大级别。 1.4.3 常量 常量 描述 TMAP_NORMAL_MAP 此地图类型展示普通街道视图。 TMAP_SATELLITE_MAP 此地图类型展示卫星视图。 TMAP_HYBRID_MAP 此地图类型展示卫星和路网的混合视图。 TMAP_TERRAIN_MAP 此地图类型展示地形视图。 TMAP_TERRAIN_HYBRID_MAP 此地图类型展示地形和路网的混合视图。 1.5 TTileLayerOptions 类 此类代表 TTileLayer 接口的可选参数。它没有构造函数,但可实例化为对象常量。 1.5.1 属性 属性 类型 说明 isPng boolean 判断图块的格式是否为 PNG。 默认为 false opacity number 设置图块的透明度(0.0-1.0)。默认值为 1.0 不透明。 tileUrlTemplate string 指定图块网址模板,该模板可以针对每个图块请求而展开,以根据现 有的图块坐标系引用唯一的图块。将模板置于 TTileLayer 构造函数 中可允许您使用此坐标系动态检索图块。 模板的格式应该为:http://host/tile?x={X}&y={Y}&z={Z}.png ,其中 X 和 Y 分别指纬度和经度图块坐标,Z 指缩放级别,比如 天地图有限公司 12 http://host/tile?x=3&y=27&z=5.png。 errorImg string 没图时候叠加层应该显示的图,默认为空 zIndex number 叠加层的 zIndex 顺序。 minResolution number 此图块层的最低缩放级别。 maxResolution number 此图块层的最高缩放级别。 1.6 TTileLayer 类 通过此类实现在地图上叠加自定义的地图图块层。 1.6.1 构造函数 构造函数 说明 TTileLayer( opts:TTileLayerOptions ) 以指定的参数创建TTileLayer对象,这个对象是在地图上叠加栅格地图的时候用到 的。 1.6.2 方法 方法 返回值 说明 getObject() HTMLDivEl ement 获取包含图片层的 Div 对象。 dispose () none 销毁创建的 layer 对象。 refresh() none 重新加载所有添加到此 TTileLayer 的可见图块。 hide() none 隐藏此叠加层使之不可见,但保留它在叠加层堆栈中的位置。 isHidden() boolean 如果图块层叠加层不可见,则返回 true。否则,返回 false。 show() none 显示先前不可见的 TTileLayer。 setOpacity(opacity:Number) none 设置透明度。 opacity 参数用于配置透明度。取值范围 0-1,默认值为 1。 setGetTileUrl(function:Function) string 设置取图函数。 例如:function(x,y,z){return some_url+x+y+z;},x,y,z 为地图的块号,返 回值为图片的路径。 setZindex(zidnex:Number) none 设置 z-index。 getImg(x:Number,y:Number,z:N umber ) HTML div 或者 image 返回块号对应的 html 对象,可能是 div 或者 image,注意操作完这个对 象以后解除所有引用防止内存泄漏。 x 参数配置横向块号。 y 参数配置纵向块号。 z 参数配置缩放等级。 getAllImg() array 返回包含所有 image 的一个对象,通过对象的 id 可以取到块号,通过 getObject()可以得到 image 或者 div。 天地图有限公司 13 1.6.3 事件 事件 说明 showimg([x,y,z]) 新加载一个图片时触发事件,注意这个函数并不是每次有新图的时候触发,而是 把地图上所有图片都触发了一遍,这就要求开发者自己去判断图片是否已加载过 了。 hiddenimg 去掉一个图片时触发事件。 1.7 TTileLayerWMSOptions 类 此类代表 TTileLayerWMS 接口的可选参数。它没有构造函数,但可实例化为对象常量。 1.7.1 属性 属性 类型 说明 REQUEST string 操作名称。必选 SERVICE string 服务类型标识符,参数值为 wms。必选 VERSION string 请求服务的版本,参数值为 1.1.1。必选 LAYERS string 用","分隔的多个图层列表。 STYLES string 每个请求图层的用","分隔的描述样式。必选 SRS string 地图投影类型。必选 BBOX string 显示范围(左下角,右上角,坐标值用","分隔)。必选 WIDTH number 输出地图图片的像素宽。必选 HEIGHT number 输出地图图片的像素高。必选 FORMAT string 输出图像的类型,参数值为"image/png"。必选 TRANSPARENT boolean 输出图像背景是否透明。 BGCOLOR string 十六进制的背景颜色。 EXCEPTIONS string 异常处理文档,参数值为 application/vnd.ogc.se_xml。 TILED boolean 是否为栅格瓦片,true 表示为栅格瓦片。注:接口目前只支持瓦片的形式。 1.8 TTileLayerWMS 类 通过此类实现在地图上叠加自定义的 WMS 地图图块层。 1.8.1 构造函数 构造函数 说明 TTileLayerWMS (name:String,url:String,opts:TTileLayerWMSOptions ) 以指定的参数创建 TTileLayerWMS 对象,这个对象是在地图 上叠加自定义栅格地图。 name:WMS 图层名称。 url: WMS 服务地址。 天地图有限公司 14 opts: TTileLayerWMSOptions。 1.8.2 方法 方法 返回值 说明 getName () string 获取 WMS 图层的名称。 loadURL (url:String,opts:JSON,fun:Functi on) none 获取图层的属性信息。 参数说明: url:WMS 图层的服务地址。 opts:获取属性的请求参数,具体参数如下: REQUEST: 操作名称,参数值为 GetFeatureInfo。 EXCEPTIONS: 异常处理文档,参数值为 application/vnd.ogc.se_xml。 BBOX: 显示范围(左下角,右上角,坐标值用","分隔)。 SERVICE: 服务类型标识符,参数值为 wms。 INFO_FORMAT: 要素信息的返回格式(MIME 类型),参数值为 application/json 。 QUERY_LAYERS: 获取某一图层的属性。 FEATURE_COUNT: 50。需要返回其信息的要素个数,默认值为 1。 LAYERS: 用","分隔的多个图层列表。 WIDTH: 地图显示的像素宽。 HEIGHT: 地图显示的像素高。 FORMAT: 输出图像的类型,参数值为"image/png"。 SRS: 地图投影类型。 VERSION: 请求服务的版本。 X: 用像素表达的要素的 X 坐标 (以左上角坐标为 0)。 Y: 用像素表达的要素的 Y 坐标 (以左上角坐标为 0)。 fun:回调函数,返回 JSON 对象。 2 控件类 2.1 TControl 类 此类是所有控件类的基类,你可以通过此类来自定义控件,所有控件均包含 Control 类的属性、方法和事件。 2.1.1 方法 方法 返回值 说明 setLeft(length:Numbe) none 设置控件相对于地图左边的像素距离。 setRight(length:Numbe) none 设置控件相对于地图右边的像素距离。 setTop(length:Numbe) none 设置控件相对于地图上方的像素距离。 setBottom(length:Number) none 设置控件相对于地图下方的像素距离。 setOpacity(opacity:Number) none 设置控件的透明度。 天地图有限公司 15 getOpacity() number 返回控件的透明度。 show() none 显示控件。 hidden() none 隐藏控件。 isHidden() boolean 控件是否被隐藏。 2.2 TNavigationControlOptions 类 此类代表 TNavigationControl 接口的可选参数。它没有构造函数,但可实例化为对象常量。 2.2.1 属性 属性 类型 说明 type string 平移缩放控件的类型。 属性说明: TMAP_NAVIGATION_CONTROL_LARGE:标准的平移缩放控件(包 括平移、缩放按钮和滑块)。 TMAP_NAVIGATION_CONTROL_SMALL:仅包含平移和缩放按钮。 TMAP_NAVIGATION_CONTROL_ZOOMANDSLIDER:包含缩放按 钮和滑块。 TMAP_NAVIGATION_CONTROL_ZOOM:仅包含缩放按钮。 TMAP_NAVIGATION_CONTROL_ZOOMHORIZONTAL:仅包含缩 放按钮,并且缩放按钮是横排。 anchor string 控件的停靠位置。 属性说明: TMAP_ANCHOR_TOP_LEFT:表示左上。 TMAP_ANCHOR_TOP_RIGHT:表示右上。 TMAP_ANCHOR_BOTTOM_LEFT:表示左下。 TMAP_ANCHOR_BOTTOM_RIGH:表示右下。 offset TPixel 控件的偏移值。 showZoomInfo boolean 是否显示级别提示信息。true 表示显示,false 表示隐藏。 2.3 TNavigationControl 类 骨头棒控件,可以缩放和移动地图。 2.3.1 构造函数 方法 返回值 说明 TNavigationControl(opts:TNavig ationControlOptions) TNavigationControl 创建一个 TNavigationControl 控件。 opts 参数用于导航控件的设置,请参考 TnavigationControlOptions 接口 天地图有限公司 16 2.4 TOverviewMapControlOptions 类 此类代表 TOverviewMapControl 接口的可选参数。它没有构造函数,但可实例化为对象常量。 2.4.1 属性 属性 类型 说明 anchor string 控件的停靠位置。 属性说明: TMAP_ANCHOR_TOP_LEFT:表示左上。 TMAP_ANCHOR_TOP_RIGHT:表示右上。 TMAP_ANCHOR_BOTTOM_LEFT:表示左下。 TMAP_ANCHOR_BOTTOM_RIGH:表示右下。 size TSize 缩略地图控件的大小。 isOpen boolean 缩略地图添加到地图后的开合状态,默认为关闭。true 表示显示,false 表示隐藏。 2.5 TOverviewMapControl 类 鹰眼地图控件,用来显示一个鹰眼地图, 继承自 TControl,拥有基类的所有方法。 2.5.1 构造函数 构造函数 说明 TOverviewMapControl(opts:TOverviewMapC ontrolOptions) 创建一个 TOverviewMapControl 控件。 2.5.2 方法 方法 返回值 说明 setButtonImage(imgOpen:String,img Close:String) none 设置鹰眼地图的按钮图片,要同时设置鹰眼地图打开和关闭状 态下的两张图片。 imgOpen:鹰眼地图在打开状态下的按钮图片。 imgClose:鹰眼地图在关闭状态下的按钮图片。 setBorderColor(color:String) none 设置鹰眼地图和主地图之间空隙的边框颜色。 setBackColor(color:String) none 设置鹰眼地图和主地图之间空隙的背景颜色。 setRectBorderColor(color:String) none 设置鹰眼地图上的矩形框边框颜色。 setRectBackColor(color:String) none 设置鹰眼地图上的矩形框背景颜色。 changeView() none 切换鹰眼地图的开-合状态。 isOpen() boolean 返回该鹰眼的视图是否被打开。 天地图有限公司 17 getMiniMap() TMap 返回该鹰眼的地图对象。 2.5.3 事件 事件 说明 viewchange(isOpen:Boolean) 鹰眼视图控件的开合状态变化时触发事件。 参数说明: isOpen:状态变化后鹰眼地图是否在打开的状态中。true 表示打开,false 表示关 闭。 2.6 TScaleControl 类 地图比例尺控件,用来实时的显示地图的当前比例尺。 2.6.1 构造函数 构造函数 说明 TScaleControl 创建一个 TScaleControl 控件。向地图添加比例尺。 2.6.2 方法 方法 返回值 说明 setColor(color:String) none 设置设置比例尺控件的颜色。 color 参数用于配置比例尺的颜色。例如“#000000”、“red”。 2.7 TCopyrightControl 类 此类表示版权控件,您可以在地图上添加自己的版权信息。每一个版权信息需要包含如下内容:版权的唯一标 识、版权内容和其适用的区域范围。 2.7.1 方法 方法 返回值 说明 addCopyright(copyright:TCopyright) none 添加一个版权信息。 removeCopyright(TCopyright) none 移除版权信息。 getCopyright(string:id) TCopyrightControl 获得单个版权信息。id 参数为获取单个版权信息 的唯一标识。 getCopyrightCollection() array 获得版权信息列表。 天地图有限公司 18 2.8 TCopyright 类 此类表示一条版权信息,可作为 TCopyrightControl.addCopyright()方法的参数。它没有构造函数,但可通过对象 字面量形式表示。 2.8.1 属性 属性 类型 说明 id number 该版权信息的唯一标识符。 content string 该版权的文本信息,用于显示在地图上,支持 HTML 内容。 bounds bounds 该版权信息所适用的地理区域。 2.9 THtmlElementControl 类 此控件是向地图上添加自定义的控件。 此类继承 TControl,拥有 TControl 的所有方法。 2.9.1 构造函数 构造函数 说明 THtmlElementControl(div) 创建一个 THtmlElementControl 控件。向地图添加自定义控件。 div:可以是一个 DIV 的 ID 号,也可以是 DIV 的对象。 2.10 TMapTypeControlOptions 类 此类表示 TMapTypeControl 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 2.10.1 属性 属性 类型 说明 mapTypes Array 控件展示的地图类型,默认为普通图、卫星图、卫星加路网混合 图。通过此属性可配置控件展示的地图类型。 2.11 TMapTypeControl 类 此类是负责切换地图类型的控件,此类继承 TControl。 天地图有限公司 19 2.11.1 构造函数 构造函数 说明 TMapTypeControl(opts:TMapTypeControlOpt ions) 创建地图类型控件。opts 为可选参数。 3 叠加物 3.1 TOverlay 类 叠加层类都直接或间接继承于此基类。如果希望在地图上显示自定义的叠加层对象类型,可以继承这一基类。 3.1.1 属性 属性 类型 说明 Type number 叠加层类型,已定义的类型有: TLabel 类型为 1; TMarker 类型为 2; TInfoWindow 类型为 3; TPolyline 类型为 4; TPolygon 类型为 5; TRect 类型为 6; TEllipse 类型为 7; TCircle 类型为 8; 对于自定义叠加层,也可以设定一个 Number 型的叠加层类型。 3.1.2 方法 方法 返回值 说明 initialize(map:TMap) boolean 抽象方法,用于初始化覆盖物,当调用 TMap.addOverlay 时,API 将 调用此方法。自定义覆盖物时需要实现此方法。自定义覆盖物时需要 将覆盖物对应的 HTML 元素返回。 参数说明: map:图层。 remove() none 使用 TMap.removeOverLay() 或 TMap.clearOverLays() 从地图中删 除叠加层后,由地图调用此方法,叠加层必须将自己从地图中删除。 refresh (force:Boolean) none 此方法在地图显示更改后由地图调用。如果更改了地图视图的缩放级 别或像素偏移量,则参数 force 将为 true,这样需要重新计算像素坐 标。 getObject() HTMLDIVE lement 返回叠加层 Div 对象。 hide() none 在地图上隐藏叠加层。 天地图有限公司 20 show() none 在地图上显示叠加层。 isHidden() boolean 判断叠加层是否隐藏,返回 true 表示当前叠加层是隐藏的,否则是 处于显示状态。 dispose() none 在地图上销毁叠加层。 3.2 TLabelOptions 类 此类表示 TLable 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 3.2.1 属性 属性 类型 说明 text string 文本标注的内容。 offset TPixel 文本标注的位置偏移值。 position TlngLat 文本标注的地理位置。 3.3 TLabel 类 此类表示地图上的文本标注。 3.3.1 构造函数 构造函数 说明 TLabel(opts:TLabelOptions) 根据给定参数对象创建文本标注。 参数说明: opts:文本标注的属性对象,请参考 TLabelOptions。 3.3.2 方法 方法 返回值 说明 getType() number 叠加层类型。 getLngLat () TLngLat 返回文本所在的地理位置坐标。 setLngLat (lnglat:TLngLat) none 设置文本所在的地理位置坐标。 参数说明: lnglat:地理位置坐标。 setOffset(offset: TPixel) none 设置文本文本的偏移值。 参数说明: offset:偏移量(像素)。 getOffset() TPixel 返回文本的偏移值。 天地图有限公司 21 setAnchorPer(anchorper:Array) none 设置文本显示时向右下角的偏移量(百分比)。 参数说明: anchorper:偏移量(百分比),格式为[width,height]。 getAnchorPer(anchorper:Array) array 获取文本显示时向右下角的偏移量(百分比)。 setLabel(content:String) none 设置文本的内容。 参数说明: content:文本的内容。 getLabel() string 返回文本的内容。 setTitle(title:String) none 设置文本的提示内容。 参数说明: title:文本的提示内容。 getTitle() string 返回文本的提示内容。 setFontSize (size:Number) none 设置文本的文本内容字体大小。 参数说明: size:字体大小。 getFontSize () number 返回文本内容字体大小。 setFontColor(color:String) none 设置文本的文本的字体颜色。 参数说明: color:字体颜色。 getFontColor() string 返回文本的字体颜色。 setBackgroundColor(color:String ) none 设置文本的背景色。 参数说明: color:背景颜色。 getBackgroundColor() string 返回文本的背景色。 setBorderLine (width:Number) none 设置文本的边框线宽。 参数说明: width:边框线宽。 getBorderLine () number 返回文本的边框线宽。 setBorderColor(color:String) none 设置文本的边框颜色。 参数说明: color:边框颜色。 getBorderColor() string 返回文本的边框颜色。 setOpacity(opacity:Number) none 设置文本的显示不透明度。 参数说明: opacity:不透明度(范围 0-1 之间)。 getOpacity() number 返回文本的显示透明度。 天地图有限公司 22 setNoWrap(noWrap:Boolean) none 设置文本的文本内容是否允许换行。 参数说明: noWrap:设置是否允许换行。true 表示允许换行,false 表示不允许。 getNoWrap() boolean 文本内容是否允许换行。 3.3.3 事件 事件 说明 click(point:TPixel,btn:Number) 当用户点击文本时触发事件。 参数说明: point:像素坐标。 btn:鼠标键编号(Number 定义 1 鼠标左键;2 鼠标右键)。 mousedown(point: TPixel,btn:Number) 鼠标在文本上按下时触发事件。 参数说明: point:像素坐标。 btn:鼠标键编号(Number 定义 1 鼠标左键;2 鼠标右键)。 mouseup(point:TPixel,btn:Numb er) 鼠标在文本上释放时触发事件。 参数说明: point:像素坐标。 btn:鼠标键编号(Number 定义 1 鼠标左键;2 鼠标右键)。 mouseover(point: TPixel) 鼠标进入文本图片上方时触发事件。 参数说明: point:像素坐标。 mouseout(point: TPixel) 鼠标离开文本图片上方时触发事件。 参数说明: point:像素坐标。 3.4 TMarkerOptions 类 此类表示 TMarker 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 3.4.1 属性 属性 类型 说明 icon TIcon 标注所用的图标对象。 3.5 TMarker 类 此类表示地图上一个图像标注。 天地图有限公司 23 3.5.1 构造函数 构造函数 说明 TMarker(lnglat:TLngLat[,opts:T MarkerOptions]) 创建一个图像标注实例。lnglat 参数指定了图像标注所在的地理位置。 参数说明: lnglat:标注点的地理坐标。 opts:标注的属性对象,请参考 TMarkerOptions。 3.5.2 方法 方法 返回值 说明 getType() number 叠加层类型。 getIcon() TIcon 返回标记显示时所使用的图标对象。 setIcon(icon:TIcon) none 设置标注所用的图标对象。 setIconImage(url:String,size:TSize ,anchor:Array) none 设置标记显示时所使用的图标的 URL 地址。 参数说明: url:图标的 URL 地址; size:图片像素大小; anchor:图片偏移量。 setLngLat (lnglat:TLngLat) none 设置标注所在的地理位置坐标。 参数说明: lnglat:地理位置坐标。 getLngLat () TLngLat 返回标注所在的地理位置坐标。 enableDragging() none 开启标注拖拽功能。 disableDragging() none 关闭标注拖拽功能。 setInfoWinWidth(width:Number) 设置在标注上弹出的信息浮窗的宽度。 参数说明: width:信息浮窗宽度。 getInfoWinWidth(:) number 返回在标注上弹出的信息浮窗的宽度。 setInfoWinHeight(height:Number) 设置在标注上弹出的信息浮窗的高度。 参数说明: height:信息浮窗的高度。 getInfoWinHeight() number 返回在标注上弹出的信息浮窗的高度。 openInfoWinElement(htmlElemen t:Object) TInfoWindow 在标注上方打开信息浮窗,信息浮窗的内容为指定的 HTML 标签对 象。 参数说明: htmlElement:html 标签对象。 openInfoWinHtml(htmlText:String ) TInfoWindow 在标注上方打开信息浮窗,信息浮窗的内容为指定的 HTML 标签内 容。 参数说明: HtmlText:html 标签内容。 天地图有限公司 24 openInfoWinUrl(url:String ) TInfoWindow 在标注上方打开信息浮窗,信息浮窗的内容为指定 URL 链接的网页内 容。 参数说明: url:链接地址。 closeInfoWindow() none 关闭信息浮窗。 3.5.3 事件 事件 说明 click(point:TPixel,btn:Number) 当用户点击标注时触发事件。 参数说明: point:像素坐标。 btn:鼠标键编号(Number 定义 1 鼠标左键;2 鼠标右键)。 mousedown(point: TPixel,btn:Number) 鼠标在标注上按下时触发事件。 参数说明: point:像素坐标。 btn:鼠标键编号(Number 定义 1 鼠标左键;2 鼠标右键)。 mouseup(point:TPixel,btn:Number) 鼠标在标注上释放时触发事件。 参数说明: point:像素坐标。 btn:鼠标键编号(Number 定义 1 鼠标左键;2 鼠标右键)。 mouseover(point: TPixel) 鼠标进入标注图片上方时触发事件。 参数说明: point:像素坐标。 mouseout(point: TPixel) 鼠标离开标注图片上方时触发事件。 参数说明: point:像素坐标。 dragstart(lnglat:TLngLat) 鼠标每次开始拖动标注时触发事件。 参数说明: lnglat:经纬度坐标。 draging(lnglat:TLngLat) 鼠标拖动标注时持续触发事件。 参数说明: lnglat:经纬度坐标。 dragend(lnglat:TLngLat) 鼠标每次拖动标注完成之后触发事件。 参数说明: lnglat:经纬度坐标。 3.6 TIconOptions 类 此类表示 TIcon 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 3.6.1 属性 属性 类型 说明 天地图有限公司 25 anchor TPixel 图标的定位锚点。此点用来决定图标与地理位置的关系,是相对于图 标左上角的偏移值,默认等于图标宽度和高度的中间值。 3.7 TIcon 类 此类表示标注覆盖物所使用的图标。 3.7.1 构造函数 构造函数 说明 TIcon(url:String,size:TSize[,opts: TIconOptions]) 以给定的图像地址和大小创建图标对象实例。 参数说明: url:标注图片的地址。 size:图片大小。 opts:图标的属性对象,请参考 TIconOptions。 3.7.2 方法 方法 返回值 说明 getImageUrl() string 获取图标使用的图片 URL。 setImageUrl(url:String) none 设置图标使用的图片链接 URL。 getSize() TSize 获取图标可视区域的大小。 setSize(size:TSize) none 设置图标可视区域的大小。 参数说明: size:图标大小。 getAnchor() TPixel 获取相对于图片左上角的像素距离。 setAnchor(anchor:TPixel) none 设置相对于图片左上角的像素距离。 参数说明: anchor:对于图片左上角的像素距离。 copy() TIcon 以此图标的图片路径、大小复制一个新的图标。 3.8 TPolylineOptions 类 此类表示 TPolyline 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 3.8.1 属性 属性 类型 说明 strokeColor string 折线颜色。 strokeWeight number 折线的宽度,以像素为单位。 strokeOpacity number 折线的透明度(范围 0-1 之间)。 天地图有限公司 26 strokeStyle string 折线的样式,solid 或 dashed。 3.9 TPolyline 类 使用浏览器的矢量制图工具在地图上绘制折线的地图叠加层。 3.9.1 构造函数 构造函数 说明 TPolyline(points:Array [,opts:TPolylineOptions]) 创建折线覆盖物对象。 参数说明: points:坐标数组。 opts:线形的属性对象,请参考 TPolylineOptions。 3.9.2 方法 方法 返回值 说明 getType() number 叠加层类型。 getLngLats() Array 返回折线的点数组。 setLngLats(lnglats: Array) none 设置折线的点数组。 参数说明: lnglats:顶点数组。 setStrokeColor(color:String) none 设置折线的颜色。 getStrokeColor() string 返回折线的颜色。 setStrokeOpacity(opacity:Number) none 设置透明度(范围 0-1 之间) getStrokeOpacity() number 返回透明度。 setStrokeWeight(weight:Number) none 设置线的宽度(范围为大于等于 1 的整数)。 getStrokeWeight() number 返回线的宽度。 setStrokeStyle(style:String) none 设置是为实线或虚线(solid 或 dashed)。 getStrokeStyle() string 返回当前线样式状态,实线或者虚线。 3.9.3 事件 事件 说明 click(point:TPixel) 当用户点击折线时触发事件。 mouseover(point:TPixel) 鼠标进入折线上方时触发事件。 mouseout(point:TPixel) 鼠标离开折线上方时触发事件。 天地图有限公司 27 3.10 TPolygonOptions 类 此类表示 TPolygon 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 3.10.1 属性 属性 类型 说明 strokeColor string 边线颜色。 fillColor string 填充颜色。当参数为空时,折线覆盖物将没有填充效果。 strokeWeight number 边线的宽度,以像素为单位。 strokeOpacity number 边线透明度(范围 0-1 之间)。 fillOpacity number 填充的透明度(范围 0-1 之间)。 strokeStyle string 边线的样式(solid 或 dashed)。 3.11 TPolygon 类 此类表示一个多边形覆盖物。 3.11.1 构造函数 构造函数 说明 TPolygon(points:Array [,opts:TPolygonOptions]) 创建多边形覆盖物。 参数说明: points:坐标数组。 opts:多边形的属性对象,请参考 TPolygonOptions。 3.11.2 方法 方法 返回值 说明 getType() number 叠加层类型。 getLngLats() Array 返回折线的点数组。 setLngLats(lnglats: Array) none 设置折线的点数组。 参数说明: lnglats:顶点数组。 getBounds() TBounds 返回覆盖物的地理区域范围。 setStrokeColor(color:String) none 设置多边型的边线颜色,参数为合法的 CSS 颜色值。 getStrokeColor() string 返回多边型的边线颜色。 setFillColor(color:String) none 设置多边形的填充颜色,参数为合法的 CSS 颜色值。当参数为空字 符串时,折线覆盖物将没有填充效果。 getFillColor() string 返回多边形的填充颜色。 天地图有限公司 28 setStrokeOpacity(opacity:Number) none 设置多边形的边线透明度(范围 0-1 之间)。 getStrokeOpacity() number 返回多边形的边线透明度。 setFillOpacity(opacity:Number) none 设置多边形的填充透明度(范围 0-1 之间)。 getFillOpacity() number 返回多边形的填充透明度。 setStrokeWeight(weight:Number) none 设置多边形边线的宽度(范围为大于等于 1 的整数)。 getStrokeWeight() number 返回多边形边线的宽度。 setStrokeStyle(style:String) none 设置多边形边线样式为实线或虚线(取值 solid 或 dashed)。 getStrokeStyle() string 返回多边形边线样式。 3.11.3 事件 事件 说明 click(point:TPixel) 当用户点击多边形时触发事件。 mouseover(point:TPixel) 鼠标进入多边形上方时触发事件。 mouseout(point:TPixel) 鼠标离开多边形上方时触发事件。 3.12 TInfoWindowOptions 类 此类表示 TInfoWindow 构造函数的可选参数,它没有构造函数,但可通过对象字面量形式表示。 3.12.1 属性 属性 类型 说明 offset TPixel 信息窗位置偏移值。默认情况下在地图上打开的信息窗底端的尖角将 指向其地理坐标,在标注上打开的信息窗底端尖角的位置取决于标注 所用图标的 infoWindowOffset 属性值,您可以为信息窗添加偏移量来 改变默认位置。 3.13 TInfoWindow 类 此类表示地图上包含信息的窗口。 3.13.1 构造函数 构造函数 说明 TInfoWindow (point:TLngLat[,opts:TInfoWindo wOptions]) 创建一个信息窗实例。 参数说明: point:信息窗口的位置,为地理坐标。 opts:信息窗口的属性对象,请参考 TInfoWindowOptions。 天地图有限公司 29 3.13.2 方法 方法 返回值 说明 getType() number 叠加层类型。 setLabel(content:Object) none 设置信息浮窗的显示 HTML 内容。 参数说明: content:html 内容。 该参数有二种类型:1,HTML 对象;2,HTML 字符串。 getLabel() String|HTM LElement 返回信息浮窗的显示 HTML 内容。 setTitle(content: Object) none 设置信息浮窗的显示标题。 参数说明: content:标题内容。 该参数有二种类型:1,HTML 对象;2,HTML 字符串.。 getTitle() String|HTM LElement 返回信息浮窗的显示标题。 setWidth(width:Number) none 设置信息浮窗的宽度,如果信息浮窗的内容超过显示范围,信息浮窗会 自动适应大小。 参数说明: width:信息浮窗宽度。 setHeight(height:Number) none 设置信息浮窗的高度,如果信息浮窗的内容超过显示范 围,信息浮窗会自动适应大小。 参数说明: height:信息浮窗高度。 setLngLat (lnglat:TLngLat) none 设置或改变信息浮窗所指向的地理位置坐标。 参数说明: lnglat:地理位置坐标。 getLngLat () TLngLat 返回信息浮窗所指向的地理位置坐标。 setOffset(array:TPixel) none 设置信息浮窗显示时向右下角偏移量(像素)。 参数说明: array:偏移量(像素)。 getOffset() TPixel 返回信息浮窗显示时向右下角偏移量。 closeInfoWindow() number 关闭信息浮窗。 closeInfoWindowWithMouse() none 设置信息浮窗在用户鼠标移开后自动关闭。 disableCloseInfoWindowWithMous e() string 取消信息浮窗在用户鼠标移开后自动关闭的设置。 3.13.3 事件 事件 说明 click(point:TPixel) 当用户点击多边形时触发事件。 mouseover(point:TPixel) 鼠标进入多边形上方时触发事件。 天地图有限公司 30 mouseout(point:TPixel) 鼠标离开多边形上方时触发事件。 3.14 TRectOptions 类 此类表示 TRect 构造函数的可选参数,它没有构造函数,但可通过对象字面量形式表示。 3.14.1 属性 属性 类型 说明 strokeColor string 矩形边框颜色。 fillColor string 填充颜色。 strokeWeight number 矩形边框的宽度,以像素为单位。 strokeOpacity number 矩形边框和填充的透明度(范围 0-1 之间)。 strokeStyle string 矩形边框的样式(solid 或 dashed)。 3.15 TRect 类 此类用来表示地图上的一个矩形图形对象。 3.15.1 构造函数 构造函数 说明 TRect(bounds:TBounds[,opts:TRe ctOptions]) 创建矩形覆盖物。 参数说明: bounds:矩形范围。 opts:矩形的属性对象,请参考 TRectOptions。 3.15.2 方法 方法 返回值 说明 getType() number 叠加层类型。 getBounds() TBounds 返回矩形的坐标范围。 setBounds(bounds:TBounds) none 设置矩形的显示范围。 参数说明: bounds:矩形的坐标范围。 setStrokeColor(color:String) none 设置矩形的边线颜色,参数为合法的 CSS 颜色值。 getStrokeColor() string 返回矩形的边线颜色。 setFillColor(color:String) none 设置矩形的填充颜色,参数为合法的 CSS 颜色值。当参数为空字符 串时,折线覆盖物将没有填充效果。 getFillColor() string 返回矩形的填充颜色。 天地图有限公司 31 setOpacity(opacity:Number) none 设置矩形的边线透明度(范围 0-1 之间)。 getOpacity() number 返回矩形的边线透明度。 setStrokeWeight(weight:Number) none 设置矩形边线的宽度(取值为大于等于 1 的整数)。 getStrokeWeight() number 返回矩形边线的宽度。 setStrokeStyle(style:String) none 设置矩形边线样式为实线或虚线(取值 solid 或 dashed)。 getStrokeStyle() string 返回矩形边线样式。 3.15.3 事件 事件 说明 click(point:TPixel) 当用户点击矩形图形时触发事件。 mouseover(point:TPixel) 鼠标进入矩形图形上方时触发事件。 mouseout(point:TPixel) 鼠标离开矩形图形上方时触发事件。 3.16 TCircleOptions 类 TCircle 类构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 3.16.1 属性 属性 类型 说明 strokeColor string 圆形边线颜色。 fillColor string 圆形填充颜色。当参数为空时,圆形将没有填充效果。 strokeWeight number 圆形边线的宽度,以像素为单位。 strokeOpacity number 圆形边线透明度(范围 0-1 之间)。 fillOpacity number 圆形填充的透明度(范围 0-1 之间)。 strokeStyle string 圆形边线的样式(solid 或 dashed)。 3.17 TCircle 类 此类表示地图上的圆覆盖物。 3.17.1 构造函数 构造函数 说明 TCircle(center:TLngLat,radius:Nu mber[,opts:TCircleOptions]) 创建圆覆盖物。 参数说明: center:圆心经纬度坐标。 radius:圆的半径,以米点单位。 天地图有限公司 32 opts:圆形的属性对象,请参考 TCircleOptions。 3.17.2 方法 方法 返回值 说明 getType() number 叠加层类型。 getArea() number 返回圆面积(平方米)。 getCenter() TLngLat 返回圆的中心点。 setCenter(lnglat:TLngLat) none 设置圆的中心点。 参数说明: lnglat:中心点对象。 setRadius(radius:Number) none 设置圆的半径。 getRadius() number 返回圆的半径。 getBounds() TBounds 返回圆的矩形范围。 setStrokeColor(color:String) none 设置圆形的边线颜色,参数为合法的 CSS 颜色值。 getStrokeColor() string 返回圆形的边线颜色。 setFillColor(color:String) none 设置圆形的填充颜色,参数为合法的 CSS 颜色值。当参数为空字符 串时,圆形覆盖物将没有填充效果。 getFillColor() string 返回圆形的填充颜色。 setStrokeOpacity(opacity:Number) none 设置圆形的边线透明度(范围 0-1 之间)。 getStrokeOpacity() number 返回圆形的边线透明度。 setFillOpacity(opacity:Number) none 设置圆形的填充透明度(范围 0-1 之间)。 getFillOpacity() number 返回圆形的填充透明度。 setStrokeWeight(weight:Number) none 设置圆形边线的宽度(取值为大于等于 1 的整数)。 getStrokeWeight() number 返回圆形边线的宽度。 setStrokeStyle(style:String) none 设置圆形边线样式为实线或虚线(取值 solid 或 dashed)。 getStrokeStyle() string 返回圆形边线样式。 3.17.3 事件 事件 说明 click(point:TPixel) 当用户点击圆时触发事件。 mouseover(point:TPixel) 鼠标进入圆上方时触发事件。 mouseout(point:TPixel) 鼠标离开圆上方时触发事件。 3.18 TEllipseOptions 类 TEllipse 类构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 天地图有限公司 33 3.18.1 属性 属性 类型 说明 strokeColor string 椭圆形边线颜色。 fillColor string 椭圆形填充颜色。 strokeWeight number 椭圆形边线的宽度,以像素为单位。 strokeOpacity number 椭圆形边线透明度(范围 0-1 之间)。 fillOpacity number 椭圆形填充的透明度(范围 0-1 之间)。 strokeStyle string 椭圆形边线的样式(取值 solid 或 dashed)。 3.19 TEllipse 类 此类表示地图上的椭圆覆盖物。 3.19.1 构造函数 构造函数 说明 TEllipse(bounds:TBounds[,opts:T EllipseOptions]) 创建椭圆覆盖物。 参数说明: bounds:矩形范围。 opts:矩形的属性对象,请参考 TEllipseOptions。 3.19.2 方法 方法 返回值 说明 getType() number 叠加层类型。 getBounds() TBounds 返回椭圆形图形的显示坐标范围。 setBounds(bounds:TBounds) none 设置椭圆形图形的显示坐标范围。 参数说明: bounds:绘制椭圆形的坐标范围。 setStrokeColor(color:String) none 设置椭圆形的边线颜色,参数为合法的 CSS 颜色值。 getStrokeColor() string 返回椭圆形的边线颜色。 setFillColor(color:String) none 设置椭圆形的填充颜色,参数为合法的 CSS 颜色值。当参数为空字 符串时,圆形覆盖物将没有填充效果。 getFillColor() string 返回椭圆形的填充颜色。 setStrokeOpacity(opacity:Number) none 设置椭圆形的边线透明度(范围 0-1 之间)。 getStrokeOpacity() number 返回椭圆形的边线透明度。 setFillOpacity(opacity:Number) none 设置椭圆形的填充透明度(范围 0-1 之间)。 getFillOpacity() number 返回椭圆形的填充透明度。 setStrokeWeight(weight:Number) none 设置椭圆形边线的宽度(取值为大于等于 1 的整数)。 getStrokeWeight() number 返回椭圆形边线的宽度。 setStrokeStyle(style:String) none 设置椭圆形边线样式为实线或虚线(取值 solid 或 dashed)。 天地图有限公司 34 getStrokeStyle() string 返回椭圆形边线样式。 3.19.3 事件 事件 说明 click(point:TPixel) 当用户点击椭圆形图形时触发事件。 mouseover(point: TPixel) 鼠标进入椭圆形图形上方时触发事件。 mouseout(point: TPixel) 鼠标离开椭圆形图形上方时触发事件。 4 工具类 4.1 TMarkToolOptions 类 此类表示 TMarkTool 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 4.1.1 属性 属性 类型 说明 icon TIcon 鼠标跟随的标注图片。 follow number 标记图标是否跟随鼠标。 4.2 TMarkTool 类 标注工具,用来让用户在地图上标注一个点,可以通过该工具获得用户标点的经纬度位置。 4.2.1 构造函数 构造函数 说明 TMarkTool(map:TMap[,opts:TM arkToolOptions]) 创建一个TMarkTool工具。 参数说明: map:地图对象。 opts:详见TPolygonToolOptions类。 4.2.2 方法 方法 返回值 说明 setPointImage(url:String) none 设置标注工具显示的标注图标路径的路径。 参数说明: 天地图有限公司 35 url:标注图标的路径URL。 getMarkControlPoint() TLngLat 获取用户标注点的坐标,如果用户尚未操作,则返回 null。 open() boolean 开启标注工具。 close() none 关闭标注工具。 4.2.3 事件 事件 说明 mouseup(point:TLngLat) 在用户每完成一次标注时触发事件。 参数说明: point::用户在地图上标的坐标。 4.3 TPolygonToolOptions 类 此类表示 TPolygonTool 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 4.3.1 属性 属性 类型 说明 strokeColor string 边线颜色。 fillColor string 填充颜色。当参数为空时,多边形覆盖物将没有填充效果。 strokeWeight number 边线的宽度,以像素为单位。 strokeOpacity number 边线透明度,取值范围 0 - 1。 fillOpacity number 填充的透明度,取值范围 0 - 1。 strokeStyle string 边线的样式,solid 或 dashed。 showLabel boolean 是否显示面积,如果不显示面积,则可以作为画面控件使用,默认值为 true。 4.4 TPolygonTool 类 多边形工具,可以通过事件来获取用户绘制的多边形,包含测面积功能。 4.4.1 构造函数 构造函数 说明 TPolygonTool(map:TMap[,opts: TPolygonToolOptions]) 创建一个TPolygonTool 控件对象。 参数说明: map:地图对象。 opts:详见TPolygonToolOptions类。 天地图有限公司 36 4.4.2 方法 方法 返回值 说明 setTips(text:String) none 跟随鼠标移动的说明文字。 参数说明: text:文字内容。 getArea(points:TLngLat []) number 计算由地理点组成的多边形的面积。 参数说明: points:点坐标TLngLat数组。 endDraw() none 完成一个多边形的绘制,运行此方法相当于用户点击双击结束当前多边 形的绘制。 clear() none 清除所有该控件在地图上绘制图形。 open() boolean 开启测面积工具。 close() none 关闭侧面积工具。 4.4.3 事件 事件 说明 draw(points:TLngLat[],area:Numb er,polygon:TPolygon) 用户每次双击完成一次多边形绘制时触发事件。 参数说明: points:最后绘制的多边形的顶点坐标数组。 area:最后绘制的多边形的面积。 polygon:最后绘制的多边形标注。 addpoint(points:TLngLat[],lengt h:Number) 用户在多边形绘制过程中,每次点击底图添加节点时触发事件。 points:最后绘制的多边形的顶点坐标数组。 area:最后绘制的多边形的面积 4.5 TPolylineToolOptions 类 此类表示 TPolylineTool 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 4.5.1 属性 属性 类型 说明 strokeColor string 边线颜色。 strokeWeight number 边线的宽度,以像素为单位。 strokeOpacity number 边线透明度,取值范围 0 - 1。 strokeStyle string 边线的样式,solid 或 dashed。 showLabel boolean 是否显示距离,如果不显示距离,则可以作为画线控件使用,默认值为 true(可选)。 天地图有限公司 37 4.6 TPolylineTool 类 折线工具,可以通过事件来获取用户绘制的折线,包含测距功能。 4.6.1 构造函数 构造函数 说明 TPolylineTool(map:TMap[,opts: TPolylineToolOptions]) 创建一个 TPolylineTool 控件。 参数说明: map:地图对象。 opts:详见 TPolylineToolOptions 类。 4.6.2 方法 方法 返回值 说明 setTips(text:String) none 跟随鼠标移动的说明文字。 参数说明: text:文本内容。 getDistance(points:TLngLat []) number 计算一系列地理坐标点的距离总和。 参数说明: points:点坐标 TLngLat 数组。 endDraw() none 完成一个折线的绘制,运行此方法相当于用户点击双击结束当前折线的 绘制。 open() boolean 开启测距工具。 close() none 关闭测距工具。 4.6.3 事件 事件 说明 draw(points:TLngLat[],length:N umber,polyline:TPolyLine) 用户双击完成一次折线绘制时触发事件。 参数说明: points:用户最后绘制的折线的点坐标数组。 length:用户最后绘制的折线的地理长度。 polyline:当前测距所画线的对象。 addpoint(points:TLngLat[],lengt h:Number) 用户测距过程中,每次点击底图添加节点时触发事件。 points:用户最后绘制的折线的点坐标数组。 length:用户最后绘制的折线的地理长度。 天地图有限公司 38 4.7 TRectToolOptions 类 此类表示 TRectTool 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 4.7.1 属性 属性 类型 说明 strokeColor string 边线颜色。 fillColor string 填充颜色。当参数为空时,矩形覆盖物将没有填充效果。 strokeWeight number 边线的宽度,以像素为单位。 strokeOpacity number 边线透明度,取值范围 0 - 1。 strokeStyle string 边线的样式,solid 或 dashed。 4.8 TRectTool 类 矩形工具,用来实现在地图上选择一个矩形区域或绘制矩形的功能。 4.8.1 构造函数 构造函数 说明 TRectTool(map:Tmap[,opts:TRe ctToolOptions]) 创建一个 TRectTool 控件。 参数说明: map :地图对象 opts:详见 TRectToolOptions 类 4.8.2 方法 方法 返回值 说明 clear() none 清除所有该控件在地图上绘制的矩形图形。 open() boolean 开启画矩形工具。 close() none 关闭画矩形工具。 4.8.3 事件 事件 说明 draw(bounds:TLngLatBounds,re ct:TRect) 用户每次完成拉框操作时触发事件。 参数说明: bounds:用户拉框选择的地理范围。 rect:用户最后绘制的矩形图形对象。 天地图有限公司 39 4.9 TCircleToolOptions 类 TCircleToolOptions 类构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 4.9.1 属性 属性 类型 说明 strokeColor string 圆形边线颜色。 fillColor string 圆形填充颜色。当参数为空时,圆形将没有填充效果。 strokeWeight number 圆形边线的宽度,以像素为单位。 strokeOpacity number 圆形边线透明度(范围 0-1 之间)。 fillOpacity number 圆形填充的透明度(范围 0-1 之间)。 strokeStyle string 圆形边线的样式(solid 或 dashed)。 4.10 TCircleTool 类 画圆工具,用来实现在地图上画圆的功能。 4.10.1 构造函数 构造函数 说明 TCircleTool(map:Tmap[,opts:TC ircleToolOptions]) 创建一个 TCircleTool 控件。 参数说明: map :地图对象 opts:详见 TCircleToolOptions 类 4.10.2 方法 方法 返回值 说明 open() boolean 开启画圆工具。 close() none 关闭画圆工具。 4.10.3 事件 事件 说明 draw(center:TLngLat,radius:Nu mber) 用户拖动绘制圆时触发。 参数说明: 天地图有限公司 40 center:中心点的地理坐标。 radius:半径,单位为米。 drawend(circle:TCircle) 用户完成绘制圆时触发。 参数说明: circle:用户最后绘制的圆对象。 5 右键菜单类 5.1 TContextMenu 类 此类表示右键菜单。您可以在地图上添加自定义内容的右键菜单。 5.1.1 构造函数 构造函数 说明 TContextMenu 创建一个右键菜单实例。 5.1.2 方法 方法 类型 说明 addItem(item:MenuItem) none 添加菜单项。 getItem(index:Number) TMenuItem 返回指定索引位置的菜单项,第一个菜单项的索引为 0。 removeItem(item:MenuItem) none 移除菜单项。 addSeparator() none 添加分隔符。 removeSeparator(index:Number) none 移除指定索引位置的分隔符,第一个分隔符的索引为 0。 getItems() array 返回所有的 TMenuItem,是一个数组。 getAllSeparato() array 返回所有分割线,是一个数组。 5.1.3 事件 事件 说明 open(pixel:TPixel) 右键菜单打开时触发事件,事件参数 pixel 表示菜单开启时的像素坐标点。 close() 右键菜单关闭时触发事件。 5.2 TMenuItem 类 此类表示一个菜单项。 天地图有限公司 41 5.2.1 构造函数 构造函数 说明 TMenuItem(text:String,callback:F unction[,opts:MenuItemOptions]) 创建一个菜单项。当菜单项被点击时,系统将会以当前菜单弹出的地理坐标点 作为参数调用回调函数 callback。 text:菜单项显示的文字。 callback:点击菜单时的回调函数。 opts:菜单项配置参数。 5.2.2 属性 属性 类型 说明 setText(text:String) none 设置菜单项显示的文本。 enable() none 启用菜单项。 disable() none 禁用菜单项。 5.3 TContextMenuOptions 类 此类表示 TMenuItem 构造函数的参数设置。它没有构造函数,可以设置菜单项。 5.3.1 属性 属性 类型 说明 width number 指定此菜单项的宽度,菜单以最长的菜单项宽度为准。 6 实体类 6.1 TLngLat 类 此类以经度和纬度表示的地理位置坐标点。 6.1.1 构造函数 构造函数 说明 TLngLat (lng:Numbe,lat:Number) 根据给定经度和纬度创建地理位置坐标点。 6.1.2 方法 方法 返回值 说明 天地图有限公司 42 getLng() number 获取地理坐标点的经度。 getLat() number 获取地理坐标点的纬度。 getMercatorLng() number 获取 WEB 墨卡托坐标点的经度。 getMercatorLat() number 获取 WEB 墨卡托坐标点的纬度。 equals(other:TLngLat) boolean 判断当前地理坐标点与给定坐标点是否为同一点。 参数说明: other:经纬度坐标。 distanceFrom(other:TLngLat,radiu s:Number) number 计算当前地理坐标点与给定坐标点之间的距离。 参数说明 ,: other:经纬度坐标。 radius:也可以传递可选的 radius 参数计算不同于地球半径的球体的 TLngLat 坐标之间的距离。 6.2 TBounds 类 此类可以指定的坐标范围建立一个矩形区域。 6.2.1 构造函数 构造函数 说明 TBounds(TLngLat:lngmin,TLngL at:latmin,TLngLat:lngmax,TLngL at:latmax) 根据给定的多个地理位置坐标点创建矩形。 lngmin:经度最小值 latmin:纬度最小值 lngmax:经度最大值 latmax:纬度最大值 6.2.2 方法 方法 返回值 说明 getCenter () TLngLat 返回此矩形的中心点坐标。 containsLngLat(lnglat:TLngLat) boolean 判断此矩形是否包含给定的位置点坐标。 intersects(startLngLat:TLngLat,en dLngLat:TLngLat) TLngLat [] 返回此矩形与给定两坐标点确定的线相交得到的交点集合。 containsBounds(other:TLngLatBo unds) boolean 判断此矩形是否包含给定的矩形。 other 参数配置坐标所确定的矩形。 extend(lnglat:TLngLat) none 扩展此矩形以包含给定坐标点,如果此矩形包含给定坐标点,则矩形 区域不变。 getSouthWest() TLngLat 返回矩形区域的西南角。 getNorthEast() TLngLat 返回矩形区域的东北角。 天地图有限公司 43 6.3 TPixel 类 此类是以像素坐标表示的地图上的一个点。 6.3.1 属性 属性 类型 说明 x number 像素坐标中 x 坐标,x 坐标向右增大。 y number 像素坐标中 y 坐标,y 坐标向下增大。 6.3.2 构造函数 构造函数 说明 TPixel (x:Number, y:Number) 根据给定 x 和 y 坐标创建地图上的一个像素坐标点。 6.3.3 方法 方法 返回值 说明 equals(other: TPixel) boolean 判断当前像素坐标点与给定像素坐标点是否为同一点。 6.4 TSize 类 此类以像素表示一个矩形区域的大小。 6.4.1 属性 属性 类型 说明 width number 地图矩形区域的宽度。 height number 地图矩形区域的高度。 6.4.2 方法 方法 返回值 说明 equals(other:TSize) boolean 判断当前地图矩形区域与给定矩形区域大小是否相同。 7 事件类 天地图有限公司 44 7.1 TEvent 类 此类用于注册事件处理程序和触发自定义事件。 7.1.1 静态方法 静态方法 返回值 说明 TEvent.addListener(source:Object, event:String, handler:Function) TEventList ener 为源对象(source)的自定义事件(event)注册事件处理程序(handler), 返回一个可用于最终注销处理程序的句柄。事件处理程序的 this 指向 源对象(source) 。 TEvent.removeListener(handle:TE ventListener) none 删除使用 addListener() 注册的事件处理程序。 TEvent.clearListeners(source:Obje ct || Node, event:String) none 删除使用 addListener() 在指定对象(source)上为指定事件(event) 注册的所有事件处理程序。 TEvent.trigger(source:Object, event:String, args:Array) none 在源对象(source)上触发自定义事件(event),可选参数作为自定 义事件调用函数的参数传递。 TEvent.bind(source:Object, event:String,object:Object, method:Function) TEventList ener 将指定对象(object)的方法(method)调用注册为源对象(source) 自定义事件(event)的事件处理程序,返回一个可用于最终注销处 理程序的句柄。 TEvent.getCallback(object:Object, method:Function) Function 返回调用指定对象(object)上的方法(method)的闭包。 TEvent.deposeNode(object:Object ) none 删除指定节点及其子节点上注册的所有事件处理程序,用来清除节 点,防止内存溢出。 TEvent.cancelBubble(event:String ) none 中止事件处理程序的执行以取消事件冒泡,并返回事件处理结果 false 。 TEvent.returnTrue(event:String) none 中止事件处理程序的执行以取消事件冒泡,并返回事件处理结果 true。 7.1.2 事件 事件 说明 clearlisteners(event:String) 当调用对象上的 clearListeners() 方法时,会在该对象上触发此事件。 8 服务类 天地图有限公司 45 8.1 搜索 8.1.1 TLocalSearchOptions 此类表示 TLocalSearchOptions 构造函数的可选参数 8.1.1.1 属性 属性 类型 说明 pageCapacity number 每页容量。 onSearchComplete Function 检索结束后的回调函数。 8.1.2 TLocalSearch 此类用于位置检索、周边检索和范围检索。 8.1.2.1 构造函数 构造函数 说明 TLocalSearch(map:TMap ,opts: TLocalSearchOptions) 创建一个搜索类实例。 参数说明: map:地图对象。 opts:详见 TLocalSearchOptions 类。 8.1.2.2 方法 方法 返回值 说明 search(keyword:String,type:Num ber) none 根据检索词发起检索。 参数说明: keyword:关键字。 type:搜索类型,1 表示普通搜索;2 表示视野内搜索;4 表示 普通建议词搜索;5 表示公交规划建议词搜索;7 表示 纯 POI 搜索(不搜公交线);10 表示拉框搜索 searchInBounds(keyword:String, bounds:TBounds) none 根据范围和检索词发起范围检索。 keyword:关键字。 bounds:搜索范围 searchNearby(keyword:String,ce nter:TlngLat, radius:Number) none 根据中心点、半径与检索词发起周边检索。 参数说明: keyword:关键字。 center:中心点。 天地图有限公司 46 Radius:搜索半径。 getResults() TLocalSearchResult 返回最近一次检索的结果。 clearResults() none 清除最近一次检索的结果。 gotoPage(page:Number) none 检索特定页面的结果。 参数说明: page:检索特定页面数值。 setSpecifyAdminCode(code:Num ber) none 设置检索范围。 参数说明: code:行政区的国标码。 setQueryType(type:Number) none 设置搜索类型。 参数说明: type:搜索类型,1 表示普通搜索;2 表示视野内搜索;4 表示 普通建议词搜索;5 表示公交规划建议词搜索;7 表示 纯 POI 搜索(不搜公交线)。 getQueryType() number 返回搜索类型。 setPageCapacity(count:Number) none 设置每页容量。 参数说明: count:每页容量。 getPageCapacity() number 返回每页容量。 setSearchCompleteCallback(fun: Function) none 设置检索结束后的回调函数。 参数说明: fun:回调函数。回调函数参数为 TlocalSearchResult,具 体内容详见 TlocalSearchResult 类。 firstPage() none 检索第一页。 nextPage() none 检索下一页。 previousPage() number 检索上一页。 lastPage() none 检索最后一页。 getCountNumber() number 返回总记录数。 getCountPage() none 返回共分总页数。 getPageIndex() string 返回当前页。 天地图有限公司 47 8.1.3 TLocalSearchResult 此类表示 TLocalSearch 的检索结果,没有构造函数,通过 TLocalSearch.getResults()方法或 TLocalSearch 的 onSearchComplete 回调函数的参数得到。 8.1.3.1 方法 方法 返回值 说明 getResultType() number 返回搜索类型,1 表示普通搜索;2 表示视野内搜索;4 表示普通建议词搜索;5 表 示公交规划建议词搜索;7 表示 纯 POI 搜索(不搜公交线)。 getCount() number 返回检索总条数。 getKeyword() string 返回检索关键词。 getPois() JSON 返回点信息,当 getResultType 值为 1 时返回。 数据结构如下: [ { "phone": "", //电话 "lonlat": "116.313488 39.979416", //坐标 "address": "北京市海淀区", //地址 "name": "中关村", //Poi点名称 "poiType": "102", //poi类型(102表示公交站,普通poi 该参数 可以不返回) }, … ] getStatistics() none 返回统计信息,当 getResultType 值为 2 时返回。 数据结构如下: { "priorityCitys": [ //推荐显示城市 { "count": "38341", //统计数量 "name": "上海市", //城市名称 "adminCode": 156310000 //城市国标码 }, { "count": "37346", "name": "北京市", "adminCode": 156110000 }, ... ], "keyword": "饭店", //搜索的关键字 "countryCount": 1, //搜索的国家数量 "citysCount": 383, //搜索的城市数量 天地图有限公司 48 "allAdmins": [ //各省包含信息集合 { "count": "82739", //统计数量 "name": "广东省", //省名称 "adminCode": 156440000, //省国标码 "childAdmins": [ //包括各市级集合 { "count": "19038", ////统计数量 "name": "广州市", //城市名称 "adminCode": "156440100" //城市国标码 }, { "count": "16578", "name": "深圳市", "adminCode": "156440300" }, ... ] }, { "count": "62891", "name": "四川省", "adminCode": 156510000, "childAdmins": [ { "count": "30673", "name": "成都市", "adminCode": "156510100" }, { "count": "4907", "name": "绵阳市", "adminCode": "156510700" }, ... ] }, {...}, ... ], "provinceCount": 34 //搜索的省份数量 } getArea() none 返回行政区省信息,当 getResultType 值为 3 时返回。 数据结构如下: { "level": "11", //显示级别 天地图有限公司 49 "lonlat": "116.38094,39.923615", //定位中心点坐标 "name": "北京市", //名称 "points": [ //行政区边界坐标 { "region": "116.625875 41.058853,116.68501 41.040147,116.692716 41.019134,116.677056 40.998562,..." } ], "type": "1" //1 表示正常区域,2 表示特殊区域 } getSuggests() none 返回建议词信息,当 getResultType 值为 4 时返回。 数据结构如下: [ { "address": "", //地址 "name": "北京市", //名称 "gbCode": "000" //国标码 }, { "address": "北京市海淀区", "name": "北京北京", "gbCode": "156110108" }, ... ] getPrompt() none 返回提示信息。 数据结构如下: [ { "keyword": "123456", //关键字 "admins": [ { "name": "中国", //搜索的行政区范围 "adminCode": 156000000 //行政区码 } ], "type": 2 /* 当 Type=1 时,会给出一个 admin 一个 keyword 还有 admincode, 此时一般的提示为“是否在 XXX 搜索名称含 XXX 的结果” 当 Type = 2 时,会给出一个 admin 一个 keyword 还有 admincode, 此时一般提示为“在 XXX 没有搜索到相关的结果” 当 Type =3 时,会给出多个 admin 及对应的 admincode ,没有 keyword,此时一般的提示为 “您是否要找: 天地图有限公司 50 ” 只列出名称即可,点击后,直接用这些关键字搜索即可完成行政区 跳转 */ }, { "admins": [ { "name": "中国", "adminCode": 156000000 } ], "type": 4 } ] getLineData() number 返回线路信息,当 getResultType 值为 5 时返回。 数据结构如下: [ { "poiType": "103", // poi 点的 poi 类型(poiType =102 表示公交站,其 它值表示普通 poi) "stationNum": "24", //站数 "name": "1 路(四惠枢纽站-靛厂新村)", //线路名称 "uuid": "23089" //线路的 id }, { "poiType": "103", "stationNum": "24", "name": "1 路(靛厂新村-四惠枢纽站)", "uuid": "23088" }, ... ] 8.2 公交 天地图有限公司 51 8.2.1 TTransitRouteOptions 此类表示 TransitRoute 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 8.2.1.1 属性 属性 类型 说明 policy number 公交导航的策略参数。 策略常量。常量如下: TMAP_TRANSIT_POLICY_LEAST_TIME = 1 表示最少时间 TMAP_TRANSIT_POLICY_LEAST_TRANSFER = 2 表示最少换乘 TMAP_TRANSIT_POLICY_LEAST_WALKING = 4 表示最少步行 TMAP_TRANSIT_POLICY_AVOID_SUBWAYS = 8 表示不乘地铁 onSearchComplete Function 检索结束后的回调函数。 8.2.2 TTransitRoute 用于获取公交路线规划方案。 8.2.2.1 构造函数 构造函数 说明 TTransitRoute(map:TMap ,opts: TransitRouteOptions) 创建一个公交导航实例。 参数说明: map:地图对象。 opts:详见 TransitRouteOptions 类。 8.2.2.2 方法 方法 返回值 说明 search(start:TLngLat,end:TLngL at) none 发起检索。 参数说明: start:起点坐标。 end:终点坐标。 getResults() TTransitRouteResult 返回最近一次检索的结果。 clearResults() none 清除最近一次检索的结果。 setPolicy(policy:Number) none 设置路线规划策略,参数为策略常量。 参数说明: policy:策略常量。常量如下: 天地图有限公司 52 TMAP_TRANSIT_POLICY_LEAST_TIME = 1 表示最少时间 TMAP_TRANSIT_POLICY_LEAST_TRANSFER = 2 表示最 少换乘 TMAP_TRANSIT_POLICY_LEAST_WALKING = 4 表示最少 步行 TMAP_TRANSIT_POLICY_AVOID_SUBWAYS = 8 表示不乘 地铁 setSearchCompleteCallback(fun: Function) none 设置检索结束后的回调函数。 参数说明: fun:回调函数。回调函数参数为 TTransitRouteResult,具体 内容详见 TTransitRouteResult 类。 getStatus() none 返回状态码。 状态码如下: 0 表示正常返回线路; 1 表示找不到起点; 2 表示找不到终点; 3 表示规划不出线路; 4 表示起终点距离 200 米以内,不返回线路; 5 表示起终点距离 500 米内,返回线路; 6 表示输入参数错误 8.2.3 TTransitRouteResult 此类表示 TTransitRoute 的检索结果,没有构造函数,通过 TTransitRoute.getResults()方法或 TTransitRoute 的 onSearchComplete 回调函数的参数得到。 8.2.3.1 方法 方法 返回值 说明 getNumPlans() number 返回方案个数。 getPlan(i:Number) TTransitRoutePlan 返回索引指定的方案。索引 0 表示第一条方案。 8.2.4 TTransitRoutePlan 此类表示一条公交出行方案。没有构造函数,通过 TTransitRouteResult.getPlan()方法获得。 8.2.4.1 方法 方法 返回值 说明 getNumSegments() number 返回单个方案的详细信息段数。 天地图有限公司 53 getDetails(i:Number) TTransitRouteLine 返回索引指定的详细信息。索引 0 表示第一条方案。 getLineName() array 返回方案描述文本。 getDistance() number 返回方案总距离。 getDuration() number 返回方案总时间。 getLineType() Number 返回公交导航的策略参数。 8.2.5 TTransitRouteLine 此类表示一条公交线路。没有构造函数,通过 TTransitRoutePlan. getDetails ()方法得到。 8.2.5.1 方法 方法 返回值 说明 getSegmentType() number 返回线路类型。1 表示步行;2 表示公交;3 表示地铁;4 表示地铁站内 换乘。 getStationStart() JSON 返回起站点信息。 数据结构如下: { "lonlat": "116.331796,39.991591", //起站点坐标 "name": "五道口站", //起站点名称 "uuid": "133010" //起站点 id } getStationEnd() JSON 返回终站点信息。 数据结构如下: { "lonlat": "116.331796,39.991591", //起站点坐标 "name": "五道口站", //起站点名称 "uuid": "133010" //起站点 id } getSegmentLine() number 返回线路内容。 数据结构如下: [ { "segmentStationCount": 3, //此段线路需要经过的站点数 "segmentTime": 8, //此段线路需要的时间 "segmentDistance": 5933.84980962115, //此段线路的距离 "direction": "地铁13号线", //此段线路的完整线路名 "linePoint": "116.331796,39.991591;116.331993,39.987717;116.332141,39.98644;...", // 此段线路的坐标 "lineName": "地铁13号线", //线路名称 "byuuid": "23200" //此段线路 id 天地图有限公司 54 } ] 8.2.6 TBusLineSearchOptions 此类表示 TBusLineSearch 构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。 8.2.6.1 属性 属性 类型 说明 onGetBusListComplete Function 设置公交列表查询后的回调函数。 onGetBusLineComplete Function 设置公交线路查询后的回调函数。 8.2.7 TBusLineSearch 公交路线搜索类。 8.2.7.1 构造函数 构造函数 说明 TBusLineSearch(map:TMap ,opts: TBusLineSearchOptions) 公交路线搜索类。 参数说明: map:地图对象。 opts:详见 TBusLineSearchOptions 类。 8.2.7.2 方法 方法 返回值 说明 getBusList(keyword: String) none 检索公交信息。 getBusLine(busLstItem:BusListItem) none 检索公交路线。 setGetBusListCompleteCallback(call back:Function) none 设置公交列表查询后的回调函数。 setGetBusLineCompleteCallback(call back:Function) none 设置公交线路查询后的回调函数。 8.2.8 TBusListResult 此类表示 TBusLineSearch 的检索结果,没有构造函数,通过 TBusLineSearch 的 setGetBusListCompleteCallback 天地图有限公司 55 回调函数的参数得到。 8.2.8.1 方法 方法 返回值 说明 getNumBusList() number 公交列表个数。 getBusListItem(i: Number) JSON 获取某一个具体的公交列表中的对象。 数据结构如下: { "stationNum": "42", //站数 "name": "850 路(东直门外-马坡站)", //线路名称 "uuid": "23084" //线路的 id } 8.2.9 TBusLine 此类表示 TBusLineSearch 的检索结果,没有构造函数,通过 TBusLineSearch 的 setGetBusLineCompleteCallback 回调函数的参数得到。 8.2.9.1 属性 属性 类型 说明 lineName string 线路名称,如:68 路。 lineType number 线路类型,1 表示公交;2 表示地铁;3 表示磁悬浮。 length number 线路的长度,单位米。 linePoint string 线路的详细点信息,格式:x,y;x,y; startTime string 始发车时间格式为:hh:mm 24 小时制。 endTime string 末班车时间格式为:hh:mm 24 小时制。 totalTime number 公交线路的全程运营总时间,单位分钟。 stationCount number 该线路所具有的站点总数量。 interval number 发车间隔,单位秒。 ticketcal number 计费模式,0 表示单一;1 表示按距离;2 表示按站。 totalPrice number 全程票价,单位分。 startPrice number 起步票价,单位分。 increasedPrice number 递增距离票价,单位千米。 increasedStep number 车站递增票价,按站。 ismonTicket number 是否支持月票,0 表示不支持;1 表示支持。 isBidirectional number 是否双向行驶,0 表示单项;1 表示双向。 isManual number 是否人工售票,0 表示有人;1 表示无人。 status number 状态,0 表示使用中;1 表示非使用中 company string 所属公交公司,公交线路所属公司。 天地图有限公司 56 8.2.9.2 方法 方法 返回值 说明 getNumBusStations() number 返回公交站点个数。 getBusStation(i: Number) JSON 返回某一个具体的公交站信息。 数据结构如下: { "lonlat": "116.430522,39.939852", //站点坐标 "name": "东直门外", //站点名称 "uuid": "122805" //站的 id 信息 } getPath() array 返回公交线地理坐标点数组。 8.3 驾车 8.3.1 TDrivingRouteOptions 此类表示 DrivingRoute 构造函数的可选参数。 8.3.1.1 属性 属性 类型 说明 policy number 驾车策略参数。 参数说明: policy:策略常量。常量如下: TMAP_DRIVING_POLICY_LEAST_TIME = 0 最少时间 TMAP_DRIVING_POLICY_LEAST_DISTANCE = 1 最短距离 TMAP_DRIVING_POLICY_AVOID_HIGHWAYS = 2 避开高速 TMAP_DRIVING_POLICY_WALK = 3 步行 onSearchComplete Function 检索完成后的回调函数。参数:results: TDrivingRouteResult 8.3.2 TDrivingRoute 此类用于获取驾车路线规划方案。 8.3.2.1 构造函数 构造函数 说明 TDrivingRoute(map:TMap ,opts: 创建一个驾车导航实例。 天地图有限公司 57 TDrivingRouteOptions) 参数说明: map:地图对象。 opts:详见 TDrivingRouteOptions 类。 8.3.2.2 方法 方法 返回值 说明 search(start:TLngLat,end:TLngL at) none 发起检索。 参数说明: start:起点坐标。 end:终点坐标。 getResults() TDrivingRouteResult 返回最近一次检索的结果。 clearResults() none 清除最近一次检索的结果。 setPolicy(policy:Number) none 设置路线规划策略,参数为策略常量。 参数说明: policy:策略常量。常量如下: TMAP_DRIVING_POLICY_LEAST_TIME = 0 最少时间 TMAP_DRIVING_POLICY_LEAST_DISTANCE = 1 最短 距离 TMAP_DRIVING_POLICY_AVOID_HIGHWAYS = 2 避 开高速 TMAP_DRIVING_POLICY_WALK = 3 步行 setSearchCompleteCallback(fun: Function) none 设置检索结束后的回调函数。 参数说明: fun:回调函数。回调函数参数为 TDrivingRouteResult,具 体内容详见 TDrivingRouteResult 类。 8.3.3 TDrivingRouteResult 此类表示 TDrivingRoute 的检索结果,没有构造函数,通过 TDrivingRoute.getResults()方法或 TDrivingRoute 的 onSearchComplete 回调函数的参数得到。 8.3.3.1 方法 方法 返回值 说明 getStart() TLngLat 返回起点。 getEnd() TLngLat 返回终点。 getNumPlans() number 返回方案个数。 getPlan(i:Number) TTransitRoutePlan 返回索引指定的方案。索引 0 表示第一条方案。 天地图有限公司 58 8.3.4 TRoutePlan 此类表示一条驾车出行方案。没有构造函数,通过 TDrivingRouteResult.getPlan()方法获得。 8.3.4.1 方法 方法 返回值 说明 getNumRoutes() number 返回该方案包含的线路的个数。 getRoute(i:Number) TRoute 返回方案中索引指定的线路信息。索引 0 表示第一条线路。 getDistance() number 返回方案总距离,单位为公里。 getDuration() number 返回方案总时间,单位为秒。 getWayPois() Array 返回途径点。 getPath() Array 返回路线的经纬度。 8.3.5 TRoute 此类表示一条驾车路线。。没有构造函数,通过 TRoutePlan.getRoute()方法获得。 8.3.5.1 方法 方法 返回值 说明 getNumSteps() number 返回该段路线包含的关键点个数。 getStep(i:Number) TStep 返回索引指定的关键点。索引 0 表示第一个关键点。 getDistance() number 返回该段路线距离。 getIndex() number 返回该段路线在方案中的索引位置。 getPath() Array 返回该段路线的坐标。 8.3.6 TStep 此类表示驾车路线中的一个关键点。它没有构造函数,通过 TRoute.getStep()方法获得。 8.3.6.1 方法 方法 返回值 说明 getPosition() TlngLat 返回关键点地理坐标。 getIndex() Number 返回本关键点在路线中的位置索引 getDescription() string 返回关键点描述文本。
还剩59页未读

继续阅读

下载pdf到电脑,查找使用更方便

pdf的实际排版效果,会与网站的显示效果略有不同!!

需要 6 金币 [ 分享pdf获得金币 ] 2 人已下载

下载pdf

pdf贡献者

Mr.Dangerous

贡献于2014-10-28

下载需要 6 金币 [金币充值 ]
亲,您也可以通过 分享原创pdf 来获得金币奖励!
下载pdf