# [maps]()
Maps模塊管理地圖控件,用于在web頁面中顯示地圖控件,提供各種接口操作地圖控件,如添加標點、路線等。通過plus.maps可獲取地圖管理對象。
### 方法:
- [openSysMap](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.openSysMap): 調用系統第三方程序進行導航
### 對象:
- [Map](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map): 地圖控件對象
- [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point): Point對象用于表示地圖元素的坐標
- [MapType](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.MapType): 地圖視圖類型
- [Overlay](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Overlay): 地圖覆蓋物基類對象
- [Marker](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker): 地圖上顯示的標點對象
- [Bubble](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble): 地圖上顯示的氣泡對象
- [Circle](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle): 地圖上顯示的圓圈對象
- [Polyline](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline): 地圖上顯示的折線對象
- [Polygon](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon): 地圖上顯示的多邊形對象
- [Search](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search): 地圖檢索對象
- [SearchPolicy](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPolicy): 檢索策略類型
- [SearchPoiResult](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult): 保存位置檢索、周邊檢索和范圍檢索返回的結果
- [SearchRouteResult](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchRouteResult): 保存位置檢索、周邊檢索和范圍檢索返回的結果
- [Position](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position): 檢索結果的位置點
- [Route](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route): 地圖中的路線對象
### 回調方法:
- [UserLocationCallback](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.UserLocationCallback): 獲取用戶當前位置信息成功回調
- [ClickEventHandler](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.ClickEventHandler): 用戶點擊地圖回調事件
- [OverlayClickEventHandler](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.OverlayClickEventHandler): 用戶點擊地圖覆蓋物回調事件
- [PoiSearchCallback](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.PoiSearchCallback): 興趣點檢索完成事件
- [RouteSearchCallback](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.RouteSearchCallback): 線路檢索完成事件
### 權限:
permissions
~~~
"Maps": {
"description": "訪問地圖插件"
}
~~~
# [openSysMap]()
調用系統第三方程序進行導航
~~~
plus.maps.openSysMap( dst, des, src );
~~~
### 參數:
- dst: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *導航目的地坐標
- des: *( DOMString ) 必選 *導航目的地描述
- src: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *導航起始地描述
### 返回值:
void : 無
### 示例:
~~~
// 設置目標位置坐標點和其實位置坐標點
var dst = new plus.maps.Point(39.906016,116.3977); // 天安門
var src = new plus.maps.Point(39.967846,116.337984); // 大鐘寺
// 調用系統地圖顯示
plus.maps.openSysMap( dst, "天安門", src );
~~~
# [Map]()
地圖控件對象
### 構造:
- [Map(id,zoomControl)](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.Map(id,zoomControl)): 創建Map對象
### 方法:
- [centerAndZoom](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.centerAndZoom): 設置地圖初始中心點和縮放級別
- [setCenter](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.setCenter): 設置地圖的中心點
- [getCenter](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.getCenter): 獲取地圖中心點
- [setZoom](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.setZoom): 設置地圖的縮放級別
- [getZoom](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.getZoom): 獲取地圖的縮放級別
- [reset](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.reset): 重新設置地圖
- [setMapType](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.setMapType): 設置地圖類型
- [getMapType](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.getMapType): 獲取地圖的顯示類型
- [setTraffic](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.setTraffic): 設置是否打開地圖交通信息圖層
- [isTraffic](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.isTraffic): 獲取是否打開地圖交通信息圖層
- [showUserLocation](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.showUserLocation): 顯示用戶位置
- [isShowUserLocation](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.isShowUserLocation): 獲取地圖是否顯示用戶位置
- [showZoomControls](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.showZoomControls): 設置是否顯示地圖內置縮放控件
- [isShowZoomControls](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.isShowZoomControls): 獲取是否顯示地圖內置縮放控件
- [addOverlay](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.addOverlay): 向地圖中添加覆蓋物
- [removeOverlay](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.removeOverlay): 從地圖中刪除覆蓋物對象
- [clearOverlays](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.clearOverlays): 清除地圖中所有覆蓋物對象
- [getUserLocation](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.getUserLocation): 獲取用戶的當前位置信息
- [getCurrentCenter](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.getCurrentCenter): 獲取當前地圖顯示的地圖中心點位置
- [show](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.show): 顯示地圖控件
- [hide](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.hide): 隱藏地圖控件
### 事件:
- [onclick](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map.onclick): 用戶點擊地圖事件
# [Map(id,zoomControl)]()
創建Map對象
~~~
var ptObj = new plus.maps.Map( id );
~~~
### 說明:
Map對象是通過DOM樹中的節點進行定位,在構造時需傳入一個DOM元素id,地圖控件將會自動保持與DOM元素位置和大小完全一致。
### 參數:
- id: *( String ) 必選 *地圖控件所占位的DOM節點(通常為div)的id
### 返回值:
Map : Map地圖控件對象
### 示例:
~~~
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Map Example</title>
<script type="text/javascript">
var em=null,map=null;
// H5 plus事件處理
function plusReady(){
if(!em||map){return};
map = new plus.maps.Map("map");
map.centerAndZoom( new plus.maps.Point(116.3977,39.906016), 12 );
createMarker();
}
if(window.plus){
plusReady();
}else{
document.addEventListener("plusready",plusReady,false);
}
// DOMContentloaded事件處理
document.addEventListener("DOMContentLoaded",function(){
em=document.getElementById("map");
plusReady();
},false);
</script>
<style type="text/css">
#map {
width: 100%;
position: fixed;
top: 0px;
bottom: 0px;
line-height: 200px;
text-align: center;
background: #FFFFFF;
}
</style>
</head>
<body>
<div id="map">地圖加載中...</div>
</body>
</html>
~~~
# [centerAndZoom]()
設置地圖初始中心點和縮放級別
~~~
void mapObj.centerAndZoom( center, zoom );
~~~
### 說明:
用于設置地圖的初始中心點和縮放級別,通常在創建地圖后立即調用。 默認中心點為天安門,默認縮放級別為12; 該方法設置的中心點和縮放級別可通過reset()方法恢復; 如果在地圖顯示后調用將改變地圖的中心點和縮放級別并立即更新,并將初始值更新。
### 參數:
- center: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *地圖初始化的中心點坐標
- zoom: *( Number ) 必選 *地圖初始化的縮放級別
### 返回值:
void : 無
### 示例:
~~~
var mapObj = new plus.maps.Map( "mapid" );
var center = new plus.maps.Point( 116.123, 36.456 );
mapObj.centerAndZoom(? center, 12 );
~~~
# [setCenter]()
設置地圖的中心點
~~~
void mapObj.setCenter( center );
~~~
### 說明:
此方法用于設置地圖的中心點,用于切換當前顯示地圖位置。 該方法改變中心點后地圖顯示內容將立即更新; 該方法不會改變地圖顯示的縮放級別。
### 參數:
- center: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *要切換到的中心點坐標
### 返回值:
void : 無
### 示例:
~~~
var center = new plus.maps.Point( 118.123, 35.456 );
mapObj.setCenter( center );
~~~
# [getCenter]()
獲取地圖中心點
~~~
Point mapObj.getCenter();
~~~
### 說明:
結束指定的持續事件統計,需先調用eventStart方法開始持續事件統計,觸發的事件必須要先在統計網站上注冊事件ID。
### 參數:
無
### 返回值:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) : 地圖中心點坐標
# [setZoom]()
設置地圖的縮放級別
~~~
void mapObj.setZoom( zoom );
~~~
### 說明:
此方法用于設置地圖的縮放級別,用于切換當前顯示地圖縮放級別。 該方法改變縮放級別后地圖顯示內容將立即更新; 該方法不會改變地圖顯示區域,以當前地圖顯示的中心點位置來縮放地圖。
### 參數:
- zoom: *( Number ) 必選 *要設置的新的縮放級別,其有效范圍為1-22
### 返回值:
void : 無
### 示例:
~~~
mapObj.setZoom( 18 );
~~~
# [getZoom]()
獲取地圖的縮放級別
~~~
Number mapObj.getZoom();
~~~
### 說明:
此方法用于設置地圖的縮放級別,用于切換當前顯示地圖縮放級別。 該方法改變縮放級別后地圖顯示內容將立即更新; 該方法不會改變地圖顯示區域,以當前地圖顯示的中心點位置來縮放地圖。
### 參數:
無
### 返回值:
Number : 地圖視圖的縮放級別
# [reset]()
重新設置地圖
~~~
void mapObj.reset();
~~~
### 說明:
此方法用于重新設置地圖,恢復地圖的初始化時的中心點和縮放級別。 該方法將導致顯示內容將立即更新。
### 參數:
無
### 返回值:
Number : 地圖視圖的縮放級別
### 示例:
~~~
mapObj.reset();
~~~
# [setMapType]()
設置地圖類型
~~~
void mapObj.setMapType( type );
~~~
### 說明:
此方法用于設置地圖類型,默認為普通街道視圖。 方法用于設置地圖類型,默認為普通街道視圖。
### 參數:
- type: *( [MapType](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.MapType) ) 必選 *要設置的地圖的顯示模式,參考maps.MapType的常量說明
### 返回值:
void : 無
### 示例:
~~~
mapObj.setMapType( plus.maps.MapType.MAPTYPE_SATELLITE );
~~~
# [getMapType]()
獲取地圖的顯示類型
~~~
void mapObj.getMapType();
~~~
### 參數:
無
### 返回值:
[MapType](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.MapType) : 地圖視圖的顯示類型
# [setTraffic]()
設置是否打開地圖交通信息圖層
~~~
void mapObj.setTraffic( traffic );
~~~
### 說明:
此方法用于設置是否打開地圖交通信息圖層,默認不顯示。 該方法改變是否顯示交通圖層后地圖顯示內容將立即更新。
### 參數:
- traffic: *( Boolean ) 必選 *是否顯示交通信息圖層
### 返回值:
void : 無
### 示例:
~~~
mapObj.setTraffic( true );
~~~
# [isTraffic]()
獲取是否打開地圖交通信息圖層
~~~
Boolean mapObj.isTraffic();
~~~
### 參數:
無
### 返回值:
Boolean : 地圖中顯示交通信息圖層則返回true,否則返回false。
# [showUserLocation]()
顯示用戶位置
~~~
void mapObj.showUserLocation( display );
~~~
### 說明:
此方法將在地圖上顯示用戶位置信息。 顯示用戶位置將打開定位設備。
### 參數:
- display: *( Boolean ) 必選 *是否顯示用戶位置
### 返回值:
void : 無
### 示例:
~~~
mapObj.showUserLocation( true );
~~~
# [isShowUserLocation]()
獲取地圖是否顯示用戶位置
~~~
Boolean mapObj.isShowUserLocation();
~~~
### 參數:
無
### 返回值:
Boolean : 地圖中顯示用戶位置則返回true,否則返回false。
# [showZoomControls]()
設置是否顯示地圖內置縮放控件
~~~
void mapObj.showUserLocation( display );
~~~
### 說明:
此方法將在地圖上顯示用戶位置信息。 顯示用戶位置將打開定位設備。
### 參數:
- display: *( Boolean ) 必選 *是否顯示地圖內置縮放控件
### 返回值:
void : 無
### 示例:
~~~
// 顯示地圖內置縮放控件
mapObj.showUserLocation( true );
~~~
# [isShowZoomControls]()
獲取是否顯示地圖內置縮放控件
~~~
Boolean mapObj.isShowZoomControls();
~~~
### 參數:
無
### 返回值:
Boolean : 地圖中顯示內置縮放控件則返回true,否則返回false。
# [addOverlay]()
向地圖中添加覆蓋物
~~~
Boolean mapObj.addOverlay( overlay );
~~~
### 說明:
此方法用于向地圖中添加覆蓋物。 支持各種從maps.Overlay對象繼承的各種覆蓋物對象; 如果添加不支持的對象則直接返回false; 同一覆蓋物對象只能添加到地圖中一次,已在地圖中的覆蓋物再次添加時則返回false。
### 參數:
- overlay: *( [Overlay](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Overlay) ) 必選 *在地圖中要添加覆蓋物
### 返回值:
Boolean : 添加成功返回true,失敗返回false。
### 示例:
~~~
// 在地圖中插入標點
var pt = new plus.maps.Point(116,36);
var mk = new plus.maps.Marker(pt);
mk.setIcon( "marker.png" );
mk.setCaption( "這是一個標點" );
mapObj.addOverlay( mk );
~~~
# [removeOverlay]()
從地圖中刪除覆蓋物對象
~~~
void mapObj.removeOverlay( overlay );
~~~
### 說明:
此方法用于從地圖中刪除覆蓋物對象。 支持各種從maps.Overlay對象繼承的各種覆蓋物對象。
### 參數:
- overlay: *( [Overlay](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Overlay) ) 必選 *需要從地圖中刪除的覆蓋物對象
### 返回值:
void : 無
### 示例:
~~~
// 清除地圖中的標點
var pt = new plus.maps.Point(116,36);
var mk = new plus.maps.Marker(pt);
mk.setIcon( "marker.png" );
mk.setCaption( "這是一個標點" );
mapObj.addOverlay( mk );
....
// 刪除標點
mapObj.removeOverlay( mk );
~~~
# [clearOverlays]()
清除地圖中所有覆蓋物對象
~~~
void mapObj.clearOverlays();
~~~
### 說明:
此方法用于清除地圖中所有覆蓋物對象。 清除地圖中的覆蓋物對象后會自動更新地圖視圖。
### 參數:
無
### 返回值:
void : 無
### 示例:
~~~
// 清除地圖中所有覆蓋物
mapObj.clearOverlays();
~~~
# [getUserLocation]()
獲取用戶的當前位置信息
~~~
Boolean mapObj.getUserLocation( callback );
~~~
### 說明:
此方法用于獲取用戶的當前位置信息,獲取成功后通過callback回調返回。 獲取用戶當前位置信息將打開定位設備。
### 參數:
- callback: *( [UserLocationCallback](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.UserLocationCallback) ) 必選 *獲取用戶當前位置信息完成后執行的通知操作結果方法,回調函數中返回的point信息為當前用戶位置的坐標
### 返回值:
Boolean : 執行獲取操作成功則返回true,一定會執行通知結果方法;否則返回false。
### 示例:
~~~
// 通知結果方法
function locationCallback( state, point ) {
if ( 0 == state ) {
alert( "Current Position:" + point.getLng() + "," + point.getLat() );
} else {
alert( "無法獲取當前位置" );
}
}
// 獲取用戶位置信息
mapObj.getUserLocation( locationCallback );
~~~
# [getCurrentCenter]()
獲取當前地圖顯示的地圖中心點位置
~~~
Boolean mapObj.getCurrentCenter( callback );
~~~
### 說明:
此方法用于獲取當前地圖顯示的地圖中心點位置,獲取成功后通過callback回調返回。
### 參數:
- callback: *( [UserLocationCallback](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.UserLocationCallback) ) 必選 *獲取當前地圖顯示的地圖中心點位置完成后執行的通知操作結果方法,在回調函數中返回的point信息為當前地圖中心點坐標
### 返回值:
Boolean : 執行獲取操作成功則返回true,一定會執行通知結果方法;否則返回false。
### 示例:
~~~
// 通知結果方法
function centerCallback( state, point ) {
if ( 0 == state ) {
alert( "Center Position:" + point.getLng() + "," + point.getLat() );
} else {
alert( "無法獲取當前顯示中心點位置" );
}
}
// 獲取當前顯示中心點位置信息
mapObj.getUserLocation( centerCallback );
~~~
# [show]()
顯示地圖控件
~~~
void mapObj.show();
~~~
### 說明:
此方法用于顯示地圖控件,通常在隱藏后調用此方法來顯示。 如果地圖已經顯示再調用此方法將無效果。
### 參數:
無
### 返回值:
void : 無
# [hide]()
隱藏地圖控件
~~~
void mapObj.show();
~~~
### 說明:
此方法用于隱藏地圖控件,通常在顯示后調用此方法來隱藏。 如果地圖已經隱藏再調用此方法將無效果。
### 參數:
無
### 返回值:
void : 無
# [onclick]()
用戶點擊地圖事件
~~~
mapObj.onclick = function?( point ) {
// JS code.
}
~~~
### 說明:
[ClickEventHandler](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.ClickEventHandler) 類型
### 示例:
~~~
// 用戶點擊地圖將彈出點擊位置的坐標
mapObj.onclick = function ( point ) {
alert( "Longitude:" + point.lng + "; Latitude:" + point.lat );
}
~~~
# [Point]()
Point對象用于表示地圖元素的坐標
### 說明:
常用語對地圖上元素進行定位時使用。
### 構造:
- [Point(lng,lat)](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point.Point(lng,lat)): 創建Point對象
### 方法:
- [setLng](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point.setLng): 設置坐標點的經度
- [getLng](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point.getLng): 獲取坐標的經度
- [setLat](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point.setLat): 設置坐標的緯度
- [getLat](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point.getLat): 獲取坐標的緯度
- [equals](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point.equals): 判斷兩個坐標點是否相等
# [Point(lng,lat)]()
創建Point對象
~~~
var ptObj = new plus.maps.Point( lng, lat );
~~~
### 參數:
- lng: *( Number ) 必選 *坐標的經度
- lat: *( Number ) 必選 *坐標的緯度
### 返回值:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) : 創建的坐標對象
### 示例:
~~~
// 創建地圖坐標對象
var pt1 = new plus.maps.Point( 116.123, 36.456 );
~~~
# [setLng]()
設置坐標點的經度
~~~
void ptObj.setLng( lng );
~~~
### 參數:
- lng: *( Number ) 必選 *要設置坐標的經度
### 返回值:
void : 無
# [getLng]()
獲取坐標的經度
~~~
Number ptObj.getLng();
~~~
### 參數:
無
### 返回值:
Number : 坐標的經度
# [setLat]()
設置坐標的緯度
~~~
void ptObj.setLat( lat );
~~~
### 參數:
無
### 返回值:
void : 無
# [getLat]()
獲取坐標的緯度
~~~
Number ptObj.getLat();
~~~
### 參數:
無
### 返回值:
Number : 坐標的緯度
# [equals]()
判斷兩個坐標點是否相等
~~~
Boolean ptObj.equals( Point pt );
~~~
### 參數:
- pt: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *要比較的坐標對象
### 返回值:
Boolean : 坐標對象是否相等,相等則返回true,否則返回false。
### 示例:
~~~
var pt1 = new plus.maps.Point( 116.123, 36.456 );
var pt2 = new plus.maps.Point( 117.234, 37.567 );
var pt3 = new plus.maps.Point( 117.789, 36.456 );
alert( pt1.equals(pt2) ); // 提示false
alert( pt1.equals(pt3) ); // 提示false
~~~
# [MapType]()
地圖視圖類型
### 常量:
- MAPTYPE_NORMAL: *(Number 類型 )*普通街道視圖類型
地圖視圖類型常量,普通街道視圖。
- MAPTYPE_SATELLITE: *(Number 類型 )*衛星視圖
地圖視圖類型常量,衛星視圖。
# [Overlay]()
地圖覆蓋物基類對象
~~~
interface Overlay {
function Boolean isVisible();
function void show();
function void hide();
}
~~~
### 說明:
Overlay是地圖上顯示元素的基類,用于抽象地圖元素,不用于實例化。
### 方法:
- [isVisible](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Overlay.isVisible): 判斷地圖覆蓋物是否可見
- [show](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Overlay.show): 顯示地圖上的覆蓋物
- [hide](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Overlay.hide): 隱藏地圖上的覆蓋物
# [isVisible]()
判斷地圖覆蓋物是否可見
~~~
Boolean overlayObj.isVisible();
~~~
### 說明:
地圖覆蓋物對象默認為可見;地圖覆蓋物對象是否可見由其自身狀態決定,不管其是否被添加到地圖層中。
### 參數:
無
### 返回值:
Boolean : 覆蓋物在地圖上可見則返回true,否則返回false。
# [show]()
顯示地圖上的覆蓋物
~~~
void overlayObj.show();
~~~
### 說明:
常用于地圖覆蓋物在隱藏后調用此方法來顯示。 只有添加到地圖上的覆蓋物才能看到效果; 如果覆蓋物對象已經在地圖上顯示再調用此方法將無效果。
### 參數:
無
### 返回值:
void : 無
# [hide]()
隱藏地圖上的覆蓋物
~~~
void overlayObj.show();
~~~
### 說明:
常用于地圖覆蓋物在顯示后調用此方法來隱藏。 只有添加到地圖上的覆蓋物才能看到效果; 如果覆蓋物對象已經在地圖上隱藏再調用此方法將無效果。
### 參數:
無
### 返回值:
void : 無
# [Marker]()
地圖上顯示的標點對象
### 說明:
從Overlay對象繼承而來,可通過Map對象的addOverlay()方法將對象添加地圖中。
### 構造:
- [Marker( point )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.Marker(%20point%20)): 創建地圖標點Marker對象
### 方法:
- [setPoint](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.setPoint): 設置標點對象的坐標
- [getPoint](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.getPoint): 獲取標點的坐標
- [setIcon](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.setIcon): 設置標點上顯示的圖標
- [setLabel](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.setLabel): 設置標點上顯示的文本標注
- [getLabel](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.getLabel): 獲取標點上顯示的文本標注
- [setBubble](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.setBubble): 設置標點的氣泡內容
- [getBubble](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.getBubble): 獲取標點上顯示的文本標注
### 事件:
- [onclick](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker.onclick): 用戶點擊地圖標點事件
# [Marker( point )]()
創建地圖標點Marker對象
~~~
var markObj = new plus.maps.Marker( point );
~~~
### 參數:
- point: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *地圖標點的坐標信息
### 返回值:
[Marker](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker) : 創建好的地圖標點對象
### 示例:
~~~
var marker=new plus.maps.Marker(new plus.maps.Point(116.347496,39.970191));
marker.setIcon("/logo.png");
marker.setLabel("HBuilder");
var bubble = new plus.maps.Bubble("打造最好的HTML5移動開發工具");
marker.setBubble(bubble);
map.addOverlay(marker);
~~~
# [setPoint]()
設置標點對象的坐標
~~~
void markObj.setPoint( point );
~~~
### 說明:
標點在設置新坐標后將在地圖上立即更新標點位置。
### 參數:
- point: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *要設置標點的坐標
### 返回值:
void : 無
# [getPoint]()
獲取標點的坐標
~~~
Point markObj.getPoint();
~~~
### 參數:
無
### 返回值:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) : 標點的坐標對象
# [setIcon]()
設置標點上顯示的圖標
~~~
void markObj.setIcon( icon );
~~~
### 說明:
若未設置則顯示默認標點圖標,已添加的標點在設置新值后將在地圖上立即更新標點內容。
### 參數:
- icon: *( DOMString ) 必選 *要設置標點圖標的URL地址
僅支持本地圖標URL地址,支持png、jpg/jpeg、bmp格式。
### 返回值:
void : 無
# [setLabel]()
設置標點上顯示的文本標注
~~~
void markObj.setLabel( label );
~~~
### 說明:
若未設置則不顯示標注(默認為空字符串),已添加的標點在設置新值后將在地圖上立即更新標點內容。
### 參數:
- label: *( DOMString ) 必選 *要設置標點的標注文字
### 返回值:
void : 無
# [getLabel]()
獲取標點上顯示的文本標注
~~~
DOMString markObj.getLabel();
~~~
### 參數:
無
### 返回值:
DOMString : 標點的標注文本內容
# [setBubble]()
設置標點的氣泡內容
~~~
void markObj.setBubble( buuble );
~~~
### 說明:
設置氣泡內容后,用戶點擊標點時彈出則彈出氣泡。 注意:用戶點擊標點時先彈出標點關聯的氣泡,再響應標點的onclick事件。
### 參數:
- buuble: *( [Bubble](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble) ) 必選 *要設置標點關聯的氣泡對象
### 返回值:
void : 無
# [getBubble]()
獲取標點上顯示的文本標注
~~~
Bubble markObj.getBubble();
~~~
### 說明:
如果沒有設置關聯的氣泡對象則返回null。
### 參數:
無
### 返回值:
[Bubble](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble) : 標點關聯的氣泡對象
# [onclick]()
用戶點擊地圖標點事件
~~~
markObj.onclick = function ( marker ) {
// Click code.
}
~~~
### 說明:
[OverlayClickEventHandler](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.OverlayClickEventHandler) 類型
### 示例:
~~~
// 用戶點擊標點將彈出標點上的文本
markObj.onclick = function ( marker ) {
alert( "Clicked:" + markObj.getLabel() );
}
~~~
# [Bubble]()
地圖上顯示的氣泡對象
### 說明:
此對象不能直接添加到地圖上顯示,只可關聯到地圖標點覆蓋物上,用戶點擊標點時彈出顯示。
### 構造:
- [Bubble( label )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble.Bubble(%20label%20)): 創建氣泡對象
### 方法:
- [setIcon](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble.setIcon): 設置氣泡上顯示的圖標
- [setLabel](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble.setLabel): 設置氣泡上顯示的文字內容
- [getLabel](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble.getLabel): 獲取氣泡上顯示的文字內容
- [belongMarker](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble.belongMarker): 獲取氣泡所屬的標點對象
### 事件:
- [onclick](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble.onclick): 用戶點擊氣泡事件
# [Bubble( label )]()
創建氣泡對象
~~~
var bubObj = new plus.maps.Bubble( label );
~~~
### 參數:
- label: *( DOMString ) 必選 *氣泡上顯示的文字
### 返回值:
[Bubble](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Bubble) : 氣泡對象
### 示例:
~~~
var marker=new plus.maps.Marker(new plus.maps.Point(116.347496,39.970191));
marker.setIcon("/logo.png");
marker.setLabel("HBuilder");
var bubble = new plus.maps.Bubble("打造最好的HTML5移動開發工具");
marker.setBubble(bubble);
map.addOverlay(marker);
~~~
# [setIcon]()
設置氣泡上顯示的圖標
~~~
void bubObj.setIcon( icon );
~~~
### 說明:
若為設置則無默認圖標,已添加的顯示的氣泡在設置新值后將在地圖上立即更新內容。
### 參數:
- icon: *( DOMString ) 必選 *設置氣泡圖標的URL地址
僅支持本地資源,支持png、jpg/jpeg、bmp格式圖片資源。
### 返回值:
void : 無
# [setLabel]()
設置氣泡上顯示的文字內容
~~~
void bubObj.setLabel( label );
~~~
### 說明:
若未設置則不顯示文字(默認為空字符串),已添加的顯示的氣泡在設置新值后將在地圖上立即更新內容。
### 參數:
- label: *( DOMString ) 必選 *要設置氣泡上顯示的文字
### 返回值:
void : 無
# [getLabel]()
獲取氣泡上顯示的文字內容
~~~
DOMString bubObj.getLabel();
~~~
### 參數:
無
### 返回值:
DOMString : 氣泡上顯示的文字內容
# [belongMarker]()
獲取氣泡所屬的標點對象
~~~
Marker bubObj.belongMarker();
~~~
### 參數:
無
### 返回值:
[Marker](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Marker) : 氣泡所屬的標點對象。
# [onclick]()
用戶點擊氣泡事件
~~~
bubObj.onclick = function ( bubble ) {
// JS code.
}
~~~
### 說明:
[OverlayClickEventHandler](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.OverlayClickEventHandler) 類型
### 示例:
~~~
// 用戶點擊氣泡將彈出氣泡上的標題信息
bubObj.onclick = function ( bubble ) {
alert( "Clicked:" + bubble.getLabel() );
}
~~~
# [Circle]()
地圖上顯示的圓圈對象
### 說明:
從Overlay對象繼承而來,可通過Map對象的addOverlay()方法將對象添加地圖中。
### 構造:
- [Circle( center, radius )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.Circle(%20center,%20radius%20)): 創建Circle對象
### 方法:
- [setCenter](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.setCenter): 設置圓圈中心點的經緯度坐標
- [getCenter](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.getCenter): 獲取圓圈中心點的坐標
- [setRadius](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.setRadius): 設置圓圈的半徑,單位為米
- [getRadius](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.getRadius): 獲取圓圈的半徑
- [setStrokeColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.setStrokeColor): 設置圓圈的邊框顏色
- [getStrokeColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.getStrokeColor): 獲取圓圈的邊框顏色
- [setStrokeOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.setStrokeOpacity): 設置圓圈的邊框顏色
- [getStrokeOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.getStrokeOpacity): 獲取圓圈邊框的透明度
- [setFillColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.setFillColor): 設置圓圈的填充顏色
- [getFillColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.getFillColor): 獲取圓圈的填充顏色
- [setFillOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.setFillOpacity): 設置圓圈填充顏色的透明度
- [getFillOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.getFillOpacity): 獲取圓圈填充色的透明度
- [setLineWidth](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.setLineWidth): 設置圓圈邊框的線條寬度
- [getLineWidth](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle.getLineWidth): 獲取圓圈邊框的線條寬度
# [Circle( center, radius )]()
創建Circle對象
~~~
var circleObj = new plus.maps.Circle( center, radius );
~~~
### 參數:
- center: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *圓圈中心點的經緯度坐標
- radius: *( Number ) 必選 *圓圈的半徑,單位為米
### 返回值:
[Circle](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Circle) : 地圖上圓圈對象
### 示例:
~~~
var circleObj=new plus.maps.Circle(new plus.maps.Point(116.347496,39.970191),500);
map.addOverlay(circleObj);
~~~
# [setCenter]()
設置圓圈中心點的經緯度坐標
~~~
void circleObj.setCenter( point );
~~~
### 說明:
該方法設置將導致地圖中的圓圈立即更新。
### 參數:
- point: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *圓圈的中心點坐標
### 返回值:
void : 無
### 示例:
~~~
// 設置新的圓圈中心點
circleObj.setCenter( new plus.maps.Point(116.0,39.0) );
~~~
# [getCenter]()
獲取圓圈中心點的坐標
~~~
Point circleObj.getCenter();
~~~
### 參數:
無
### 返回值:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) : 圓圈中心點的坐標對象
# [setRadius]()
設置圓圈的半徑,單位為米
~~~
void circleObj.setRadius( radius );
~~~
### 說明:
該方法設置將導致地圖中的圓圈立即更新。
### 參數:
- radius: *( Number ) 必選 *圓圈的半徑,單位為米
### 返回值:
void : 無
### 示例:
~~~
// 設置新的圓圈半徑
circleObj.setRadius( 1000 );
~~~
# [getRadius]()
獲取圓圈的半徑
~~~
Number circleObj.getRadius();
~~~
### 參數:
無
### 返回值:
Number : 圓圈的半徑,單位為米。
# [setStrokeColor]()
設置圓圈的邊框顏色
~~~
void circleObj.setStrokeColor( color );
~~~
### 說明:
圓圈默認的圓圈邊框顏色為黑色"#000000",該方法設置將導致地圖中的圓圈立即更新。
### 參數:
- color: *( DOMString ) 必選 *圓圈邊框的線條顏色值
格式為"#RRGGBB",如紅色為"#ff0000"。
### 返回值:
void : 無
### 示例:
~~~
// 設置圓圈的邊框顏色為紅色
circleObj.setStorkeColor( "#ff0000" );
~~~
# [getStrokeColor]()
獲取圓圈的邊框顏色
~~~
DOMString circleObj.getStrokeColor();
~~~
### 參數:
無
### 返回值:
DOMString : 圓圈邊框的線條顏色,格式為"#RRGGBB",如黑色為"#000000"。
# [setStrokeOpacity]()
設置圓圈的邊框顏色
~~~
void circleObj.setStrokeOpacity( opacity );
~~~
### 說明:
圓圈默認值為不透明。 如果設置的值不合法則保持原有的透明度;該方法設置將導致地圖中的圓圈立即更新。
### 參數:
- opacity: *( Number ) 必選 *圓圈邊框的透明度
取值范圍為0-1,0表示全透明,1表示不透明。
### 返回值:
void : 無
### 示例:
~~~
// 設置圓圈邊框為半透明
circleObj.setStrokeOpacity( 0.5 );
~~~
# [getStrokeOpacity]()
獲取圓圈邊框的透明度
~~~
Number circleObj.getStrokeOpacity();
~~~
### 參數:
無
### 返回值:
Number : 圓圈的透明度,取值范圍為0-1,0表示全透明,1表示不透明。
# [setFillColor]()
設置圓圈的填充顏色
~~~
void circleObj.setStrokeColor( color );
~~~
### 說明:
圓圈默認的圓圈填充顏色為無色,該方法設置將導致地圖中的圓圈立即更新。
### 參數:
- color: *( DOMString ) 必選 *圓圈填充的顏色值
格式為"#RRGGBB",如紅色為"#ff0000"。
### 返回值:
void : 無
### 示例:
~~~
// 設置圓圈的邊框顏色為紅色
circleObj.setStorkeColor( "#ff0000" );
~~~
# [getFillColor]()
獲取圓圈的填充顏色
~~~
DOMString circleObj.getFillColor();
~~~
### 說明:
如果填充顏色為無色,則返回空字符串。
### 參數:
無
### 返回值:
DOMString : 圓圈的填充顏色,格式為"#RRGGBB",如黑色為"#000000"。
# [setFillOpacity]()
設置圓圈填充顏色的透明度
~~~
void circleObj.setFillOpacity( opacity );
~~~
### 說明:
圓圈默認值為不透明。 如果設置的值不合法則保持原有的透明度;該方法設置將導致地圖中的圓圈立即更新。
### 參數:
- opacity: *( Number ) 必選 *圓圈填充顏色的透明度
取值范圍為0-1,0表示全透明,1表示不透明。
### 返回值:
void : 無
### 示例:
~~~
// 設置圓圈填充顏色為半透明
circleObj.setFillOpacity( 0.5 );
~~~
# [getFillOpacity]()
獲取圓圈填充色的透明度
~~~
Number circleObj.getFillOpacity();
~~~
### 參數:
無
### 返回值:
Number : 圓圈填充色的透明度,取值范圍為0-1,0表示全透明,1表示不透明。
# [setLineWidth]()
設置圓圈邊框的線條寬度
~~~
void circleObj.setLineWidth( width );
~~~
### 說明:
圓圈邊框的默認值為5。 如果設置的值不合法則保持原有的寬度;該方法設置將導致地圖中的圓圈立即更新。
### 參數:
- width: *( Number ) 必選 *圓圈邊框的線條寬度
取值范圍為正整數。
### 返回值:
void : 無
### 示例:
~~~
// 設置圓圈邊框線條為寬度為10
circleObj.setLineWidth( 10 );
~~~
# [getLineWidth]()
獲取圓圈邊框的線條寬度
~~~
Number circleObj.getLineWidth();
~~~
### 參數:
無
### 返回值:
Number : 圓圈邊框的線條寬度,正整數。
# [Polyline]()
地圖上顯示的折線對象
### 說明:
從Overlay對象繼承而來,可通過Map對象的addOverlay()方法將對象添加地圖中。
### 構造:
- [Polyline( points )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.Polyline(%20points%20)): 創建Polyline對象
### 方法:
- [setPath](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.setPath): 設置折線的頂點坐標
- [getPath](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.getPath): 獲取折線的頂點坐標
- [setStrokeColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.setStrokeColor): 設置折線的顏色
- [getStrokeColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.getStrokeColor): 獲取折線的顏色
- [setStrokeOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.setStrokeOpacity): 設設置折線的透明度
- [getStrokeOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.getStrokeOpacity): 獲取折線的透明度
- [setLineWidth](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.setLineWidth): 設置折線的線條寬度
- [getLineWidth](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline.getLineWidth): 獲取折線的線條寬度
# [Polyline( points )]()
創建Polyline對象
~~~
var polylineObj = new plus.maps.Polyline( points );
~~~
### 參數:
- points: *( Array ) 必選 *折線的頂點坐標,Point數組
### 返回值:
[Polyline](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polyline) : 地圖上折線對象
### 示例:
~~~
// 創建一個折線對象
var points = new Array( new plus.maps.Point(116.0,39.0), new plus.maps.Point(115.0,38.0), new plus.maps.Point(117.0,38.0) );
var polylineObj = new plus.maps.Polyline( points );
~~~
# [setPath]()
設置折線的頂點坐標
~~~
void polylineObj.setPath( points );
~~~
### 說明:
該方法設置將導致地圖中的折線立即更新。
### 參數:
- points: *( Array ) 必選 *折線的頂點坐標Point數組
### 返回值:
void : 無
### 示例:
~~~
// 設置新的折線頂點
var points = new Array( new plus.maps.Point(116.0,39.0), new plus.maps.Point(115.0,38.0), new plus.maps.Point(117.0,38.0) );
polylineObj.setPath( points );
~~~
# [getPath]()
獲取折線的頂點坐標
~~~
Array<Point> polylineObj.getPath();
~~~
### 參數:
無
### 返回值:
Array : 折線的頂點坐標數組。
# [setStrokeColor]()
設置折線的顏色
~~~
void circleObj.setStrokeColor( color );
~~~
### 說明:
折線默認的顏色為黑色"#000000",該方法設置將導致地圖中的折線立即更新。
### 參數:
- color: *( DOMString ) 必選 *折線的顏色值
格式為"#RRGGBB",如紅色為"#ff0000"。
### 返回值:
void : 無
### 示例:
~~~
// 設置折線為紅色
polylineObj.setStorkeColor( "#ff0000" );
~~~
# [getStrokeColor]()
獲取折線的顏色
~~~
DOMString polylineObj.getStrokeColor();
~~~
### 參數:
無
### 返回值:
DOMString : 折線的顏色,格式為"#RRGGBB",如黑色為"#000000"。
# [setStrokeOpacity]()
設設置折線的透明度
~~~
void polylineObj.setStrokeOpacity( opacity );
~~~
### 說明:
折線默認值為不透明。 如果設置的值不合法則保持原有的透明度;該方法設置將導致地圖中的折線立即更新。
### 參數:
- opacity: *( Number ) 必選 *折線的透明度
取值范圍為0-1,0表示全透明,1表示不透明。
### 返回值:
void : 無
### 示例:
~~~
// 設置折線為半透明
polylineObj.setStrokeOpacity( 0.5 );
~~~
# [getStrokeOpacity]()
獲取折線的透明度
~~~
Number polylineObj.getStrokeOpacity();
~~~
### 參數:
無
### 返回值:
Number : 折線的透明度,取值范圍為0-1,0表示全透明,1表示不透明。
# [setLineWidth]()
設置折線的線條寬度
~~~
void polylineObj.setLineWidth( width );
~~~
### 說明:
折線線條的寬度默認值為5。 如果設置的值不合法則保持原有的寬度;該方法設置將導致地圖中的折線立即更新。
### 參數:
- width: *( Number ) 必選 *折線的線條寬度
取值范圍為正整數。
### 返回值:
void : 無
### 示例:
~~~
// 設置折線為寬度為10
polylineObj.setLineWidth( 10 );
~~~
# [getLineWidth]()
獲取折線的線條寬度
~~~
Number polylineObj.getLineWidth();
~~~
### 參數:
無
### 返回值:
Number : 折線的線條寬度,正整數。
# [Polygon]()
地圖上顯示的多邊形對象
### 說明:
從Overlay對象繼承而來,可通過Map對象的addOverlay()方法將對象添加地圖中。
### 構造:
- [Polygon( points )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.Polygon(%20points%20)): 創建Polygon對象
### 方法:
- [setPath](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.setPath): 設置多邊形的頂點坐標
- [getPath](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.getPath): 獲取多邊形的頂點坐標
- [setStrokeColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.setStrokeColor): 設置多邊形的顏色
- [getStrokeColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.getStrokeColor): 獲取多邊形邊框的顏色
- [setStrokeOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.setStrokeOpacity): 設置多邊形的透明度
- [getStrokeOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.getStrokeOpacity): 獲取多邊形邊框的透明度
- [setFillColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.setFillColor): 設置多邊形的填充顏色
- [getFillColor](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.getFillColor): 獲取多邊形的填充色
- [setFillOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.setFillOpacity): 設置多邊形填充色的透明度
- [getFillOpacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.getFillOpacity): 獲取多邊形填充色的透明度
- [setLineWidth](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.setLineWidth): 設置多邊形的邊框寬度
- [getLineWidth](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon.getLineWidth): 獲取多邊形邊框的寬度
# [Polygon( points )]()
創建Polygon對象
~~~
var polygonObj = new plus.maps.Polygon( points );
~~~
### 參數:
- points: *( Array ) 必選 *多邊形的頂點坐標,Point數組
### 返回值:
[Polygon](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Polygon) : 地圖上多邊形對象
### 示例:
~~~
// 創建一個多邊形對象
var points = new Array( new plus.maps.Point(116.0,39.0), new plus.maps.Point(115.0,38.0), new plus.maps.Point(117.0,38.0) );
var polygonObj = new plus.maps.Polygon( points );
~~~
# [setPath]()
設置多邊形的頂點坐標
~~~
void polygonObj.setPath( points );
~~~
### 說明:
該方法設置將導致地圖中的多邊形立即更新。
### 參數:
- points: *( Array ) 必選 *多邊形的頂點坐標Point數組
### 返回值:
void : 無
### 示例:
~~~
// 設置新的多邊形頂點
var points = new Array( new plus.maps.Point(116.0,39.0), new plus.maps.Point(115.0,38.0), new plus.maps.Point(117.0,38.0) );
polygonObj.setPath( points );
~~~
# [getPath]()
獲取多邊形的頂點坐標
~~~
Array<Point> polygonObj.getPath();
~~~
### 參數:
無
### 返回值:
Array : 多邊形的頂點坐標數組。
# [setStrokeColor]()
設置多邊形的顏色
~~~
void polygonObj.setStrokeColor( color );
~~~
### 說明:
多邊形邊框默認的顏色為黑色"#000000",該方法設置將導致地圖中的多邊形立即更新。
### 參數:
- color: *( DOMString ) 必選 *多邊形邊框的顏色值
格式為"#RRGGBB",如紅色為"#ff0000"。
### 返回值:
void : 無
### 示例:
~~~
// 設置多邊形邊框為紅色
polygonObj.setStorkeColor( "#ff0000" );
~~~
# [getStrokeColor]()
獲取多邊形邊框的顏色
~~~
DOMString polygonObj.getStrokeColor();
~~~
### 參數:
無
### 返回值:
DOMString : 多邊形邊框的顏色,格式為"#RRGGBB",如黑色為"#000000"。
# [setStrokeOpacity]()
設置多邊形的透明度
~~~
void polygonObj.setStrokeOpacity( opacity );
~~~
### 說明:
多邊形邊框默認值為不透明。 如果設置的值不合法則保持原有的透明度;該方法設置將導致地圖中的多邊形立即更新。
### 參數:
- opacity: *( Number ) 必選 *多邊形邊框的透明度
取值范圍為0-1,0表示全透明,1表示不透明。
### 返回值:
void : 無
### 示例:
~~~
// 設置多邊形邊框為半透明
polygonObj.setStrokeOpacity( 0.5 );
~~~
# [getStrokeOpacity]()
獲取多邊形邊框的透明度
~~~
Number polygonObj.getStrokeOpacity();
~~~
### 參數:
無
### 返回值:
Number : 多邊形邊框的透明度,取值范圍為0-1,0表示全透明,1表示不透明。
# [setFillColor]()
設置多邊形的填充顏色
~~~
void polygonObj.setStrokeColor( color );
~~~
### 說明:
多邊形默認填充顏色為無色,該方法設置將導致地圖中的多邊形立即更新。
### 參數:
- color: *( DOMString ) 必選 *多邊形填充的顏色值
格式為"#RRGGBB",如紅色為"#ff0000"。
### 返回值:
void : 無
### 示例:
~~~
// 設置多邊形的填充顏色為紅色
polygonObj.setStorkeColor( "#ff0000" );
~~~
# [getFillColor]()
獲取多邊形的填充色
~~~
DOMString polygonObj.getFillColor();
~~~
### 說明:
如果填充色為無色,則返回空字符串。
### 參數:
無
### 返回值:
DOMString : 多邊形的填充色,格式為"#RRGGBB",如黑色為"#000000"。
# [setFillOpacity]()
設置多邊形填充色的透明度
~~~
void polygonObj.setFillOpacity( opacity );
~~~
### 說明:
多邊形填充色默認值為不透明。 如果設置的值不合法則保持原有的透明度;該方法設置將導致地圖中的多邊形立即更新。
### 參數:
- opacity: *( Number ) 必選 *多邊形填充色的透明度
取值范圍為0-1,0表示全透明,1表示不透明。
### 返回值:
void : 無
### 示例:
~~~
// 設置多邊形填充色為半透明
polygonObj.setFillOpacity( 0.5 );
~~~
# [getFillOpacity]()
獲取多邊形填充色的透明度
~~~
Number polygonObj.getFillOpacity();
~~~
### 參數:
無
### 返回值:
Number : 多邊形填充色的透明度,取值范圍為0-1,0表示全透明,1表示不透明。
# [setLineWidth]()
設置多邊形的邊框寬度
~~~
void polygonObj.setLineWidth( width );
~~~
### 說明:
多邊形邊框的寬度默認值為5。 如果設置的值不合法則保持原有的寬度;該方法設置將導致地圖中的多邊形立即更新。
### 參數:
- width: *( Number ) 必選 *多邊形的邊框寬度
取值范圍為正整數。
### 返回值:
void : 無
### 示例:
~~~
// 設置多邊形為寬度為10
polygonObj.setLineWidth( 10 );
~~~
# [getLineWidth]()
獲取多邊形邊框的寬度
~~~
Number polygonObj.getLineWidth();
~~~
### 參數:
無
### 返回值:
Number : 多邊形的邊框寬度,正整數。
# [Search]()
地圖檢索對象
### 說明:
Search對象用于管理地圖上的檢索功能,包括位置檢索、周邊檢索和范圍檢索。
### 構造:
- [Search( map )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.Search(%20map%20)): 創建Search對象
### 方法:
- [setPageCapacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.setPageCapacity): 設置檢索返回結果每頁的信息數目
- [getPageCapacity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.getPageCapacity): 獲取檢索返回結果每頁的信息數目
- [poiSearchInCity](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.poiSearchInCity): 城市興趣點檢索
- [poiSearchNearBy](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.poiSearchNearBy): 周邊檢索
- [poiSearchInbounds](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.poiSearchInbounds): 指定范圍檢索
- [setTransitPolicy](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.setTransitPolicy): 設置公交路線檢索策略
- [transitSearch](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.transitSearch): 公交路線檢索
- [setDrivingPolicy](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.setDrivingPolicy): 設置駕車路線檢索策略
- [drivingSearch](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.drivingSearch): 駕車路線檢索
- [walkingSearch](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.walkingSearch): 步行路線檢索
### 事件:
- [onPoiSearchComplete](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.onPoiSearchComplete): 興趣點檢索完成事件
- [onRouteSearchComplete](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search.onRouteSearchComplete): 線路檢索完成事件
# [Search( map )]()
創建Search對象
~~~
var searchObj = new plus.maps.Search( map );
~~~
### 參數:
- map: *( [Map](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Map) ) 必選 *檢索關聯的地圖對象
### 返回值:
[Search](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Search) : 地圖檢索對象
### 示例:
~~~
// 將檢索到的第一條信息作為標點添加到地圖中
var searchObj = new plus.maps.Search( map );
searchObj.onPoiSearchComplete = function( state, result ){
console.log("onPoiSearchComplete: "+state+" , "+result.currentNumber);
if ( state == 0 ) {
if ( result.currentNumber <= 0 ) {
alert( "沒有檢索到結果" );
}
for(var i=0; i<result.currentNumber; i++){
var pos = result.getPosition( i );
var marker = new plus.maps.Marker( pos.point );
marker.setLabel( pos.name );
map.addOverlay( marker );
}
} else {
alert( "檢索失敗" );
}
}
var pt = new plus.maps.Point( 116.404, 39.915 ); // 天安門坐標
searchObj.poiSearchNearBy( "肯德基", pt, 1000 );
~~~
# [setPageCapacity]()
設置檢索返回結果每頁的信息數目
~~~
void searchObj.setPageCapacity( capacity );
~~~
### 說明:
地圖檢索結果是按頁返回的,默認檢索每頁返回10條信息。
### 參數:
- capacity: *( Number ) 必選 *要指定檢索返回結果每頁的信息數目
### 返回值:
void : 無
# [getPageCapacity]()
獲取檢索返回結果每頁的信息數目
~~~
Number searchObj.getPageCapacity();
~~~
### 參數:
無
### 返回值:
Number : 檢索返回結果每頁的信息數目
# [poiSearchInCity]()
城市興趣點檢索
~~~
Boolean searchObj.poiSearchInCity( city, key, index );
~~~
### 說明:
檢索結果將通過onPoiSearchComplete事件返回。 如果調用此方法時已經處于POI檢索操作中,則終止上次檢索操作,重新開始新的檢索。
### 參數:
- city: *( DOMString ) 必選 *檢索的城市名稱
如果設置為空字符串則在地圖定位出當前所在城市內進行檢索。
- key: *( DOMString ) 必選 *檢索的關鍵字
- index: *( Number ) 可選 *要獲取檢索結果的頁號索引
頁號索引值從0開始,即0表示第一頁,默認值為0。
### 返回值:
Boolean : 檢索成功返回true,否則返回false。
### 示例:
~~~
// 在北京對關鍵字“肯德基”進行檢索
var searchObj = new plus.maps.Search( map );
searchObj. poiSearchInCity( "北京", "肯德基" );
~~~
# [poiSearchNearBy]()
周邊檢索
~~~
Boolean searchObj.poiSearchNearBy( key, pt, radius, index );
~~~
### 說明:
周邊檢索根據中心點、半徑與檢索詞進行檢索,檢索完成后觸發onPoiSearchComplete()事件。 若調用此方法時對象處于POI檢索操作中,則終止上次檢索操作,重新開始新的檢索。
### 參數:
- key: *( DOMString ) 必選 *檢索的關鍵字
- pt: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *檢索的中心點坐標
- radius: *( Number ) 必選 *檢索的半徑,單位為米
- index: *( Number ) 必選 *要獲取檢索結果的頁號索引
頁號索引值從0開始,即0表示第一頁,默認值為0。
### 返回值:
Boolean : 檢索成功返回true,否則返回false。
### 示例:
~~~
// 在天安門周圍1千米內對關鍵字“肯德基”進行檢索
var searchObj = new plus.maps.Search( map );
var pt = new plus.maps.Point( 116.404, 39.915 ); // 天安門坐標
searchObj. poiSearchNearBy( "肯德基", pt, 1000 );
~~~
# [poiSearchInbounds]()
指定范圍檢索
~~~
Boolean searchObj.poiSearchInbounds( key, ptLB, ptRT, index );
~~~
### 說明:
根據范圍和檢索詞進行檢索,檢索完成后觸發onPoiSearchComplete()事件。 若調用此方法時對象處于POI檢索操作中,則終止上次檢索操作,重新開始新的檢索。
### 參數:
無
### 返回值:
Boolean : 檢索成功返回true,否則返回false。
# [setTransitPolicy]()
設置公交路線檢索策略
~~~
Boolean searchObj.poiSearchInbounds( key, ptLB, ptRT, index );
~~~
### 說明:
默認采用maps.SearchPolicy.TRANSIT_TIME_FIRST策略。 需在調用transitSearch()方法前設置的策略才生效; 如果設置非法值則認為設置失敗,采用上次設置的檢索策略并返回false。
### 參數:
- policy: *( [SearchPolicy](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPolicy) ) 必選 *公交線路檢索策略
可取值為maps.SearchPolicy.TRANSIT_TIME_FIRST、maps.SearchPolicy.TRANSIT_TRANSFER_FIRST、maps.SearchPolicy.TRANSIT_WALK_FIRST、maps.SearchPolicy.TRANSIT_NO_SUBWAY。
### 返回值:
Boolean : 設置成功返回true,否則返回false。
# [transitSearch]()
公交路線檢索
~~~
Boolean searchObj.transitSearch( start, end, city );
~~~
### 說明:
檢索完成后觸發onRouteSearchComplete()事件。 若調用此方法時對象處于檢索操作中,則終止上次檢索操作,重新開始新的檢索。
### 參數:
- start: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *公交線路檢索的起點
可以為起點地名關鍵字或地圖坐標。
- end: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *公交線路檢索的終點
可以為起點地名關鍵字或地圖坐標。
- city: *( DOMString ) 必選 *要檢索的城市名稱
### 返回值:
Boolean : 檢索成功返回true,否則返回false。
### 示例:
~~~
// 在北京檢索從天安門到鳥巢的公交線路
var searchObj = new plus.maps.Search( map );
searchObj.transitSearch( "天安門", "鳥巢", "北京" );
~~~
# [setDrivingPolicy]()
設置駕車路線檢索策略
~~~
Boolean searchObj.setDrivingPolicy( policy );
~~~
### 說明:
設置駕車路線檢索策略,默認采用maps.SearchPolicy.DRIVING_TIME_FIRST策略。 如果設置非法值則認為設置失敗,采用上次設置的檢索策略并返回false;需在調用drivingSearch()方法前設置的策略才生效。
### 參數:
- policy: *( [SearchPolicy](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPolicy) ) 必選 *駕車線路檢索策略
可取值為maps.SearchPolicy.DRIVING_TIME_FIRST、maps.SearchPolicy.DRIVING_DIS_FIRST、maps.SearchPolicy.DRIVING_FEE_FIRST。
### 返回值:
Boolean : 設置成功返回true,否則返回false。
# [drivingSearch]()
駕車路線檢索
~~~
Boolean searchObj.drivingSearch( start, startCity, end, endCity );
~~~
### 說明:
用于駕車路線檢索,檢索完成后觸發onRouteSearchComplete()事件。 調用此方法時對象處于檢索操作中,則終止上次檢索操作,重新開始新的檢索。
### 參數:
- start: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *駕車線路檢索的起點
可以為起點地名關鍵字或地圖坐標。
- startCity: *( DOMString ) 必選 *駕車線路檢索的起點位置所屬城市
如果start為坐標則可傳入空字符串
- end: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *駕車線路檢索的終點
可以為終點地名關鍵字或地圖坐標。
- endCity: *( DOMString ) 必選 *駕車線路檢索的終點位置所屬城市
### 返回值:
Boolean : 檢索成功返回true,否則返回false。
### 示例:
~~~
// 檢索從北京天安門到上海市政府線路
var searchObj = new plus.maps.Search( map );
searchObj.drivingSearch( "天安門", "北京", "市政府", "上海" );
~~~
# [walkingSearch]()
步行路線檢索
~~~
Boolean searchObj.walkingSearch( start, startCity, end, endCity );
~~~
### 說明:
用于步行路線檢索,檢索完成后觸發onRouteSearchComplete()事件。 調用此方法時對象處于檢索操作中,則終止上次檢索操作,重新開始新的檢索。
### 參數:
- start: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *步行線路檢索的起點位置
可以為起點地名關鍵字或地圖坐標。
- startCity: *( DOMString ) 必選 *步行線路檢索的起點所屬城市
如果start為坐標則可傳入空字符串。
- end: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *步行線路檢索的終點
可以為終點地名關鍵字或地圖坐標。
- endCity: *( DOMString ) 必選 *步行線路檢索的終點所屬城市
如果end為坐標則可傳入空字符串。
### 返回值:
Boolean : 檢索成功返回true,否則返回false。
### 示例:
~~~
// 檢索從天安門到鳥巢的步行線路
var searchObj = new plugins.maps.Search( map );
searchObj.walkingSearch( "天安門", "北京", "鳥巢", "北京" );
~~~
# [onPoiSearchComplete]()
興趣點檢索完成事件
~~~
searchObj.onPoiSearchComplete = function ( state, result ) {
// JS Code.
}
~~~
### 說明:
[PoiSearchCallback](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.PoiSearchCallback) 類型
### 示例:
~~~
// 將檢索到的第一條信息作為標點添加到地圖中
var searchObj = new plus.maps.Search( map );
searchObj.onPoiSearchComplete = function ( state, result ) {
if ( state == 0 ) {
if ( result.currentNumber <= 0 ) {
alert( "沒有檢索到結果" );
}
var pos = result.getPosition( 0 );
var marker = new plus.maps.Marker( pos.point );
marker.setLabel( pos.name );
map.addOverlay( marker );
} else {
alert( "檢索失敗" );
}
}
var pt = new plus.maps.Point( 116.404, 39.915 ); // 天安門坐標
searchObj. poiSearchNearBy( "肯德基", pt, 1000 );
~~~
# [onRouteSearchComplete]()
線路檢索完成事件
~~~
searchObj.onRouteSearchComplete = function ( state, result ) {
// JS Code.
}
~~~
### 說明:
[RouteSearchCallback](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.RouteSearchCallback) 類型
### 示例:
~~~
// 將檢索到的第一條信息作為標點添加到地圖中
var searchObj = new plus.maps.Search( map );
searchObj.onRouteSearchComplete = function ( state, result ) {
if ( state == 0 ) {
if ( result.currentNumber <= 0 ) {
alert( "沒有檢索到結果" );
}
var pos = result.getPosition( 0 );
var marker = new plus.maps.Marker( pos.point );
marker.setLabel( pos.name );
map.addOverlay( marker );
} else {
alert( "檢索失敗" );
}
}
var pt = new plus.maps.Point( 116.404, 39.915 ); // 天安門坐標
searchObj. poiSearchNearBy( "肯德基", pt, 1000 );
~~~
# [SearchPolicy]()
檢索策略類型
### 說明:
在線路檢索時設置檢索策略時使用。
### 常量:
- TRANSIT_TIME_FIRST: *(Number 類型 )*時間優先
檢索策略類型常量,用于公交檢索策略
- TRANSIT_TRANSFER_FIRST: *(Number 類型 )*最少換乘優先
檢索策略類型常量,用于公交檢索策略
- TRANSIT_WALK_FIRST: *(Number 類型 )*最少步行距離優先
檢索策略類型常量,用于公交檢索策略
- TRANSIT_FEE_FIRST: *(Number 類型 )*選擇車票花銷最少優先
檢索策略類型常量,用于公交檢索策略
- DRIVING_DIS_FIRST: *(Number 類型 )*最短距離優先
檢索策略類型常量,用于駕車檢索策略
- DRIVING_NO_EXPRESSWAY: *(Number 類型 )*無高速公路線路
檢索策略類型常量,用于駕車檢索策略
- DRIVING_FEE_FIRST: *(Number 類型 )*最少費用優先
檢索策略類型常量,用于駕車檢索策略
# [SearchPoiResult]()
保存位置檢索、周邊檢索和范圍檢索返回的結果
### 屬性:
- [totalNumber](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult.totalNumber): POI檢索總結果數
- [currentNumber](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult.currentNumber): 當前頁的POI檢索結果數
- [pageNumber](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult.pageNumber): 本次POI檢索的總頁數
- [pageIndex](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult.pageIndex): 獲取當前頁的索引
- [poiList](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult.poiList): 本次POI檢索結果數組
### 方法:
- [getPosition](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult.getPosition): 獲取指定索引的檢索結果
# [totalNumber]()
POI檢索總結果數
~~~
poiResult.totalNumber;
~~~
### 說明:
Number 類型 只讀屬性
POI檢索總結果數,若沒有檢索到則返回0。
# [currentNumber]()
當前頁的POI檢索結果數
~~~
poiResult.currentNumber;
~~~
### 說明:
Number 類型 只讀屬性
當前頁POI檢索結果數,若沒有檢索到則返回0。
# [pageNumber]()
本次POI檢索的總頁數
~~~
poiResult.pageNumber;
~~~
### 說明:
Number 類型 只讀屬性
本次POI檢索的總頁數,若沒有檢索到則返回0。
# [pageIndex]()
獲取當前頁的索引
~~~
poiResult.pageIndex;
~~~
### 說明:
Number 類型 只讀屬性
當前頁的索引值,從0開始,即0表示第一頁。
# [poiList]()
本次POI檢索結果數組
~~~
poiResult.poiList;
~~~
### 說明:
Array 類型 只讀屬性
POI檢索結果數組,Array數組對象,數組內容為Position對象。
# [getPosition]()
獲取指定索引的檢索結果
~~~
Position poiResult.getPosition( index ) ;
~~~
### 說明:
如果index值超出范圍則返回null對象。
### 參數:
無
### 返回值:
[Position](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position) : 指定索引的檢索結果。
# [SearchRouteResult]()
保存位置檢索、周邊檢索和范圍檢索返回的結果
### 說明:
不可通過new操作符創建SearchRouteResult對象,在觸發onRouteSearchComplete()時自動創建。
### 屬性:
- [startPosition](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchRouteResult.startPosition): 線路的起點位置
- [endPosition](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchRouteResult.endPosition): 線路的終點位置
- [routeNumber](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchRouteResult.routeNumber): 本次線路檢索的總方案數
- [routeList](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchRouteResult.routeList): 線路檢索結果數組
### 方法:
- [getRoute](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchRouteResult.getRoute): 獲取指定索引的線路方案
# [startPosition]()
線路的起點位置
~~~
routeResult.startPosition;
~~~
### 說明:
[Position](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position) 類型 只讀屬性
線路檢索結果的起始位置點對象。
# [endPosition]()
線路的終點位置
~~~
poiResult.endPosition;
~~~
### 說明:
[Position](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position) 類型 只讀屬性
線路檢索結果的終點位置點對象。
# [routeNumber]()
本次線路檢索的總方案數
~~~
routeResult.routeNumber;
~~~
### 說明:
Number 類型 只讀屬性
線路檢索結果的方案數目,若未檢索到有效結果則返回0。
# [routeList]()
線路檢索結果數組
~~~
routeResult.routeList;
~~~
### 說明:
Array 類型 只讀屬性
線路檢索結果數組,Array數組對象,數組內容為Route對象。
# [getRoute]()
獲取指定索引的線路方案
~~~
Route poiResult.getRoute( index );
~~~
### 說明:
如果index值超出范圍則返回null對象。
### 參數:
- index: *( Number ) 必選 *要獲取結果的索引值
### 返回值:
[Route](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route) : 指定索引的線路方案。
# [Position]()
檢索結果的位置點
### 構造:
- [Position( point )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position.Position(%20point%20)): 創建Position對象
### 屬性:
- [point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position.point): 位置點的經緯度坐標
- [address](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position.address): 位置點的地址信息
- [city](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position.city): 位置點的所屬城市信息
- [name](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position.name): 位置點的名稱
- [phone](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position.phone): 位置點的電話信息
- [postcode](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position.postcode): 位置點的郵編信息
# [Position( point )]()
創建Position對象
~~~
var posObj = new plus.maps.Position( point );
~~~
### 參數:
- point: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *位置點的經緯度坐標
### 返回值:
[Position](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Position) : 創建的Position對象。
### 示例:
~~~
// 創建檢索位置點對象
var posObj = new plus.maps.Position( new plus.maps.Point(116.404,39.915) );
~~~
# [point]()
位置點的經緯度坐標
~~~
posObj.point;
~~~
### 說明:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) 類型 只讀屬性
# [address]()
位置點的地址信息
~~~
posObj.address;
~~~
### 說明:
DOMString 類型 只讀屬性
如果沒有位置點的地址信息則返回空字符串。
# [city]()
位置點的所屬城市信息
~~~
posObj.city;
~~~
### 說明:
DOMString 類型 只讀屬性
如果沒有位置點的所屬城市信息則返回空字符串。
# [name]()
位置點的名稱
~~~
posObj.name;
~~~
### 說明:
DOMString 類型 只讀屬性
如果沒有位置點的名稱則返回空字符串。
# [phone]()
位置點的電話信息
~~~
posObj.phone;
~~~
### 說明:
DOMString 類型 只讀屬性
如果沒有位置點的電話信息則返回空字符串。
# [postcode]()
位置點的郵編信息
~~~
posObj.postcode;
~~~
### 說明:
DOMString 類型 只讀屬性
如果沒有位置點的郵編信息則返回空字符串。
# [Route]()
地圖中的路線對象
### 說明:
從Overlay對象繼承而來,可通過Map對象的addOverlay()方法將對象添加地圖中。
### 構造:
- [Route( ptStart, ptEnd )](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route.Route(%20ptStart,%20ptEnd%20)): 創建Route對象
### 屬性:
- [startPoint](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route.startPoint): 路線起點地理坐標點
- [endPoint](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route.endPoint): 路線終點地理坐標點
- [pointCount](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route.pointCount): 路線坐標點段數
- [pointList](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route.pointList): 路線的地理坐標點數組
- [distance](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route.distance): 路線總距離
- [routeTip](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route.routeTip): 線路的提示信息
# [Route( ptStart, ptEnd )]()
創建Route對象
~~~
var routeObj = new plus.maps.Route( ptStart, ptEnd );
~~~
### 參數:
- ptStart: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *路線起點經緯度坐標
- ptEnd: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *路線終點經緯度坐標
### 返回值:
[Route](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Route) : 創建的Route對象。
### 示例:
~~~
// 創建Route線路對象
var routeObj = new plus.maps.Route( new plus.maps.Point(116.404,39.915), new plus.maps.Point(116.347496,39.970191) );
~~~
# [startPoint]()
路線起點地理坐標點
~~~
routeObj.startPoint;
~~~
### 說明:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) 類型 只讀屬性
# [endPoint]()
路線終點地理坐標點
~~~
routeObj.endPoint;
~~~
### 說明:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) 類型 只讀屬性
# [pointCount]()
路線坐標點段數
~~~
routeObj.pointCount;
~~~
### 說明:
[Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) 類型 只讀屬性
# [pointList]()
路線的地理坐標點數組
~~~
routeObj.pointList;
~~~
### 說明:
Array 類型 只讀屬性
路線的地理坐標點數組,數組中保存Point對象。
# [distance]()
路線總距離
~~~
routeObj.distance;
~~~
### 說明:
Number 類型 只讀屬性
路線從起始點到終點的距離,單位為米。
# [routeTip]()
線路的提示信息
~~~
routeObj.routeTip;
~~~
### 說明:
DOMString 類型 只讀屬性
線路提示信息,沒有提示信息則返回空字符串。
# [UserLocationCallback]()
獲取用戶當前位置信息成功回調
~~~
void onSuccess( state, point ) {
// Get location code
}
~~~
### 參數:
- state: *( Number ) 必選 *獲取用戶位置操作狀態碼,0表示成功,其它為錯誤碼
- point: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *位置經緯度坐標,如果獲取操作失敗則為null對象
### 返回值:
void : 無
# [ClickEventHandler]()
用戶點擊地圖回調事件
~~~
void onClick( point ) {
// Click code
}
~~~
### 參數:
- point: *( [Point](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Point) ) 必選 *用戶在地圖上點擊的坐標點
### 返回值:
void : 無
# [OverlayClickEventHandler]()
用戶點擊地圖覆蓋物回調事件
~~~
void onClick( overlay ) {
// Click code
}
~~~
### 參數:
- overlay: *( [Overlay](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.Overlay) ) 必選 *用戶在地圖上點擊的覆蓋物對象
overlay可以是Marker、Bubble、Circle、Polyline、Polygon對象的引用。
### 返回值:
void : 無
# [PoiSearchCallback]()
興趣點檢索完成事件
~~~
void onPoiSearchComplete( state, result ) {
// JS code.
}
~~~
### 說明:
在興趣點檢索完成時觸發,并返回檢索結果。
### 參數:
- state: *( Number ) 必選 *檢索結果狀態號
0表示檢索正確并返回結果,其它表示檢索錯誤。
- result: *( [SearchPoiResult](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchPoiResult) ) 必選 *POI檢索結果
若檢索錯誤,則為null對象。
### 返回值:
void : 無
# [RouteSearchCallback]()
線路檢索完成事件
~~~
void onRouteSearchComplete( state, result ) {
// JS code.
}
~~~
### 說明:
在線路檢索完成時觸發,并返回檢索結果。
### 參數:
- state: *( Number ) 必選 *檢索結果狀態號
0表示檢索正確并返回結果,其它表示檢索錯誤。
- result: *( [SearchRouteResult](http://www.dcloud.io/docs/api/zh_cn/maps.shtml#plus.maps.SearchRouteResult) ) 必選 *線路檢索結果
若檢索錯誤,則為null對象。
### 返回值:
void : 無
- API參考
- Accelerometer
- Audio
- Camera
- Contacts
- Device
- Downloader
- Events
- Gallery
- Geolocation
- IO
- Key
- Messaging
- NativeUI
- Navigator
- Orientation
- Proximity
- SplashScreen
- Storage
- UI
- Uploader
- InterfaceOrientation
- Runtime
- WebView
- XMLHttpRequest
- Zip
- Plugins
- Barcode
- Maps
- Payment
- Push
- Share
- Speech
- Statistic
- Native.js
- Android
- iOS