Google Mapplets 参考
class 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) |
Array of GMapType |
返回在此地图中注册的地图类型数组。 |
| getCurrentMapTypeAsync(callback) |
GMapType |
返回当前选中的地图类型。 |
| setMapType(type) |
none |
选择给定的新地图类型。类型必须是为地图所知的类型。请参阅构造函数和方法 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?) |
none |
设置地图视图中心设定为给定的点。也可以同时设置缩放级别和地图类型。地图类型必须是为地图所知的类型。请参阅构造函数和方法 addMapType()。必须在构造后先调用此方法，才能设置地图的初始状态。在构造后先调用地图上的其他操作是错误的。 |
| panTo(center) |
none |
将地图的中心点更改为给定的点。如果该点在当前的地图视图中已经可视，请更改平滑动画中的中心点。 |
| panBy(distance) |
none |
按给定的距离（以像素表示）开始平移动画。 |
| panDirection(dx, dy) |
none |
按指定方向以一半的地图宽度开始平移动画，+1 是向右向下方向，-1 是向左向上方向。 |
| setZoom(level) |
none |
将缩放级别设置为给定的新值。 |
| zoomIn() |
none |
按 1 递增缩放级别。 |
| zoomOut() |
none |
按 1 递减缩放级别。 |
叠加层
| 异步方法 |
回调值 |
描述 |
| addOverlay(overlay) |
none |
将叠加层添加到地图中，并触发 addoverlay 事件。 |
| removeOverlay(overlay) |
none |
从地图中删除叠加层。如果地图中存在叠加层，则会触发 removeoverlay 事件。 |
| clearOverlays() |
none |
从地图中删除所有叠加层，并触发 clearoverlays 事件。 |
信息窗口
| 异步方法 |
回调值 |
描述 |
| openInfoWindow(point, node, opts?) |
none |
在给定的点打开简单的信息窗口。在地图上将地图平移到使打开的信息窗口完全可见的位置。信息窗口的内容以 DOM 节点的形式显示。 |
| openInfoWindowHtml(point, html,
opts?) |
none |
在给定的点打开简单的信息窗口。在地图上将地图平移到使打开的信息窗口完全可见的位置。信息窗口的内容显示为 HTML 文本。 |
| openInfoWindowTabs(point, tabs, opts?) |
none |
在给定的点打开带标签页的信息窗口。在地图上将地图平移到使打开的信息窗口完全可见的位置。信息窗口的内容以 DOM 节点的形式显示。 |
| openInfoWindowTabsHtml(point, tabs, opts?) |
none |
在给定的点打开带标签页的信息窗口。在地图上将地图平移到使打开的信息窗口完全可见的位置。信息窗口的内容显示为 HTML 文本。 |
| showMapBlowup(point, opts?) |
none |
在给定的点打开信息窗口，它包含地图上围绕此点的一个近景视图。 |
| closeInfoWindow() |
none |
关闭当前打开的信息窗口。 |
| 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 |
none |
地图视图开始更改时会触发此事件。拖动操作或调用更改地图视图的方法时也会触发此事件，前者还同时触发 dragstart 事件。 |
| moveend |
none |
结束地图视图的更改时会触发此事件。 |
| zoomend |
oldLevel, newLevel
|
地图到达新的缩放级别时会触发此事件。事件处理程序将先前缩放级别和新缩放级别作为参数接收。 |
| maptypechanged |
none |
选择另一地图类型时会触发此事件。 |
| infowindowopen |
none |
打开信息窗口时会触发此事件。 |
| infowindowclose |
none |
关闭信息窗口时会触发此事件。此事件发生前会触发 infowindowbeforeclose 事件。如果通过再次调用 openInfoWindow*() 在其他点重打开当前已打开的信息窗口，则会先后触发 infowindowbeforeclose、infowindowclose 和 infowindowopen 事件。 |
| addoverlay |
overlay |
当使用 addOverlay() 方法向地图中添加单个叠加层时会触发此事件。新的叠加层将作为参数 overlay 传递到事件处理程序中。 |
| removeoverlay |
overlay |
当使用 removeOverlay() 方法删除单个叠加层时会触发此事件。删除的叠加层将作为参数 overlay 传递到事件处理程序中。 |
| clearoverlays |
none |
当使用 clearOverlays() 方法一次性删除全部叠加层时会触发此事件。 |
| dragstart |
none |
当用户开始拖动地图时会触发此事件。 |
| dragend |
none |
当用户停止拖动地图时会触发此事件。 |
class GInfoWindow
GInfoWindow 不包含构造函数。它是由地图创建的，可使用 GMap2.getInfoWindowAsync(callback: Function) 方法进行访问。
异步方法
| 异步方法 |
回调值 |
描述 |
| selectTab(index) |
none |
选择含给定索引的标签页。它的效果等同于单击相应标签页。 |
| hide() |
none |
隐藏信息窗口。注：该操作并不关闭信息窗口。使用 show() 可重新显示信息窗口。 |
| show() |
none |
如果信息窗口当前处于隐藏状态，则可显示信息窗口。 |
| isHiddenAsync() |
Boolean |
当且仅当隐藏了信息窗口时，返回 true。关闭的信息窗口视为隐藏。 |
| reset(point, tabs, size, offset?, selectedTab?) |
none |
重置信息窗口的状态。每个参数都可设为 null，那么参数的值将保持当前值 |
| getPointAsync() |
GLatLng |
返回信息窗口锚定位置的地理坐标。窗口的箭头指向地图中的该点（对像素取整）。 |
| getPixelOffsetAsync() |
GSize |
返回信息窗口箭头所指向的地理位置（信息窗口所锚定的点）的像素偏移。 |
| getSelectedTabAsync() |
Number |
返回当前所选标签页的对应索引值，从 0 开始。 |
事件
| 事件 |
参数 |
描述 |
| closeclick |
none |
单击信息窗口关闭按钮时会触发此事件。此事件的事件处理程序可通过调用 GMap2.closeInfoWindow() 方法实现关闭信息窗口的操作。 |
class 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*() 方法的信息窗口标签页数据结构。 |
class GInfoWindowOptions
此类的实例可用于方法 openInfoWindow(), openInfoWindowHtml()、openInfoWindowTabs()、openInfoWindowTabsHtml()、bindInfoWindow*() 以及类 GMap2 和 GMarker 的 showMapBlowup() 的 opts? 参数中。此类不存在构造函数。但是，此类可以实例化为 javascript object literal。
属性
正如此类的类名所显示的，其所有属性都是可选的。
| 属性 |
类型 |
描述 |
| disableGoogleLinks |
Boolean |
取消自动追加在信息窗口底部的驾车指南和本地搜索的 Google 链接。
|
| selectedTab |
Number |
选择以 0 开始的、含给定索引值的标签页，而不是以索引值 0 开始的第一个标签页。 |
| maxWidth |
Number |
信息窗口内容的最大宽度（以像素表示）。 |
| zoomLevel |
Number |
仅限于 showMapBlowup()。
信息窗口中放大的地图的缩放级别。 |
| mapType |
GMapType |
仅限于 showMapBlowup()。
信息窗口中放大的地图的地图类型。 |
class GMarker
GMarker 标记地图上的位置。它实现 GOverlay 接口，因此可使用 GMap2.addOverlay() 方法添加到地图中。
标记对象包含 point（这是标记在地图中锚定的地理位置）和 icon。如果在构造函数中未设置 icon，则使用默认图标 G_DEFAULT_ICON。
将信息窗口添加到地图中后，可在地图中通过其标记打开它。标记对象会触发鼠标事件和信息窗口事件。
构造函数
| 构造函数 |
描述 |
| GMarker(point, icon?, inert?) |
在输入的 GPoint 或 GLatLng 对应的 point 中创建带有 icon 或 G_DEFAULT_ICON 的标记。如果 inert 标记为 true，则标记是不可单击的，也不会触发任何事件。（自 2.50 开始建议不要使用） |
| GMarker(latlng, opts?) |
可按 GMarkerOptions 中指定的选项，在 latlng 位置创建标记。（自 2.50 开始） |
异步方法
将标记添加到地图中后，才能调用这些方法。
| 异步方法 |
回调值 |
描述 |
| openInfoWindow(content, opts?) |
none |
在标记图标之上打开地图信息窗口。信息窗口的内容以 DOM 节点的形式显示。仅适用于 GInfoWindowOptions.maxWidth 选项。 |
| openInfoWindowHtml(content, opts?) |
none |
在标记图标之上打开地图信息窗口。信息窗口的内容显示为包含 HTML 文本的字符串。仅适用于 GInfoWindowOptions.maxWidth 选项。 |
| openInfoWindowTabs(tabs,
opts?) |
none |
在标记图标之上打开带标签页的地图信息窗口。信息窗口的内容显示为标签页数组，这些标签页以 DOM 节点的形式包含标签页内容。只有选项 GInfoWindowOptions.maxWidth 和 InfoWindowOptions.selectedTab 适用。 |
| openInfoWindowTabsHtml(tabs, opts?) |
none |
在标记图标之上打开带标签页的地图信息窗口。信息窗口的内容显示为标签页数组，这些标签页中的内容为包含 HTML 文本的字符串。只有选项 InfoWindowOptions.maxWidth 和 InfoWindowOptions.selectedTab 适用。 |
| bindInfoWindow(content, opts?) |
none |
将给定的 DOM 节点捆绑到此标记中。当单击标记时，这些内容将自动显示在信息窗口中。将 content 作为 null 来传递以解除捆绑。 |
| bindInfoWindowHtml(content, opts?) |
none |
将给定的 html 绑定到此标记中。当单击标记时，这些内容将自动显示在信息窗口中。将 content 设置为 null 会解除绑定。 |
| bindInfoWindowTabs(tabs,
opts?) |
none |
将给定的标签页绑定到此标记中。当单击标记时，这些内容将自动显示在信息窗口中。将 content 设置为 null 会解除捆绑。 |
| bindInfoWindowTabsHtml(tabs, opts?) |
none |
将给定的标签页绑定到此标记中。当单击标记时，这些内容将自动显示在信息窗口中。将 content 设置为 null 会解除捆绑。 |
| closeInfoWindow() |
none |
只有当信息窗口属于此标记时，才关闭信息窗口。 |
| showMapBlowup(opts?) |
none |
在标记图标之上打开地图信息窗口。信息窗口的内容是围绕标记位置的一个封闭的放大地图。只有选项 InfoWindowOptions.zoomLevel 和 InfoWindowOptions.mapType 适用。 |
| getIconAsync(callback) |
GIcon |
如构造函数所设置的，返回此标记的 icon。 |
| getPointAsync(callback) |
GLatLng |
按构造函数或 setPoint() 的设置返回此标记锚定点的地理坐标。 |
| setPoint(point) |
none |
设置此标记所锚定点的地理坐标。 |
| enableDragging() |
none |
允许在地图上拖放标记。对于函数，必须已经用 GMarkerOptions.draggable = true 初始化标记。 |
| disableDragging() |
none |
禁止在地图上拖放标记。 |
| draggableAsync(callback) |
Boolean |
如果标记可拖动，则返回“true”。 |
| draggingEnabledAsync(callback) |
Boolean |
如果标记已启用拖动，则返回“true”。 |
| setImage(url) |
none |
请求将 url 指定的图像设置为此标记的前景图。请注意：不调整打印图像和阴影图像。因此，此方法主要是为了达到高亮显示或变暗显示效果，而不是彻底改变标记的外观。（自 2.75 开始） |
| hide() |
none |
如果当前标记可见，则隐藏标记。请注意：如果当前标记可见，则此函数会触发 GMarker.visibilitychanged 事件。（自 2.77 开始） |
| show() |
none |
如果当前标记不可见，则显示标记。请注意：如果当前标记不可见，则此函数会触发 GMarker.visibilitychanged 事件。（自 2.77 开始） |
| isHiddenAsync(callback) |
Boolean |
如果当前标记不可见，则返回“true”。否则返回“false”。（自 2.77 开始） |
事件
只有当标记处于活动状态时，才会触发上述所有事件（请参阅构造函数）。
| 事件 |
参数 |
描述 |
| click |
none |
单击了标记图标后会触发此事件。注意：同时还会为地图触发此事件，将标记作为第一个参数传递到那里的事件处理程序中。 |
| dblclick |
none |
双击了标记图标后会触发此事件。注意：不会为地图触发此事件，因为地图双击时置中是固定行为。 |
| infowindowopen |
none |
当通过此标记打开地图的信息窗口时会触发此事件。 |
| infowindowclose |
none |
关闭通过此标记打开的地图信息窗口时会触发此事件。关闭信息窗口或在其他标记或地图上打开信息窗口时都会发生此事件。此事件发生前会触发 infowindowbeforeclose 事件。 |
| remove |
none |
当使用 GMap2.removeOverlay() 或 GMap2.clearOverlays() 从地图上删除标记时会触发此事件。 |
| dragstart |
none |
如果启用了标记的拖动操作，则在开始拖动标记时会触发此事件。 |
| dragend |
none |
如果启用了标记的拖动操作，则在停止拖动标记时会触发此事件。 |
| visibilitychanged |
isVisible |
当标记的可见性发生更改时会触发此事件（即可见性从可见更改为隐藏时，反之亦然）。 isVisible 指发生可见性更改后标记的状态。（自 2.77 开始） |
class GMarkerOptions
此类的实例用于类 GMarker 的构造函数的 opts? 参数中。此类不存在构造函数。但是，此类可以实例化为 javascript object literal。
属性
正如此类名所显示的，其所有属性都是可选的。
| 属性 |
类型 |
描述 |
| 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 开始） |
class 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 |
none |
当使用 GMap2.removeOverlay() 或 GMap2.clearOverlays() 从地图上删除折线时会触发此事件。 |
class GPolylineOptions
此类的实例用于 GPolyline 的构造函数中。此类不存在构造函数。但是，此类可以实例化为 javascript object literal。
属性
正如此类的类名所显示的，其所有属性都是可选的。
| 属性 |
类型 |
描述 |
| geodesic |
Boolean |
将折线的每个边绘制为测地线。这是球形的地球表面上两点间最短的距离。
|
class 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 |
none |
当使用 GMap2.removeOverlay() 或 GMap2.clearOverlays() 从地图上删除多边形时会触发此事件。 |
GMap2.clearOverlays().
class GGroundOverlay
此对象可在地图中创建矩形图像叠加层，其边界由 GLatLngBounds 定义。
构造函数
| 构造函数 |
描述 |
| GGroundOverlay(imageUrl, bounds) |
|
class GIcon
图标指定用来在地图上显示 GMarker 的图像。由于浏览器兼容性原因，要指定一个图标实际上相当复杂。 注：如果不希望指定自己的图标，则可使用默认 Google 地图图标 G_DEFAULT_ICON。
构造函数
| 构造函数 |
描述 |
| GIcon(copy?, image?) |
创建新图标对象。如果可选的 copy 参数中给出了另一图标，将复制其属性，否则将留为空白。可选的 image 参数设置 image 的属性值。 |
常数
| 常数 |
描述 |
| G_DEFAULT_ICON |
标记使用的默认图标。 |
属性
| 属性 |
类型 |
描述 |
| image |
String |
图标的前景图像 URL。 |
| shadow |
String |
图标的阴影图像 URL。 |
| iconSize |
GSize |
图标前景图像的像素大小。 |
| shadowSize |
GSize |
阴影图像的像素大小。 |
| iconAnchor |
GPoint |
此图标在地图上的锚定点相对于图标图像左上角的像素坐标。 |
| infoWindowAnchor |
GPoint |
信息窗口在此图标上的锚定点相对于图标图像左上角的像素坐标。 |
| printImage |
String |
打印地图所用的前景图标图像的 URL。其大小必须与 image 提供的主图标图像的大小相同。 |
| mozPrintImage |
字符串 |
用 Firefox/Mozilla 打印地图时所用的前景图标图像的 URL。其大小必须与 image 提供的主图标图像的大小相同。 |
| printShadow |
字符串 |
打印地图时所用的阴影图像的 URL。由于大多数浏览器都无法打印 PNG 图像，所以图像格式应该为 GIF。 |
| transparent |
String |
在 Internet Explorer 中用于捕获单击事件的透明版的前景图标图像的 URL。此图像应该是具有 1% 不透明性的 24 位 PNG 版本的主图标图像，但其大小和形状同主图标的大小和形状相同。 |
| imageMap |
Array of Number |
表示图像地图 x/y 坐标的整数数组，我们用它指定浏览器（非 Internet Explorer）中图标图像的可单击部分。 |
| maxHeight |
Integer |
指定拖动标记时视觉上垂直“上升” 的距离（以像素表示）。（自 2.79 开始） |
| dragCrossImage |
String |
指定拖动图标时十字交叉图像的 URL。（自 2.79 开始） |
| dragCrossSize |
GSize |
指定拖动图标时十字交叉图像的像素大小。（自 2.79 开始） |
| dragCrossAnchor |
GPoint |
指定拖动图标时十字交叉图像的像素坐标偏移量（相对于 iconAnchor）。（自 2.79 开始） |
class GPoint
GPoint 是以像素坐标表示的地图上的一点。注意：在 v2 中，它不再是以地理坐标表示的地面上的一个点。现在，地理坐标用 GLatLng 表示。
在地图坐标系统中，x 坐标向右增大，y 坐标向下增大。
注意：GPoint 的两个参数同 x 和 y 属性一样可访问，但最好不要修改它们，而是在创建新对象时使用不同的参数。
构造函数
| 构造函数 |
描述 |
| GPoint(x, y) |
创建 GPoint 对象。 |
属性
| 属性 |
类型 |
描述 |
| x |
Number |
x 坐标，向右增大。 |
| y |
Number |
y 坐标，向下增大。 |
方法
| 方法 |
返回值 |
描述 |
| equals(other) |
Boolean |
当且仅当其他点有相等的坐标时，返回 true。 |
| toString() |
String |
返回包含 x 和 y 坐标的字符串，先 x 坐标后 y 坐标，之间用逗号分隔。 |
class GSize
GSize 是地图矩形区域的大小（以像素表示）。大小对象有两个参数：width 和 height。宽度是点的 x 坐标的差值，高度是 y 坐标的差值。
注意：GSize 的两个参数同 width 和 height 属性一样可访问，但最好不要修改它们，而是在创建新对象时使用不同的参数。
构造函数
| 构造函数 |
描述 |
| GSize(width, height) |
创建 GSize 对象。 |
属性
| 属性 |
类型 |
描述 |
| width |
Number |
宽度参数。 |
| height |
Number |
高度参数。 |
方法
| 方法 |
返回值 |
描述 |
| equals(other) |
Boolean |
当且仅当其他大小都完全相同时，则返回 true。 |
| toString() |
String |
返回包含宽度和高度的字符串，先宽度后高度，之间用逗号分隔。 |
class 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) |
none |
放大此框，使该点也包括在框中。 |
| intersection(other) |
GBounds |
将此框与其他框相交，则返回相交部分。如果没有相交，则返回空框。 |
class 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 |
返回一个表示此点的字符串，其格式适合用于 URL 参数值，中间用逗号分隔不含空格。默认情况下，精确度的返回值为 6 位数字，相当于 4 英寸/11 厘米的分辨率。可选的 precision 参数允许您指定更低的精确度以减轻服务器负载。注：在 2.78 以前的版本中，此 precision 参数不可用。（自 2.78 开始） |
属性
这些属性的存在，只是为了实现与 v1 事件处理程序函数的向后兼容。不应使用它们。
这些属性反映 lng() 和 lat() 存取方法的返回值，允许 GLatLng 出现在 v1 客户端期望 GPoint 出现的位置。GLatLng 必须出现在事件明细中（即出现在事件处理程序函数的参数中）。与方法封装相比，它在当前框架下不可创建事件封装。
| 属性 |
类型 |
描述 |
| x |
Number |
建议不要使用。 |
| y |
Number |
建议不要使用。 |
class GLatLngBounds
GLatLngBounds 实例在地理坐标中代表矩形，包括与 180 度子午线相交的矩形。
构造函数
| 构造函数 |
描述 |
| GLatLngBounds(sw?, ne?) |
从西南角和东北角两个点构建矩形。 |
方法
| 方法 |
返回值 |
描述 |
| equals(other) |
Boolean |
当且仅当此矩形中的所有参数都等于其他矩形的参数（在某一舍入舍出误差范围内）时，返回 true。 |
| contains(latlng) |
Boolean |
如果点的地理坐标位于此矩形内，则返回 true。 |
| intersects(other) |
Boolean |
如名所述。 |
| containsBounds(other) |
Boolean |
如名所述。 |
| extend(latlng) |
none |
放大此矩形，使其包含给定的点。沿经线方向两种可能的放大方式中，按较小的那种方式放大。如果两者相等，则放大东部的边界。 |
| getSouthWest() |
GLatLng |
返回矩形西南角的点。 |
| getNorthEast() |
GLatLng |
返回矩形东北角的点。 |
| toSpan() |
GLatLng |
返回 GLatLng，其坐标值表示此矩形的大小。 |
| isFullLat() |
Boolean |
如果此矩形从南极延伸到北极，则返回 true。 |
| isFullLng() |
Boolean |
如果此矩形沿经线方向环绕地球一周，则返回 true。 |
| isEmpty() |
Boolean |
如果此矩形为空，则返回“true”。 |
| getCenter() |
GLatLng |
返回矩形的中心点。（自 2.52 开始） |
class GTileLayer
指定图块 URL 模板，每个图块请求可以展开该模板，以指向现有的图块坐标系统中唯一的图块。例如，'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 必须是一个如上所述有效的 url 模板。 |
class GTileLayerOverlay
GTileLayerOverlay 可作为地图的 GTileLayer 参数。它实现 GOverlay 接口，因此可使用 GMap2.addOverlay() 方法添加到地图中。
构造函数
异步方法
| 异步方法 |
回调值 |
描述 |
| hide() |
none |
隐藏此叠加层使之不可见，但保留它在叠加层堆栈中的位置。（自 2.71 开始） |
| show() |
none |
显示先前不可见的 TileLayerOverlay。（自 2.71 开始） |
| getTileLayerAsync() |
none |
返回此叠加层所使用的图块层。（自 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) |
none |
删除使用 addListener() 或 addDomListener() 安装的处理程序。 |
| clearListeners(source, event) |
none |
删除使用 addListener() 或 addDomListener() 为给定事件在给定对象上安装的所有处理程序。 |
| clearInstanceListeners(source) |
none |
删除使用 addListener() 或 addDomListener() 为所有事件在给定对象上安装的所有处理程序。 |
| trigger(source, event, ...) |
none |
使源对象触发自定义事件。在将 event 作为参数依次传递到事件处理程序函数后所有剩余的可选参数。 |
| bind(source, event, object,
method) |
GEventListener |
将给定对象的方法调用注册为源对象自定义事件的事件处理程序。返回一个可用于最终注销处理程序的句柄。 |
| bindDom(source, event, object,
method) |
GEventListener |
将给定对象的方法调用注册为源对象自定义事件的事件处理程序。返回一个可用于最终注销处理程序的句柄。 |
| callback(object, method) |
Function |
返回 closure，在 object 上调用 method。 |
| callbackArgs(object, method, ...) |
Function |
返回 closure，在 object 上调用 method。调用返回的函数时，将 method 后面所有余下的可选参数依次输入 method 作为参数。 |
事件
| 事件 |
参数 |
描述 |
| clearlisteners |
event? |
在该对象上调用 clearListeners() 或 clearInstanceListeners() 时会在该对象上触发此事件。当然，在执行函数前也会触发该事件。 |
class GEventListener
此类是隐藏的。它不包含方法和构造函数。从 GEvent.addListener() 或 GEvent.addDomListener() 返回其实例，并且最终传递回 GEvent.removeListener()。
enum GGeoStatusCode
在圆括号中指定每个符号常数对应的数值。
常数
| 常数 |
描述 |
| G_GEO_SUCCESS (200) |
未出现错误，已对地址成功地进行了语法分析，并返回其地理位置。
（自 2.55 开始） |
| G_GEO_SERVER_ERROR (500) |
无法成功处理地址解析请求，但是确切的失败原因未知。
（自 2.55 开始） |
| G_GEO_MISSING_QUERY (601) |
地址解析的请求的空地址指定为输入。
（自 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 开始） |
class 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 开始） |
class GGeoXml
GGeoXml 对象将可公共访问的网络服务器上储存的 XML 文件（如 KML 文件）中的地理内容添加到地图上。它实现 GOverlay 接口，因此可使用 GMap2.addOverlay() 方法添加到地图中。
构造函数
| 构造函数 |
描述 |
| GGeoXml(urlOfXml, opt_callback) |
创建表示该 XML 文件的 GOverlay。当 GGeoXml 对象完成 XML 文件的装载时会调用可选的回调函数。
（自 2.76 开始） |
function GAsync
使多个异步请求并行的工具函数。它收集结果并将它们传递到您提供的单个回调函数中。例如，要获取 map 的当前缩放级别，对 point 执行坐标变换并获取 marker 的位置：
GAsync(
map, 'getZoom', 'fromContainerPixelToLatLng', [ point ],
marker, 'getPoint',
function(zoom, pointA, pointB) { ... });
异步方法
| 异步方法 |
回调值 |
描述 |
| GAsync(...) |
... |
执行一个或多个并行的异步请求。
参数的格式为：
(object1,
methodName1 [, 可选的参数数组]，
methodName2 [, 可选的参数数组]，
...,
object2,
methodName3 [, 可选的参数数组]，
...,
callback)
回调函数传递每个异步请求返回的值，这样方法名就能在此函数的参数中显示。
|
返回页首
