# [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