My favorites | 中文(简体) | Sign in

Google Mapplet 参考

GMap2 类

GMap2 类进行实例化以创建地图。这是 API 中的中心类。其他都是辅助类。

构造函数

构造函数 说明
GMap2() 将句柄返回给主地图。

异步方法

配置

异步方法 回调值 说明
draggingEnabledAsync(callback) Boolean 当且仅当启用了地图拖动时,返回 true
infoWindowEnabledAsync(callback) Boolean 当且仅当启用了信息窗口时,返回 true
doubleClickZoomEnabledAsync(callback) Boolean 当且仅当启用了双击缩放地图时,返回 true。(自 2.58 开始)
continuousZoomEnabledAsync(callback) Boolean 如果启用了连续平滑缩放,返回 true。(自 2.58 开始)

地图类型

异步方法 回调值 说明
getMapTypesAsync(callback) GMapType 数组 返回在此地图中注册的地图类型数组。
getCurrentMapTypeAsync(callback) GMapType 返回当前选中的地图类型。
setMapType(type) 选择指定的新地图类型。类型必须是地图已知的类型。请参见构造函数和方法 addMapType()

地图状态

异步方法 回调值 说明
isLoadedAsync(callback) Boolean 当且仅当地图在创建后使用 setCenter() 进行初始化时,返回 true
getCenterAsync(callback) GLatLng 返回地图视图中心点的地理坐标。
getBoundsAsync(callback) GLatLngBounds 返回地图视图的可视矩形区域(以地理坐标表示)。
getBoundsZoomLevelAsync(bounds, callback) Number 返回指定矩形区域在地图视图中的缩放级别。缩放级别按当前选定的地图类型计算。如果尚未选定地图类型,将使用地图类型列表中列出的第一个类型。
getSizeAsync(callback) GSize 返回地图视图的大小(以像素为单位)。
getZoomAsync(callback) Number 返回当前的缩放级别。

修改地图状态

异步方法 回调值 说明
setCenter(center, zoom?, type?) 按指定的中心设置地图视图。也可以同时设置缩放级别和地图类型。地图类型必须是地图已知的类型。请参见构造函数和方法 addMapType()。必须在构造后先调用此方法,才能设置地图的初始状态。在构造后先调用地图上的其他操作是错误的。
panTo(center) 将地图的中心点更改为指定的点。如果该点已经在当前的地图视图中可见,则会以平滑动画的方式移动中心点。
panBy(distance) 以动画方式平移指定的距离(以像素为单位)。
panDirection(dx, dy) 以动画方式向指示方向平移地图宽度的一半。+1 是向右向下,-1 是向左向上。
setZoom(level) 将缩放级别设置为指定的新值。
zoomIn() 将缩放级别加 1。
zoomOut() 将缩放级别减 1。

叠加层

异步方法 回调值 说明
addOverlay(overlay) 将叠加层添加到地图中,并触发 addoverlay 事件。
removeOverlay(overlay) 从地图中删除叠加层。如果地图上有叠加层,则会触发 removeoverlay 事件。
clearOverlays() 从地图中删除所有叠加层,并触发 clearoverlays 事件。

信息窗口

异步方法 回调值 说明
openInfoWindow(point, node, opts?) 在指定点处打开一个简单的信息窗口。平移地图,使得打开的信息窗口完全可见。信息窗口的内容为 DOM 节点。
openInfoWindowHtml(point, html, opts?) 在指定点处打开一个简单的信息窗口。平移地图,使得打开的信息窗口完全可见。信息窗口的内容为 HTML 文本。
openInfoWindowTabs(point, tabs, opts?) 在指定点处打开一个带标签的信息窗口。平移地图,使得打开的信息窗口完全可见。信息窗口的内容为 DOM 节点。
openInfoWindowTabsHtml(point, tabs, opts?) 在指定点处打开一个带标签的信息窗口。平移地图,使得打开的信息窗口完全可见。信息窗口的内容为 HTML 文本。
showMapBlowup(point, opts?) 在指定的点打开信息窗口,它包含地图上该点附近的近景视图。
closeInfoWindow() 关闭当前打开的信息窗口。
getInfoWindowAsync(callback) GInfoWindow 返回此地图的信息窗口对象。如果还没有信息窗口,将创建一个信息窗口,但不显示它。此操作不受 enableInfoWindow() 影响。

坐标变换

异步方法 回调值 说明
fromLatLngToDivPixelAsync(latlng, callback) GPoint 计算指定地理位置在含有可拖动地图的 DOM 元素中的像素坐标。将 GOverlay.redraw() 方法用于自定义叠加层时,需要用此方法定位自定义叠加层。
fromDivPixelToLatLngAsync(pixel, callback) GLatLng 根据含有可拖动地图的 div 中的像素坐标计算地理坐标。实现与自定义叠加层的交互时需要使用此方法。
fromContainerPixelToLatLngAsync(pixel, callback) GLatLng 在含有页面地图的 DOM 元素中计算指定像素坐标点的地理坐标。实现自定义控件与地图的交互时需要使用此方法。

事件

事件 参数 说明
addmaptype type 向地图中添加地图类型时会触发此事件。
removemaptype type 从地图中删除地图类型时会触发此事件。
click overlay, point 用鼠标点击地图时会触发此事件。如果点击了某个标记,则该标记将通过 overlay 参数传递到事件处理程序,并且还在标记上触发 click 事件。否则,被点击点的地理坐标将通过 point 参数传递。
dblclick overlay, point 双击地图时会触发此事件。注意,双击标记时不触发此事件。被双击的点的地理坐标将被传递到 point 参数中。overlay 参数始终设置为 null。(自 2.83 开始)
movestart 地图视图开始更改时会触发此事件。拖动操作或调用更改地图视图的方法时也会触发此事件,前者还同时触发 dragstart 事件。
moveend 结束地图视图的更改时会触发此事件。
zoomend oldLevel, newLevel 地图到达新的缩放级别时会触发此事件。事件处理程序接收先前缩放级别和新缩放级别作为参数。
maptypechanged 选择其他地图类型时会触发此事件。
infowindowopen 打开信息窗口时会触发此事件。
infowindowclose 关闭信息窗口时会触发此事件。此事件在触发前会触发 infowindowbeforeclose 事件。如果通过再次调用 openInfoWindow*() 在其他点重新打开当前已打开的信息窗口,则会先后触发 infowindowbeforecloseinfowindowcloseinfowindowopen 事件。
addoverlay overlay 当使用 addOverlay() 方法向地图中添加单个叠加层时会触发此事件。新的叠加层将作为参数 overlay 传递到事件处理程序中。
removeoverlay overlay 当使用 removeOverlay() 方法删除单个叠加层时会触发此事件。删除的叠加层将作为参数 overlay 传递到事件处理程序中。
clearoverlays 当使用 clearOverlays() 方法一次性删除全部叠加层时会触发此事件。
dragstart 当用户开始拖动地图时会触发此事件。
dragend 当用户停止拖动地图时会触发此事件。

GInfoWindow 类

GInfoWindow 不包含构造函数。它是由地图创建的,可使用 GMap2.getInfoWindowAsync(callback: Function) 方法进行访问。

异步方法

异步方法 回调值 说明
selectTab(index) 选择指定索引对应的标签。它的效果等同于点击相应标签。
hide() 隐藏信息窗口。注意:这不会关闭信息窗口。使用 show() 可重新显示信息窗口。
show() 如果信息窗口当前处于隐藏状态,则可显示信息窗口。
isHiddenAsync() Boolean 当且仅当信息窗口处于隐藏状态时,返回 true。关闭的信息窗口视为隐藏。
reset(point, tabs, size, offset?, selectedTab?) 重置信息窗口的状态。每个参数都可能为 null,因此其值仍将保持为当前值。
getPointAsync() GLatLng 返回信息窗口锚定位置的地理坐标。窗口的箭头指向地图中的该点(对像素偏移取整)。
getPixelOffsetAsync() GSize 返回信息窗口的箭头距离信息窗口在地图上所锚定的地理坐标点的像素偏移量。
getSelectedTabAsync() Number 返回当前选定的标签的索引(从 0 开始)。

事件

事件 参数 说明
closeclick 点击信息窗口关闭按钮时会触发此事件。此事件的事件处理程序可通过调用 GMap2.closeInfoWindow() 方法实现关闭信息窗口的操作。

GInfoWindowTab 类

此类的实例数组可作为 tabs 参数传递至方法 GMap2.openInfoWindowTabs()GMap2.openInfoWindowTabsHtml()GMarker.openInfoWindowTabs()GMarker.openInfoWindowTabsHtml()bindInfoWindow*() 变量。如果数组包含多个元素,则将显示带有标签的信息窗口。每个 InfoWindowTab 对象都包含两个项目:content 定义选中标签时信息窗口的内容,label 定义标签的标签。这些属性将作为参数传递到构造函数中。对于 openInfoWindowTabs() 方法,content 为 DOM 节点。对于 openInfoWindowTabsHtml() 方法,content 为包含 HTML 文字的字符串。

构造函数

构造函数 说明
GInfoWindowTab(label, content) 创建一个可以在 tabs 参数中传递到 openInfoWindowTabs*() 方法的信息窗口标签数据结构。

GInfoWindowOptions 类

此类的实例可用于类 GMap2GMarker 的方法 openInfoWindow()openInfoWindowHtml()openInfoWindowTabs()openInfoWindowTabsHtml()bindInfoWindow*()showMapBlowup()opts? 参数中。此类不存在构造函数。但是,此类可以实例化为 javascript 对象常量。

属性

正如此类的名称所示,所有属性都是可选的。

属性 类型 说明
disableGoogleLinks Boolean 取消自动追加在信息窗口底部的行车路线和本地搜索的 Google 链接。
selectedTab Number 选择指定索引(从 0 开始)对应的标签,而不是索引 0 对应的第一个标签。
maxWidth Number 信息窗口内容的最大宽度(以像素为单位)。
zoomLevel Number 仅限于 showMapBlowup()。信息窗口中放大地图的缩放级别。
mapType GMapType 仅限于 showMapBlowup()。信息窗口中放大地图的地图类型。

GMarker 类

GMarker 标记地图上的位置。它实现 GOverlay 接口,因此可使用 GMap2.addOverlay() 方法添加到地图中。

标记对象包含 point(这是标记在地图中锚定的地理位置)和 icon。如果未在构造函数中设置 icon,则会使用默认图标 G_DEFAULT_ICON

将标记对象添加到地图中后,通过标记可打开该地图的信息窗口。标记对象会触发鼠标事件和信息窗口事件。

构造函数

构造函数 说明
GMarker(point, icon?, inert?) 在传递的 GPointGLatLngpoint 上创建带有 iconG_DEFAULT_ICON 的标记。如果 inert 标记为 true,则标记不可点击,也不会触发任何事件。(自 2.50 开始不推荐使用)
GMarker(latlng, opts?) GMarkerOptions 中指定的选项在 latlng 创建标记。(自 2.50 开始)

异步方法

将标记添加到地图中后,才能调用这些方法。

异步方法 回调值 说明
openInfoWindow(content, opts?) 通过标记图标打开地图信息窗口。信息窗口的内容为 DOM 节点。只适用于 GInfoWindowOptions.maxWidth 选项。
openInfoWindowHtml(content, opts?) 通过标记图标打开地图信息窗口。信息窗口的内容显示为包含 HTML 文本的字符串。只适用于 GInfoWindowOptions.maxWidth 选项。
openInfoWindowTabs(tabs, opts?) 通过标记图标打开带标签的地图信息窗口。信息窗口的内容显示为标签数组,这些标签以 DOM 节点的形式包含标签内容。只适用于 GInfoWindowOptions.maxWidthInfoWindowOptions.selectedTab 选项。
openInfoWindowTabsHtml(tabs, opts?) 通过标记图标打开带标签的地图信息窗口。信息窗口的内容显示为标签数组,这些标签以包含 HTML 文本的字符串形式包含标签内容。只适用于 InfoWindowOptions.maxWidthInfoWindowOptions.selectedTab 选项。
bindInfoWindow(content, opts?) 将指定的 DOM 节点绑定到此标记。当点击标记时,这些内容将自动显示在信息窗口中。将 null 作为 content 传递来解除绑定。
bindInfoWindowHtml(content, opts?) 将指定的 html 绑定到此标记。当点击标记时,这些内容将自动显示在信息窗口中。将 null 作为 content 传递来解除绑定。
bindInfoWindowTabs(tabs, opts?) 将指定的标签绑定到此标记。当点击标记时,这些内容将自动显示在信息窗口中。将 null 作为 content 传递来解除绑定。
bindInfoWindowTabsHtml(tabs, opts?) 将指定的标签绑定到此标记。当点击标记时,这些内容将自动显示在信息窗口中。将 null 作为 content 传递来解除绑定。
closeInfoWindow() 仅关闭属于此标记的信息窗口。
showMapBlowup(opts?) 通过标记图标打开地图信息窗口。信息窗口的内容是标记位置周围的近景地图。只适用于 InfoWindowOptions.zoomLevelInfoWindowOptions.mapType 选项。
getIconAsync(callback) GIcon 根据构造函数的设置返回此标记的 icon
getPointAsync(callback) GLatLng 根据构造函数或 setPoint() 的设置返回此标记锚定点的地理坐标。
setPoint(point) 设置此标记的锚定点的地理坐标。
enableDragging() 允许在地图上拖放标记。该方法只有在已经用 GMarkerOptions.draggable = true 初始化标记的情况下才生效。
disableDragging() 禁止在地图上拖放标记。
draggableAsync(callback) Boolean 如果标记可拖动,则返回 true。
draggingEnabledAsync(callback) Boolean 如果标记已启用拖动,则返回 true。
setImage(url) 请求将 url 指定的图像设置为此标记的前景图。请注意,不会调整打印图像和阴影图像。因此,此方法主要是为了达到高亮显示或变暗显示效果,而不是彻底改变标记的外观。(自 2.75 开始)
hide() 如果标记当前可见,则隐藏标记。请注意,如果标记当前可见,则此函数会触发 GMarker.visibilitychanged 事件。(自 2.77 开始)
show() 如果标记当前不可见,则显示标记。请注意,如果标记当前不可见,则此函数会触发 GMarker.visibilitychanged 事件。(自 2.77 开始)
isHiddenAsync(callback) Boolean 如果标记当前不可见,则返回 true。否则返回 false。(自 2.77 开始)

事件

只有当标记处于活动状态时,才会触发上述所有事件(请参见构造函数)。

事件 参数 说明
click 点击标记图标后会触发此事件。注意:同时还会使地图触发此事件,将标记作为第一个参数传递到那里的事件处理程序中。
dblclick 双击标记图标后会触发此事件。请注意,不会使地图触发此事件,因为地图双击时居中是固定行为。。
infowindowopen 当通过此标记打开地图的信息窗口时会触发此事件。
infowindowclose 关闭通过此标记打开的地图信息窗口时会触发此事件。关闭信息窗口或在其他标记或地图上打开信息窗口时都会发生此事件。此事件在触发前会触发 infowindowbeforeclose 事件。
remove 使用 GMap2.removeOverlay()GMap2.clearOverlays() 从地图删除标记时会触发此事件。
dragstart 如果启用了拖动标记,则在开始拖动标记时会触发此事件。
dragend 如果启用了拖动标记,则在停止拖动标记时会触发此事件。
visibilitychanged isVisible 当标记的可见性发生更改时会触发此事件(即可见性从可见更改为隐藏时,或从隐藏更改为可见时)。isVisible 指发生可见性更改后标记的状态。(自 2.77 开始)

GMarkerOptions 类

此类的实例可用于 GMarker 类构造函数的 opts? 参数中。此类不存在构造函数。但是,此类可以实例化为 javascript 对象常量。

属性

正如此类的名称所示,所有属性都是可选的。

属性 类型 说明
icon GIcon 为此类选择图标。如果未指定,则使用 G_DEFAULT_ICON。(自 2.50 开始)
dragCrossMove Boolean 正常拖动标记时,标记将浮起并离开光标。将此值设置为 true 可以保持标记位于光标的下面,用十字光标下移代替标记浮起。此选项的默认值为 false。(自 2.63 开始)
title String 此字符串显示为标记的工具提示,即它的作用等同于 HTML 元素中的 title 属性。(自 2.50 开始)
clickable Boolean 切换标记是否可点击。不可点击或拖动的标记是不活动的,它消耗的资源较少但不对任何事件作出响应。此选项的默认值为 true,即未指定该选项时,标记是可点击的。(自 2.50 开始)
draggable Boolean 切换以选择用户是否可拖动标记。设置为可拖动的标记比设置为可点击的标记所需的资源更多。任意可拖动标记拖动结束后默认可点击并有弹跳效果。此选项的默认值为 false。(自 2.61 开始)
bouncy Boolean 切换拖动完标记后是否应上下弹动。此选项的默认值为 false。(自 2.61 开始)
bounceGravity Number 此数字用于定义完成拖动操作时标记在弹到地面期间的加速度。此选项的默认值为 1。(自 2.61 开始)

GPolyline 类

这是一种使用浏览器的矢量制图工具(如果可用)在地图上绘制折线的地图叠加层,或者是来自 Google 服务器的图像叠加层。

构造函数

构造函数 说明
GPolyline(points, color?, weight?, opacity?, opts?) 根据顶点数组创建折线。color 是一个字符串,包含十六进制数字、HTML 样式的颜色,如 #RRGGBB。weight 是以像素为单位的线宽度。opacity 为 0 到 1 之间的数字。该线条平滑且半透明。

异步方法

异步方法 回调值 说明
getVertexCountAsync(callback) Number 返回折线中顶点的数目。(自 2.46 开始)
getVertexAsync(index, callback) GLatLng 返回折线中指定索引对应的顶点。(自 2.46 开始)
getLengthAsync(callback) Number 返回沿地球表面的折线的长度(以米为单位)。(自 2.85 开始)
getBoundsAsync(callback) GLatLngBounds 返回此折线的边界。(自 2.85 开始)

事件

事件 参数 说明
remove 使用 GMap2.removeOverlay()GMap2.clearOverlays()从地图删除折线时会触发此事件。

GPolylineOptions 类

此类的实例用于 GPolyline 的构造函数中。此类不存在构造函数。但是,此类可以实例化为 javascript 对象常量。

属性

正如此类的名称所示,所有属性都是可选的。

属性 类型 说明
geodesic Boolean 将折线的每个边绘制为测地线。这是地球表面上两点间最短的距离。

GPolygon 类

除了可另外指定填充色和不透明性外,其他方面都非常类似于 GPolyline

构造函数

构造函数 说明
GPolygon(points, strokeColor?, strokeWeight?, strokeOpacity?, fillColor?, fillOpacity?) 根据顶点数组创建多边形。colors 是一个字符串,包含十六进制数字、HTML 样式的颜色,如 #RRGGBB。weight 是以像素为单位的线宽度。opacities 为 0 到 1 之间的数字。该线条平滑且半透明。(自 2.69 开始)

异步方法

异步方法 回调值 说明
getVertexCountAsync(callback) Number 返回多边形中的顶点数。(自 2.69 开始)
getVertexAsync(index, callback) GLatLng 返回多边形中指定索引对应的顶点。(自 2.69 开始)
getAreaAsync(callback) Number 返回以平方米为单位的多边形面积(假定地球是一个球形)。(自 2.46 开始)
getBoundsAsync(callback) GLatLngBounds 返回此多边形的边界。(自 2.85 开始)

事件

事件 参数 说明
remove 使用 GMap2.removeOverlay()GMap2.clearOverlays() 从地图删除多边形时会触发此事件。

GGroundOverlay 类

此对象可在地图中创建矩形图像叠加层,其边界由 GLatLngBounds 定义。

构造函数

构造函数 说明
GGroundOverlay(imageUrl, bounds)

GIcon 类

指定用来在地图上显示 GMarker 的图像的图标。由于浏览器兼容性的原因,要指定一个图标实际上相当复杂。请注意,如果不想指定自己的图标,则可使用默认 Google 地图图标 G_DEFAULT_ICON

构造函数

构造函数 说明
GIcon(copy?, image?) 创建新图标对象。如果可选的 copy 参数中给出另一个图标,则将复制其属性,否则将留为空白。可选的参数 image 可设置 image 属性的值。

常数

常数 说明
G_DEFAULT_ICON 标记使用的默认图标。

属性

属性 类型 说明
image String 图标的前景图像网址。
shadow String 图标的阴影图像网址。
iconSize GSize 图标前景图像的像素大小。
shadowSize GSize 阴影图像的像素大小。
iconAnchor GPoint 此图标在地图上的锚定点相对于图标图像左上角的像素坐标。
infoWindowAnchor GPoint 信息窗口在此图标上的锚定点相对于图标图像左上角的像素坐标。
printImage String 打印地图所用的前景图标图像网址。其大小必须与 image 提供的主图标图像的大小相同。
mozPrintImage String 用 Firefox/Mozilla 打印地图时所用的前景图标图像网址。其大小必须与 image 提供的主图标图像的大小相同。
printShadow String 打印地图时所用的阴影图像网址。由于大多数浏览器都无法打印 PNG 图像,所以图像格式应该为 GIF。
transparent String 在 Internet Explorer 中捕获点击事件时,所用的透明前景图标图像网址。此图像应是具有 1% 不透明度的 24 位 PNG 格式的主图标图像,但其大小和形状同主图标相同。
imageMap 数组 表示图像地图 x/y 坐标的整数数组,用它指定浏览器(非 Internet Explorer)中图标图像的可点击部分。
maxHeight Integer 指定拖动标记时视觉上垂直“上升”的距离(以像素为单位)。(自 2.79 开始)
dragCrossImage String 指定拖动图标时十字交叉图像的网址。(自 2.79 开始)
dragCrossSize GSize 指定拖动图标时十字交叉图像的像素大小。(自 2.79 开始)
dragCrossAnchor GPoint 指定拖动图标时十字交叉图像的像素坐标偏移量(相对于 iconAnchor)。(自 2.79 开始)

GPoint 类

GPoint 是以像素坐标表示的地图上的一点。注意:在 v2 中,它不再是以地理坐标表示的地面上的一个点。现在,地理坐标可以用 GLatLng 表示。

在地图坐标系统中, x 坐标向左增大,y 坐标向下增大。

注意:尽管 GPoint 的两个参数可以作为属性 xy 访问,但是请勿修改它们,而是在创建新对象时使用不同的参数。

构造函数

构造函数 说明
GPoint(x, y) 创建 GPoint 对象。

属性

属性 类型 说明
x Number x 坐标,向左增大。
y Number y 坐标,向下增大。

方法

方法 返回值 说明
equals(other) Boolean 当且仅当其他点有相等的坐标时,返回 true
toString() String 返回包含 x 和 y 坐标的字符串,先 x 坐标后 y 坐标,之间用逗号分隔。

GSize 类

GSize 是地图矩形区域的大小(以像素为单位)。大小对象有两个参数:widthheight。宽度是点的 x 坐标的差值,高度是 y 坐标的差值。

注意:尽管 GSize 的两个参数可以作为属性 widthheight 访问,但是请勿修改它们,而是在创建新对象时使用不同的参数。

构造函数

构造函数 说明
GSize(width, height) 创建 GSize 对象。

属性

属性 类型 说明
width Number 宽度参数。
height Number 高度参数。

方法

方法 返回值 说明
equals(other) Boolean 当且仅当其他大小都完全相同时,返回 true
toString() String 返回包含宽度和高度的字符串,先宽度后高度,之间用逗号分隔。

GBounds 类

GBounds 是以像素坐标表示的地图矩形区域。请注意,地理坐标中的矩形可用 GLatLngBounds 对象表示。

构造函数

构造函数 说明
GBounds(points) 构造一个包含所有指定 points 的矩形。

属性

属性 类型 说明
minX Number 矩形左边的 x 坐标。
minY Number 矩形上边的 y 坐标。
maxX Number 矩形右边的 x 坐标。
maxY Number 矩形下边的 y 坐标。

方法

方法 返回值 说明
toString() String 返回包含框的左上角点坐标和右下角点坐标的字符串,先左上后右下,中间用逗号分隔,前后用圆括号括起来。
min() GPoint 方框左上角的点。
max() GPoint 方框右下角的点。
containsBounds(other) Boolean 当且仅当其他框完全包含在此框中时,返回 true
extend(point) 放大此框,以便使该点也包括在框中。
intersection(other) GBounds 返回两个框的重叠部分。如果没有重叠,则返回空框。

GLatLng 类

GLatLng 是以经度和纬度表示的地理坐标点。

请注意,尽管进行地图投影时通常将经度与 x 坐标相关联,将纬度与 y 坐标相关联,但总是先填写纬度坐标,后填写经度坐标,因为这符合绘图习惯。

另请注意,不能修改 GLatLng 的坐标。如果想要计算另一个点,必须新建一个。

构造函数

构造函数 说明
GLatLng(lat, lng, unbounded?) 注意纬度和经度的顺序。如果 unbounded 标记为 true,则传递时会使用数字,否则纬度将会限定在 -90 度和 +90 度之间,而经度将会限定在 -180 度和 +180 度之间。

方法

方法 返回值 说明
lat() Number 返回以度数表示的纬度坐标(-90 到 +90 之间的数字)。如果在构造函数中设置了 unbounded 标记,则纬度坐标可能超出此范围。
lng() Number 返回以度数表示的经度坐标(-180 到 +180 之间的数字)。如果在构造函数中设置了 unbounded 标记,则经度坐标可能超出此范围。
latRadians() Number 返回以弧度为单位的纬度坐标(-PI/2 到 +PI/2之间的数字)。如果在构造函数中设置了 unbounded 标记,则纬度坐标可能超出此范围。
lngRadians() Number 返回以弧度表示的经度坐标(-PI 到 +PI 之间的数字)。如果在构造函数中设置了 unbounded 标记,则经度坐标值可能超出此范围。
equals(other) Boolean 当且仅当另一大小的分量相同(在一定的舍入范围内)时返回 true
distanceFrom(other) Number 返回从此点到某个指定点的距离(以米为单位)。地球近似一个球体,因此距离可能会有不会超过 0.3% 的误差。
toUrlValue() String 不推荐使用此版本的方法,而使用能传递可选 precision 参数的修订版方法(如下所示)。(自 2.78 开始不建议使用)
toUrlValue(precision?) String 返回表示此点的字符串,采用适合用作网址参数值的格式,中间用逗号分隔且不含空格。默认情况下,精确度的返回值为 6 位数字,相当于 4 英寸/11 厘米的分辨率。可选的 precision 参数可让您指定更低的精确度以减轻服务器负载。注意:在 2.78 之前,此 precision 参数不可用。(自 2.78 开始)

属性

这些属性只是用来实现与 v1 事件处理程序函数的向后兼容。不应使用它们。

这些属性反映 lng()lat() 存取器方法的返回值,还可在 v1 客户端期望的 GPoint 位置显示 GLatLng。如果要使 GLatLng 出现在事件明细中(即出现在事件处理程序函数的参数中),这是必需的。与方法包装器不同,在当前的基础框架中不可创建事件包装器。

属性 类型 说明
x Number 不建议使用。
y Number 不建议使用。

GLatLngBounds 类

GLatLngBounds 实例在地理坐标中代表矩形,包括与 180 度子午线相交的矩形。

构造函数

构造函数 说明
GLatLngBounds(sw?, ne?) 根据西南角和东北角两个点构建矩形。

方法

方法 返回值 说明
equals(other) Boolean 当且仅当此矩形中的所有参数都等于其他矩形的参数(在一定的舍入范围内)时,返回 true
contains(latlng) Boolean 当且仅当该点的地理坐标位于此矩形内时,返回 true
intersects(other) Boolean 如名所述。
containsBounds(other) Boolean 如名所述。
extend(latlng) 放大此矩形,使其包含指定的点。沿经线方向的两种可能的放大方式中,按较小的那种方式放大。如果两者相等,则放大东部的边界。
getSouthWest() GLatLng 返回矩形西南角的点。
getNorthEast() GLatLng 返回矩形东北角的点。
toSpan() GLatLng 返回 GLatLng,其坐标值表示此矩形的大小。
isFullLat() Boolean 如果此矩形从南极延伸到北极,则返回 true
isFullLng() Boolean 如果此矩形沿经线方向环绕地球一周,则返回 true
isEmpty() Boolean 如果此矩形为空,则返回 true。
getCenter() GLatLng 返回矩形的中心点。(自 2.52 开始)

GTileLayer 类

此类接收一个根据每个图块请求展开的图块网址模板。例如,'http://host/tile?x={X}&y={Y}&z={Z}.png', 将变成 'http://host/tile?x=3&y=27&z=5.png'.,{Z} 可以将“缩放”选择表示为 {V1_Z},这表示“使用地图 API 版本 1 进行缩放命名惯例”,其中 17 是最大程度的缩小(全世界在一个图块中),而缩放 0 为街道级别。实际上,{V1_Z} = 17 - {Z}。

构造函数

构造函数 说明
GTileLayer(null, minResolution, maxResolution, opts) opts.tileUrlTemplate 必须如上所述是一个有效的网址模板。

GTileLayerOverlay 类

GTileLayerOverlay 通过 GTileLayer 放大地图。它实现 GOverlay 接口,因此可使用 GMap2.addOverlay() 方法添加到地图中。

构造函数

构造函数 说明
GTileLayerOverlay(tileLayer) 创建封装 GTileLayerOverlaytileLayer。(自 2.61 开始)

异步方法

异步方法 回调值 说明
hide() 隐藏此叠加层使之不可见,但保留它在叠加层堆栈中的位置。(自 2.71 开始)
show() 显示先前不可见的 TileLayerOverlay。(自 2.71 开始)
getTileLayerAsync() 返回此叠加层所使用的图块层。(自 2.83 开始)

namespace GEvent

此命名空间包含的函数可用于注册事件处理程序(既处理自定义事件也处理 DOM 事件)和触发自定义事件。此 API 定义的所有事件都是由 GEvent.trigger() 内部触发的自定义事件。

静态方法

静态方法 返回值 说明
addListener(source, event, handler) GEventListener 为源对象的自定义事件注册事件处理程序。返回一个可用于最终注销处理程序的句柄。可使用源对象的 this 集合调用事件处理程序。
addDomListener(source, event, handler) GEventListener 为源对象的 DOM 事件注册事件处理程序。源对象必须为 DOM 节点。返回一个可用于最终注销处理程序的句柄。可使用源对象的 this 集合调用事件处理程序。此函数将 DOM 方法用于当前浏览器来注册事件处理程序。
removeListener(handle) 删除使用 addListener()addDomListener() 安装的处理程序。
clearListeners(source, event) 删除使用 addListener()addDomListener() 在指定对象上为指定事件安装的所有处理程序。
clearInstanceListeners(source) 删除使用 addListener()addDomListener() 在指定对象上为所有事件安装的所有处理程序。
trigger(source, event, ...) 触发源对象上的自定义事件。在将 event 作为参数轮流传递到事件处理程序函数后所有剩余的可选参数。
bind(source, event, object, method) GEventListener 将指定对象的方法调用注册为源对象自定义事件的事件处理程序。返回一个可用于最终注销处理程序的句柄。
bindDom(source, event, object, method) GEventListener 将指定对象的方法调用注册为源对象自定义事件的事件处理程序。返回一个可用于最终注销处理程序的句柄。
callback(object, method) Function 返回调用 object 上的 method 的闭包。
callbackArgs(object, method, ...) 函数 返回调用 object 上的 method 的闭包。返回的函数被调用时,会将 method 后的所有其他可选参数作为参数 method 依次传递。

事件

事件 参数 说明
clearlisteners event? 调用对象上的 clearListeners()clearInstanceListeners() 时,会在该对象上触发此事件。当然,在执行函数前也会触发该事件。

GEventListener 类

此类是不透明的。它不包含方法和构造函数。从 GEvent.addListener()GEvent.addDomListener() 返回其实例并最终传递回 GEvent.removeListener()

enum GGeoStatusCode

在圆括号中指定每个符号常数对应的数值。

常数

常数 说明
G_GEO_SUCCESS (200) 未出现错误,已对地址成功地进行了解析,并返回其地址解析。(自 2.55 开始)
G_GEO_BAD_REQUEST (400) 无法成功解析行车路线请求。(自 2.81 开始)
G_GEO_SERVER_ERROR (500) 无法成功处理地址解析或行车路线请求,但是确切的失败原因未知。(自 2.55 开始)
G_GEO_MISSING_QUERY (601) HTTP q 参数缺失或没有值。对于地址解析请求,这意味着将空地址指定为输入。对于行车路线请求,这意味着输入中未指定查询。(自 2.81 开始)
G_GEO_MISSING_ADDRESS (601) G_GEO_MISSING_QUERY 的同义名。(自 2.55 开始)
G_GEO_UNKNOWN_ADDRESS (602) 找不到指定地址的对应地理位置。这可能是地址较新,或地址不正确。(自 2.55 开始)
G_GEO_UNAVAILABLE_ADDRESS (603) 由于合法性或合同原因,无法返回指定地址的地址解析或指定行车路线查询的路线。(自 2.55 开始)
G_GEO_UNKNOWN_DIRECTIONS (604) Gdirections 对象无法计算查询中提到的两点之间的行车路线。这通常是因为两点之间无可用路线,或我们没有该地区的路线数据。(自 2.81 开始)
G_GEO_BAD_KEY (610) 指定的密钥无效或与指定的域不匹配。(自 2.55 开始)

enum GGeoAddressAccuracy

未为此枚举定义符号常数。

常数

常数 说明
0 未知的地点。(自 2.59 开始)
1 国家级准确度。(自 2.59 开始)
2 地区(省/自治区/直辖市、辖区等)级准确度。(自 2.59 开始)
3 子地区(县、市等)级准确度。(自 2.59 开始)
4 城镇(城市、村镇)级准确度。(自 2.59 开始)
5 邮政编码级准确度。(自 2.59 开始)
6 街道级准确度。(自 2.59 开始)
7 十字路口级准确度。(自 2.59 开始)
8 地址级准确度。(自 2.59 开始)

GClientGeocoder 类

此类用于与 Google 服务器直接通信,以获取用户指定地址的地址解析。另外,地址解析器可维护自己的地址缓存,可以无需往返于服务器而回答重复的查询。

构造函数

构造函数 说明
GClientGeocoder() 创建地址解析器的新实例,直接与 Google 服务器对话。(自 2.55 开始)

异步方法

异步方法 回调值 说明
getLatLngAsync(address, callback) GLatLng 向 Google 服务器发送请求,对指定的地址进行地址解析。如果成功定位了该地址,则用 GLatLng 点调用用户指定的回调函数。否则,向回调函数提供一个 null 点。如果地址不明确,则仅向回调函数传递最匹配的点。(自 2.55 开始)
getLocationsAsync(address, callback) JSON 向 Google 服务器发送请求,对指定的地址进行地址解析。包含状态代码的答复,如果答复成功,则向用户指定的回调函数传递一个或多个 Placemark 对象。与 GClientGeocoder.getLatLng 方法不同,回调函数可以通过检查 Status 字段的代码值确定失败的原因。(自 2.55 开始)

GGeoXml 类

GGeoXml 对象将可公开访问的网络服务器上托管的 XML 文件(如 KML 文件)中的地理内容添加到地图上。它实现 GOverlay 接口,因此可使用 GMap2.addOverlay() 方法添加到地图中。

构造函数

构造函数 说明
GGeoXml(urlOfXml, opt_callback) 创建表示该 XML 文件的 GOverlay。当 GGeoXml 对象完成加载 XML 文件时会调用可选的回调函数。(自 2.76 开始)

函数 GAsync

并行提出多个异步请求的实用工具函数。它收集结果并将其传递到您提供的单个回调函数中。例如,要获得 map 的当前缩放级别,请对 point 执行坐标变换获得 marker 的位置:

GAsync( map, 'getZoom', 'fromContainerPixelToLatLng', [ point ], marker, 'getPoint', function(zoom, pointA, pointB) { ... });

异步方法

异步方法 回调值 说明
GAsync(...) ... 执行一个或多个并行的异步请求。参数的格式为:(object1, methodName1 [, 可选的参数数组], methodName2 [, 可选的参数数组], ..., object2, methodName3 [, 可选的参数数组], ..., 回调) 每个异步请求返回的值按照它们的方法名在此函数中的显示顺序传递给回调函数。

GDirections 类

此类用于获取行车路线的结果,并将它显示在地图上和/或文本面板中。

构造函数

构造函数 说明
GDirections(map?) 创建行车路线对象的新实例,以请求和存储行车路线的结果。如果使用 GDirections.load() 方法进行查询,则此行车路线对象可创建行车路线。构造函数采用可选的地图对象(显示计算出的行车路线的折线)和/或面板 DIV 元素(以文本形式显示行车路线结果)。如果传递了 map 参数,则只要计算出新的行车路线结果,与结果关联的折线和标记就会作为叠加层自动添加到地图上。来自地图 API 的 panel 参数在 Mapplet API 中不受支持。此外,该对象还包含三个事件侦听器,可以截获“load”:当通过 GDirections.load() 发布的行车路线查询的结果可用时,会触发此事件。注意,load() 方法会启动一个新的查询,该查询一旦完成加载又会触发一个“load”事件。将任何叠加层元素添加到地图/面板之前都会触发“load”事件。“addoverlay”:在将折线和/或文本格式的行车路线组件添加到地图和/或 DIV 元素之后会触发此事件。注意:如果两个元素均不与 GDirections 对象关联,则不会触发“addoverlay”事件。“error”:如果行车路线请求导致错误,则触发此事件。调用者可以使用 GDirections.getStatusAsync() 获取有关该错误的详细信息。发生“error”事件时,不会触发“load”或“addoverlay”事件。(自 2.87 开始)

异步方法

异步方法 回调值 说明
load(query, queryOpts?) 此方法将发布新的行车路线查询。query 参数为字符串,包含所有有效的行车路线查询,例如,“从西雅图到旧金山”或“从多伦多到渥太华到纽约”。默认情况下,如果在构造 GDirections 对象时指定了地图,则该查询将请求折线结果。否则,结果会只包含已找到的路线的摘要信息。要覆盖此行为(即使未将地图添加到此对象,也可请求折线信息),调用者可使用 queryOpts 可选参数。有关详细信息,请参见 GDirectionsOptions 文档。收到行车路线结果时,此对象会清除旧结果,代之以新结果并用新结果更新地图。行车路线结果由多条路线组成(GRoute 类型的对象),查询中指定的每个连续路标/地址对都有一条路线。而路线又由多个路段组成(GStep 类型的对象)。如果在重新调用 load() 时还未完成前一 load() 请求,则取消先前的请求。因此,可以使用单个 GDirections 对象连续发布行车路线请求,但要并行生成多个请求则必须使用多个 GDirections 对象。(自 2.87 开始)
loadFromWaypoints(waypoints, queryOpts?) 使用路标数组(而不是单一查询字符串)作为输入来发布新的行车路线查询。数组中的每一项都是一个表示输入地址或(纬度,经度)点的字符串。有关此方法行为的详细信息,请参见 GDirections.load()。(自 2.87 开始)
clear() 清除所有现有的行车路线结果,从地图和面板中删除叠加层,并取消所有未决 load() 请求。(自 2.87 开始)
getStatusAsync() Object 返回行车路线请求状态。返回的对象采用以下格式:{   code: 200   request: "directions" } 状态代码可以采用在 GGeoStatusCode 中定义的任意值。(自 2.87 开始)
getBoundsAsync() GLatLngBounds 此方法用于获取此行车路线查询结果的边界框。如果无法获得成功的结果,则返回 GLatLngBounds 对象或 null。(自 2.87 开始)
getNumRoutesAsync() Number 返回结果中可用的路线数目。对于成功的查询,该数目应该是输入路标总数减 1。当没有可用结果时(因为未发布查询或先前的查询失败),此方法返回 0。(自 2.87 开始)
getRouteAsync(i) GRoute 在响应中返回第 i 条路线的 GRoute 对象。(自 2.87 开始)
getNumGeocodesAsync() Number 返回结果中可用的地址解析项的数目。对于成功的查询,此数目应等于输入路标的总数目。当不存在可用结果时(因为未发布查询或先前的查询失败),此方法返回 0。(自 2.87 开始)
getGeocodeAsync(i) Object 返回第 i 个路标的地址解析结果。此对象的结构与 GClientGeocoder 对象的响应中单个地标的结构相同。(自 2.87 开始)
getCopyrightsHtmlAsync() String 返回 HTML 字符串,它包含此结果的版权信息。(自 2.87 开始)
getSummaryHtmlAsync() String 返回包含对整个行车路线请求的距离和时间的概述的 HTML 代码段。注意,此摘要是返回给构造时无关联地图或 DIV 元素的 GDirections 对象的唯一信息。(自 2.87 开始)
getDistanceAsync() Object 返回一个表示行车路线请求总距离(跨所有路线)的对象常量。对象包含两个字段:一个是称为“meters”的数字,表示距离的数值(以米为单位);一个是称为“html”字符串,包含本地化的距离字符串表示(以此行车路线组合的出发国家/地区的通用度量单位为单位)。(自 2.87 开始)
getDurationAsync() Object 返回一个表示行车路线请求总时间(跨所有路线)的对象常量。对象包含两个字段:一个是称为“seconds”的数字,表示时间的数值(以秒为单位),另一个是称为“html”的字符串,包含时间的本地化字符串表示。(自 2.87 开始)
getPolylineAsync() GPolyline 返回与整个行车路线响应相关联的 GPolyline 对象。注意,在响应中有一条表示所有路线的折线。只有在载入了行车路线结果(即触发“load”事件)后,才能定义此对象。(自 2.87 开始)
getMarkerAsync(i) GMarker 返回与第 i 个地址解析相关联的标记。只有在载入了行车路线结果(即触发“load”事件)后,此方法才能返回非空值。(自 2.87 开始)

GDirectionsOptions 类

此类表示 GDirections.load()GDirections.loadFromWaypoints() 方法的可选参数。它没有构造函数,但可实例化为对象常量。

属性

属性 类型 说明
locale String 用于行车路线结果的区域。例如:“en_US”、“fr”和“fr_CA”等。
getPolyline Boolean 默认情况下,仅在地图与 GDirections 对象关联时,GDirections.load*() 方法才会抓取折线数据。此字段可用于覆盖此行为,使得即使地图不与 Directions 对象关联也可检索折线数据。
getSteps Boolean 默认情况下,仅在面板与 GDirections.load*() 对象关联时,GDirections 方法才会抓取步骤数据。此字段可用于覆盖此行为,使得即使面板不与 Directions 对象关联也可检索折线数据。
preserveViewport Boolean 默认情况下,当 Directions 对象包含地图时,地图将处于中心位置并缩放为行车路线结果的边界框大小。当此选项设置为 true 时,则此请求仅留视口(除非从未设置)。

GRoute 类

此类的对象由 GDirections 对象创建,可在行车路线结果中存储单条路线的信息。客户端不应直接创建此类的对象。

方法

方法 返回值 说明
getNumSteps() Number 返回此路线的路段数。(自 2.87 开始)
getStep(i) GStep 返回此路线中第 i 条路段的 Gstep 对象。(自 2.87 开始)
getStartGeocode() Object 返回此路线出发点的地址解析结果。此对象的结构与 GClientGeocoder 对象的响应中单个地标的结构相同。(自 2.87 开始)
getEndGeocode() Object 返回此路线终点的地址解析结果。此对象的结构与 GClientGeocoder 对象的响应中单个地标的结构相同。(自 2.87 开始)
getEndLatLng() GLatLng 为此路线的折线最后点返回 GLatLng 的对象。请注意,此点可能不同于 GRoute.getEndGeocode() 中的“经度, 纬度”,因为 getEndLatLng() 总是返回对齐到路网的点。没有对应的 getStartLatLng() 方法,因为其与调用 GRoute.getStep(0).getLatLng() 相同。(自 2.87 开始)
getSummaryHtml() String 返回包含此路线的距离和时间概述的 HTML 代码段。(自 2.87 开始)
getDistance() Object 返回表示此路线总距离的对象常量。有关此对象的结构,请参见 GDirections.getDistance()。(自 2.87 开始)
getDuration() Object 返回表示此路线总时间的对象常量。有关此对象的结构,请参见 GDirections.getDuration()。(自 2.87 开始)

GStep 类

此类的对象由 GDirections 对象创建,可在行车路线结果中存储一条路线中单个路段的信息。此类没有公共构造函数。客户端不应直接创建此类的对象。

方法

方法 返回值 说明
getLatLng() GLatLng 沿此路段的折线开始点返回 GLatLng 对象。(自 2.87 开始)
getPolylineIndex() Number 返回此路段折线的开始点索引。(自 2.87 开始)
getDescriptionHtml() String 返回包含此路段描述的 HTML 字符串。(自 2.87 开始)
getDistance() Object 返回表示此路段总距离的对象常量。有关此对象的结构,请参见 GDirections.getDistance()。(自 2.87 开始)
getDuration() Object 返回表示此路段总时间的对象常量。有关此对象的结构,请参见 GDirections.getDuration()。(自 2.87 开始)

返回页首