maps

Maps模块管理地图控件，用于在web页面中显示地图控件，提供各种接口操作地图控件，如添加标点、路线等。通过plus.maps可获取地图管理对象。

方法：

对象：

回调方法：

权限：

permissions

{
// ...
"permissions":{
	// ...
	"Maps": {
		"description": "地图"
	}
}
}

Map

地图控件对象

构造：

方法：

事件：

MapStyles

地图控件对象的参数

interface plus.maps.MapStyles {
	attribute Point center;
	attribute Number zoom;
	attribute MapType type;
	attribute Boolean traffic;
	attribute Boolean zoomControls;
	
	attribute String top;
	attribute String left;
	attribute String width;
	attribute String height;
	attribute String position;
}

说明：

设置地图对象显示时使用的参数，如地图的中心位置、缩放级别等。

属性：

GeocodeOptions

地理编码转换的参数

属性：

CoordinateConvertOptions

地图坐标转换的参数

属性：

Point

Point对象用于表示地图元素的坐标

说明：

常用语对地图上元素进行定位时使用。

构造：

方法：

Bounds

地理区域

说明：

有西南及东北坐标点数据组成的矩形区域。

构造：

方法：

MapType

地图视图类型

常量：

Overlay

地图覆盖物基类对象

interface Overlay {
	function Boolean isVisible();
	function void show();
	function void hide();
}

说明：

Overlay是地图上显示元素的基类，用于抽象地图元素，不用于实例化。

方法：

Marker

地图上显示的标点对象

说明：

从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。

构造：

方法：

事件：

Bubble

地图上显示的气泡对象

说明：

此对象不能直接添加到地图上显示，只可关联到地图标点覆盖物上，用户点击标点时弹出显示。

构造：

方法：

事件：

Circle

地图上显示的圆圈对象

说明：

从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。

构造：

方法：

Polyline

地图上显示的折线对象

说明：

从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。

构造：

方法：

Polygon

地图上显示的多边形对象

说明：

从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。

构造：

方法：

Search

地图检索对象

说明：

Search对象用于管理地图上的检索功能，包括位置检索、周边检索和范围检索。

构造：

方法：

事件：

SearchPolicy

检索策略类型

说明：

在线路检索时设置检索策略时使用。

常量：

SearchPoiResult

保存位置检索、周边检索和范围检索返回的结果

属性：

方法：

SearchRouteResult

保存位置检索、周边检索和范围检索返回的结果

说明：

不可通过new操作符创建SearchRouteResult对象，在触发onRouteSearchComplete()时自动创建。

属性：

方法：

Position

检索结果的位置点

构造：

属性：

Route

地图中的路线对象

说明：

从Overlay对象继承而来，可通过Map对象的addOverlay()方法将对象添加地图中。

构造：

属性：

GeocodeCallback

地理编码转换成功的回调函数

void onGeocodeSuccess( Event event ) {
	// JS code.
	var address = event.address;  // 转换后的地理位置
	var point = event.coord;  // 转换后的坐标信息
	var coordType = event.coordType;	// 转换后的坐标系类型
}

说明：

在地理编码转换成功触发，并返回转换结果。

参数：

返回值：

void : 无

CoordinateConvertCallback

坐标转换成功的回调函数

void onConvertSuccess( Event event ) {
	// JS code.
	var point = event.coord;  // 转换后的坐标值
	var coordType = event.coordType;	// 转换后的坐标系类型
}

说明：

在坐标转换成功触发，并返回转换结果。

参数：

返回值：

void : 无

DistanceCalculateCallback

距离计算成功的回调函数

void onCalculateSuccess( Event event ) {
	// JS code.
	var distance = event.distance;  // 转换后的距离值
}

说明：

在距离计算成功触发，并返回计算结果。

参数：

返回值：

void : 无

AreaCalculateCallback

地理区域面积计算成功的回调函数

void onCalculateSuccess( Event event ) {
	// JS code.
	var area = event.area;  // 计算后的面积值
}

说明：

在地理区域面积计算成功触发，并返回计算结果。

参数：

返回值：

void : 无

UserLocationCallback

获取用户当前位置信息成功回调

void onSuccess( state, point ) {
	// Get location code
}

参数：

返回值：

void : 无

ClickEventHandler

用户点击地图回调事件

void onClick( point ) {
	// Click code
}

参数：

返回值：

void : 无

StatusChangedEventHandler

地图状态变化回调事件

void onStatusChanged( event ) {
	// Click code
	var target = event.target;		// 状态变化的地图对象(plus.maps.Map)
	var bounds = event.bounds;		// 地图的可视地理区域(plus.maps.Bounds)
	var center = event.center;		// 地图的中心点坐标(plus.maps.Point)
	var zoom = event.zoom;			// 地图的缩放级别(Number)
}

参数：

返回值：

void : 无

OverlayClickEventHandler

用户点击地图覆盖物回调事件

void onClick( overlay ) {
	// Click code
}

参数：

返回值：

void : 无

OverlayDragEventHandler

用户拖拽覆盖物回调事件

void onDrag( target ) {
	// Click code
	var marker = target;    // 拖拽的覆盖物对象
}

参数：

返回值：

void : 无

PoiSearchCallback

兴趣点检索完成事件

void onPoiSearchComplete( state, result ) {
	// JS code.
}

说明：

在兴趣点检索完成时触发，并返回检索结果。

参数：

返回值：

void : 无

RouteSearchCallback

线路检索完成事件

void onRouteSearchComplete( state, result ) {
	// JS code.
}

说明：

在线路检索完成时触发，并返回检索结果。

参数：

返回值：

void : 无

SuccessCallback

地图操作成功回调函数

void onSuccess(){
	// Success code.
}

说明：

地图操作成功后触发回调函数。

参数：

无

返回值：

void : 无

ErrorCallback

地图操作失败的回调函数

function void onError( error ) {
	// Handle error
	var code = error.code; // 错误编码
	var message = error.message; // 错误描述信息
}

参数：

返回值：

void : 无