地图功能
MMap类
MMapOptions类
MOverlay类
MLabel类
MLabelOptions类
MFontStyle类
MMarker类
MMarkerOptions类
MTipOptions类
MCorrectionTipOptions类
MPolyline类
MLineOptions类
MLineStyle类
MArea类
MAreaOptions类
MAreaStyle类
MFillStyle类
MRectangle类
MCircle类
MPolygon类
MMenuItem类
MClusterOptions类
MLngLat类
MLngLats类
MPoint类
MSize类
MLngLatBounds类
MPixelBounds类
MMapTools类
MEvent类
附录
搜索功能
MLocalSearch类
MLocalSearchOptions类
MRoutSearch类
MRoutSearchOptions类
附录
MMap类

• 描述

该类封装了flash地图组件，对地图的操作都是通过它完成。这是API的核心类。其他的都是辅助类。


• 构造函数
构造函数 描述
MMap(container, mapOption) container是盛放地图的容器，如果不指定地图尺寸大小，则默认为容器的大小。mapOption是对地图选项参数的设置。

• 方法
1、返回地图状态
方法 返回值 描述
getCenter() MLngLat 返回当前地图中心点的经纬度坐标。
getZoomLevel() number 返回当前地图的缩放级别。
getSize() MSize 返回当前地图视野范围，单位为像素(px)。
getScale() number 返回当前地图中心点的比例尺，即一个像素代表的实际距离，单位为米。
getPixelBounds() MPixelBounds 返回地图视野范围矩形区域左上方和右下方的像素坐标。
getLngLatBounds() MLngLatBounds 返回地图视野范围矩形区域西南和东北角点的经纬度坐标。
isContinuousZoom() boolean 返回地图缩放时是否具有连续缩放效果的参数。
getDragEnabled()（V2.3.2新增） boolean 返回是否允许地图拖拽的参数。
getZoomEnabled() boolean 返回是否允许地图缩放的参数。
getKeyboardEnabled()（V2.3新增） boolean 返回键盘工具是否有效的参数。

2、修改地图状态
方法 返回值 描述
setCenter(center) number 设置地图中心点坐标。该方法会触发地图移动类事件。
setZoomLevel(zoomLevel) number 设置地图的缩放级别 ，范围从3到17，数值越大，图上信息越详细。
setZoomAndCenter(zoom,center) number 同时设置地图的缩放级别和中心点。
setContinuousZoom(isContinuous) number 设置地图缩放时是否有连续缩放效果。
setMapColor(color)（V2.3.2新增） number 设置地图的颜色。
setDragEnabled(DragEnabled)（V2.3.2新增） none 设置是否允许地图拥有拖拽功能。
setZoomEnabled(zoomEnabled) none 设置是否允许地图拥有缩放功能。地图缩放方法包括通过鱼骨条缩放地图、鼠标双击放大、键盘缩放地图以及zoomIn()、zoomOut()方法。
setLngLatBounds(bounds)（V2.3.2更新） number 根据经纬度bounds设置最合适的地图位置和zoom级别。其中bounds表示MLngLatBounds对象。该方法会触发地图移动类事件
zoomIn(lnglat) number 放大地图的一个级别。该方法会触发地图缩放类事件。
zoomOut(lnglat) number 缩小地图的一个级别。该方法会触发地图缩放类事件。
panDirection(dx,dy) number 朝着指定的方向滑动地图宽度一半的距离。dx的值为EAST和WEST，其中WEST表示向左方滑动，EAST表示向右方滑动；dy的值为SOUTH和NORTH，其中NORTH表示向上方滑动，SOUTH表示向下方滑动。该方法会触发地图移动类事件。
panTo(center) number 设置地图的中心点到指定的坐标，如果该点已经在当前的视口之中，则地图中心会滑动到该位置；如果该点不在当前的视口之中，地图中心点跳转到指定坐标。该方法会触发地图移动类事件。
panBy(position) number 地图滑动指定的像素距离。position参数的类型为MSize。该方法会触发地图移动类事件。
setCtrlPanelState(ctrlName,state) number 设置地图控制面板的显示隐藏状态。控制面板名称：ctrlName，类型：constant，取值：OVERVIEW_CTRL（鹰眼）、TOOLBAR_CTRL（工具条）、SCALE_CTRL（比例尺） 。显示隐藏状态：state，类型：constant，取值：SHOW、HIDE、MINIMIZE(只适用于鹰眼)。 当改变鹰眼状态时会触发OVERVIEWMAP_CHANGED事件。
setOverviewState(state) number 设置鹰眼的状态，state值为SHOW（显示鹰眼）、MINIMIZE（最小化鹰眼）或者HIDE（隐藏鹰眼）。该方法会触发OVERVIEWMAP_CHANGED事件。
loadCtrlPanel(ctrlName,opt)（V2.3.1更新） number 加载工具条，ctrlName值为TOOLBAR_CTRL（工具条）；opt：说明：opt结构为：：{toolbarPos:MPoint, toolbar:int,toolbarUrl:String}，其中第一个属性表示工具条的位置，第二个参数表示工具条的类型（必填），第三个参数表示工具条的url（必填）。
setCurrentMouseTool(ctrlName,option)（V2.3.2更新） number 设置鼠标当前功能，如画标注点、画线、画多边形等。具体参数值为PAN_WHEELZOOM(滚轮缩放、移图)、ADD_MARKER（加点）、DRAW_LINE（画线）、DRAW_POLYGON（画多边形）、DRAW_RECTANGLE（画矩形）、 DRAW_CIRCLE（画圆）、RULER（ 测距）、COMPUTE_AREA（测面积）、FRAME_ZOOMIN（拉框放大）、FRAME_ZOOMOUT（拉框缩小）。option对象目前可以应用到RULER和DRAW_CIRCLE功能上。RULER功能的option参数可设置的的属性为：hasCircle，布尔型，设置是否显示测距圆，默认为true（显示）；hasPrompt，布尔型，设置是否有"双击结束"提示，默认为true（有提示）。DRAW_CIRCLE功能的option参数可设置的属性值为：showRadius，布尔型，是否显示圆半径，默认为false（不显示）。该鼠标工具方法会触发鼠标事件、添加覆盖物事件、地图缩放事件、测距、测面积事件等，不同的参数对应不同的事件类型。
setOverlayVisibleById(overlayId,isVisible) number 通过overlay的Id 设置是否显示该overlay。
setKeyboardEnabled(enabled)（V2.3新增） number 设置键盘操作是否有效。
savePosition() number 保存地图当前中心点位置和zoom级别，只是存储下来，并不能被调用返回存储值。
returnToSavedPosition() number 返回到由上次保存的地图中心点位置和zoom级别所确定的视野范围状态。该方法与 savePosition()方法成对使用。该方法会触发ROLL_BACK事件。

3、叠加层或覆盖物
方法 返回值 描述
addOverlay(overlay,isToFitView) number 向地图添加覆盖物（如标记，线，面等）。overlay参数表示要添加的覆盖物对象；isToFitView参数设置是否为自动适应视野，默认为false。当值为true时，添加点线面覆盖物时自动适应地图视野级别。该方法会触发ADD_OVERLAY事件。
addOverlays(overlays,azc) number 向地图添加一组覆盖物（如标记，线，面等）。overlays参数表示要添加的覆盖物对象数组；azc参数表示是否自动调整视野到能在地图范围内显示这些Overlays，默认为false。该方法会触发ADD_OVERLAY事件。
updateOverlay(overlay) number 更新MOverlay对象，目前支持更新MMarker、MPolyline及MArea对象。使用该方法既可以更新整个对象，也可以更新原始对象的部分属性特征。注意，使用该方法更新marker时不能更新其经纬度坐标。
setOverlayEditableById(overlayId,isEditable) number 设置overlay是否为可编辑状态(注意：圆形覆盖物目前无法编辑)。overlayId设置要修改的覆盖物的id；isEditable设置overlay是否可编辑，默认为false，即不可编辑。
setOverlayToTopById(overlayId)（V2.3新增） number 设置指定的覆盖物位于同类覆盖物的最顶层。在flash引擎中,点对象位于最顶层，线对象位于中间层，面对像位于最底层。该方法只能调整同类覆盖物之间的位置关系，并不能调整不同类覆盖物之间相对位置。
setClusterState(state,clusterOption)（V2.2.2新增） number 设置点聚合方式，只对marker对象起作用。state用来设置聚合状态，此参数有两个值，即："NoCluster"（不聚合，此为默认值）、"NormalCluster"（普通的点聚合）；clusterOption用来设置聚合参数选项。
getOverlayById(overlayId) MOverlay 通过Id返回覆盖物的构造。注意，要想获得指定覆盖物对象，首先必须添加该覆盖物。
getOverlaysByType(type) Array 根据overlay类型得到overlay对象。注意，要想获得指定覆盖物对象，首先必须添加该覆盖物。
expOverlay(overlayId)（V2.2.1新增） jason 根据overlayId导出json形式的overlay对象。导出的json对象格式为：type：覆盖物类型；id:覆盖物的id；coordinates：坐标数组，根据属性x，y取得经纬度坐标。
removeOverlaysByType(type) number 根据overlay类型删除overlay对象。该方法会触发REMOVE_OVERLAY事件。
removeOverlay(overlay) number 删除地图上指定的地图覆盖物。overlay为要删除的覆盖物对象。该方法会触发REMOVE_OVERLAY事件。
removeOverlayById(overlayId) number 删除地图上指定id的地图覆盖物。该方法会触发REMOVE_OVERLAY事件。
removeOverlays(overlays)（V2.3.1新增） number 一次删除地图上多个覆盖物对象。该覆盖物数组可以指同类覆盖物，也可以是不同类的覆盖物对象。该方法会触发REMOVE_OVERLAY事件。
removeAllOverlays() number 删除地图上所有的覆盖物对象(overlays)。该方法会触发CLEAR_OVERLAYS事件。
setDefaultMarkerOption(option) none 设置默认MMarker选项。option表示marker样式，遵从MMarkerOptions结构。
setDefaultLineOption(option) none 设置默认线选项。option表示线样式，遵从MLineOptions结构。
setDefaultAreaOption(option) none 设置默认面选项。option表示面样式，遵从MAreaOptions结构。

4、注册（反注册）事件
方法 返回值 描述
addEventListener(object,eventType,functionname) number 添加(注册)事件处理函数，当eventType事件发生时，执行object对象的functionName方法。可以向一个事件注册多个事件处理函数，在事件发生时，事件处理函数按注册时的顺序执行。
removeEventListener(object,eventType,functionName) number 注销flash向外发送的事件。

5、右键菜单
方法 返回值 描述
addMenuItems(arr) array 添加右键菜单的菜单项，传入的参数是数组，可以一次传入多个。
removeMenuItem(menuItemId) number 删除右键菜单子项。添加菜单时可以同时添加多个，但是删除时只能逐一删除。

6、信息窗口
方法 返回值 描述
openTip(position, tipOptions) number 打开信息窗口。可以通过该方法打开tip，当设置canShowTip为true时，用鼠标单击覆盖物，也可以打开tip。该方法可以触发TIP_OPEN事件。
openOverlayTip(overlayId) number 显示指定overlay对象的信息窗口。该方法可以触发TIP_OPEN事件。
closeTip() none 关闭当前打开的信息窗口。该方法可以触发TIP_CLOSE事件、TIP_BEFORE_CLOSE事件。


MMapOptions 类

• 描述

此类代表MMap构造函数中的可选参数，用来设置地图初始化时的中心点坐标、缩放级别、比例尺、工具条url 、工具条在地图中的显示位置及要加载的鹰眼url等属性值。


• 构造函数
构造函数 描述
MMapOptions() 构造地图参数选项对象。该构造方法中没有参数，对地图选项参数的设置通过设置该对象的属性进行。

• 属性
属性 类型 描述
zoom number 设置要加载的地图的缩放级别，范围为从3到17。
center MLngLat 设置要加载的地图的中心点坐标。
scale（V2.3新增） constant 设置初始化时是否在地图上显示比例尺，取值为DEFAULT，默认为null，即不显示比例尺。
toolbar（V2.3更新） constant 设置地图初始化工具条。此属性的取值为DEFAULT、BLACK、SMALL、MINI、ROUND，其中DEFAULT表示默认工具条，BLACK表示备选工具条。SMALL表示只有移动和缩放功能的小工具。MINI表示只有缩放功能的迷你工具条。ROUND表示新版圆工具条。
toolbarPos MPoint 工具条在地图上的显示位置。
overviewMap constant 设置加载到地图上的鹰眼的状态。取值为：SHOW(显示鹰眼)、HIDE(隐藏鹰眼)、MINIMIZE(最小化鹰眼)。
isCongruence boolean 是否在地图上叠加覆盖层，true为叠加，false为不叠加。
returnCoordType constant 返回坐标类型。COORD_TYPE_ENCODE：加密坐标，COORD_TYPE_OFFSET：偏移明码坐标。
fullScreenButton（V2.3.2新增） constant 设置是否显示地图初始化全屏按钮，取值为SHOW（显示）、HIDE（隐藏）。默认为显示状态。
centerCross（V2.3.2新增） constant 设置是否在地图上显示中心十字，取值为SHOW（显示）、HIDE（隐藏）。默认为显示中心十字。

MOverlay类

• 描述

覆盖在地图表面，随地图移动而移动的所有对象都叫覆盖类(overlay)。MOverlay是抽象类，它通过其子类MLabel、MMarker、MPolyline及MArea等类来实现此接口。可以使用addOverlay()方法，将覆盖类显示在地图上。


• 构造函数
构造函数 描述
MOverlay() 构造一个MOverlay对象，一般不直接创建MOverlay的实例，而是创建其子类的实例，在子类的初始化过程中调用MOverlay的构造函数。

• 属性
属性

类型

描述

id string

对象编号，也是对象的唯一标识。

TYPE constant MOverlay的类型，包括MOverlay.TYPE_MARKER、MOverlay.TYPE_LABEL、MOverlay.TYPE_POLYLINE、MOverlay.TYPE_POLYGON、MOverlay.TYPE_CIRCLE、MOverlay.TYPE_RECTANGLE、MOverlay.TYPE_AREA等。

MLabel类

• 描述

通过使用MLabel可以创建label对象，便于在地图上直接显示label。它有两个参数lnglat与option，lnglat用来标定label显示的位置，option用来设置label的字体样式、内容等。该类继承自MOverlay类。


• 构造函数
构造函数 描述
MLabel(lnglat,option) 通过经纬度坐标及参数选项确定label信息。通过addoverlay()方法可以直接将label信息显示在地图上。

• 属性
属性

类型

描述

id string

对象编号，也是对象的唯一标识。

TYPE constant MOverlay.TYPE_LABEL。
lnglat MLngLat label在地图上的显示位置。
option MLabelOptions label的参数选项。

MLabelOptions类

• 描述

label的选项参数类。


• 构造函数
构造函数 描述
MLabelOptions() 实例化一个MLabelOptions参数选项对象，实例化的对象可作为MLabel构造函数的第二个参数。

• 属性
属性 类型 描述
fontStyle MFontStyle label字体的样式，包含name、size、bold及color等4个属性，具体含义见MFontStyle类。
alpha number 设置label背景及边框的透明度，范围为从0到1，默认为1，即不透明。
hasBackground boolean 设置label是否有背景，默认为false，即没有背景。
hasBorder boolean 设置label背景是否有边框，默认为false，即没有边框。
content string 显示的label的内容。
backgroundColor hex 设置label的背景颜色，16进制整数，范围为0x000000-0xffffff。
borderColor hex 设置label的边框颜色，16进制整数，范围为0x000000-0xffffff。

MFontStyle类

• 描述

描述字体的风格。


• 构造函数
构造函数 描述
MFontStyle() 创建字体样式对象。字体样式包括线的字体名称(name)、字体大小(size)、字体颜色(color)及是否为粗体(bold)。

• 属性
属性 类型 描述
name string 字体的名称，默认为宋体。
size number 字体的大小，默认为12。
color hex 字体的颜色，默认为黑色。该属性值为16进制整数，范围为0x000000-0xffffff。
bold boolean 是否为粗体，默认为否。

MMarker类

• 描述

MMarker标注地图上点的位置，它实现MOverlay接口，因此可以用addOverlay()方法添加到地图中。标记对象包含lnglat(这是标记在地图中锚定的地理位置）和option。如果在构造函数中未设置option，则使用默认的选项。将信息窗口添加到地图中后，可在地图中通过其标记打开它。标记对象会触发鼠标事件和信息窗口事件。


• 构造函数
构造函数 描述
MMarker(lnglat,option) 通过经纬度坐标及参数选项确定标注信息。类似于MLabel对象的构建。option参数可以缺省。

• 属性
属性 类型 描述
id string

对象编号，也是对象的唯一标识。
TYPE constant 覆盖物的类型，默认为MOverlay.TYPE_MARKER。
lnglat MLngLat 描述marker显示的位置。
option MMarkerOptions marker的参数选项。
size MSize marker的宽度高度信息，只读属性，对应于MSize类。要想获取此对象首先需要调用getOverlayById()方法得到marker对象。

MMarkerOptions类

• 描述

描述标注的参数选项。此类的实例用于类 MMarker 的构造函数的option参数中。


• 构造函数
构造函数 描述
MMarkerOptions()

构建marker的参数选项。实例化该对象服务于MMarker对象。


• 属性
属性 类型 描述
imageUrl string 标注图片的URL，不设置此属性时，系统指定默认值。
anchor MPoint 图片的锚定点。同时设置anchor与imageAlign时，以anchor属性值为准；anchor与imageAlign都不设置时，以imageAlign的默认属性值为准。
labelAlign（V2.2.1新增） constant Label对应于图片的锚点。九宫格位置。TOP_LEFT：左上方 TOP_CENTER：正上方 TOP_RIGHT：右上方 MIDDLE_LEFT：正左边 MIDDLE_CENTER：正中心 MIDDLE_RIGHT：正右方 BOTTOM_LEFT：左下方 BOTTOM_CENTER：正下方 BOTTOM_RIGHT：右下方（默认值）。同时设置labelAlign和 labelPosition时，以labelPosition属性值为准；两个属性都不设置时，以labelAlign的默认值为准。
labelOption MLabelOptions 设置label的参数选项，默认为null。
labelPosition MPoint 标注点相对于marker锚点的位置。同时设置labelAlign和 labelPosition时，以labelPosition属性值为准；两个属性都不设置时，以labelAlign的默认值为准。
isDraggable boolean 是否可以拖动，默认为否。
imageAlign constant 设置图片锚点相对于图片的位置，九宫格位置。TOP_LEFT：左上方 TOP_CENTER：正上方 TOP_RIGHT：右上方 MIDDLE_LEFT：正左边 MIDDLE_CENTER：正中心 MIDDLE_RIGHT：正右方 BOTTOM_LEFT：左下方 BOTTOM_CENTER：正下方(默认值) BOTTOM_RIGHT：右下方。同时设置anchor与imageAlign时，以anchor属性值为准；anchor与imageAlign都不设置时，以imageAlign的默认属性值为准。
tipOption MTipOptions tip选项，具体见MTipOptions类。
canShowTip boolean 是否在地图中显示 tip，默认为true，即显示tip。
rotation number 设置MMarker图标的旋转角度。
isEditable boolean 设置marker点是否处于可编辑状态。
hasShadow boolean 是否显示阴影，默认true，即有阴影。
picAgent boolean 是否使用图片代理。默认为true，使用代理。备注：使用图片代理，Marker所使用的图片不存在跨域问题，imageUrl属性对应的图片地址必须是互联网可访问地址。不使用图片代理，Marker所使用的图片存在跨域问题，用户必须在图片所在域名下存放crossdomain.xml文件。
isDimorphic boolean 设置是否具有二态，此为可选项，默认为false，即没有二态。
dimorphicColor hex 此为可选项，设置第二种状态的颜色，默认为0xFF0000，即红色。

MTipOptions类

• 描述

提示窗口选项对象，通过该对象的各个属性来设置提示窗口的标题、内容、边框风格等内容，此对象服务于MMarker、MPlyline、MArea等对象。


• 构造函数
构造函数 描述
MTipOptions()

创建提示窗口对象。


• 属性
属性 类型 描述
tipType（V2.2.1更新） constant tip显示类型，其中FLASH_BUBBLE_TIP表示flash气泡信息窗口，此为默认项。HTML_BUBBLE_TIP表示html气泡信息窗口。HTML_CUSTOM_TIP表示html用户自定义信息窗口。
content string tip的内容。 注意：tipType和content两个属性为三类tip共有属性。
title string tip的标题。适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
hasShadow boolean tip是否有阴影，默认为false，即无阴影。适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
roundRectSize number tip矩形框的圆边长度。适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
borderStyle MLineStyle 边框风格。MLineStyle对象有四个属性，thickness、color、alpha及lineType，详见MLineStyle。适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
titleFontStyle MFontStyle 标题文字风格。适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
contentFontStyle MFontStyle 内容文字风格。 适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
fillStyle MFillStyle 内容部分的填充风格。填充风格包括两个属性，color及alpha，详见MFillStyle。适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
titleFillStyle MFillStyle 标题部分的填充风格。适用于HTML_BUBBLE_TIP和FLASH_BUBBLE_TIP。
tipHeight number HTML气泡信息窗口高度。仅用于HTML_BUBBLE_TIP。
tipWidth number HTML气泡信息窗口宽度。仅用于HTML_BUBBLE_TIP。
tipAlign（V2.2.1新增） number HTML用户自定义信息窗口锚点。默认锚点为正下方。TOP_LEFT：左上方 TOP_CENTER：正上方 TOP_RIGHT：右上方 MIDDLE_LEFT：正左边 MIDDLE_CENTER：正中心 MIDDLE_RIGHT：正右方 BOTTOM_LEFT：左下方 BOTTOM_CENTER：正下方 BOTTOM_RIGHT：右下方。仅用于HTML_CUSTOM_TIP。

MCorrectionTipOptions类

• 描述

设置具有纠错特殊功能的tip参数选项。


• 构造函数
构造函数 描述
MCorrectionTipOptions()

构造具有纠错功能的tip参数选项。


• 属性
属性 类型 描述
titleName string 纠错tip的标题，必选属性。
address string 传给纠错tip的地址信息，必选属性。
telephone string 传给纠错tip的电话信息，必选属性。
details string 传给纠错tip的详细信息，必选属性。
imgUrl string 传给纠错tip的图片信息。必选属性。

MPolyline类

• 描述

多折线对象类，继承自MOverlay类。


• 构造函数
构造函数 描述
MPolyline(lnglatArr,option) 通过经纬度坐标数组及参数选项构建多折线对象。构造完MPolyline对象后，可以通过addOverlay()方法将其加载到地图上。当然也可以采用setCurrentMouseTool(DRAW_LINE)方法在地图上画多折线。

属性
属性 类型 描述
id string

对象编号，也是对象的唯一标识。
TYPE constant 覆盖物(overlay)的类型，默认为MOverlay.TYPE_POLYLINE。
lnglatArr array 线的经纬度坐标数组。
option MLineOptions MPolyline对象的参数选项。

MLineOptions类

• 描述

描述线选项。线选项包括线样式（见MLineStyle）、线的tip（见MTipOptions）及是否显示tip（canShowTip）。


• 构造函数
构造函数 描述
MLineOption()

构造线选项参数对象。该实例化对象可作为MPolyline的第二个参数。


• 属性
属性 类型 描述
lineStyle MLineStyle 线的边缘风格，参照MLineStyle类。
tipOptions MTipOptions tip选项，参见MTipOptions。
canShowTip boolean 是否显示tip。
isEditable boolean 是否为可编辑状态。默认false，即不可编辑。
isDimorphic boolean 设置是否具有二态，此为可选项，默认为false，即没有二态。
dimorphicColor hex 此为可选项，设置第二种状态的颜色，默认为0xFF0000，即红色。

MLineStyle类

• 描述

描述线的风格，如线的粗细度、颜色及透明度等，此对象既可服务于MPolygon，又可以服务于MArea的边框线。


• 构造函数
构造函数 描述
MLineStyle() 创建线样式对象。线样式包括线的宽度(thickness)、颜色(color)、透明度(alpha)及线样式(lineType)。

• 属性
属性 类型 描述
thickness number 线的粗细度，默认为2。
color hex 线的颜色，默认为0x005890（蓝色)。
alpha number 线的透明度，范围为0~1，0为透明，1为不透明，缺省为1。
lineType constant 线的表示样式：LINE_SOLID表示实线，默认值 ；LINE_DASHED表示虚线。

MArea类

• 描述

构建覆盖面对象，以便能在地图上显示。参数设置、构造方法均类似于MPolyline。MArea与MLabel、MMarker、MPolyline一起继承父类MOverlay的属性及方法，同时又将属性、方法传递到子类上。一般我们并不直接构造MArea对象，而是构建其子类的对象。


• 构造函数
构造函数 描述
MArea(lnglatArr,option) 通过经纬度对象和参数选项构建面覆盖物。第二个参数option是MAreaOptions对象的实例。

• 属性
属性 类型 描述
TYPE constant 覆盖物类型，默认为MOverlay.TYPE_AREA。

MAreaOptions类

• 描述

描述面选项，该类除了可另外指定填充色和不透明性外，其他方面都非常类似于 MLineOptions。


• 构造函数
构造函数 描述
MAreaOptions() 创建一个面选项对象，通过对该对象的属性赋值可以生成所需要的面状覆盖物风格。

• 属性
属性 类型 描述
areaStyle MAreaStyle 面的风格，参照MAreaStyle。
tipOptions MTipOptions

面的tip选项，参照MTipOptions。

canShowTip boolean

是否显示tip。

isEditable boolean

是否为可编辑状态，目前只有圆形不可编辑。
labelOption MLabelOptions 设置面label的参数选项。
labelPosition MPoint label在area对象中的位置，默认label位于area的中心。
isDimorphic boolean 设置是否具有二态，此为可选项，默认为false，即没有二态。
dimorphicColor hex 此为可选项，设置第二种状态的颜色，默认为0xFF0000，即红色。

MAreaStyle类

• 描述

描述面的风格，除了比MLineStyle多填充样式外，其它方面都很类似。


• 构造函数
构造函数 描述
MAreaStyle() 创建面样式对象。

• 属性
属性 类型 描述
borderStyle MLineStyle

描述边框的风格，参照MLineStyle。

fillStyle MFillStyle 描述面的填充风格，参照MFillStyle。

MFillStyle类

• 描述

描述面状对象的填充风格，如描述多边形、矩形及圆的填充风格，也可以用于描述MTipOptions类的tip标题部分（titleFillStyle）及内容部分（fillStyle）的填充。


• 构造函数
构造函数 描述
MFillStyle() 创建填充样式对象。填充样式包括填充颜色(color)及透明度(alpha)。

• 属性
属性 类型 描述
color hex 面的填充颜色。16进制整数，范围为0x000000-0xffffff。
alpha number 填充面的透明度，范围为0~1，0为透明，1为不透明，缺省为1。

MRectangle类

• 描述

描述矩形面对象，继承自MArea。


• 构造函数
构造函数 描述
MRectangle(lnglatArr,option) 通过由左上、右下点组成的经纬度数组和参数选项构建矩形对象。其中第二个参数option是MAreaOptions实例化对象。

• 属性
属性 类型 描述
id string

对象编号，也是对象的唯一标识。
TYPE constant 覆盖物类的型，默认为MOverlay.TYPE_RECTANGLE。
lnglatArr array 左上、右下角组成的经纬度数组。
option MAreaOptions rectangle的参数选项。

MCircle类

• 描述

构建圆对象，继承自MArea。圆的构造函数有三个参数，第一个是经纬度数组，表示圆的中心点坐标和圆上任意一点坐标，或者仅表示圆中心点坐标。第二个参数表示圆的半径，为可选参数。第三个参数表示圆的样式，MAreaOptions类型。


• 构造函数
构造函数 描述
MCircle(lnglatArr, radius, option) 因选择参数的不同，该方法可以使用两种途径构建圆对象。第一种途径是缺省第二个参数，使用第一个和第三个参数构建对象，即利用圆的中心点及圆上任意一点画圆。第二种途径是利用圆的中心点、圆半径及option选项来创建对象，即第一个参数是一个仅包含圆中心点坐标的数组。

• 属性
属性 类型 描述
id string

对象编号，也是对象的唯一标识。
TYPE constant 覆盖物类的型，默认为MOverlay.TYPE_CIRCLE。
center MLngLat 圆的中心点坐标。
radius number 圆的半径。
option MAreaOptions MCircle的参数选项。
bounds(2.3.1版新增) MLngLatBounds 圆外切矩形的西南东北角经纬度坐标。

MPolygon类

• 描述

描述多边形面的覆盖物，继承自MArea。


• 构造函数
构造函数 描述
MPolygon(lnglatArr, option) 通过经纬度数组及参数选项构建多边形对象。第二个参数为MAreaOptions类型。

• 属性
属性 类型 描述
id string

对象编号，也是对象的唯一标识。
TYPE constant

覆盖物类的型，默认为MOverlay.TYPE_POLYGON。

lnglatArr Array

由多边形顶点组成的经纬度数组。
option MAreaOptions

Polygon的参数选项。

MMenuItem类

• 描述

构造一个右键菜单类对象，该MMenuItem对象对应的菜单类型分为两种：一种为类型菜单(classMenu)，一种为独立菜单(singleMenu)，由menuType属性决定添加的是哪种菜单，注意当一个覆盖物(MOverlay)添加了两种菜单，独立菜单会替换掉类型菜单，即独立菜单优先级高于类型菜单。


• 构造函数
构造函数 描述
MMenuItem() 在地图上添加的右键菜单对象。

• 属性
属性 类型 描述
menuType string 菜单的类型："classMenu"为类型菜单，即给一种类型添加菜单；"singleMenu"为独立菜单，即给单独一个覆盖物添加菜单，注意只有在覆盖物已经创建的情况下添加才会成功，如果该属性为空或""，则菜单类型为类型菜单(classMenu) 。
objectType string 拥有菜单的对象类型，""为空字符串，代表地图菜单,其他参照该MOverlay.TYPE。此属性对应于menuType的classMenu值。
overlayId string 根据overlayId把菜单绑定到某一个MOverlay类（只包括：Marker、Polyline、Area）上。此属性对应于menuType的singleMenu值。
order number 菜单序号，数字从小到大对应菜单从上到下。
menuText string 菜单项名称。
functionName function 单击菜单执行的函数操作。要想执行菜单项的函数操作，必须注册右键菜单事件。
isEnabled boolean 菜单项是否可用，true为可用，false为不可用，系统默认为true。
isHaveSeparator boolean 菜单项上方是否显示分隔条，默认为false，即无分隔条。
id string 可选项，表示用户传入的菜单项id，在菜单单击事件中传出此参数。如果id冲突，则删除旧菜单项，添加新菜单项，两种菜单通用。

MClusterOptions类

• 描述

设置点聚合的参数选项。


• 构造函数
构造函数 描述
MClusterOptions() 点聚合的参数选项。

• 属性
属性

类型

描述

gridSize number 设置聚合的范围，以像素为单位，默认为25。
maxZoom number 设置聚合的最大级别，默认为17级，即小于17级的级别均进行聚合，17级不聚合。

MLngLat类

• 描述

构造一个经纬度坐标对象，用于标定地图上一个点。


• 描构造函数
构造函数 描述
MLngLat(longitude,latitude,TYPE) 构建一个MLngLat对象，其中参数的顺序是经度在前，纬度在后，与lng、lat顺序对应。

• 属性
属性 类型 描述
lngX string/number 地图上点的经度。
latY string/number 地图上点的纬度。
TYPE constant 坐标类型：COORD_TYPE_ENCODE：加密坐标。COORD_TYPE_OFFSET：明码坐标。

MLngLats类

• 描述

构建经纬度坐标集合对象。


• 构造函数
构造函数 描述
MLngLats(lnglatArr) 构建一个经纬度坐标集合对象，该对象将用于功能扩展。

• 属性
属性 类型

描述

lnglatArr array

经纬度对象数组。


MPoint类

• 描述

通过像素坐标标定地图上的点。


• 构造函数
构造函数 描述
MPoint(x,y) 通过像素坐标标定地图上的点。坐标原点在屏幕左上方。

• 属性
属性 类型 描述
x number 水平向右方向偏离坐标原点的值。
y number 垂直向下方向偏远坐标原点方向的值。

MSize类

• 描述

构建地图内矩形区域尺寸的对象。MSize的两个参数同 width 和 height 属性一样可访问，但最好不要修改它们，而是在创建新对象时使用不同的参数。


• 构造函数
构造函数 描述
MSize(width,height) MSize表示地图内矩形区域的大小（以像素表示）。大小对象有两个参数：width 和 height。宽度是点的 x 坐标的差值，高度是 y 坐标的差值。

• 属性
属性 类型 描述
width number width属性是x坐标的差值。
height number height属性是y坐标的差值。

MLngLatBounds类

• 描述

通过西南角、东北角的经纬度坐标，构建经纬度矩形区域对象。


• 构造函数
构造函数 描述
MLngLatBounds(southWest,northEast) 通过西南、东北角的经纬度坐标构建经纬度矩形区域对象。

• 方法
方法 返回值 描述
getSouthWest() MLngLat 返回该对象西南角的经纬度坐标值。
getNorthEast() MLngLat 返回该对象东北角的经纬度坐标。

• 属性
属性 类型 描述
southWest MLngLat 对象西南角的经纬度坐标值。
northEast MLngLat 对象东北角的经纬度坐标值。

MPixelBounds类

• 描述

构建像素坐标矩形区域对象，可以用来表示矩形区域最大、最小像素坐标，其值因zoom级别的不同而不同。该对象类似于MLngLatBounds对象。


• 构造函数
构造函数 描述
MPixelBounds(topLeftPt，rightBottomPt) 通过左上角和右下角的像素坐标构建矩形区域边界对象。

• 方法
方法 返回值 描述
getCenter() MPoint

返回矩形区域的中心点坐标。

getTopLeft() MPoint 返回矩形区域左上角的像素坐标。
getRightBottom() MPoint 返回矩形区域右下角的像素坐标。
containsBounds(bounds) boolean 是否包含指定范围内的bounds对象。参数bounds是实例化的MPixelBounds对象。
contains(pixel) boolean 是否包含指定像素坐标的点。参数pixel是实例化的MPoint对象。

• 属性
属性 类型 描述
maxX number 最大的x值，即屏幕右下角的x坐标。
maxY number 最大的y值，即屏幕右下角的y坐标。
minX number 最小的x值，即屏幕左上角的x坐标。
minY number 最大的y值，即屏幕左上角的y坐标。

MMapTools类

• 描述

地图工具类，它包含所有的地图应用功能。


• 构造函数
构造函数 描述
MMapTools(map) 构造一个MMapTools对象，参数表示当前地图对象。

• 方法
方法 返回值 描述
addSpecialLayer() none 在地图上添加轨道交通图层。
removeSpecialLayer() none 删除地图上叠加的轨道交通图层。

MEvent类

• 事件回调返回值
返回值 返回值类型 描述
mapId string 当前地图的id。
overlayId string 覆盖物对象的id。
eventType string 事件类型的名称。
eventX MLngLat 经度坐标。
eventY MLngLat 纬度坐标。
zoom number 地图的zoom级别。
measureResult number 测量的结果。如果测量的是直线长度则单位为米，如果测量的是面积则单位为平方米。
menuItemId string 右键菜单项的Id。
objectType string 右键菜单触发事件的对象类型，即addMenuItem构造方法中的第一个参数。

• 事件
事件名称 返回值 描述
MAP_READY mapId、eventType 当地图准备完毕时触发该事件。
TIP_OPEN mapId、eventType、overlayId 打开tip时触发该事件。
TIP_CLOSE mapId、eventType、overlayId 关闭tip时触发该事件。
TIP_BEFORE_CLOSE mapId、eventType、overlayId 关闭tip之前触发该事件。
ADD_OVERLAY mapId、eventType、overlayId 向地图上添加覆盖层时触发该事件。
REMOVE_OVERLAY mapId、eventType、overlayId 删除地图上覆盖物时触发该事件。
CLEAR_OVERLAYS mapId、eventType 同时删除地图上所有覆盖层时触发该事件。
MOUSE_CLICK mapId、eventType、overlayId、eventX、eventY 在地图或者覆盖物上单击鼠标左键时触发该事件。
MOUSE_DBCLICK mapId、eventType、eventX、eventY 在地图上双击鼠标左键时触发该事件。
MOUSE_DOWN mapId、eventType、overlayId、eventX、eventY 在地图或者覆盖物上落下鼠标键时触发该事件。
MOUSE_MOVING mapId、eventType、eventX、eventY 鼠标移动时触发该事件。
MOUSE_UP mapId、eventType、overlayId、eventX、eventY 在地图或者覆盖物上抬起鼠标键时触发该事件。
MOUSE_OVER mapId、eventType、overlayId、eventX、 eventY 鼠标移到地图或覆盖物上时触发该事件。
MOUSE_OUT mapId、eventType、overlayId、eventX、 eventY 鼠标移出地图或者是覆盖物时触发该事件。
DRAG_START mapId、eventType、eventX、eventY、overlayId 开始拖拽地图 或覆盖物对象时触发该事件。
DRAGGING mapId、eventType、eventX、eventY、overlayId 拖拽地图或者覆盖物对象过程中触发该事件。
DRAG_END mapId、eventType、eventX、eventY、overlayId 拖拽结束时触发该事件。
MAP_MOVE_START mapId、eventType、eventX、eventY 地图开始移动时触发该事件。
MAP_MOVING mapId、eventType、eventX、eventY 地图移动过程中触发该事件。
MAP_MOVE_END mapId、eventType、eventX、eventY 地图移动结束时触发该事件。
ZOOM_START mapId、eventType、eventX、eventY、zoom 开始缩放地图时触发该事件。
ZOOM_END mapId、eventType、eventX、eventY、Zoom 缩放地图结束时触发该事件。
ZOOM_CHANGED mapId、eventType、eventX、eventY、zoom 改变地图缩放级别时触发该事件。
ROLL_BACK mapId、eventType 地图状态回滚时触发该事件。
MEASURE_STEP mapId、eventType、overlayId、eventX、eventY、measureResult 测量一次直线距离后时触发该事件。
MEASURE_END mapId、eventType、eventX、eventY、measureResult、overlayId 测距结束时触发该事件。
COMPUTE_AREA_END mapId、eventType、eventX、eventY、measureResult、overlayId 测面结束时触发该事件。
MENUITEM_CLICK mapId、eventType、overlayId、menuItemId、objectType、eventX、eventY 点击右键菜单时触发该事件。
OVERVIEWMAP_CHANGE mapId、eventType 改变鹰眼地图状态时触发该事件。

附录

1. 错误代码表
常数 描述
-1 方法执行失败。
0 成功返回结果。
1 坐标对象结构不正确。
2 数组中坐标对象结构不正确。
3 数组中坐标格式不统一。
4 坐标或坐标数组为空。
14 坐标类型是加密，但坐标内容却是数字类型错误。
15 坐标值输入错误。
20 地图缩放级别超出范围，即小于3或者大于17。
MLocalSearch类

• 描述

MLocalSearch封装了本地搜索功能,包括关键字查询和周边查询。通过创建一个MLocalSearch对象并调用关键字查询和周边查询相应方法就可以实现本地搜索功能。


• 构造函数
构造函数 描述
MLocalSearch() 初始化MLocalSearch类的一个新实例。

• 方法
1、关键字查询
方法 返回值 描述
poiSearchByKeywords(keywords,citycode,localSearchOptions) JSON 根据关键词搜索POI。
typeAhead (keywords,citycode,localSearchOptions) JSON 输入提示功能。

2、周边查询
方法 返回值 描述
poiSearchByCenterKeywords(centerKeywords,keywords,citycode,localSearchOptions) JSON 通过中心点关键词查询符合条件的周边POI。
poiSearchByCenterXY(centerXY,keywords,citycode,localSearchOptions) JSON 通过中心点坐标查询符合条件的周边POI。

MLocalSearchOptions类

• 描述

此类代表MLocalSearch的可选参数，用来设置本地搜索的数据源，数据类型，周边查询范围，返回结果形式，返回结果个数等参数。


• 构造函数
构造函数 描述
MLocalSearchOptions() 初始化MLocalSearchOptions类的一个新实例。

• 属性
属性 类型 描述
dataSources string 数据源。取值：MLocalSearch.BASE 基础数据、MLocalSearch.ENPOI 企业地标数据、MLocalSearch.BASE_ENPOI 基础数据+企业地标数据（默认值）、MLocalSearch. BASE_USERPOI 基础数据+编辑器数据、MLocalSearch.USERPOI 编辑器数据。
dataType string 数据类型。默认值：""。
returnType string 返回结果形式。默认值：JSON，可选值：XML。
recordsPerPage int 返回每页几条记录。默认值：10。
pageNum int 返回第几页。默认值：1。
language string 设置查询语言类型。默认值：""。
extId string 外部id。默认值：""。编辑器查询专用。
eid string 企业id。默认值：""。编辑器查询专用。
userId string 用户id。默认值：""。编辑器查询专用。
srcType string 临时参数，解决公交站点查询排序问题，默认值："" ，可选值：BUS:1%2BPOI。 公交查询专用，仅用于关键字词搜索：poiSearchByKeywords方法中。
range int 周边查询范。单位：m，默认值：3000m。周边查询专用。
naviFlag int 周边查询结果是否按导航距离排序。取值：0（默认）不排序；1 查询结果按导航距离排序。周边查询专用。

MRoutSearch类

• 描述

MRoutSearch封装了路径查询功能,包括公交查询和驾车查询。通过创建一个MRoutSearch对象并调用公交驾车的相应方法就可以实现路径查询功能。


• 构造函数
构造函数 描述
MRoutSearch() 初始化MRoutSearch类的一个新实例。

• 方法
方法 返回值 描述
routSearchByStartXYAndEndXY(searchType,startXY,endXY,citycode,routSearchOptions) JSON

通过起点终点坐标查询路径。

routSearchByMultiXY (multiXY,routSearchOptions) JSON

通过用户输入的多点坐标，按顺序进行路径查询。参数：1、multiXY：多点坐标。必填。参数类型：MLngLats。2、routSearchOptions：路径查询输入参数选项。非必填。参数类型：MRoutSearchOptions。

routSearchByBusLineName(busLineName,citycode,routSearchOptions) JSON 通过公交线路名称查询公交线路信息。
routSearchByBusLineID(busLineID,citycode,routSearchOptions) JSON 通过公交线路id查询公交线路信息。
routSearchByBusStationName(stationName,cityCode,routSearchOptions) JSON 通过公交站点查询经过此公交站点的公交线路信息。
getAllBusStations(xml,Interval) Arr 返回地图视野范围矩形区域右下方和左上方的像素坐标。用于routSearchByBusLineName、routSearchByBusLineID、routSearchByBusStationName方法，当flag参数选项取值为1时，解析XML站点信息。
calculationDistance(startXY,endXY,routSearchOptions) JSON 计算两点距离。

MRoutSearchOptions类

• 描述

此类代表MRoutSearch的可选参数，用来设置路径查询的路线查询方式，返回结果形式等参数。


• 构造函数
构造函数 描述
MRoutSearchOptions() 初始化MRoutSearchOptions类的一个新实例。

• 属性
属性 类型 描述
routeType int 设置路线查询方式。 1、公交查询： 最快捷模式 0 尽可能乘坐轨道交通和快速公交线路 （默认）。 最经济模式 1 尽可能乘坐月票车线路。 最少换乘模式2 尽可能减少换乘次数。 最少步行模式3 尽可能减少步行距离。 最舒适模式 4 尽可能乘坐有空调车线。 2、导航查询： 速度优先 0。 费用优先 1。 距离优先 2。
resultType int 查询返回值类型。 1.公交查询 0 表示不返回公交线路的xy坐标和扩展站点信息描述（默认）。 1 表示返回站点描述信息。 2．导航查询 0 表示返回全部的导航信息。 1 表示只返回相邻点的距离信息，不返回其他导航信息。 2 表示返回坐标信息以外的导航信息。
returnType string 返回结果形式，默认值：JSON，可选值：XML。
per int 表示在地图上画导航路径的关键点的个数，值越大路径越准确，默认为150。
passByXY MLngLats 驾车路径查询中，必经地点的坐标。默认值为””。此参数仅用于routSearchByStartXYAndEndXY方法中的驾车路径查询。并且，routSearchByStartXYAndEndXY查询方法加入此参数后，同routSearchByMultiXY查询方法的区别为：routSearchByStartXYAndEndXY按照routeType参数设置的导航方式进行导航，而routSearchByMultiXY按照多点参数的输入顺序进行导航。

附录

1. 错误处理代码表

在查询结果中返回。


代码 描述
400错误请求
参数为空 ：data.error_id =400 ； data.error_message=XXX参数为空.
参数过长 ：data.error_id =400； data.error_message=XXX参数长度超过范围.
参数错误 ：data.error_id =400；data.error_message=XXX参数错误.
403无权访问
强制锁定 ：data.error_id =403；data.error_message=被强制锁定.
余额不足 ：data.error_id =403；data.error_message=余额不足.
过期 ：data.error_id =403；data.error_message=过期.
KEY存在,但是URL错误 ：data.error_id =403； data.error_message=KEY存在,但是URL错误.
KEY不存在 ：data.error_id =403； data.error_message=KEY不存在（没申请或被注销）.
503服务异常 暂无