百度地图API类参考.docx

资源描述

百度地图API类参考.docx

《百度地图API类参考.docx》由会员分享，可在线阅读，更多相关《百度地图API类参考.docx（193页珍藏版）》请在冰点文库上搜索。

百度地图API类参考.docx

XX地图API类参考

一、

a）

核心类

Map

此类是地图API的核心类，用来实例化一个地图。

构造函数

Map（container:

String|HTMLElem

ent[,opts:

MapOptions]）

描述

在指定的容器内创建地图实例，之后需要调用

Map.centerAndZoom（）方法对地图进行初始化。

未进行初

始化的地图将不能进行任何操作。

配置方法

返

方法

回

值

enableDragging（）

disableDragging（

）

enableScrollWhee

lZoom（）

disableScrollWhe

elZoom（）

enableDoubleClic

kZoom（）

disableDoubleCli

ckZoom（）

none

启用地图拖拽，默认启用。

禁用地图拖拽。

描述

none

启用滚轮放大缩小，默认禁用。

none

禁用滚轮放大缩小。

none

启用双击放大，默认启用。

none

禁用双击放大。

启用键盘操作，默认禁用。

键盘的上、下、左、右键可连续移动地

enableKeyboard（）

none

图。

同时按下其中两个键可使地图进行对角移动。

PgUp、PgDn、Home

和End键会使地图平移其1/2的大小。

+、-键会使地图放大或缩小一

级。

disableKeyboard（

）

enableInertialDr

agging（）

disableInertialD

ragging（）

enableContinuous

none

禁用键盘操作。

启用地图惯性拖拽（默认为关闭状态）。

（自1.1新增）

禁用地图惯性拖拽

（自1.1新增）

启用连续缩放效果（默认为禁用状态）。

1/55

none

XX地图API类参考

Zoom（）

disableContinuou

sZoom（）

enablePinchToZoo

m（）

disablePinchToZo

om（）

none

（自1.1新增）

禁用连续缩放效果

（自1.1新增）

启用双指操作缩放（默认为开启状态）。

（自1.1新增）

禁用双指操作缩放。

（自1.1新增）

none

地图状态方法

返

方法

回

值

getBounds（）

Bou

nds

Poi

Num

ber

Map

getMapType（）

Typ

getSize（）

Siz

返回地图可视区域，以地理坐标表示。

描述

getCenter（）

getDistance（start:

Point,

end:

Point）

返回地图当前中心点。

获取两点之间的距离，单位是米。

（自1.1新增）

获取地图类型。

（自1.1新增）

返回地图视图的大小，以像素表示。

根据提供的地理区域或坐标获得最佳的地图视

getViewport（view:

Array[,

viewportOptions:

ViewportOptions]）

Vie

wpo

野，返回的对象中包含center和zoom属性，分

别表示地图的中心点和级别。

此方法仅返回视野信息，不会将新的中心点和级

别做用到当前地图上。

（自1.1新增）

getZoom（）

Num

ber

Str

ing

返回地图当前缩放级别。

toString（）

返回类型描述字符串。

修改地图状态方法

返

方法

回

值

2/55

描述

XX地图API类参考

centerAndZoom（center:

Point,

zoom:

Number）

设置地图中心点地理坐标，并改变缩放等级。

在

创建地图实例后应立即调用此方法对地图进行

初始化。

将地图的中心点更改为给定的点。

如果该点在当

前的地图视图中已经可见，则会以平滑动画的方

式移动到中心点位置。

将地图在水平位置上移动x像素，垂直位置上移

动y像素。

如果指定的像素大于可视区域范围，

不执行滑动效果。

重新设置地图，恢复地图初始化时的中心点和级

别。

设置地图中心点地理坐标。

设置地图城市，注意当地图初始化时的类型设置

为BMAP_PERSPECTIVE_MAP时，需要在调用

centerAndZoom之前调用此方法设置地图所在

城市。

例如：

varmap=newBMap.Map（“container”,

{mapType:

BMAP_PERSPECTIVE_MAP}）;

map.setCurrentCity（“北京市”）;

map.centerAndZoom（new

BMap.Point（116.404,39.915）,18）;

注意：

初始化的坐标应与您设置的城市对应，否

则地图将无法正常显示

如果地图初始化为BMAP_NORMAL_MAP，则在调

用setMapType切换地图类型时不必调用此方

法。

（自1.1新增）

panTo（center:

Point）

panBy（x:

Number,y:

Number）

reset（）

setCenter（center:

Point）

setCurrentCity（city:

String）

setMapType（mapType:

MapTypes）

setViewport（view:

Array|View

port[,

ViewportOptions]）

viewportOptions:

设置地图类型。

（自1.1新增）

根据提供的地理区域或坐标设置地图视野，调整

后的视野会保证包含提供的地理区域或坐标。

（自1.1新增）

将视图切换到指定的缩放等级，中心点坐标不

变。

注意：

当有信息窗口在地图上打开时，地图

缩放将保证信息窗口所在的坐标位置不动。

放大一级视图。

zoomTo（zoom:

Number）

zoomIn（）

3/55

XX地图API类参考

zoomOut（）

缩小一级视图。

控件方法

方法

addControl（control

Control）

removeControl（cont

rol:

Control）

值

none

描述

将控件添加到地图，一个控件实例只能向地图中添加一次。

从地图中移除控件。

如果控件从未被添加到地图中，则该移除

不起任何作用。

返回地图的容器元素。

当创建用户自定义控件时，需要自行实

现Control.initialize（）方法，并将控件的容器元素添加到

地图上，通过此方法可获得地图容器。

none

getContainer（）

HTMLEl

ement

右键菜单方法

方法

addContextMenu（menu:

ContextMenu）

removeContextMenu（menu:

ContextMenu）

返回值

none

描述

添加右键菜单。

移除右键菜单。

覆盖物方法

方法

addOverlay（overlay:

Overl

ay）

removeOverlay（overlay:

erlay）

clearOverlays（）

openInfoWindow（infoWnd:

nfoWindow,point:

Point）

closeInfoWindow（）

返回值

none

描述

将覆盖物添加到地图中，一个覆盖物实例只能向地图

中添加一次。

从地图中移除覆盖物。

如果覆盖物从未被添加到地图

中，则该移除不起任何作用。

清除地图上所有覆盖物。

在地图上打开信息窗口。

关闭在地图上打开的信息窗口。

在标注上打开的信息

窗口也可通过此方法进行关闭。

根据地理坐标获取对应的覆盖物容器的坐标，此方法

Pixel

用于自定义覆盖物。

（自1.1新增）

Point

InfoWin

dow|Nul

根据覆盖物容器的坐标获取对应的地理坐标。

（自1.1新增）

获取地图上处于打开状态的信息窗的实例。

当地图没

有打开的信息窗口时，此方法返回null。

4/55

none

pointToOverlayPixel（poin

Point）

overlayPixelToPoint（pixe

Pixel）

getInfoWindow（）

XX地图API类参考

getOverlays（）

Array

verlay>

（自1.1新增）

获取地图上的所有覆盖物。

（自1.1新增）

获取地图覆盖物容器列表。

对象包含覆盖物可被添加的各个HTML容器元素。

此

方法返回的对象包括：

{

floatPane,

markerMouseTarget,

floatShadow,

labelPane,

markerPane,

mapPane

}

（自1.1新增）

getPanes（）

Object

地图图层方法

方法

addTileLayer（tileLayer:

TileLayer）

removeTileLayer（tilelayer:

TileLay

er）

getTileLayer（mapType:

String）

返回值

none

TileLayer

描述

添加一个自定义地图图层。

移除一个自定义地图图层。

通过地图类型得到一个地图图层对象。

坐标变换

方法

pixelToPoint（pixel:

Pixel）

pointToPixel（point:

Point）

返回值

Point

Pixel

描述

像素坐标转换为经纬度坐标。

经纬度坐标转换为像素坐标。

事件

参数

描述

左键单击地图时触发此事件。

click

event{type,

target,

当双击时，产生的事件序列为：

clickclickdblclick

（自1.1更新）

dblclic

rightcl

ick

event{type,

pixel,point}

event{type,

target,

鼠标双击地图时会触发此事件。

右键单击地图时触发此事件。

当双击时，产生的事件序列为：

5/55

point,pixel,overlay}

XX地图API类参考

rightclickrightclickrightdblclick

（自1.1更新）

rightdb

lclick

maptype

change

mousemo

movesta

moving

moveend

zoomsta

zoomend

addover

lay

addcont

rol

removec

ontrol

removeo

verlay

clearov

erlays

dragsta

draggin

dragend

addtile

layer

removet

event{type,

target,

右键双击地图时触发此事件。

（自1.1新增）

地图类型发生变化时触发此事件。

（自1.1新增）

鼠标在地图区域移动过程中触发此事件。

（自1.1更新）

地图移动开始时触发此事件。

地图移动过程中触发此事件。

地图移动结束时触发此事件。

地图更改缩放级别开始时触发触发此事件。

地图更改缩放级别结束时触发触发此事件。

当使用Map.addOverlay（）方法向地图中添加单个覆盖

物时会触发此事件。

当使用Map.addControl（）方法向地图中添加单个控件

时会触发此事件。

当使用Map.removeControl（）方法移除单个控件时会

触发此事件。

当使用Map.removeOverlay（）方法移除单个覆盖物时

会触发此事件。

当使用Map.clearOverlays（）方法一次性移除全部覆

盖物时会触发此事件。

开始拖拽地图时触发。

point,pixel,overlay}

event{type,target}

event{type,

target,

point,pixel,overlay}

event{type,target}

event{type,

pixel,point}

event{type,

pixel,point}

event{type,

pixel,point}

event{type,target}

target,

拖拽地图过程中触发。

停止拖拽地图时触发。

添加一个自定义地图图层时触发此事件。

移除一个自定义地图图层时触发此事件。

6/55

XX地图API类参考

ilelaye

event{type,

target,

调用Map.centerAndZoom（）方法时会触发此事件。

这

表示位置、缩放层级已经确定，但可能还在载入地图图

块。

地图可视区域大小发生变化时会触发此事件。

load

pixel,point,zoom}

event{type,

size}

target,

resize

b）

MapOptions

此类表示Map构造函数的可选参数。

它没有构造函数，但可通过对象字面量形式表示。

属性

zoomLevelMin

zoomLevelMax

mapType

类型

Number

MapTypes

描述

设置地图显示最小缩放级别。

设置地图显示最大缩放级别。

地图类型，默认为BMAP_NORMAL_MAP

（自1.1新增）

c）

Viewport

此类代表视野，不可实例化。

属性

center

类型

Point

描述

视野中心点。

（自1.1新增）

视野级别。

（自1.1新增）

zoom

Number

d）

ViewportOptions

此类作为map.getViewport与map.setViewport方法的可选参数，不可实例化。

属性

enableAnim

ation

margins

类型

描述

是否启用动画效果移动地图，默认为true。

当调整后的级别与当前地

Boolean

图级别一致时，将使用动画效果移动地图。

（自1.1新增）

Array

视野调整的预留边距，例如：

7/55

XX地图API类参考

ber>

margins:

[30,20,0,20]

表示坐标点会限制在上述区域内。

（自1.1新增）

地图级别的偏移量，您可以在方法得出的结果上增加一个偏移值。

例

zoomFactor

Number

如map.setViewport计算出地图的级别为10，如果zoomFactor为-1，

则最终的地图级别为9。

（自1.1新增）

改变地图视野的延迟执行时间，单位毫秒，默认为200ms。

此延时仅

delay

Number

针对动画效果有效。

（自1.1新增）

e）

MapTypes

此常量表示地图展示的类型。

常量

BMAP_NORMAL_MAP

描述

此地图类型展示普通街道视图。

（自1.1新增）

此地图类型展示透视图像视图。

（自1.1新增）

BMAP_PERSPECTIVE_MAP

二、

a）

基础类

Point

此类表示一个地理坐标点。

构造函数

Point（lng:

Number,lat:

Number）

描述

以指定的经度和纬度创建一个地理点坐标。

属性

lng

lat

类型

Number

描述

地理经度。

地理纬度。

方法

equals（other:

Poi

nt）

返回值

Boolea

描述

判断坐标点是否相等，当且仅当两点的经度和纬度均相等时返回

true。

8/55

XX地图API类参考

toString（）

String

返回类型描述字符串。

b）

Pixel

此类表示地图上的一点，单位为像素。

构造函数

Pixel（x:

Number,

Number）

描述

创建像素点对象实例。

像素坐标的坐标原点为地图区域的左上角。

属性

类型

Number

描述

x坐标。

y坐标。

方法

equals（other:

Pix

el）

toString（）

值

Boolea

String

描述

判断坐标点是否相等，当且仅当两点的x坐标和y坐标均相等时

返回true。

返回类型描述字符串。

c）

Bounds

此类表示地理坐标的矩形区域。

矩形区域通过两个点的x、y坐标进行描述，其中数值较

小的点位于矩形的左下角、数值较大的点位于矩形的右上角。

构造函数

Bounds（minX:

Number,minY:

Number,maxX:

Number,

maxY:

Number）

描述

创建一个包含所有给定点坐标的矩形

区域。

属性

minX

minY

maxX

maxY

类型

Number

描述

矩形左下角的x坐标。

矩形左下角的y坐标。

矩形右上角的x坐标。

矩形右上角的y坐标。

9/55

XX地图API类参考

方法

值

Boole

Bound

none

Point

Boole

Strin

描述

当且仅当此矩形中的两点参数都等于其他矩形的两点参数

时，返回true。

如果点的地理坐标位于此矩形内，则返回true。

equals（other:

Bounds）

containsPoint（point:

oint）

containsBounds（bounds

Bounds）

intersects（other:

Boun

ds）

extend（point:

Point）

getCenter（）

isEmpty（）

传入的矩形区域完全包含于此矩形区域中，则返回true。

计算与另一矩形的交集区域。

放大此矩形，使其包含给定的点。

返回矩形的中心点。

如果矩形为空，则返回true。

toString（）

返回类型描述字符串。

d）

Size

此类以像素表示一个矩形区域的大小。

Size对象包含两个属性：

width、height，分别

表示矩形的水平方向的数值和竖直方向的数值。

属性

width

height

类型

Number

描述

水平方向数值。

竖直方向的数值。

方法

equals（other:

ze）

toString（）

值

Boolea

String

描述

当且仅当此矩形中的宽度和高度都等于其他矩形的宽度和高度时，

返回true。

返回类型描述字符串。

三、

a）

控件类

ControlNavigation

10/55

XX地图API类参考

此类是所有控件的基类，您可以通过此类来实现自定义控件。

所有控件均包含Control

类的属性、方法和事件。

通过Map.addControl（）方法可将控件添加到地图上。

构造函数

Control（）

描述

创建一个控件原型实例，通过该原型实例可创建自定义控件。

属性

defaultAnch

defaultOffs

类型

enum

ControlAnchor

Size

描述

控件默认的停靠位置。

自定义控件时需要提供此属性，作为控件的默认停靠位置。

控件默认的位置偏移值。

自定义控件时需要提供此属性，作为控件的默认偏移位置。

方法

返回值

描述

抽象方法。

调用Map.addControl（）方法添加控件时将调

initialize（map:

Map）

HTMLEleme

用此方法，从而实现该控件的初始化。

自定义控件时需要

实现此方法，并将元素的DOM元素在该方法中返回。

DOM

元素需要添加到地图的容器中，使用

map.getContainer（）方法可获得地图容器元素。

setAnchor（anchor:

umControlAnchor）

none

enum

getAnchor（）

ControlAn

chor

setOffset（offset:

ze）

getOffset（）

show（）

hide（）

isVisible（）

toString（）

none

Size

none

Boolean

String

设置控件停靠的偏移量

获取控件停靠的偏移量

显示控件

隐藏控件

判断控件的可见性

返回描述类型字符串。

如果需要，自定义控件需要自行实

现此方法以获得描述自身类型的字符串。

获取控件停靠的位置

设置控件停靠的位置

b）

ControlOptions

此类表示NavigationControl构造函数的可选参数。

它没有构造函数，但可通过对象字

11/55

XX地图API类参考

面量形式表示。

属性

anchor

offset

type

类型

enumControlAnchor

Size

enumNavigationControlType

描述

控件的停靠位置。

控件的水平偏移值。

平移缩放控件的类型。

c）

ScaleControlOptions

此类表示ScaleControl构造函数的可选参数。

它没有构造函数，但可通过对象字面量形

式表示。

属性

anchor

offset

类型

enumControlAnchor

Size

描述

控件的停靠位置。

控件的偏移值。

d）

Copyrig

展开阅读全文