百度地图API手册.docx

1、XX地图API手册核心类 Map 基础类 Point Pixel Bounds Size 控件类 Control ControlAnchor NavigationControl NavigationControlType NavigationControlOptions OverviewMapControl OverviewMapControlOptions ScaleControl ScaleControlOptions LengthUnit CopyrightControl Copyright CopyrightControlOptions 覆盖物类 Overlay InfoWindow

2、InfoWindowOptions Marker MarkerOptions Label LabelOptions Polyline PolylineOptions Polygon PolygonOptions Icon IconOptions 右键菜单类 ContextMenu MenuItem MenuItemOptions 工具类 PushpinTool PushpinToolOptions DistanceTool DragAndZoomTool DragAndZoomToolOptions ZoomType 地图图层类 TileLayer TileLayerOptions MapTy

3、pe 服务类 LocalSearch LocalSearchOptions StatusCode LocalResult LocalResultPoi PoiType TransitRoute TransitRouteOptions TransitPolicy TransitRouteResult TransitRoutePlan Line LineType DrivingRoute DrivingRouteOptions DrivingPolicy DrivingRouteResult RoutePlan Route RouteType WalkingRoute WalkingRouteOp

4、tions WalkingRouteResult Geocoder LocalCity LocalCityOptions LocalCityResult TrafficControl Map 类此类是地图API的核心类，用来实例化一个地图。 构造函数构造函数描述Map(container:String|HTMLElement, opts:MapOptions)在指定的容器内创建地图实例，之后需要调用()方法对地图进行初始化。未进行初始化的地图将不能进行任何操作。配置方法方法 返回值 描述 enableDragging()none启用地图拖拽，默认启用。disableDragging()none

5、禁用地图拖拽。enableScrollWheelZoom()none启用滚轮放大缩小，默认禁用。disableScrollWheelZoom()none禁用滚轮放大缩小。enableDoubleClickZoom()none启用双击放大，默认启用。disableDoubleClickZoom()none禁用双击放大。enableKeyboard()none启用键盘操作，默认禁用。键盘的上、下、左、右键可连续移动地图。同时按下其中两个键可使地图进行对角移动。PgUp、PgDn、Home和End键会使地图平移其1/2的大小。+、-键会使地图放大或缩小一级disableKeyboard()none禁

6、用键盘操作。地图状态方法方法 返回值 描述 getSize()Size返回地图视图的大小，以像素表示。getZoom()Number返回地图当前缩放级别。getCenter()Point返回地图当前中心点。getBounds()Bounds返回地图可视区域，以地理坐标表示。toString()String返回类型描述字符串。修改地图状态方法方法 返回值 描述 setCenter(center:Point)none设置地图中心点地理坐标。panTo(center:Point)none将地图的中心点更改为给定的点。如果该点在当前的地图视图中已经可见，则会以平滑动画的方式移动中心点。panBy(x:

7、Number, y:Number)none以动画效果移动地图的中心点。(像素单位),如果指定的像素大于可视区域范围，不执行滑动效果。zoomTo(zoom:Number)none将视图切换到指定的缩放等级，中心点坐标不变。注意：当有信息窗口在地图上打开时，地图缩放将保证信息窗口所在的坐标位置不动。zoomIn()none放大一级视图。zoomOut()none缩小一级视图。centerAndZoom(center:Point, zoom:Number)none设置地图中心点地理坐标，并改变缩放等级。在创建地图实例后应立即调用此方法对地图进行初始化。reset()none重新设置地图，恢复地图初

8、始化时的中心点和级别。控件方法方法 返回值 描述 addControl(control:Control)none将控件添加到地图，一个控件实例只能向地图中添加一次。removeControl(control:Control)none从地图中移除控件。如果控件从未被添加到地图中，则该移除不起任何作用。getContainer()HTMLElement返回地图的容器元素。当创建用户自定义控件时，需要自行实现()方法，并将控件的容器元素添加到地图上，通过此方法可获得地图容器。右键菜单方法方法 返回值 描述 addContextMenu(menu:ContextMenu)none添加右键菜单。remo

9、veContextMenu(menu:ContextMenu)none移除右键菜单。覆盖物方法方法 返回值 描述 addOverlay(overlay:Overlay)none将覆盖物添加到地图中，一个覆盖物实例只能向地图中添加一次。removeOverlay(overlay:Overlay)none从地图中移除覆盖物。如果覆盖物从未被添加到地图中，则该移除不起任何作用。clearOverlays()none清除地图上所有覆盖物。openInfoWindow(infoWnd:InfoWindow, point:Point)none在地图上打开信息窗口。closeInfoWindow()none

10、关闭在地图上打开的信息窗口。在标注上打开的信息窗口也可通过此方法进行关闭。地图图层方法方法 返回值 描述 addTileLayer(tileLayer:TileLayer)none添加一个自定义地图图层。removeTileLayer(tilelayer:TileLayer)none移除一个自定义地图图层。getTileLayer(mapType:String)TileLayer通过地图类型得到一个地图图层对象。坐标变换方法 返回值 描述 pixelToPoint(pixel:Pixel)Point像素坐标转换为经纬度坐标。pointToPixel(point:Point)Pixel经纬度坐标

11、转换为像素坐标。事件事件 参数 描述 clickeventtype, target, pixel, point鼠标点击地图时会触发此事件。dblclickeventtype, target, pixel, point鼠标双击地图时会触发此事件。rightclickeventtype, target, pixel, point鼠标右键点击地图时会触发此事件。mousemoveeventtype, target, pixel, point在地图中移动鼠标时会触发此事件。movestarteventtype, target地图移动开始时触发此事件。movingeventtype, target地图移

12、动过程中触发此事件。moveendeventtype, target地图移动结束时触发此事件。zoomstarteventtype, target地图更加缩放级别开始时触发触发此事件。zoomendeventtype, target地图更加缩放级别结束时触发触发此事件。addoverlayeventtype, target当使用()方法向地图中添加单个覆盖物时会触发此事件。addcontroleventtype, target当使用()方法向地图中添加单个控件时会触发此事件。removecontroleventtype, target当使用()方法移除单个控件时会触发此事件。removeove

13、rlayeventtype, target当使用()方法移除单个覆盖物时会触发此事件。clearoverlayseventtype, target当使用()方法一次性移除全部覆盖物时会触发此事件。dragstarteventtype, target, pixel, point开始拖拽地图时触发。draggingeventtype, target, pixel, point拖拽地图过程中触发。dragendeventtype, target, pixel, point停止拖拽地图时触发。addtilelayereventtype, target添加一个自定义地图图层时触发此事件。removeti

14、lelayereventtype, target移除一个自定义地图图层时触发此事件。loadeventtype, target, pixel, point, zoom调用()方法时会触发此事件。这表示位置、缩放层级已经确定，但可能还在载入地图图块。resizeeventtype, target, size地图可视区域大小发生变化时会触发此事件。MapOptions 类此类表示Map构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。 属性 类型 描述 zoomLevelNumber地图的初始缩放级别，范围1 - 18。centerPointPoint地图的初始中心点坐标。zoomL

15、evelMinNumber设置地图显示最小缩放级别。zoomLevelMaxNumber设置地图显示最大缩放级别。Point 类此类表示一个地理坐标点。 构造函数描述Point(lng:Number, lat:Number)以指定的经度和纬度创建一个地理点坐标。属性属性 类型 描述 lngNumber地理经度。latNumber地理纬度。方法方法 返回值 描述 equals(other:Point)Boolean判断坐标点是否相等，当且仅当两点的经度和纬度均相等时返回true。toString()String返回类型描述字符串。Pixel 类此类表示地图上的一点，单位为像素。 构造函数描述Pi

16、xel(x:Number, y:Number)创建像素点对象实例。像素坐标的坐标原点为地图区域的左上角。属性属性 类型 描述 xNumberx坐标。yNumbery坐标。方法方法 返回值 描述 equals(other:Pixel)Boolean判断坐标点是否相等，当且仅当两点的x坐标和y坐标均相等时返回true。toString()String返回类型描述字符串。Bounds 类构造函数此类表示地理坐标的矩形区域。矩形区域通过两个点的x、y坐标进行描述，其中数值较小的点位于矩形的左下角、数值较大的点位于矩形的右上角。 构造函数描述Bounds(minX:Number, minY:Number

17、, maxX:Number, maxY:Number)创建一个包含所有给定点坐标的矩形区域。属性属性 类型 描述 minXNumber矩形左下角的x坐标。minYNumber矩形左下角的y坐标。maxXNumber矩形右上角的x坐标。maxYNumber矩形右上角的y坐标。方法方法 返回值 描述 equals(other:Bounds)Boolean当且仅当此矩形中的两点参数都等于其他矩形的两点参数时，返回true。containsPoint(point:Point)Boolean如果点的地理坐标位于此矩形内，则返回true。containsBounds(bounds:Bounds)Boole

18、an传入的矩形区域完全包含于此矩形区域中，则返回true。intersects(other:Bounds)Bounds计算与另一矩形的交集区域。extend(point:Point)none放大此矩形，使其包含给定的点。getCenter()Point返回矩形的中心点。isEmpty()Boolean如果矩形为空，则返回true。toString()String返回类型描述字符串。Size 类此类以像素表示一个矩形区域的大小。Size对象包含两个属性：width、height，分别表示矩形的水平方向的数值和竖直方向的数值。 属性属性 类型 描述 widthNumber水平方向数值。height

19、Number竖直方向的数值。方法方法 返回值 描述 equals(other:Bounds)Boolean当且仅当此矩形中的宽度和高度都等于其他矩形的宽度和高度时，返回true。toString()String返回类型描述字符串。Control 类此类是所有控件的基类，您可以通过此类来实现自定义控件。所有控件均包含Control类的属性、方法和事件。通过()方法可将控件添加到地图上。构造函数描述Control()创建一个控件原型实例，通过该原型实例可创建自定义控件。 属性方法 返回值 描述 defaultAnchorenum ControlAnchor控件默认的停靠位置。自定义控件时需要提供此

20、属性，作为控件的默认停靠位置。defaultOffsetSize控件默认的位置偏移值。自定义控件时需要提供此属性，作为控件的默认偏移位置。方法方法 返回值 描述 initialize(map:Map)HTMLElement抽象方法。调用()方法添加控件时将调用此方法，从而实现该控件的初始化。自定义控件时需要实现此方法，并将元素的DOM元素在该方法中返回。DOM元素需要添加到地图的容器中，使用()方法可获得地图容器元素。setAnchor(anchor:enum ControlAnchor)none设置控件停靠的位置getAnchor()enum ControlAnchor获取控件停靠的位置se

21、tOffset(offset:Size)none设置控件停靠的偏移量getOffset()Size获取控件停靠的偏移量show()none显示控件hide()none隐藏控件isVisible()Boolean判断控件的可见性toString()String返回描述类型字符串。如果需要，自定义控件需要自行实现此方法以获得描述自身类型的字符串。ControlAnchor 枚举常量此常量表示控件的定位。 常数 描述 BMAP_ANCHOR_TOP_LEFT控件将定位到地图的左上角。BMAP_ANCHOR_TOP_RIGHT控件将定位到地图的右上角。BMAP_ANCHOR_BOTTOM_LEFT控件

22、将定位到地图的左下角。BMAP_ANCHOR_BOTTOM_RIGHT控件将定位到地图的右下角。NavigationControl 类此类表示地图的平移缩放控件，可以对地图进行上下左右四个方向的平移和缩放操作。 构造函数构造函数描述NavigationControl(opts:NavigationControlOptions)创建一个特定样式的地图平移缩放控件。方法方法 返回值 描述 getType()enum NavigationControlType获取平移缩放控件的类型。setType(type:enum NavigationControlType)none设置平移缩放控件的类型。Nav

23、igationControlType 枚举常量此常数表示平移缩放控件的类型 常数常数 描述 BMAP_NAVIGATION_CONTROL_LARGE标准的平移缩放控件（包括平移、缩放按钮和滑块）。BMAP_NAVIGATION_CONTROL_SMALL仅包含平移和缩放按钮。BMAP_NAVIGATION_CONTROL_PAN仅包含平移按钮。BMAP_NAVIGATION_CONTROL_ZOOM仅包含缩放按钮。NavigationControlOptions 类此类表示NavigationControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。 属性属性 类型 描述

24、 anchorenum ControlAnchor控件的停靠位置。offsetSize控件的水平偏移值。typeenum NavigationControlType平移缩放控件的类型。OverviewMapControl 类此类表示缩略地图控件。 构造函数构造函数描述OverviewMapControl(opts:OverviewMapControlOptions)创建一个缩略地图控件实例方法方法 返回值 描述 changeView()none切换缩略地图控件的开合状态。setSize(size:Size)none设置缩略地图的大小。getSize()Size获取缩略地图的大小。事件事件 参数

25、 描述 viewchangedeventtype, target, isOpen缩略地图开合状态发生变化后触发此事件。viewchangingeventtype, target缩略地图开合状态发生变化过程中触发此事件。OverviewMapControlOptions 类此类表示OverviewMapControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。 属性属性 类型 描述 anchorenum ControlAnchor控件的停靠位置。offsetSize控件的偏移值。sizeNumber缩略地图控件的大小。isOpenNumber缩略地图添加到地图后的开合状态，默

26、认为关闭。ScaleControl 类此类表示比例尺控件。 构造函数构造函数描述ScaleControl(opts:ScaleControlOptions)创建一个比例尺控件。方法方法 返回值 描述 getUnit()enum LengthUnit获取比例尺单位制。setUnit(unit:enum LengthUnit)none设置比例尺单位制。LengthUnit 枚举常量此常数表示长度单位制。 常数常数 描述 BMAP_UNIT_METRIC公制单位。BMAP_UNIT_IMPERIAL英制单位。ScaleControlOptions 类此类表示ScaleControl构造函数的可选参数

27、。它没有构造函数，但可通过对象字面量形式表示。 属性属性 类型 描述 anchorenum ControlAnchor控件的停靠位置。offsetSize控件的偏移值。CopyrightControl 类此类表示版权控件，您可以在地图上添加自己的版权信息。每一个版权信息需要包含如下内容：版权的唯一标识、版权内容和其适用的区域范围。 构造函数构造函数描述CopyrightControl(opts:CopyrightControlOptions)创建一个版权控件实例。方法方法 返回值 描述 addCopyright(copyright:Copyright)none添加版权信息。removeCopyright(id)none移除版权信息。getCopyright(id)Copyright获取单个版权信息。getCopyrightCollection()Array获取版权信息列表。Copyright 类此类表示一条版权信息。可作为()方法的参数。它没有构造函数，但可通过对象字面量形式表示。 属性属性 类型 描述