maps.html 37 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
  6. <meta name="HandheldFriendly" content="true">
  7. <meta name="MobileOptimized" content="320">
  8. <title>Maps Document</title>
  9. <link rel="stylesheet" type="text/css" href="res/doc.css" charset="utf-8">
  10. <link rel="stylesheet" type="text/css" href="res/prettify.sons.css" charset="utf-8">
  11. <script type="text/javascript" src="res/doc.js" charset="utf-8"></script><script type="text/javascript" src="res/prettify.js" charset="utf-8"></script>
  12. </head>
  13. <body><div id="content" class="content">
  14. <h1><a name="plus.maps">maps</a></h1>
  15. <p>Maps模块管理地图控件,用于在web页面中显示地图控件,提供各种接口操作地图控件,如添加标点、路线等。通过plus.maps可获取地图管理对象。</p>
  16. <h2>方法:</h2>
  17. <ul>
  18. <li>
  19. <a href="#plus.maps.openSysMap">openSysMap</a>: 调用系统第三方程序进行导航</li>
  20. <li>
  21. <a href="#plus.maps.create">create</a>: 创建Map对象</li>
  22. <li>
  23. <a href="#plus.maps.getMapById">getMapById</a>: 查找已经创建的Map对象</li>
  24. </ul>
  25. <h2>对象:</h2>
  26. <ul>
  27. <li>
  28. <a href="#plus.maps.Map">Map</a>: 地图控件对象</li>
  29. <li>
  30. <a href="#plus.maps.MapStyles">MapStyles</a>: 地图控件对象的参数</li>
  31. <li>
  32. <a href="#plus.maps.GeocodeOptions">GeocodeOptions</a>: 地理编码转换的参数</li>
  33. <li>
  34. <a href="#plus.maps.CoordinateConvertOptions">CoordinateConvertOptions</a>: 地图坐标转换的参数</li>
  35. <li>
  36. <a href="#plus.maps.Point">Point</a>: Point对象用于表示地图元素的坐标</li>
  37. <li>
  38. <a href="#plus.maps.Bounds">Bounds</a>: 地理区域</li>
  39. <li>
  40. <a href="#plus.maps.MapType">MapType</a>: 地图视图类型</li>
  41. <li>
  42. <a href="#plus.maps.Overlay">Overlay</a>: 地图覆盖物基类对象</li>
  43. <li>
  44. <a href="#plus.maps.Marker">Marker</a>: 地图上显示的标点对象</li>
  45. <li>
  46. <a href="#plus.maps.Bubble">Bubble</a>: 地图上显示的气泡对象</li>
  47. <li>
  48. <a href="#plus.maps.Circle">Circle</a>: 地图上显示的圆圈对象</li>
  49. <li>
  50. <a href="#plus.maps.Polyline">Polyline</a>: 地图上显示的折线对象</li>
  51. <li>
  52. <a href="#plus.maps.Polygon">Polygon</a>: 地图上显示的多边形对象</li>
  53. <li>
  54. <a href="#plus.maps.Search">Search</a>: 地图检索对象</li>
  55. <li>
  56. <a href="#plus.maps.SearchPolicy">SearchPolicy</a>: 检索策略类型</li>
  57. <li>
  58. <a href="#plus.maps.SearchPoiResult">SearchPoiResult</a>: 保存位置检索、周边检索和范围检索返回的结果</li>
  59. <li>
  60. <a href="#plus.maps.SearchRouteResult">SearchRouteResult</a>: 保存位置检索、周边检索和范围检索返回的结果</li>
  61. <li>
  62. <a href="#plus.maps.Position">Position</a>: 检索结果的位置点</li>
  63. <li>
  64. <a href="#plus.maps.Route">Route</a>: 地图中的路线对象</li>
  65. </ul>
  66. <h2>回调方法:</h2>
  67. <ul>
  68. <li>
  69. <a href="#plus.maps.GeocodeCallback">GeocodeCallback</a>: 地理编码转换成功的回调函数</li>
  70. <li>
  71. <a href="#plus.maps.CoordinateConvertCallback">CoordinateConvertCallback</a>: 坐标转换成功的回调函数</li>
  72. <li>
  73. <a href="#plus.maps.DistanceCalculateCallback">DistanceCalculateCallback</a>: 距离计算成功的回调函数</li>
  74. <li>
  75. <a href="#plus.maps.AreaCalculateCallback">AreaCalculateCallback</a>: 地理区域面积计算成功的回调函数</li>
  76. <li>
  77. <a href="#plus.maps.UserLocationCallback">UserLocationCallback</a>: 获取用户当前位置信息成功回调</li>
  78. <li>
  79. <a href="#plus.maps.ClickEventHandler">ClickEventHandler</a>: 用户点击地图回调事件</li>
  80. <li>
  81. <a href="#plus.maps.StatusChangedEventHandler">StatusChangedEventHandler</a>: 地图状态变化回调事件</li>
  82. <li>
  83. <a href="#plus.maps.OverlayClickEventHandler">OverlayClickEventHandler</a>: 用户点击地图覆盖物回调事件</li>
  84. <li>
  85. <a href="#plus.maps.OverlayDragEventHandler">OverlayDragEventHandler</a>: 用户拖拽覆盖物回调事件</li>
  86. <li>
  87. <a href="#plus.maps.PoiSearchCallback">PoiSearchCallback</a>: 兴趣点检索完成事件</li>
  88. <li>
  89. <a href="#plus.maps.RouteSearchCallback">RouteSearchCallback</a>: 线路检索完成事件</li>
  90. <li>
  91. <a href="#plus.maps.SuccessCallback">SuccessCallback</a>: 地图操作成功回调函数</li>
  92. <li>
  93. <a href="#plus.maps.ErrorCallback">ErrorCallback</a>: 地图操作失败的回调函数</li>
  94. </ul>
  95. <h2>权限:</h2>
  96. <p>permissions</p>
  97. <pre class="prettyprint linenums">
  98. {
  99. // ...
  100. "permissions":{
  101. // ...
  102. "Maps": {
  103. "description": "地图"
  104. }
  105. }
  106. }
  107. </pre>
  108. <h1><a name="plus.maps.Map">Map</a></h1>
  109. <p>地图控件对象</p>
  110. <h2>构造:</h2>
  111. <ul><li>
  112. <a href="#plus.maps.Map.Map(domId,%20styles)">Map(domId, styles)</a>: 创建Map对象</li></ul>
  113. <h2>方法:</h2>
  114. <ul>
  115. <li>
  116. <a href="#plus.maps.Map.calculateArea">calculateArea</a>: 静态方法,计算面积</li>
  117. <li>
  118. <a href="#plus.maps.Map.calculateDistance">calculateDistance</a>: 静态方法,计算距离</li>
  119. <li>
  120. <a href="#plus.maps.Map.convertCoordinates">convertCoordinates</a>: 静态方法,坐标转换</li>
  121. <li>
  122. <a href="#plus.maps.Map.geocode">geocode</a>: 静态方法,地理编码</li>
  123. <li>
  124. <a href="#plus.maps.Map.reverseGeocode">reverseGeocode</a>: 静态方法,反向地理编码</li>
  125. <li>
  126. <a href="#plus.maps.Map.addOverlay">addOverlay</a>: 向地图中添加覆盖物</li>
  127. <li>
  128. <a href="#plus.maps.Map.centerAndZoom">centerAndZoom</a>: 设置地图初始中心点和缩放级别</li>
  129. <li>
  130. <a href="#plus.maps.Map.clearOverlays">clearOverlays</a>: 清除地图中所有覆盖物对象</li>
  131. <li>
  132. <a href="#plus.maps.Map.close">close</a>: 关闭地图控件</li>
  133. <li>
  134. <a href="#plus.maps.Map.getBounds">getBounds</a>: 获取当前地图可视范围的地理区域</li>
  135. <li>
  136. <a href="#plus.maps.Map.getCenter">getCenter</a>: 获取地图中心点位置</li>
  137. <li>
  138. <a href="#plus.maps.Map.getCurrentCenter">getCurrentCenter</a>: 获取当前地图显示的地图中心点位置</li>
  139. <li>
  140. <a href="#plus.maps.Map.getMapType">getMapType</a>: 获取地图的显示类型</li>
  141. <li>
  142. <a href="#plus.maps.Map.getUserLocation">getUserLocation</a>: 获取用户的当前位置信息</li>
  143. <li>
  144. <a href="#plus.maps.Map.getZoom">getZoom</a>: 获取地图的缩放级别</li>
  145. <li>
  146. <a href="#plus.maps.Map.hide">hide</a>: 隐藏地图控件</li>
  147. <li>
  148. <a href="#plus.maps.Map.isShowUserLocation">isShowUserLocation</a>: 获取是否显示用户位置</li>
  149. <li>
  150. <a href="#plus.maps.Map.isShowZoomControls">isShowZoomControls</a>: 获取是否显示地图内置缩放控件</li>
  151. <li>
  152. <a href="#plus.maps.Map.isTraffic">isTraffic</a>: 获取是否打开地图交通信息图层</li>
  153. <li>
  154. <a href="#plus.maps.Map.removeOverlay">removeOverlay</a>: 从地图中删除覆盖物对象</li>
  155. <li>
  156. <a href="#plus.maps.Map.reset">reset</a>: 重置地图</li>
  157. <li>
  158. <a href="#plus.maps.Map.resize">resize</a>: 重设地图控件大小</li>
  159. <li>
  160. <a href="#plus.maps.Map.setCenter">setCenter</a>: 设置地图的中心点</li>
  161. <li>
  162. <a href="#plus.maps.Map.setMapType">setMapType</a>: 设置地图的视图类型</li>
  163. <li>
  164. <a href="#plus.maps.Map.setStyles">setStyles</a>: 设置地图控件的配置参数</li>
  165. <li>
  166. <a href="#plus.maps.Map.setTraffic">setTraffic</a>: 是否打开地图交通信息图层</li>
  167. <li>
  168. <a href="#plus.maps.Map.setZoom">setZoom</a>: 设置地图的缩放级别</li>
  169. <li>
  170. <a href="#plus.maps.Map.show">show</a>: 显示地图控件</li>
  171. <li>
  172. <a href="#plus.maps.Map.showUserLocation">showUserLocation</a>: 显示用户位置</li>
  173. <li>
  174. <a href="#plus.maps.Map.showZoomControls">showZoomControls</a>: 设置是否显示地图内置缩放控件</li>
  175. </ul>
  176. <h2>事件:</h2>
  177. <ul>
  178. <li>
  179. <a href="#plus.maps.Map.onclick">onclick</a>: 用户点击地图事件</li>
  180. <li>
  181. <a href="#plus.maps.Map.onstatuschanged">onstatuschanged</a>: 地图状态改变事件</li>
  182. </ul>
  183. <h1><a name="plus.maps.MapStyles">MapStyles</a></h1>
  184. <p>地图控件对象的参数</p>
  185. <pre class="prettyprint linenums">
  186. interface plus.maps.MapStyles {
  187. attribute Point center;
  188. attribute Number zoom;
  189. attribute MapType type;
  190. attribute Boolean traffic;
  191. attribute Boolean zoomControls;
  192. attribute String top;
  193. attribute String left;
  194. attribute String width;
  195. attribute String height;
  196. attribute String position;
  197. }
  198. </pre>
  199. <h2>说明:</h2>
  200. <p class="des">
  201. 设置地图对象显示时使用的参数,如地图的中心位置、缩放级别等。
  202. </p>
  203. <h2>属性:</h2>
  204. <ul>
  205. <li>center: <em>(<a href="#plus.maps.Point">Point</a>
  206. 类型
  207. )</em>地图的中心位置<br><p>
  208. 未设置则使用地图的默认中心点(由地图供应商确定)。
  209. </p>
  210. </li>
  211. <li>zoom: <em>(<font class="type">Number</font>
  212. 类型
  213. )</em>地图的缩放级别<br><p>
  214. 有效范围为有效范围为3-21(高德地图为3-20,百度地图为4-21),默认值为12,设置无效的值则使用默认值。
  215. </p>
  216. </li>
  217. <li>type: <em>(<a href="#plus.maps.MapType">MapType</a>
  218. 类型
  219. )</em>地图的视图类型<br><p>
  220. 可设置普通街道视图、卫星视图,默认值为普通街道视图。
  221. </p>
  222. </li>
  223. <li>traffic: <em>(<font class="type">Boolean</font>
  224. 类型
  225. )</em>地图的是否显示交通信息<br><p>
  226. true表示显示地图的交通信息图层,false则不显示,默认值为false。
  227. </p>
  228. </li>
  229. <li>zoomControls: <em>(<font class="type">Boolean</font>
  230. 类型
  231. )</em>是否显示地图的内置缩放控件<br><p>
  232. true表示显示地图的内置缩放控件,false则不显示,默认值为false。
  233. </p>
  234. </li>
  235. <li>top: <em>(<font class="type">String</font>
  236. 类型
  237. )</em>地图控件左上角的垂直偏移量<br><p>
  238. 可取值:
  239. 像素值,如"100px";
  240. 百分比,如"10%",相对于父Webview窗口的高度;
  241. 自动计算,如"auto",根据height值自动计算,相对于父Webview窗口垂直居中。
  242. </p>
  243. </li>
  244. <li>left: <em>(<font class="type">String</font>
  245. 类型
  246. )</em>地图控件左上角的水平偏移量<br><p>
  247. 可取值:
  248. 像素值,如"100px";
  249. 百分比,如"10%",相对于父Webview窗口的宽度;
  250. 自动计算,如"auto",根据width值自动计算,相对于父Webview窗口水平居中。
  251. 默认值为"0px"。
  252. </p>
  253. </li>
  254. <li>width: <em>(<font class="type">String</font>
  255. 类型
  256. )</em>地图控件的宽度<br><p>
  257. 可取值:
  258. 像素值,如"100px";
  259. 百分比,如"10%",相对于父Webview窗口的宽度。
  260. 默认值为"100%"。
  261. </p>
  262. </li>
  263. <li>height: <em>(<font class="type">String</font>
  264. 类型
  265. )</em>地图控件的高度<br><p>
  266. 可取值:
  267. 像素值,如"100px";
  268. 百分比,如"10%",相对于父Webview窗口的高度。
  269. 默认值为"100%"。
  270. </p>
  271. </li>
  272. <li>position: <em>(<font class="type">String</font>
  273. 类型
  274. )</em>地图控件在Webview窗口的布局模式<br><p>
  275. 可取值:
  276. "static" - 静态布局模式,如果页面存在滚动条则随窗口内容滚动;
  277. "absolute" - 绝对布局模式,如果页面存在滚动条不随窗口内容滚动;
  278. 默认值为"static"。
  279. </p>
  280. </li>
  281. </ul>
  282. <h1><a name="plus.maps.GeocodeOptions">GeocodeOptions</a></h1>
  283. <p>地理编码转换的参数</p>
  284. <h2>属性:</h2>
  285. <ul>
  286. <li>coordType: <em>(<font class="type">String</font>
  287. 类型
  288. )</em>源数据的坐标系类型<br><p>
  289. 仅在反向地理编码转换时生效。
  290. “wgs84”:表示WGS-84坐标系; “gcj02”:表示国测局经纬度坐标系; “bd09”:表示百度墨卡托坐标系; “bd09ll”:表示百度经纬度坐标系;
  291. 默认使用wgs84坐标系。
  292. </p>
  293. </li>
  294. <li>city: <em>(<font class="type">String</font>
  295. 类型
  296. )</em>源地址所属的城市<br><p>
  297. 仅在地理编码转换时生效,如果不指定则在全国范围内区配转换。
  298. </p>
  299. </li>
  300. </ul>
  301. <h1><a name="plus.maps.CoordinateConvertOptions">CoordinateConvertOptions</a></h1>
  302. <p>地图坐标转换的参数</p>
  303. <h2>属性:</h2>
  304. <ul><li>coordType: <em>(<font class="type">String</font>
  305. 类型
  306. )</em>源数据的坐标系类型<br><p>
  307. “wgs84”:表示WGS-84坐标系; “gcj02”:表示国测局经纬度坐标系; “bd09”:表示百度墨卡托坐标系; “bd09ll”:表示百度经纬度坐标系;
  308. 默认使用wgs84坐标系。
  309. </p>
  310. </li></ul>
  311. <h1><a name="plus.maps.Point">Point</a></h1>
  312. <p>Point对象用于表示地图元素的坐标</p>
  313. <h2>说明:</h2>
  314. <p class="des">常用语对地图上元素进行定位时使用。</p>
  315. <h2>构造:</h2>
  316. <ul><li>
  317. <a href="#plus.maps.Point.Point(lng,lat)">Point(lng,lat)</a>: 创建Point对象</li></ul>
  318. <h2>方法:</h2>
  319. <ul>
  320. <li>
  321. <a href="#plus.maps.Point.setLng">setLng</a>: 设置坐标点的经度</li>
  322. <li>
  323. <a href="#plus.maps.Point.getLng">getLng</a>: 获取坐标的经度</li>
  324. <li>
  325. <a href="#plus.maps.Point.setLat">setLat</a>: 设置坐标的纬度</li>
  326. <li>
  327. <a href="#plus.maps.Point.getLat">getLat</a>: 获取坐标的纬度</li>
  328. <li>
  329. <a href="#plus.maps.Point.equals">equals</a>: 判断两个坐标点是否相等</li>
  330. </ul>
  331. <h1><a name="plus.maps.Bounds">Bounds</a></h1>
  332. <p>地理区域</p>
  333. <h2>说明:</h2>
  334. <p class="des">
  335. 有西南及东北坐标点数据组成的矩形区域。
  336. </p>
  337. <h2>构造:</h2>
  338. <ul>
  339. <li>
  340. <a href="#plus.maps.Bounds.Bounds(northease,southwest)">Bounds(northease,southwest)</a>: 创建Bounds对象</li>
  341. <li>
  342. <a href="#plus.maps.Bounds.Bounds(nelng,nelat,swlng,swlat)">Bounds(nelng,nelat,swlng,swlat)</a>: 创建Bounds对象</li>
  343. </ul>
  344. <h2>方法:</h2>
  345. <ul>
  346. <li>
  347. <a href="#plus.maps.Bounds.setNorthEase">setNorthEase</a>: 设置地理区域的东北坐标点</li>
  348. <li>
  349. <a href="#plus.maps.Bounds.getNorthEase">getNorthEase</a>: 地理区域的东北坐标点</li>
  350. <li>
  351. <a href="#plus.maps.Bounds.setSouthWest">setSouthWest</a>: 设置地理区域的西南坐标点</li>
  352. <li>
  353. <a href="#plus.maps.Bounds.getSouthWest">getSouthWest</a>: 地理区域的西南坐标点</li>
  354. <li>
  355. <a href="#plus.maps.Bounds.contains">contains</a>: 判断制定的坐标是否在地理区域中</li>
  356. <li>
  357. <a href="#plus.maps.Bounds.equals">equals</a>: 判断两个地理区域是否相等</li>
  358. <li>
  359. <a href="#plus.maps.Bounds.getCenter">getCenter</a>: 获取地理区域的中心点坐标</li>
  360. </ul>
  361. <h1><a name="plus.maps.MapType">MapType</a></h1>
  362. <p>地图视图类型</p>
  363. <h2>常量:</h2>
  364. <ul>
  365. <li>MAPTYPE_NORMAL: <em>(<font class="type">Number</font>
  366. 类型
  367. )</em>普通街道视图类型<br><p>地图视图类型常量,普通街道视图。</p>
  368. </li>
  369. <li>MAPTYPE_SATELLITE: <em>(<font class="type">Number</font>
  370. 类型
  371. )</em>卫星视图<br><p>地图视图类型常量,卫星视图。</p>
  372. </li>
  373. </ul>
  374. <h1><a name="plus.maps.Overlay">Overlay</a></h1>
  375. <p>地图覆盖物基类对象</p>
  376. <pre class="prettyprint linenums">
  377. interface Overlay {
  378. function Boolean isVisible();
  379. function void show();
  380. function void hide();
  381. }
  382. </pre>
  383. <h2>说明:</h2>
  384. <p class="des">
  385. Overlay是地图上显示元素的基类,用于抽象地图元素,不用于实例化。
  386. </p>
  387. <h2>方法:</h2>
  388. <ul>
  389. <li>
  390. <a href="#plus.maps.Overlay.isVisible">isVisible</a>: 判断地图覆盖物是否可见</li>
  391. <li>
  392. <a href="#plus.maps.Overlay.show">show</a>: 显示地图上的覆盖物</li>
  393. <li>
  394. <a href="#plus.maps.Overlay.hide">hide</a>: 隐藏地图上的覆盖物</li>
  395. </ul>
  396. <h1><a name="plus.maps.Marker">Marker</a></h1>
  397. <p>地图上显示的标点对象</p>
  398. <h2>说明:</h2>
  399. <p class="des">从Overlay对象继承而来,可通过Map对象的addOverlay()方法将对象添加地图中。</p>
  400. <h2>构造:</h2>
  401. <ul><li>
  402. <a href="#plus.maps.Marker.Marker(%20point%20)">Marker( point )</a>: 创建地图标点Marker对象</li></ul>
  403. <h2>方法:</h2>
  404. <ul>
  405. <li>
  406. <a href="#plus.maps.Marker.bringToTop">bringToTop</a>: 覆盖物显示到最上层</li>
  407. <li>
  408. <a href="#plus.maps.Marker.setPoint">setPoint</a>: 设置标点对象的坐标</li>
  409. <li>
  410. <a href="#plus.maps.Marker.getPoint">getPoint</a>: 获取标点的坐标</li>
  411. <li>
  412. <a href="#plus.maps.Marker.setIcon">setIcon</a>: 设置标点上显示的图标</li>
  413. <li>
  414. <a href="#plus.maps.Marker.setIcons">setIcons</a>: 设置标点上显示的图标数组</li>
  415. <li>
  416. <a href="#plus.maps.Marker.setLabel">setLabel</a>: 设置标点上显示的文本标注</li>
  417. <li>
  418. <a href="#plus.maps.Marker.getLabel">getLabel</a>: 获取标点上显示的文本标注</li>
  419. <li>
  420. <a href="#plus.maps.Marker.setBubble">setBubble</a>: 设置标点的气泡内容</li>
  421. <li>
  422. <a href="#plus.maps.Marker.getBubble">getBubble</a>: 获取标点上显示的文本标注</li>
  423. <li>
  424. <a href="#plus.maps.Marker.hideBubble">hideBubble</a>: 隐藏标点上显示的气泡</li>
  425. <li>
  426. <a href="#plus.maps.Marker.setDraggable">setDraggable</a>: 设置标点的是否允许拖拽</li>
  427. <li>
  428. <a href="#plus.maps.Marker.isDraggable">isDraggable</a>: 获取标点是否允许拖拽</li>
  429. </ul>
  430. <h2>事件:</h2>
  431. <ul>
  432. <li>
  433. <a href="#plus.maps.Marker.onclick">onclick</a>: 用户点击地图标点事件</li>
  434. <li>
  435. <a href="#plus.maps.Marker.onDrag">onDrag</a>: 用户拖拽标点事件</li>
  436. </ul>
  437. <h1><a name="plus.maps.Bubble">Bubble</a></h1>
  438. <p>地图上显示的气泡对象</p>
  439. <h2>说明:</h2>
  440. <p class="des">
  441. 此对象不能直接添加到地图上显示,只可关联到地图标点覆盖物上,用户点击标点时弹出显示。
  442. </p>
  443. <h2>构造:</h2>
  444. <ul><li>
  445. <a href="#plus.maps.Bubble.Bubble(%20label%20)">Bubble( label )</a>: 创建气泡对象</li></ul>
  446. <h2>方法:</h2>
  447. <ul>
  448. <li>
  449. <a href="#plus.maps.Bubble.setIcon">setIcon</a>: 设置气泡上显示的图标</li>
  450. <li>
  451. <a href="#plus.maps.Bubble.setLabel">setLabel</a>: 设置气泡上显示的文字内容</li>
  452. <li>
  453. <a href="#plus.maps.Bubble.getLabel">getLabel</a>: 获取气泡上显示的文字内容</li>
  454. <li>
  455. <a href="#plus.maps.Bubble.belongMarker">belongMarker</a>: 获取气泡所属的标点对象</li>
  456. <li>
  457. <a href="#plus.maps.Bubble.loadImage">loadImage</a>: 从图片加载气泡显示的内容</li>
  458. <li>
  459. <a href="#plus.maps.Bubble.loadImageDataURL">loadImageDataURL</a>: 从图片数据加载气泡显示的内容</li>
  460. </ul>
  461. <h2>事件:</h2>
  462. <ul><li>
  463. <a href="#plus.maps.Bubble.onclick">onclick</a>: 用户点击气泡事件</li></ul>
  464. <h1><a name="plus.maps.Circle">Circle</a></h1>
  465. <p>地图上显示的圆圈对象</p>
  466. <h2>说明:</h2>
  467. <p class="des">从Overlay对象继承而来,可通过Map对象的addOverlay()方法将对象添加地图中。</p>
  468. <h2>构造:</h2>
  469. <ul><li>
  470. <a href="#plus.maps.Circle.Circle(%20center,%20radius%20)">Circle( center, radius )</a>: 创建Circle对象</li></ul>
  471. <h2>方法:</h2>
  472. <ul>
  473. <li>
  474. <a href="#plus.maps.Circle.setCenter">setCenter</a>: 设置圆圈中心点的经纬度坐标</li>
  475. <li>
  476. <a href="#plus.maps.Circle.getCenter">getCenter</a>: 获取圆圈中心点的坐标</li>
  477. <li>
  478. <a href="#plus.maps.Circle.setRadius">setRadius</a>: 设置圆圈的半径,单位为米</li>
  479. <li>
  480. <a href="#plus.maps.Circle.getRadius">getRadius</a>: 获取圆圈的半径</li>
  481. <li>
  482. <a href="#plus.maps.Circle.setStrokeColor">setStrokeColor</a>: 设置圆圈的边框颜色</li>
  483. <li>
  484. <a href="#plus.maps.Circle.getStrokeColor">getStrokeColor</a>: 获取圆圈的边框颜色</li>
  485. <li>
  486. <a href="#plus.maps.Circle.setStrokeOpacity">setStrokeOpacity</a>: 设置圆圈的边框颜色</li>
  487. <li>
  488. <a href="#plus.maps.Circle.getStrokeOpacity">getStrokeOpacity</a>: 获取圆圈边框的透明度</li>
  489. <li>
  490. <a href="#plus.maps.Circle.setFillColor">setFillColor</a>: 设置圆圈的填充颜色</li>
  491. <li>
  492. <a href="#plus.maps.Circle.getFillColor">getFillColor</a>: 获取圆圈的填充颜色</li>
  493. <li>
  494. <a href="#plus.maps.Circle.setFillOpacity">setFillOpacity</a>: 设置圆圈填充颜色的透明度</li>
  495. <li>
  496. <a href="#plus.maps.Circle.getFillOpacity">getFillOpacity</a>: 获取圆圈填充色的透明度</li>
  497. <li>
  498. <a href="#plus.maps.Circle.setLineWidth">setLineWidth</a>: 设置圆圈边框的线条宽度</li>
  499. <li>
  500. <a href="#plus.maps.Circle.getLineWidth">getLineWidth</a>: 获取圆圈边框的线条宽度</li>
  501. </ul>
  502. <h1><a name="plus.maps.Polyline">Polyline</a></h1>
  503. <p>地图上显示的折线对象</p>
  504. <h2>说明:</h2>
  505. <p class="des">从Overlay对象继承而来,可通过Map对象的addOverlay()方法将对象添加地图中。</p>
  506. <h2>构造:</h2>
  507. <ul><li>
  508. <a href="#plus.maps.Polyline.Polyline(%20points%20)">Polyline( points )</a>: 创建Polyline对象</li></ul>
  509. <h2>方法:</h2>
  510. <ul>
  511. <li>
  512. <a href="#plus.maps.Polyline.setPath">setPath</a>: 设置折线的顶点坐标</li>
  513. <li>
  514. <a href="#plus.maps.Polyline.getPath">getPath</a>: 获取折线的顶点坐标</li>
  515. <li>
  516. <a href="#plus.maps.Polyline.setStrokeColor">setStrokeColor</a>: 设置折线的颜色</li>
  517. <li>
  518. <a href="#plus.maps.Polyline.getStrokeColor">getStrokeColor</a>: 获取折线的颜色</li>
  519. <li>
  520. <a href="#plus.maps.Polyline.setStrokeOpacity">setStrokeOpacity</a>: 设设置折线的透明度</li>
  521. <li>
  522. <a href="#plus.maps.Polyline.getStrokeOpacity">getStrokeOpacity</a>: 获取折线的透明度</li>
  523. <li>
  524. <a href="#plus.maps.Polyline.setLineWidth">setLineWidth</a>: 设置折线的线条宽度</li>
  525. <li>
  526. <a href="#plus.maps.Polyline.getLineWidth">getLineWidth</a>: 获取折线的线条宽度</li>
  527. </ul>
  528. <h1><a name="plus.maps.Polygon">Polygon</a></h1>
  529. <p>地图上显示的多边形对象</p>
  530. <h2>说明:</h2>
  531. <p class="des">从Overlay对象继承而来,可通过Map对象的addOverlay()方法将对象添加地图中。</p>
  532. <h2>构造:</h2>
  533. <ul><li>
  534. <a href="#plus.maps.Polygon.Polygon(%20points%20)">Polygon( points )</a>: 创建Polygon对象</li></ul>
  535. <h2>方法:</h2>
  536. <ul>
  537. <li>
  538. <a href="#plus.maps.Polygon.setPath">setPath</a>: 设置多边形的顶点坐标</li>
  539. <li>
  540. <a href="#plus.maps.Polygon.getPath">getPath</a>: 获取多边形的顶点坐标</li>
  541. <li>
  542. <a href="#plus.maps.Polygon.setStrokeColor">setStrokeColor</a>: 设置多边形的颜色</li>
  543. <li>
  544. <a href="#plus.maps.Polygon.getStrokeColor">getStrokeColor</a>: 获取多边形边框的颜色</li>
  545. <li>
  546. <a href="#plus.maps.Polygon.setStrokeOpacity">setStrokeOpacity</a>: 设置多边形的透明度</li>
  547. <li>
  548. <a href="#plus.maps.Polygon.getStrokeOpacity">getStrokeOpacity</a>: 获取多边形边框的透明度</li>
  549. <li>
  550. <a href="#plus.maps.Polygon.setFillColor">setFillColor</a>: 设置多边形的填充颜色</li>
  551. <li>
  552. <a href="#plus.maps.Polygon.getFillColor">getFillColor</a>: 获取多边形的填充色</li>
  553. <li>
  554. <a href="#plus.maps.Polygon.setFillOpacity">setFillOpacity</a>: 设置多边形填充色的透明度</li>
  555. <li>
  556. <a href="#plus.maps.Polygon.getFillOpacity">getFillOpacity</a>: 获取多边形填充色的透明度</li>
  557. <li>
  558. <a href="#plus.maps.Polygon.setLineWidth">setLineWidth</a>: 设置多边形的边框宽度</li>
  559. <li>
  560. <a href="#plus.maps.Polygon.getLineWidth">getLineWidth</a>: 获取多边形边框的宽度</li>
  561. </ul>
  562. <h1><a name="plus.maps.Search">Search</a></h1>
  563. <p>地图检索对象</p>
  564. <h2>说明:</h2>
  565. <p class="des">
  566. Search对象用于管理地图上的检索功能,包括位置检索、周边检索和范围检索。
  567. </p>
  568. <h2>构造:</h2>
  569. <ul><li>
  570. <a href="#plus.maps.Search.Search(%20map%20)">Search( map )</a>: 创建Search对象</li></ul>
  571. <h2>方法:</h2>
  572. <ul>
  573. <li>
  574. <a href="#plus.maps.Search.setPageCapacity">setPageCapacity</a>: 设置检索返回结果每页的信息数目</li>
  575. <li>
  576. <a href="#plus.maps.Search.getPageCapacity">getPageCapacity</a>: 获取检索返回结果每页的信息数目</li>
  577. <li>
  578. <a href="#plus.maps.Search.poiSearchInCity">poiSearchInCity</a>: 城市兴趣点检索</li>
  579. <li>
  580. <a href="#plus.maps.Search.poiSearchNearBy">poiSearchNearBy</a>: 周边检索</li>
  581. <li>
  582. <a href="#plus.maps.Search.poiSearchInbounds">poiSearchInbounds</a>: 指定范围检索</li>
  583. <li>
  584. <a href="#plus.maps.Search.setTransitPolicy">setTransitPolicy</a>: 设置公交路线检索策略</li>
  585. <li>
  586. <a href="#plus.maps.Search.transitSearch">transitSearch</a>: 公交路线检索</li>
  587. <li>
  588. <a href="#plus.maps.Search.setDrivingPolicy">setDrivingPolicy</a>: 设置驾车路线检索策略</li>
  589. <li>
  590. <a href="#plus.maps.Search.drivingSearch">drivingSearch</a>: 驾车路线检索</li>
  591. <li>
  592. <a href="#plus.maps.Search.walkingSearch">walkingSearch</a>: 步行路线检索</li>
  593. </ul>
  594. <h2>事件:</h2>
  595. <ul>
  596. <li>
  597. <a href="#plus.maps.Search.onPoiSearchComplete">onPoiSearchComplete</a>: 兴趣点检索完成事件</li>
  598. <li>
  599. <a href="#plus.maps.Search.onRouteSearchComplete">onRouteSearchComplete</a>: 线路检索完成事件</li>
  600. </ul>
  601. <h1><a name="plus.maps.SearchPolicy">SearchPolicy</a></h1>
  602. <p>检索策略类型</p>
  603. <h2>说明:</h2>
  604. <p class="des">在线路检索时设置检索策略时使用。</p>
  605. <h2>常量:</h2>
  606. <ul>
  607. <li>TRANSIT_TIME_FIRST: <em>(<font class="type">Number</font>
  608. 类型
  609. )</em>时间优先<br><p>检索策略类型常量,用于公交检索策略</p>
  610. </li>
  611. <li>TRANSIT_TRANSFER_FIRST: <em>(<font class="type">Number</font>
  612. 类型
  613. )</em>最少换乘优先<br><p>检索策略类型常量,用于公交检索策略</p>
  614. </li>
  615. <li>TRANSIT_WALK_FIRST: <em>(<font class="type">Number</font>
  616. 类型
  617. )</em>最少步行距离优先<br><p>检索策略类型常量,用于公交检索策略</p>
  618. </li>
  619. <li>TRANSIT_FEE_FIRST: <em>(<font class="type">Number</font>
  620. 类型
  621. )</em>选择车票花销最少优先<br><p>检索策略类型常量,用于公交检索策略</p>
  622. </li>
  623. <li>DRIVING_DIS_FIRST: <em>(<font class="type">Number</font>
  624. 类型
  625. )</em>最短距离优先<br><p>检索策略类型常量,用于驾车检索策略</p>
  626. </li>
  627. <li>DRIVING_NO_EXPRESSWAY: <em>(<font class="type">Number</font>
  628. 类型
  629. )</em>无高速公路线路<br><p>检索策略类型常量,用于驾车检索策略</p>
  630. </li>
  631. <li>DRIVING_FEE_FIRST: <em>(<font class="type">Number</font>
  632. 类型
  633. )</em>最少费用优先<br><p>检索策略类型常量,用于驾车检索策略</p>
  634. </li>
  635. </ul>
  636. <h1><a name="plus.maps.SearchPoiResult">SearchPoiResult</a></h1>
  637. <p>保存位置检索、周边检索和范围检索返回的结果</p>
  638. <h2>属性:</h2>
  639. <ul>
  640. <li>
  641. <a href="#plus.maps.SearchPoiResult.totalNumber">totalNumber</a>: POI检索总结果数</li>
  642. <li>
  643. <a href="#plus.maps.SearchPoiResult.currentNumber">currentNumber</a>: 当前页的POI检索结果数</li>
  644. <li>
  645. <a href="#plus.maps.SearchPoiResult.pageNumber">pageNumber</a>: 本次POI检索的总页数</li>
  646. <li>
  647. <a href="#plus.maps.SearchPoiResult.pageIndex">pageIndex</a>: 获取当前页的索引</li>
  648. <li>
  649. <a href="#plus.maps.SearchPoiResult.poiList">poiList</a>: 本次POI检索结果数组</li>
  650. </ul>
  651. <h2>方法:</h2>
  652. <ul><li>
  653. <a href="#plus.maps.SearchPoiResult.getPosition">getPosition</a>: 获取指定索引的检索结果</li></ul>
  654. <h1><a name="plus.maps.SearchRouteResult">SearchRouteResult</a></h1>
  655. <p>保存位置检索、周边检索和范围检索返回的结果</p>
  656. <h2>说明:</h2>
  657. <p class="des">
  658. 不可通过new操作符创建SearchRouteResult对象,在触发onRouteSearchComplete()时自动创建。
  659. </p>
  660. <h2>属性:</h2>
  661. <ul>
  662. <li>
  663. <a href="#plus.maps.SearchRouteResult.startPosition">startPosition</a>: 线路的起点位置</li>
  664. <li>
  665. <a href="#plus.maps.SearchRouteResult.endPosition">endPosition</a>: 线路的终点位置</li>
  666. <li>
  667. <a href="#plus.maps.SearchRouteResult.routeNumber">routeNumber</a>: 本次线路检索的总方案数</li>
  668. <li>
  669. <a href="#plus.maps.SearchRouteResult.routeList">routeList</a>: 线路检索结果数组</li>
  670. </ul>
  671. <h2>方法:</h2>
  672. <ul><li>
  673. <a href="#plus.maps.SearchRouteResult.getRoute">getRoute</a>: 获取指定索引的线路方案</li></ul>
  674. <h1><a name="plus.maps.Position">Position</a></h1>
  675. <p>检索结果的位置点</p>
  676. <h2>构造:</h2>
  677. <ul><li>
  678. <a href="#plus.maps.Position.Position(%20point%20)">Position( point )</a>: 创建Position对象</li></ul>
  679. <h2>属性:</h2>
  680. <ul>
  681. <li>
  682. <a href="#plus.maps.Position.point">point</a>: 位置点的经纬度坐标</li>
  683. <li>
  684. <a href="#plus.maps.Position.address">address</a>: 位置点的地址信息</li>
  685. <li>
  686. <a href="#plus.maps.Position.city">city</a>: 位置点的所属城市信息</li>
  687. <li>
  688. <a href="#plus.maps.Position.name">name</a>: 位置点的名称</li>
  689. <li>
  690. <a href="#plus.maps.Position.phone">phone</a>: 位置点的电话信息</li>
  691. <li>
  692. <a href="#plus.maps.Position.postcode">postcode</a>: 位置点的邮编信息</li>
  693. </ul>
  694. <h1><a name="plus.maps.Route">Route</a></h1>
  695. <p>地图中的路线对象</p>
  696. <h2>说明:</h2>
  697. <p class="des">
  698. 从Overlay对象继承而来,可通过Map对象的addOverlay()方法将对象添加地图中。
  699. </p>
  700. <h2>构造:</h2>
  701. <ul><li>
  702. <a href="#plus.maps.Route.Route(%20ptStart,%20ptEnd%20)">Route( ptStart, ptEnd )</a>: 创建Route对象</li></ul>
  703. <h2>属性:</h2>
  704. <ul>
  705. <li>
  706. <a href="#plus.maps.Route.startPoint">startPoint</a>: 路线起点地理坐标点</li>
  707. <li>
  708. <a href="#plus.maps.Route.endPoint">endPoint</a>: 路线终点地理坐标点</li>
  709. <li>
  710. <a href="#plus.maps.Route.pointCount">pointCount</a>: 路线坐标点段数</li>
  711. <li>
  712. <a href="#plus.maps.Route.pointList">pointList</a>: 路线的地理坐标点数组</li>
  713. <li>
  714. <a href="#plus.maps.Route.distance">distance</a>: 路线总距离</li>
  715. <li>
  716. <a href="#plus.maps.Route.routeTip">routeTip</a>: 线路的提示信息</li>
  717. </ul>
  718. <h1><a name="plus.maps.GeocodeCallback">GeocodeCallback</a></h1>
  719. <p>地理编码转换成功的回调函数</p>
  720. <pre class="prettyprint linenums">
  721. void onGeocodeSuccess( Event event ) {
  722. // JS code.
  723. var address = event.address; // 转换后的地理位置
  724. var point = event.coord; // 转换后的坐标信息
  725. var coordType = event.coordType; // 转换后的坐标系类型
  726. }
  727. </pre>
  728. <h2>说明:</h2>
  729. <p class="des">
  730. 在地理编码转换成功触发,并返回转换结果。
  731. </p>
  732. <h2>参数:</h2>
  733. <ul><li>event:
  734. <em>(
  735. <font class="type">Event</font>
  736. )
  737. 可选 </em>转换后的坐标信息<br>
  738. 可通过event.coord(Point类型)获取转换后的坐标值。
  739. 可通过event.coordType(String类型)获取转换后的坐标系类型,“wgs84”:表示WGS-84坐标系; “gcj02”:表示国测局经纬度坐标系; “bd09”:表示百度墨卡托坐标系; “bd09ll”:表示百度经纬度坐标系。
  740. </li></ul>
  741. <h2>返回值:</h2>
  742. <font class="type">void</font>
  743. : 无<h1><a name="plus.maps.CoordinateConvertCallback">CoordinateConvertCallback</a></h1>
  744. <p>坐标转换成功的回调函数</p>
  745. <pre class="prettyprint linenums">
  746. void onConvertSuccess( Event event ) {
  747. // JS code.
  748. var point = event.coord; // 转换后的坐标值
  749. var coordType = event.coordType; // 转换后的坐标系类型
  750. }
  751. </pre>
  752. <h2>说明:</h2>
  753. <p class="des">
  754. 在坐标转换成功触发,并返回转换结果。
  755. </p>
  756. <h2>参数:</h2>
  757. <ul><li>event:
  758. <em>(
  759. <font class="type">Event</font>
  760. )
  761. 可选 </em>转换后的坐标信息<br>
  762. 可通过event.coord(Point类型)获取转换后的坐标值。
  763. 可通过event.coordType(String类型)获取转换后的坐标系类型,“wgs84”:表示WGS-84坐标系; “gcj02”:表示国测局经纬度坐标系; “bd09”:表示百度墨卡托坐标系; “bd09ll”:表示百度经纬度坐标系。
  764. </li></ul>
  765. <h2>返回值:</h2>
  766. <font class="type">void</font>
  767. : 无<h1><a name="plus.maps.DistanceCalculateCallback">DistanceCalculateCallback</a></h1>
  768. <p>距离计算成功的回调函数</p>
  769. <pre class="prettyprint linenums">
  770. void onCalculateSuccess( Event event ) {
  771. // JS code.
  772. var distance = event.distance; // 转换后的距离值
  773. }
  774. </pre>
  775. <h2>说明:</h2>
  776. <p class="des">
  777. 在距离计算成功触发,并返回计算结果。
  778. </p>
  779. <h2>参数:</h2>
  780. <ul><li>event:
  781. <em>(
  782. <font class="type">Event</font>
  783. )
  784. 可选 </em>距离计算后的信息<br>
  785. 可通过event.distance(Number类型)获取计算后的距离值,单位为米(m)。
  786. </li></ul>
  787. <h2>返回值:</h2>
  788. <font class="type">void</font>
  789. : 无<h1><a name="plus.maps.AreaCalculateCallback">AreaCalculateCallback</a></h1>
  790. <p>地理区域面积计算成功的回调函数</p>
  791. <pre class="prettyprint linenums">
  792. void onCalculateSuccess( Event event ) {
  793. // JS code.
  794. var area = event.area; // 计算后的面积值
  795. }
  796. </pre>
  797. <h2>说明:</h2>
  798. <p class="des">
  799. 在地理区域面积计算成功触发,并返回计算结果。
  800. </p>
  801. <h2>参数:</h2>
  802. <ul><li>event:
  803. <em>(
  804. <font class="type">Event</font>
  805. )
  806. 可选 </em>地理区域面积计算后的信息<br>
  807. 可通过event.area(Number类型)获取计算后的面积值,单位为平方米。
  808. </li></ul>
  809. <h2>返回值:</h2>
  810. <font class="type">void</font>
  811. : 无<h1><a name="plus.maps.UserLocationCallback">UserLocationCallback</a></h1>
  812. <p>获取用户当前位置信息成功回调</p>
  813. <pre class="prettyprint linenums">
  814. void onSuccess( state, point ) {
  815. // Get location code
  816. }
  817. </pre>
  818. <h2>参数:</h2>
  819. <ul>
  820. <li>state:
  821. <em>(
  822. <font class="type">Number</font>
  823. )
  824. 必选 </em>获取用户位置操作状态码,0表示成功,其它为错误码<br>
  825. </li>
  826. <li>point:
  827. <em>(
  828. <a href="#plus.maps.Point">Point</a>
  829. )
  830. 必选 </em>位置经纬度坐标,如果获取操作失败则为null对象<br>
  831. </li>
  832. </ul>
  833. <h2>返回值:</h2>
  834. <font class="type">void</font>
  835. : 无<h1><a name="plus.maps.ClickEventHandler">ClickEventHandler</a></h1>
  836. <p>用户点击地图回调事件</p>
  837. <pre class="prettyprint linenums">
  838. void onClick( point ) {
  839. // Click code
  840. }
  841. </pre>
  842. <h2>参数:</h2>
  843. <ul><li>point:
  844. <em>(
  845. <a href="#plus.maps.Point">Point</a>
  846. )
  847. 必选 </em>用户在地图上点击的坐标点<br>
  848. </li></ul>
  849. <h2>返回值:</h2>
  850. <font class="type">void</font>
  851. : 无<h1><a name="plus.maps.StatusChangedEventHandler">StatusChangedEventHandler</a></h1>
  852. <p>地图状态变化回调事件</p>
  853. <pre class="prettyprint linenums">
  854. void onStatusChanged( event ) {
  855. // Click code
  856. var target = event.target; // 状态变化的地图对象(plus.maps.Map)
  857. var bounds = event.bounds; // 地图的可视地理区域(plus.maps.Bounds)
  858. var center = event.center; // 地图的中心点坐标(plus.maps.Point)
  859. var zoom = event.zoom; // 地图的缩放级别(Number)
  860. }
  861. </pre>
  862. <h2>参数:</h2>
  863. <ul><li>event:
  864. <em>(
  865. <font class="type">Event</font>
  866. )
  867. 必选 </em>地图状态变化对象<br>
  868. 可通过event.target(plus.maps.Map类型)获取状态变化的地图对象;
  869. 可通过event.bounds(plus.maps.Bounds类型)获取地图当前的可视区域;
  870. 可通过event.center(plus.maps.Point类型)获取地图当前的中心点坐标;
  871. 可通过event.zoom(Number类型)获取地图当前的缩放级别。
  872. </li></ul>
  873. <h2>返回值:</h2>
  874. <font class="type">void</font>
  875. : 无<h1><a name="plus.maps.OverlayClickEventHandler">OverlayClickEventHandler</a></h1>
  876. <p>用户点击地图覆盖物回调事件</p>
  877. <pre class="prettyprint linenums">
  878. void onClick( overlay ) {
  879. // Click code
  880. }
  881. </pre>
  882. <h2>参数:</h2>
  883. <ul><li>overlay:
  884. <em>(
  885. <a href="#plus.maps.Overlay">Overlay</a>
  886. )
  887. 必选 </em>用户在地图上点击的覆盖物对象<br>
  888. overlay可以是Marker、Bubble、Circle、Polyline、Polygon对象的引用。
  889. </li></ul>
  890. <h2>返回值:</h2>
  891. <font class="type">void</font>
  892. : 无<h1><a name="plus.maps.OverlayDragEventHandler">OverlayDragEventHandler</a></h1>
  893. <p>用户拖拽覆盖物回调事件</p>
  894. <pre class="prettyprint linenums">
  895. void onDrag( target ) {
  896. // Click code
  897. var marker = target; // 拖拽的覆盖物对象
  898. }
  899. </pre>
  900. <h2>参数:</h2>
  901. <ul><li>target:
  902. <em>(
  903. <font class="type">Event</font>
  904. )
  905. 必选 </em>拖拽事件对象<br>
  906. 可通过target(Overlay类型)获取拖拽的覆盖物对象,target可以是Marker、Bubble、Circle、Polyline、Polygon对象的引用。
  907. </li></ul>
  908. <h2>返回值:</h2>
  909. <font class="type">void</font>
  910. : 无<h1><a name="plus.maps.PoiSearchCallback">PoiSearchCallback</a></h1>
  911. <p>兴趣点检索完成事件</p>
  912. <pre class="prettyprint linenums">
  913. void onPoiSearchComplete( state, result ) {
  914. // JS code.
  915. }
  916. </pre>
  917. <h2>说明:</h2>
  918. <p class="des">
  919. 在兴趣点检索完成时触发,并返回检索结果。
  920. </p>
  921. <h2>参数:</h2>
  922. <ul>
  923. <li>state:
  924. <em>(
  925. <font class="type">Number</font>
  926. )
  927. 必选 </em>检索结果状态号<br>0表示检索正确并返回结果,其它表示检索错误。</li>
  928. <li>result:
  929. <em>(
  930. <a href="#plus.maps.SearchPoiResult">SearchPoiResult</a>
  931. )
  932. 必选 </em>POI检索结果<br>若检索错误,则为null对象。</li>
  933. </ul>
  934. <h2>返回值:</h2>
  935. <font class="type">void</font>
  936. : 无<h1><a name="plus.maps.RouteSearchCallback">RouteSearchCallback</a></h1>
  937. <p>线路检索完成事件</p>
  938. <pre class="prettyprint linenums">
  939. void onRouteSearchComplete( state, result ) {
  940. // JS code.
  941. }
  942. </pre>
  943. <h2>说明:</h2>
  944. <p class="des">
  945. 在线路检索完成时触发,并返回检索结果。
  946. </p>
  947. <h2>参数:</h2>
  948. <ul>
  949. <li>state:
  950. <em>(
  951. <font class="type">Number</font>
  952. )
  953. 必选 </em>检索结果状态号<br>0表示检索正确并返回结果,其它表示检索错误。</li>
  954. <li>result:
  955. <em>(
  956. <a href="#plus.maps.SearchRouteResult">SearchRouteResult</a>
  957. )
  958. 必选 </em>线路检索结果<br>若检索错误,则为null对象。</li>
  959. </ul>
  960. <h2>返回值:</h2>
  961. <font class="type">void</font>
  962. : 无<h1><a name="plus.maps.SuccessCallback">SuccessCallback</a></h1>
  963. <p>地图操作成功回调函数</p>
  964. <pre class="prettyprint linenums">
  965. void onSuccess(){
  966. // Success code.
  967. }
  968. </pre>
  969. <h2>说明:</h2>
  970. <p class="des">
  971. 地图操作成功后触发回调函数。
  972. </p>
  973. <h2>参数:</h2>
  974. <p>无</p>
  975. <h2>返回值:</h2>
  976. <font class="type">void</font>
  977. : 无<h1><a name="plus.maps.ErrorCallback">ErrorCallback</a></h1>
  978. <p>地图操作失败的回调函数</p>
  979. <pre class="prettyprint linenums">
  980. function void onError( error ) {
  981. // Handle error
  982. var code = error.code; // 错误编码
  983. var message = error.message; // 错误描述信息
  984. }
  985. </pre>
  986. <h2>参数:</h2>
  987. <ul><li>error:
  988. <em>(
  989. <font class="type">Exception</font>
  990. )
  991. 必选 </em>地图操作的错误信息<br>
  992. 可通过error.code(Number类型)获取错误编码;
  993. 可通过error.message(String类型)获取错误描述信息。
  994. </li></ul>
  995. <h2>返回值:</h2>
  996. <font class="type">void</font>
  997. : 无<br><br>
  998. </div></body>
  999. </html>