构造函数	说明
GMap2(container:Node, opts?:GMapOptions)	在指定的 HTML 容器中创建新的地图，该容器通常是一个 DIV 元素。如果可选参数 opts.mapTypes 中没有给出地图类型集合，则使用默认的集合 G_DEFAULT_MAP_TYPES 。如果可选参数 opts.size 中没有给出大小，则使用 container 的大小。如果给出了 opts.size ，则相应地调整地图容器元素的大小。请参见 class GMapOptions 。注意：需要先将地图居中，才能使用该地图。您应该立即调用 GMap2.setCenter() 来初始化使用该构造函数创建的地图。

说明

GMap2(container:Node, opts?:GMapOptions)

在指定的 HTML 容器中创建新的地图，该容器通常是一个

DIV

元素。如果可选参数

opts.mapTypes

中没有给出地图类型集合，则使用默认的集合

G_DEFAULT_MAP_TYPES

。如果可选参数

opts.size

中没有给出大小，则使用

container

的大小。如果给出了

opts.size

，则相应地调整地图容器元素的大小。请参见

class GMapOptions

。注意：需要先将地图居中，才能使用该地图。您应该立即调用

GMap2.setCenter()

来初始化使用该构造函数创建的地图。

方法

配置

方法	返回值	说明
enableDragging()	None	启用地图拖动（默认情况下启用）。
disableDragging()	None	禁用地图拖动。
draggingEnabled()	Boolean	当且仅当启用了地图拖动时，返回 true 。
enableInfoWindow()	None	启用地图上的信息窗口操作（默认情况下启用）。
disableInfoWindow()	None	如果信息窗口处于打开状态，请关闭它并禁用打开新信息窗口。
infoWindowEnabled()	Boolean	当且仅当启用了信息窗口时，返回 true 。
enableDoubleClickZoom()	None	启用双击缩放地图（默认情况下启用）。（自 2.58开始）
disableDoubleClickZoom()	None	禁用双击缩放地图。（自 2.58开始）
doubleClickZoomEnabled()	Boolean	当且仅当启用了双击缩放地图时，返回 true 。（自 2.58开始）
enableContinuousZoom()	None	启用选择浏览器的连续平滑缩放（默认情况下禁用）。（自 2.58开始）
disableContinuousZoom()	None	禁用连续平滑缩放。（自 2.58开始）
continuousZoomEnabled()	Boolean	如果启用了连续平滑缩放，则返回 true 。（自 2.58开始）
enableGoogleBar()	None	为地图启用集成搜索控件 GoogleBar。如果启用，该控件会取代默认的“由 Google 强力驱动”徽标。请注意，该控件默认情况下未启用。（自 2.92开始）
disableGoogleBar()	None	禁用 GoogleBar 集成搜索控件。如果禁用，默认的“由 Google 强力驱动”徽标会占据以前放置此控件的位置。请注意，该控件已经默认禁用。（自 2.92开始）
enableScrollWheelZoom()	None	启用使用鼠标滚轮缩放。注意：默认情况下禁用滚轮缩放。（自 2.78开始）
disableScrollWheelZoom()	None	禁用使用鼠标滚轮缩放。注意：默认情况下禁用滚轮缩放。（自 2.78开始）
scrollWheelZoomEnabled()	Boolean	返回一个表示是否启用滚轮缩放的布尔值。（自 2.78开始）

控件

方法	返回值	说明
addControl(control:GControl, position?:GControlPosition)	None	将控件添加到地图。地图上的位置由可选的 position 参数确定。如果此参数不存在，则使用由 GControl.getDefaultPosition() 方法确定的控件默认位置。一个控件实例只能向地图中添加一次。
removeControl(control:GControl)	None	从地图中删除控件。如果控件从未被添加到地图中，则该删除不起任何作用。
getContainer()	Node	返回包含地图的 DOM 对象。由 GControl.initialize() 使用。

方法

返回值

说明

addControl(control:GControl, position?:GControlPosition)

None

将控件添加到地图。地图上的位置由可选的

position

参数确定。如果此参数不存在，则使用由

GControl.getDefaultPosition()

方法确定的控件默认位置。一个控件实例只能向地图中添加一次。

removeControl(control:GControl)

None

从地图中删除控件。如果控件从未被添加到地图中，则该删除不起任何作用。

getContainer()

Node

返回包含地图的 DOM 对象。由

GControl.initialize()

使用。

地图类型

方法	返回值	说明
getMapTypes()	GMapType[]	返回在此地图中注册的地图类型数组。
getCurrentMapType()	GMapType	返回当前选中的地图类型。
setMapType(type:GMapType)	None	选择指定的新地图类型。类型必须是地图已知的类型。请参见构造函数和方法 addMapType() 。
addMapType(type:GMapType)	None	将新地图类型添加到地图中。有关怎样定义自定义地图类型的信息，请参见 GMapType 部分。GMapType
removeMapType(type:GMapType)	None	从地图中删除地图类型。会更新由 GMapTypeControl 或 GHierarchicalMapTypeControl 显示的按钮集并触发 removemaptype 事件。

地图状态

方法	返回值	说明
isLoaded()	Boolean	当且仅当地图在创建后使用 setCenter() 进行初始化时，返回 true 。
getCenter()	GLatLng	返回地图视图中心点的地理坐标。
getBounds()	GLatLngBounds	返回地图视图的可视矩形区域（以地理坐标表示）。
getBoundsZoomLevel(bounds:GLatLngBounds)	Number	返回指定矩形区域在地图视图中的缩放级别。缩放级别要按当前选中的地图类型计算。如果还未选择地图类型，将使用地图类型列表中列出的第一个类型。
getSize()	GSize	返回地图视图的大小（以像素表示）。
getZoom()	Number	返回当前的缩放级别。
getDragObject()	GDraggableObject	返回此地图使用的可拖放对象。（自 2.93开始）
getEarthInstance(callback:Function(instance: GEPlugin))	None	检索附加到此地图的 Google 地球浏览器插件的实例，并在该实例准备好接收命令时调用传递的回调函数，从而将地球实例（ GEPlugin 对象）作为参数传递。如果 Google 地球实例以前已通过设置 Google 地球地图类型（通过 GMap2.setMapType(G_SATELLITE_3D_MAP) ）进行了实例化，可能会立即触发该回调函数。如果实例尚未创建，调用 getEarthInstance 会初始化 Google 地球插件。（这种异步行为就是该方法需要回调的原因。）注意：如果初始化遇到错误，回调函数将传递 null 参数。请注意，尽管该方法会创建 Google 地球实例，但不会将 Google 地球地图类型设置为当前视图。要执行此操作，请显式地调用 GMap2.setMapType(G_SATELLITE_3D_MAP) ，或让用户通过 MapTypeControl 选择此地图类型。请参见 Google 地球 API 开发人员指南，以获取有关怎样使用 GEPlugin 对象的详细信息。（自 2.113开始）

修改地图状态

方法	返回值	说明
setCenter(center:GLatLng, zoom?:Number, type?:GMapType)	None	按指定的中心设置地图视图。也可以同时设置缩放级别和地图类型。地图类型必须是地图已知的类型。请参见构造函数和方法 addMapType() 。必须在构造后先调用此方法，才能设置地图的初始状态。在调用此函数之前调用对新构造的 GMap2 对象执行的操作，这是错误的。
panTo(center:GLatLng)	None	将地图的中心点更改为指定的点。如果该点已经在当前的地图视图中可见，则会以平滑动画的方式移动中心点。
panBy(distance:GSize)	None	以动画方式平移指定的距离（以像素为单位）。
panDirection(dx:one of -10+1, dy:one of -10+1)	None	以动画方式向指示方向平移地图宽度的一半。 +1 是向右向下， -1 是向左向上。
setZoom(level:Number)	None	将缩放级别设置为指定的新值。
zoomIn()	None	将缩放级别加 1。
zoomOut()	None	将缩放级别减 1。
savePosition()	None	存储当前的地图位置和缩放级别，以便以后用 returnToSavedPosition() 重新调用。
returnToSavedPosition()	None	恢复用 savePosition() 保存的地图视图。
checkResize()	None	通知地图其容器大小已更改。在更改了容器 DOM 对象的大小后调用此方法，以便地图能够调整自己适合于新的大小。

叠加层

方法	返回值	说明
addOverlay(overlay:GOverlay)	None	将叠加层添加到地图中，并触发 addoverlay 事件。
removeOverlay(overlay:GOverlay)	None	从地图中删除叠加层。尝试删除不在地图上的叠加层是错误的。如果调用成功，会触发 removeoverlay 事件。
clearOverlays()	None	从地图中删除所有叠加层，并触发 clearoverlays 事件。
getPane(pane:GMapPane)	Node	返回层中包含 pane 识别的对象的 DIV。由 GOverlay 实例用于方法 GOverlay.initialize() 的实例中，以在地图上绘制它们自身。

信息窗口

方法	返回值	说明
openInfoWindow(latlng:GLatLng, node:Node, opts?:GInfoWindowOptions)	None	在指定点处打开一个简单的信息窗口。平移地图，使得打开的信息窗口完全可见。信息窗口的内容为 DOM 节点。
openInfoWindowHtml(latlng:GLatLng, html:String, opts?:GInfoWindowOptions)	None	在指定点处打开一个简单的信息窗口。平移地图，使得打开的信息窗口完全可见。信息窗口的内容为 HTML 文本。
openInfoWindowTabs(latlng:GLatLng, tabs:GInfoWindowTab[], opts?:GinfoWindowOptions)	None	在指定点处打开一个带标签的信息窗口。平移地图，使得打开的信息窗口完全可见。信息窗口的内容为 DOM 节点。
openInfoWindowTabsHtml(latlng:GLatLng, tabs:GInfoWindowTab[], opts?:GInfoWindowOptions)	None	在指定点处打开一个带标签的信息窗口。平移地图，使得打开的信息窗口完全可见。信息窗口的内容为 HTML 文本。
showMapBlowup(latlng:GLatLng, opts?:GInfoWindowOptions)	None	在指定的点打开信息窗口，它包含地图上该点附近的近景视图。
updateInfoWindow(tabs:GInfoWindowTab[], onupdate?:Function)	None	更新当前打开的 GInfoWindow 对象的内容，而不重新放置。信息窗口的大小将被调整，以便与新内容相符。对信息窗口内容实际进行更改后，将调用可选的 onupdate 回调函数。（自 2.85开始）
updateCurrentTab(modifier:Function, onupdate?:Function)	None	会更新当前选中的标签，从而调整 GInfoWindow 对象的大小，而不重新放置。 modifier 函数用于修改当前选中的标签并将 GInfoWindowTab 作为参数传递。在信息窗口显示新内容后，调用可选的 onupdate 回调函数。（自 2.85开始）
closeInfoWindow()	None	关闭当前打开的信息窗口。
getInfoWindow()	GInfoWindow	返回此地图的信息窗口对象。如果还没有信息窗口，会创建一个，但该窗口不显示。此操作不受 enableInfoWindow() 影响。

坐标变换

方法	返回值	说明
fromContainerPixelToLatLng(pixel:GPoint)	GLatLng	在含有页面地图的 DOM 元素中计算指定像素坐标点的地理坐标。此方法有助于实现自定义控件与地图的交互。
fromLatLngToContainerPixel(latlng:GLatLng)	GPoint	在包含该页面地图的 DOM 元素中计算指定的地理位置的像素坐标。（自 2.100开始）
fromLatLngToDivPixel(latlng:GLatLng)	GPoint	计算指定地理位置在含有可拖动地图的 DOM 元素中的像素坐标。为自定义叠加层实现 GOverlay.redraw() 方法时，需要用此方法定位自定义叠加层。
fromDivPixelToLatLng(pixel:GPoint)	GLatLng	根据含有可拖动地图的 div 中的像素坐标计算地理坐标。此方法可能有助于实现与不扩展 GOverlay 接口的自定义叠加层的交互。如果此方法没有给出预期输出，请尝试使用 fromContainerPixelToLatLng 方法。

事件

事件	说明
addmaptype(type:GMapType)	向地图中添加地图类型时会触发此事件。
removemaptype(type:GMapType)	从地图中删除地图类型时会触发此事件。
click(overlay:GOverlay, latlng:GLatLng, overlaylatlng:GLatLng)	用户用鼠标点击地图时会触发此事件。根据所点击的环境的不同以及是否点击了可点击的叠加层， click 事件会传递不同的参数。如果点击的不是可点击叠加层， overlay 参数为 null 并且 latlng 参数包含点击点的地理坐标。如果点击的是 clickable 叠加层（如 GMarker 、 GPolygon 、 GPolyline 或 GInfoWindow ）， overlay 参数包含叠加层对象，而 overlaylatlng 参数会包含所点击叠加层的坐标。另外，还会在该叠加层自身上触发 click 事件。
dblclick(overlay:GOverlay, latlng:GLatLng)	双击地图时会触发此事件。注意，双击标记或其他可点击叠加层时不触发此事件。被双击的点的地理坐标将被传递到 latlng 参数中。 overlay 参数始终设置为 null 。（自 2.83开始）
singlerightclick(point:GPoint, src:Element, overlay?:GOverlay)	在地图容器中触发 DOM contextmenu 事件时会触发此事件。如果右键点击某个标记或其他可点击叠加层，则该叠加层会传递到 overlay 参数的事件处理程序中。右键点击的这一点的像素坐标（在包含地图的 DOM 元素中）和 DOM 事件的源元素会分别传递到 point 和 src 参数中。注意，如果在启用了双击缩放的情况下进行右键双击，那么，地图会缩小，并且不触发 singlerightclick 事件。但是，如果禁用了双击缩放，会触发两个 singlerightclick 事件。（自 2.84开始）
movestart()	地图视图开始更改时会触发此事件。执行拖动操作时或调用更改地图视图的方法时也会触发此事件，前者还同时触发 dragstart 事件。
move()	更改地图视图时会触发此事件，并且可能是重复触发。
moveend()	结束地图视图的更改时会触发此事件。
zoomend(oldLevel:Number, newLevel:Number)	地图到达新的缩放级别时会触发此事件。事件处理程序接收先前的缩放级别和新缩放级别作为参数。
maptypechanged()	选择另一地图类型时会触发此事件。
infowindowopen()	打开信息窗口时会触发此事件。
infowindowbeforeclose()	关闭信息窗口前会触发此事件。（自 2.83开始）
infowindowclose()	关闭信息窗口时会触发此事件。此事件在触发前会触发 infowindowbeforeclose 事件。如果通过再次调用 openInfoWindow*() 在其他点重新打开当前已打开的信息窗口，则会先后触发 infowindowbeforeclose 、 infowindowclose 和 infowindowopen 事件。
addoverlay(overlay:GOverlay)	当使用 addOverlay() 方法向地图中添加单个叠加层时会触发此事件。新的叠加层会作为参数 overlay 传递到事件处理程序中。
removeoverlay(overlay:GOverlay)	当使用 removeOverlay() 方法删除单个叠加层时会触发此事件。删除的叠加层会作为参数 overlay 传递到事件处理程序中。
clearoverlays()	当使用 clearOverlays() 方法一次性删除全部叠加层时会触发此事件。
mouseover(latlng:GLatLng)	当用户将鼠标从地图外移动到地图上时会触发此事件。
mouseout(latlng:GLatLng)	当用户将鼠标移离地图时会触发此事件。
mousemove(latlng:GLatLng)	当用户在地图中移动鼠标时会触发此事件。
dragstart()	当用户开始拖动地图时会触发此事件。
drag()	当用户拖动地图时会重复触发此事件。
dragend()	当用户停止拖动地图时会触发此事件。
load()	当完成地图设置时会触发此事件，并且 isLoaded()会返回 true 。这表示位置、缩放和地图类型都已完成初始化，但可能还在载入图块。（自 2.52开始）

GMapOptions 类

此类代表

GMap2

构造函数的可选参数。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
size	GSize	以像素为单位设置地图大小。传递到地图构造函数的容器会调整为指定大小。默认情况下，地图会采用其容器的大小。
mapTypes	GMapType[]	此地图要使用的地图类型数组。默认情况下使用 G_DEFAULT_MAP_TYPES 。使用此选项可以限制地图中显示的预定义地图类型集合，或者将自有的地图类型传递到地图中。另请参见 GMap2.addMapType() 。
draggableCursor	String	地图可拖动时显示的光标。（自 2.59开始）
draggingCursor	String	拖动地图时显示的光标。（自 2.59开始）
googleBarOptions	GGoogleBarOptions	该属性指定配置 GGoogleBar 搜索控件的选项。当构造地图时，会将这些选项传递到 GMapOptions 对象常量，当调用 GMap2.enableGoogleBar() 时，会使用这些选项构造本地 GGoogleBar 控件。（自 2.95开始）
backgroundColor	String	该属性指定地图图块后要显示的颜色。该颜色可以是任何有效的 W3C 标准颜色值。（自 2.119开始）

GGoogleBarOptions 类

此类表示在

googleBarOptions

参数中传递到

GMapOptions

对象的选项。它没有构造函数，但可实例化为对象常量。请注意，与

GInfoWindow

一样，

GGoogleBar

对象不会被构造，但是会自动添加到地图对象中，并通过此处描述的属性启用。

属性

属性	类型	说明
showOnLoad	Boolean	当设置为 true 时，该属性显示 GoogleBar 中的搜索框（如果启用了控件并加载了地图）。默认情况下，控件中的搜索框是隐藏的，只有当点击该控件的放大镜时才会展开。（自 2.95开始）
linkTarget	GGoogleBarLinkTarget	该属性允许指定嵌入 GoogleBar 的搜索结果中的链接目标。默认值为 G_GOOGLEBAR_LINK_TARGET_BLANK ，该默认值指定这些链接将在新窗口中打开。（自 2.95开始）
resultList	GGoogleBarResultList or Element	该属性可让您指定 GoogleBar 的搜索结果列表的样式，该样式可能为以下样式的一种： G_GOOGLEBAR_RESULT_LIST_INLINE （默认样式）将结果列表放入搜索框上的表中； G_GOOGLEBAR_RESULT_LIST_SUPPRESS 使用“下一个”/“上一个”按钮替换该列表；传递块级别的 DOM 的 Element 将列表放入您选择的容器（通常为 <div> 元素）中。（自 2.95开始）
suppressInitialResultSelection	Boolean	系统完成 GoogleBar 中的搜索后就会在其信息窗口中显示第一个结果（这是默认行为），该属性抑制这种行为。（自 2.95开始）
suppressZoomToBounds	Boolean	该属性还抑制完成 GoogleBar 中的搜索后自动平移和缩放以适合结果集的操作。（该属性抑制默认行为。）（自 2.95开始）
onIdleCallback	Function	该属性指定 GoogleBar 完成搜索且搜索结果关闭时要调用的回调函数。（自 2.95开始）
onSearchCompleteCallback	Function	该属性指定 GoogleBar 完成搜索且搜索结果完全显示时要调用的回调函数向该函数传递与搜索控件相关的 GlocalSearch 对象。在结果放到地图上或结果列表中之前调用该回调函数。（自 2.95开始）
onGenerateMarkerHtmlCallback	Function	此属性可让您指定打开搜索结果标记的信息窗口时要调用的回调函数。应该向该函数先后传递 GMarker 、生成的 HTML 字符串和 GlocalSearchResult ，并且该函数必须返回要显示在信息窗口中的已修改 HTML 字符串。（自 2.95开始）
onMarkersSetCallback	Function	该属性可让您指定 GGoogleBar 完成创建标记并将标记放到地图上时要调用的回调函数。必须向该函数传递一个表格对象数组 {result: GlocalSearch, marker: GMarker} 。（自 2.95开始）

枚举 GGoogleBarListingTypes

这些常数指定用户在使用

GGoogleBar

进行本地搜索时返回结果的类型。在

GGoogleBarOptions.listingTypes

属性中设置该搜索行为。

常数

常数	说明
G_GOOGLEBAR_TYPE_BLENDED_RESULTS	该常数表示 GGoogleBar 的搜索结果仅返回从已经编入索引的 KML/KMZ/GeoRSS 等文件中得到的结果。（自 2.113开始）
G_GOOGLEBAR_TYPE_KMLONLY_RESULTS	该常数表示 GGoogleBar 的搜索结果仅返回从已经编入索引的 KML/KMZ/GeoRSS 等文件中得到的结果。（自 2.113开始）
G_GOOGLEBAR_TYPE_LOCALONLY_RESULTS	该常数表示 GGoogleBar 的搜索结果仅返回商业结果和地址解析结果。（自 2.113开始）

枚举 GGoogleBarLinkTarget

这些常数被传递到

GGoogleBarOptions

.linkTarget中，定义结果信息窗口中的默认链接目标。

常数

常数	说明
G_GOOGLEBAR_LINK_TARGET_BLANK	等同于 target = '_blank'。
G_GOOGLEBAR_LINK_TARGET_PARENT	等同于 target = '_parent'。
G_GOOGLEBAR_LINK_TARGET_SELF	等同于 target = '_self'。
G_GOOGLEBAR_LINK_TARGET_TOP	等同于 target = '_top'。

枚举 GGoogleBarResultList

这些常数被传递到

GGoogleBarOptions.resultList

中，定义怎样显示结果列表。

常数

常数	说明
G_GOOGLEBAR_RESULT_LIST_INLINE	这是默认样式，其结果使用列表形式显示在地图上。
G_GOOGLEBAR_RESULT_LIST_SUPPRESS	这是默认样式，其结果列表是隐藏的并替换为下一个/上一个按钮。

枚举 GMapPane

这些常数定义地图及地图上的对象为了显示而使用的堆叠顺序（z
顺序）。每个窗格定义一组要显示在地图上的类似显示对象，并且还会在地图上定义唯一的 z 顺序。z 顺序较高的窗格会显示在 z
顺序较低的窗格的“顶部”。（请注意，指定窗格内的对象也可能有自身的 z 顺序优先级；有的对象可能显示在同窗格中其他对象的顶部。）

如果您通过

GOverlay

进行子类化，则需要使用这些常数，从而可以将自定义叠加层放入某个窗格中。

按照 z 顺序从最低（底部）到最高（顶部）的顺序列出以下常数。

常数

常数	说明
G_MAP_MAP_PANE	该窗格是 z 顺序最低的窗格，在图块之上。
G_MAP_OVERLAY_LAYER_PANE	该窗格包含折线、多边形、底面叠加层和图块叠加层。（自 2.127开始）
G_MAP_MARKER_SHADOW_PANE	该窗格包含标记阴影。
G_MAP_MARKER_PANE	该窗格包含标记前景图。
G_MAP_FLOAT_SHADOW_PANE	该窗格包含信息窗口阴影。它在 G_MAP_MARKER_PANE 之上，使得标记可以位于信息窗口的阴影中。
G_MAP_MARKER_MOUSE_TARGET_PANE	此窗格包含透明元素，可为标记接收 DOM 鼠标事件。它在 G_MAP_FLOAT_SHADOW_PANE 之上，以便可以点击信息窗口阴影中的标记。
G_MAP_FLOAT_PANE	此窗格包含信息窗口。它在所有地图叠加层之上。

GKeyboardHandler 类

对此类进行实例化，以便向地图中添加键盘绑定。该键盘绑定类似于地图应用程序的键盘绑定。

键	操作
向上箭头键，向下箭头键，向左箭头键，向右箭头键	按下这些键时可连续移动地图。同时按下其中两个键可对角移动。
page down 键，page up 键，home 键，end 键	以相应方向将地图平移其 3/4大小，以漂亮的动画显示。其作用等同于 GLargeMapControl 和 GsmallMapControl 中的箭头按钮。
+，-	分别放大或缩小一个级别。其作用等同于 GLargeMapControl 和 GsmallMapControl 中的 + 和 - 按钮。

构造函数

构造函数	说明
GKeyboardHandler(map:GMap2)	为作为参数传递的地图安装键盘事件处理程序。

接口 GOverlay

地图 API 库中的

GMarker

、

GPolyline

、

GTileLayerOverlay

和

GInfoWindow

类都是通过此接口实现的。如果希望在地图上显示自定义的叠加层对象类型，可以实现这一功能。可使用

GMap2.addOverlay()

方法将

GOverlay

的实例放置于地图上。然后，地图在叠加层实例上调用

GOverlay.initialize()

方法，先将自己显示在地图上。每当地图显示更改时，地图都会调用

GOverlay.redraw()

，这样叠加层就可以在需要时对自己进行重新放置。叠加层实例可使用方法

GMap2.getPane()

获取一个或多个自己要附加的 DOM 容器元素。

构造函数

构造函数	说明
GOverlay()	此构造函数为这些方法创建哑元实现。尽管如此，当有继承自此类的派生类时，派生类的构造函数会调用此构造函数以完成实现。

静态方法

方法	返回值	说明
GOverlay.getZIndex(latitude:Number)	Number	返回指定纬度的 CSS z-index 值。它计算 z 索引，使靠南的叠加层在靠北的叠加层之上，从而创建标记叠加层的三维外观。

抽象方法

方法	返回值	说明
initialize(map:GMap2)	None	使用 GMap2.addOverlay() 向地图中添加叠加层后，由地图调用此方法。叠加层对象可以将其本身拖到地图的各个窗格中，这些窗格可使用 GMap2.getPane() 获取。
remove()	None	使用 GMap2.removeOverlay() 或 GMap2.clearOverlays() 从地图中删除叠加层后，由地图调用此方法。此时，叠加层必须将自己从地图窗格中删除
copy()	GOverlay	返回叠加层的未初始化副本，可添加到地图中。
redraw(force:Boolean)	None	此方法在地图显示更改后由地图调用。如果更改了地图视图的缩放级别或像素偏移量，则参数 force 将为 true ，这样需要重新计算像素坐标。

GInfoWindow 类

GInfoWindow

没有构造函数。它是由地图创建的，可使用

GMap2.getInfoWindow()

方法访问。

方法

方法	返回值	说明
selectTab(index:Number)	None	选择指定索引对应的标签。它的效果等同于点击相应标签。
hide()	None	隐藏信息窗口。注意：这不会关闭信息窗口。使用 show() 可重新显示信息窗口。
show()	None	如果信息窗口当前处于隐藏状态，则可显示信息窗口。
isHidden()	Boolean	当且仅当信息窗口处于隐藏状态时，返回 true 。这包括关闭状态。
reset(latlng:GLatLng, tabs:GInfoWindowTab[], size:GSize, offset?:GSize, selectedTab?:Number)	None	重置信息窗口的状态。每个参数都可能为 null ，因此其值仍将保持为当前值。
getPoint()	GLatLng	返回信息窗口锚定位置的地理坐标。窗口的箭头指向地图中的该点（对像素偏移取整）。
getPixelOffset()	GSize	返回信息窗口的箭头距离信息窗口在地图上所锚定的地理坐标点的像素偏移量。
getSelectedTab()	Number	返回当前选定的标签的索引（从 0开始）。
getTabs()	GInfoWindowTabs[]	返回此信息窗口的标签数组。（自 2.59开始）
getContentContainers()	Node[]	返回包含此信息窗口的标签内容的 DOM 节点数组。（自 2.59开始）
enableMaximize()	None	启用信息窗口最大化。可最大化的信息窗口会展开，使用通过 GInfoWindowOptions 的 maxContent 和 maxTitle 属性指定的内容填充大部分地图。必须使用 maxContent 或 maxTitle 选项打开信息窗口， enableMaximize() 或 disableMaximize 才能生效。默认情况下，使用 maxContent 或 maxTitle 打开的信息窗口会启用最大化。（自 2.93开始）
disableMaximize()	None	禁用信息窗口最大化。必须使用 maxContent 或 maxTitle 选项打开信息窗口。注意，如果信息窗口当前是打开的，则此函数会移除最大化按钮，但不会将该窗口恢复为最小化状态。（自 2.93开始）
maximize()	None	最大化信息窗口。必须使用 maxContent 或 maxTitle 选项打开信息窗口，并且确保没有通过 disableMaximize 禁用信息窗口最大化。（自 2.93开始）
restore()	None	将信息窗口恢复到其默认（非最大化）状态。必须使用 maxContent 或 maxTitle 选项打开信息窗口。（自 2.93开始）

事件

事件	说明
closeclick()	点击信息窗口关闭按钮时会触发此事件。
maximizeclick()	表示此信息窗口将要最大化。（自 2.93开始）
maximizeend()	表示此信息窗口已完成最大化。（自 2.93开始）
restoreclick()	表示此信息窗口将要恢复到非最大化状态。（自 2.93开始）
restoreend()	表示此信息窗口已完成恢复到非最大化状态的操作。（自 2.93开始）

GInfoWindowTab 类

此类的实例数组可以作为

tabs

参数传递到方法

GMap2.openInfoWindowTabs()

、

GMap2.openInfoWindowTabsHtml()

、

GMarker.openInfoWindowTabs()

、

GMarker.openInfoWindowTabsHtml()

以及

GMarker.bindInfoWindow*()

变体中。如果数组包含多个元素，则将显示带有标签的信息窗口。每个

InfoWindowTab

对象都包含两个项目：

content

定义选中标签时信息窗口的内容，

label

定义标签的标签。这些属性将作为参数传递到构造函数中。对于

openInfoWindowTabs()

方法，

content

为 DOM 节点。对于

openInfoWindowTabsHtml()

方法，

content

为包含 HTML 文字的字符串。

构造函数

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

说明

GInfoWindowTab(label:String, content:Node or String)

创建一个可以在

tabs

参数中传递到

openInfoWindowTabs*()

方法的信息窗口标签数据结构。

GInfoWindowOptions 类

此类的实例可用于类

GMap2

和

GMarker

的方法

openInfoWindow()

、

openInfoWindowHtml()

、

openInfoWindowTabs()

、

openInfoWindowTabsHtml()

、变体

bindInfoWindow*()

和

showMapBlowup()

的

opts?

参数中。此类不存在构造函数。但是，此类可以实例化为 javascript 对象常量。

属性

正如此类的名称所指明的一样，所有属性都是可选的。

属性	类型	说明
selectedTab	Number	选择指定索引（从 0开始）对应的标签，而不是索引 0对应的第一个标签。
maxWidth	Number	信息窗口内容的最大宽度（以像素表示）。
noCloseOnClick	Boolean	表明点击地图（未点中标记）时是否应关闭信息窗口。如果设置为 true ，则在点击地图时不关闭信息窗口。默认值为 false 。（自 2.83开始）
onOpenFn	Function	打开信息窗口并显示内容后调用函数。
onCloseFn	Function	关闭信息窗口时调用函数。
zoomLevel	Number	仅限于 showMapBlowup() 。信息窗口中放大地图的缩放级别。
mapType	GMapType	仅限于 showMapBlowup() 。信息窗口中放大地图的地图类型。
maxContent	String	指定最大化信息窗口时要显示的内容。该内容可以为 HTML 字符串或 HTML DOM 元素。（自 2.93开始）
maxTitle	String	指定最大化信息窗口时要显示的标题。该内容可以为 HTML 字符串或 HTML DOM 元素。（自 2.93开始）
pixelOffset	GSize	指定要在向上 (x) 方向和向右 (y) 方向从指定的 GLatLng 移动信息窗口所移动的像素数。（自 2.98开始）

GMarker 类

GMarker

标记地图上的位置。它实现

GOverlay

接口，因此可使用

GMap2.addOverlay()

方法添加到地图中。

标记对象包含

latlng

（这是标记在地图中锚定的地理位置）和

icon

。如果未在构造函数中设置

icon

，则会使用默认图标

G_DEFAULT_ICON

。

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

构造函数

构造函数	说明
GMarker(latlng:GLatLng, icon?:GIcon, inert?:Boolean)	在传递的 GPoint 或 GLatLng 的 latlng 上创建带有 icon 或 G_DEFAULT_ICON 的标记。如果 inert 标记为 true ，则标记不可点击，也不会触发任何事件。（自 2.50开始不推荐使用）
GMarker(latlng:GLatLng, opts?:GMarkerOptions)	按 GMarkerOptions 中指定的选项在 latlng 创建标记。默认情况下，标记是可点击的，并且有默认图标 G_DEFAULT_ICON 。（自 2.50开始）

说明

GMarker(latlng:GLatLng, icon?:GIcon, inert?:Boolean)

在传递的

GPoint

或

GLatLng

的

latlng

上创建带有

icon

或

G_DEFAULT_ICON

的标记。如果

inert

标记为

true

，则标记不可点击，也不会触发任何事件。
（自 2.50开始不推荐使用）

GMarker(latlng:GLatLng, opts?:GMarkerOptions)

按

GMarkerOptions

中指定的选项在

latlng

创建标记。默认情况下，标记是可点击的，并且有默认图标

G_DEFAULT_ICON

。
（自 2.50开始）

方法

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

方法	返回值	说明
openInfoWindow(content:Node, opts?:GInfoWindowOptions)	None	通过标记图标打开地图信息窗口。信息窗口的内容为 DOM 节点。只适用于 GInfoWindowOptions.maxWidth 选项。
openInfoWindowHtml(content:String, opts?:GInfoWindowOptions)	None	通过标记图标打开地图信息窗口。信息窗口的内容为包含 HTML 文本的字符串。只适用于 GInfoWindowOptions.maxWidth 选项。
openInfoWindowTabs(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions)	None	通过标记图标打开带标签的地图信息窗口。信息窗口的内容为标签数组，这些标签包含 DOM 节点形式的标签内容。只适用于 GInfoWindowOptions.maxWidth 和 InfoWindowOptions.selectedTab 选项。
openInfoWindowTabsHtml(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions)	None	通过标记图标打开带标签的地图信息窗口。信息窗口的内容为标签数组，这些标签所包含的标签内容是包含 HTML 文本的字符串。只适用于 InfoWindowOptions.maxWidth 和 InfoWindowOptions.selectedTab 选项。
bindInfoWindow(content:Node, opts?:GInfoWindowOptions)	None	将指定的 DOM 节点绑定到此标记。当点击标记时，此节点中的内容会自动显示在信息窗口中。将 null 作为 content 传递来解除绑定。（自 2.85开始）
bindInfoWindowHtml(content:String, opts?:GInfoWindowOptions)	None	将指定的 HTML 绑定到此标记。当点击标记时，HTML 内容将自动显示在信息窗口中。将 null 作为 content 传递来解除绑定。（自 2.85开始）
bindInfoWindowTabs(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions)	None	将指定的 GInfoWindowTab （作为 DOM 节点提供）绑定到此标记。当点击标记时，这些标签节点中的内容会自动显示在信息窗口中。将 null 作为 tabs 传递来解除绑定。（自 2.85开始）
bindInfoWindowTabsHtml(tabs:GInfoWindowTab[], opts?:GInfoWindowOptions)	None	将指定的 GInfoWindowTab （作为 HTML 字符串提供）绑定到此标记。当点击标记时，这些标签中的 HTML 内容会自动显示在信息窗口中。将 null 作为 tabs 传递来解除绑定。（自 2.85开始）
closeInfoWindow()	None	仅关闭属于此标记的信息窗口。（自 2.85开始）
showMapBlowup(opts?:GInfoWindowOptions)	None	通过标记图标打开地图信息窗口。信息窗口的内容是标记位置周围的近景地图。只适用于 InfoWindowOptions.zoomLevel 和 InfoWindowOptions.mapType 选项。
getIcon()	GIcon	根据构造函数的设置返回此标记的 icon 。
getTitle()	String	根据构造函数通过 GMarkerOptions.title 属性的设置，返回此标记的标题。如果未传入标题，则返回“undefined”。（自 2.85开始）
getPoint()	GLatLng	根据构造函数或 setPoint() 的设置，返回此标记锚定的地理坐标。（自 2.88开始不推荐使用）
getLatLng()	GLatLng	根据构造函数或 setLatLng() 的设置，返回此标记锚定的地理坐标。（自 2.88开始）
setPoint(latlng:GLatLng)	None	设置此标记的锚定点的地理坐标。（自 2.88开始不推荐使用）
setLatLng(latlng:GLatLng)	None	设置此标记的锚定点的地理坐标。（自 2.88开始）
enableDragging()	None	允许在地图上拖放标记。该方法只有在已经用 GMarkerOptions.draggable= true 初始化标记的情况下才生效。
disableDragging()	None	禁止在地图上拖放标记。
draggable()	Boolean	如果已使用 GMarkerOptions.draggable= true 通过构造函数对标记进行了初始化，则返回 true 。否则，返回 false 。
draggingEnabled()	Boolean	如果当前允许用户在地图中拖动标记，则返回 true 。
setImage(url:String)	None	请求将 url 指定的图像设置为此标记的前景图。注意，不调整打印图像和阴影图像。因此，此方法主要是为了达到高亮显示或变暗显示效果，而不是彻底改变标记的外观。（自 2.75开始）
hide()	None	如果当前标记可见，则隐藏标记。注意，如果当前标记可见，则此函数会触发 GMarker.visibilitychanged 事件。（自 2.77开始）
show()	None	如果当前标记不可见，则显示标记。请注意，如果当前标记不可见，则此函数会触发 GMarker.visibilitychanged 事件。（自 2.77开始）
isHidden()	Boolean	如果当前标记不可见，则返回 true 。否则，返回 false 。（自 2.77开始）

事件

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

事件	说明
click(latlng:GLatLng)	点击标记图标时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。请注意，同时还会使地图触发此事件，将标记作为第一个参数传递到那里的事件处理程序中。
dblclick(latlng:GLatLng)	双击标记图标时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。请注意，不会使地图触发此事件，因为地图双击时居中是固定行为。
mousedown(latlng:GLatLng)	在标记图标上触发 DOM mousedown 事件时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。请注意，标记会停止 mousedown DOM 事件，这样就不会导致地图开始拖动。
mouseup(latlng:GLatLng)	在标记上触发 DOM mouseup 事件时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。请注意，标记不会停止 mousedown DOM 事件，因为它不会干扰地图的拖动处理程序。
mouseover(latlng:GLatLng)	当鼠标进入标记图标区域时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。
mouseout(latlng:GLatLng)	当鼠标离开标记图标区域时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。
infowindowopen()	当通过此标记打开地图的信息窗口时会触发此事件。
infowindowbeforeclose()	关闭通过此标记打开的地图信息窗口前会触发此事件。（自 2.83开始）
infowindowclose()	关闭通过此标记打开的地图信息窗口时会触发此事件。关闭信息窗口或在其他标记或在地图上打开信息窗口时，都会触发此事件。此事件在触发前会触发 infowindowbeforeclose 事件。
remove()	使用 GMap2.removeOverlay() 或 GMap2.clearOverlays() 从地图删除标记时会触发此事件。
dragstart(latlng:GLatLng)	如果启用了标记的拖动操作，则在开始拖动标记时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。
drag(latlng:GLatLng)	如果启用了标记的拖动操作，则在拖动标记的过程中会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。
dragend(latlng:GLatLng)	如果启用了标记的拖动操作，则在停止拖动标记时会触发此事件，从而通过其 latlng 参数传入标记的当前坐标。
visibilitychanged(isVisible:Boolean)	当标记的可见性发生更改时会触发此事件（即可见性从可见更改为隐藏时，或从隐藏更改为可见时）。 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开始）
autoPan	Boolean	将标记拖到边缘时自动平移地图。如果标记是可拖动的，则此选项的默认值为 true 。（自 2.87开始）
zIndexProcess	Function	此函数用于在标记叠加到地图上时更改标记的 z-Index顺序，当其信息窗口打开时也调用该函数。默认顺序是越靠南的标记越靠上。此函数被传递到 GMarker 对象中，返回一个表示新 z-index的数字。（自 2.98开始）
hide	Boolean	设置为 true 时，表示地图不应一开始就显示 GMarker 。要打开叠加层，请调用 GMarker.show() 。默认情况下，该值设置为 false。（自 2.139开始）

GPolyline 类

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

构造函数

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

说明

GPolyline(latlngs:GLatLng[], color?:String, weight?:Number, opacity?:Number, opts?:GPolylineOptions)

根据顶点数组创建折线。

color

是一个字符串，包含十六进制数字、HTML 样式的颜色，如 #RRGGBB。

weight

是以像素为单位的线宽度。

opacity

为 0到 1之间的数字。该线条平滑且半透明。

工厂方法

方法	返回值	说明
GPolyline.fromEncoded(color?:String, weight?:Number, opacity?:Number, latlngs:String, zoomFactor:Number, levels:String, numLevels:Number)	GPolyline	根据聚合坐标和级别的编码字符串创建折线。 color 是一个字符串，包含十六进制数字、HTML 样式的颜色，如 #RRGGBB。 weight 是以像素为单位的线宽。 opacity 是介于 0和 1之间的数字。 latlngs 是包含已编码的经度和纬度坐标的字符串。 levels 是包含已编码的折线缩放级别组的字符串。 numLevels 是已编码的 levels 字符串中包含的缩放级别数。 zoomFactor 是编码的 levels 字符串中相邻缩放级别组合之间的倍数。这两个值结合使用可确定已编码的折线中 levels 的精确度。该线条是防锯齿且半透明的。（自 2.63开始）

方法

返回值

说明

GPolyline.fromEncoded(color?:String,
weight?:Number, opacity?:Number, latlngs:String, zoomFactor:Number,
levels:String, numLevels:Number)

GPolyline

根据聚合坐标和级别的编码字符串创建折线。

color

是一个字符串，包含十六进制数字、HTML 样式的颜色，如 #RRGGBB。

weight

是以像素为单位的线宽。

opacity

是介于 0和 1之间的数字。

latlngs

是包含已编码的经度和纬度坐标的字符串。

levels

是包含已编码的折线缩放级别组的字符串。

numLevels

是已编码的

levels

字符串中包含的缩放级别数。

zoomFactor

是编码的

levels

字符串中相邻缩放级别组合之间的倍数。这两个值结合使用可确定已编码的折线中

levels

的精确度。该线条是防锯齿且半透明的。
（自 2.63开始）

方法

方法	返回值	说明
deleteVertex(index:Number)	None	删除折线中含有指定索引值的顶点并相应更新折线的形状。必须已通过 GMap2.addOverlay() 将 GPolyline 添加到地图中。（自 2.111开始）
disableEditing()	None	撤消 enableEditing 的效果，从而删除线上的所有控制点并显示为用户不可编辑。（自 2.111开始）
enableDrawing(opts?:GPolyEditingOptions)	None	允许用户通过点击地图上的其他点构造（或修改） GPolyline 对象。必须已通过 GMap2.addOverlay() 将 GPolyline 添加到地图中，即使折线最初未填充任何内容，也不包含任何顶点。每点击一次都会向折线链添加一个附加“顶点”，可通过双击或再次点击最后添加的点来结束制图，如果折线顺利绘制完，会在最后添加的点处触发“endline”事件，否则，会触发“cancelline”事件，但是不会从地图上删除折线。如果要修改现有 GPolyline ，则会从现有折线的起点或终点连接顶点，这在可选参数 GPolyEditingOptions.fromStart 中指定。（自 2.111开始）
enableEditing(opts?:GPolyEditingOptions)	None	允许修改点的现有 GPolyline 链。如果启用，则用户可以选择并拖动现有顶点。除非在 GPolyEditingOptions 中通过 maxVertices 指定了小于当前顶点数的顶点限制，否则还将在折线部分的中点处添加“假性控制”点，从而可让用户通过点击和拖动这些附加顶点加入新顶点。每当添加或移动顶点时，都会触发“lineupdated”事件。（自 2.111开始）
getVertexCount()	Number	返回折线中顶点的数目。（自 2.46开始）
getVertex(index:Number)	GLatLng	返回折线中指定索引对应的顶点。（自 2.46开始）
getLength()	Number	返回沿地球表面的折线的长度（以米为单位）。（自 2.85开始）
getBounds()	GLatLngBounds	返回此折线的边界。（自 2.85开始）
hide()	None	如果当前折线可见并且 GPolyline.supportsHide() 返回 true ，则隐藏此折线。注意，如果当前折线可见，则此函数会触发 GPolyline.visibilitychanged 事件。（自 2.87开始）
insertVertex(index:Number, latlng:GLatLng)	None	在折线中的指定索引处插于一个新点并更新其形状。必须已通过 GMap2.addOverlay() 将 GPolyline 添加到地图中。（自 2.111开始）
isHidden()	Boolean	如果当前折线不可见，则返回 true 。否则，返回 false 。（自 2.87开始）
show()	None	如果当前折线不可见，则显示该折线。注意，如果当前折线不可见，则此函数会触发 GPolyline.visibilitychanged 事件。（自 2.87开始）
supportsHide()	Boolean	如果当前环境下支持 GPolyline 对象的 GPolyline.hide() ，则返回 true 。否则，返回 false 。（自 2.87开始）
setStrokeStyle(style:GPolyStyleOptions)	None	更改折线的样式。必须已通过 GMap2.addOverlay() 将 GPolyline 添加到地图中。（自 2.111开始）

事件

事件	说明
remove()	使用 GMap2.removeOverlay() 或 GMap2.clearOverlays() 从地图删除折线时会触发此事件。
visibilitychanged(isVisible:Boolean)	当折线的可见性状态从可见更改为不可见或从不可见更改为可见时会触发此事件。 isVisible 参数反映完成此可见性状态的更改后折线的状态。（自 2.87开始）
click(latlng:GLatLng)	点击折线时会触发此事件，从而通过其 latlng 参数传入线条的已点击坐标。请注意，此事件随后还会触发地图上的“click”事件，在该事件中折线作为 overlay 参数传递。（自 2.88开始）
mouseover()	鼠标移动到折线上时会触发此事件。（自 2.111开始）
mouseout()	鼠标离开折线时会触发此事件。（自 2.111开始）
lineupdated()	更新折线的样式或形状时会触发此事件。（自 2.111开始）
endline()	用户完成线的绘制（通过调用 GPolyline.enableDrawing 开始）时会触发此事件。（自 2.111开始）
cancelline()	用户中断线的绘制（通过调用 GPolyline.enableDrawing 开始）时会触发此事件。（自 2.111开始）

GPolylineOptions 类

此类的实例用于

GPolyline

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

属性

正如此类的名称所指明的一样，所有属性都是可选的。

属性	类型	说明
clickable	Boolean	切换以选择折线是否可点击。此选项的默认值为 true ，即未指定该选项时，折线可点击。（自 2.91开始）
geodesic	Boolean	将折线的每个边渲染为测地线（大圆的一段）。测地线是沿地球表面的两个点之间的最近路径。（自 2.84开始）

GPolyEditingOptions 类

此类的实例用于

GPolyline

和

GPolygon

的

enableEditing

方法中。此类不存在构造函数。但是，此类可以实例化为 javascript 对象常量。

属性

正如此类的名称所指明的一样，所有属性都是可选的。

属性	类型	说明
maxVertices	Number	此属性指定可用于该折线的最大顶点数。一旦达到此最大数，就不再添加顶点。（自 2.111开始）
fromStart	Boolean	此属性指定 enableDrawing 是否应从起点而不是端点（默认值）添加点。（自 2.111开始）

GPolyStyleOptions 类

此类的实例用于

GPolyline

和

GPolygon

的

setStrokeStyle

方法以及

GPolygon

的

setFillStyle

方法中。此类不存在构造函数。但是，此类可以实例化为 javascript 对象常量。

属性

正如此类的名称所指明的一样，所有属性都是可选的。

属性	类型	说明
color	String	此属性指定一个字符串，包含十六进制数字、HTML 样式的颜色，如 #RRGGBB。（自 2.111开始）
weight	Number	此属性指定以像素为单位的线宽。（自 2.111开始）
opacity	Number	此属性将折线的不透明度指定为 0（透明）和 1（不透明）之间的分数值。（自 2.111开始）

GPolygon 类

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

GPolyline

。

构造函数

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

说明

GPolygon(latlngs:GLatLng[], strokeColor?:String, strokeWeight?:Number, strokeOpacity?:Number, fillColor?:Number, fillOpacity?:Number, opts?:GPolygonOptions)

根据顶点数组创建多边形。

colors

是一个字符串，包含十六进制数字、HTML 样式的颜色，如 #RRGGBB。

weight

是以像素为单位的线宽度。

opacities

为 0到 1之间的数字。该线条平滑且半透明。
（自 2.69开始）

工厂方法

方法	返回值	说明
GPolygon.fromEncoded(polylines:encoded polylines[], fill?:Boolean, color?:String, opacity?:Number, outline?:Boolean)	GPolygon	根据聚合坐标和级别的编码字符串创建多边形（由大量折线组成）。 polylines 包含组成它的折线的关联数组，其编码格式与 GPolyline.fromEncoded 文档中所描述的格式相同。 fill 指定是否用某种 color 填充该多边形。 opacity 和 outline 指定是否用折线的颜色、重量和不透明性画多边形。如果在折线中指定多个值，则采用折线的第一个值。（自 2.78开始） GPolyline.fromEncoded

方法

返回值

说明

GPolygon.fromEncoded(polylines:encoded polylines[], fill?:Boolean, color?:String, opacity?:Number, outline?:Boolean)

GPolygon

根据聚合坐标和级别的编码字符串创建多边形（由大量折线组成）。

polylines

包含组成它的折线的关联数组，其编码格式与

GPolyline.fromEncoded 文档中所描述的格式相同。

fill

指定是否用某种

color

填充该多边形。

opacity

和

outline

指定是否用折线的颜色、重量和不透明性画多边形。如果在折线中指定多个值，则采用折线的第一个值。
（自 2.78开始）

GPolyline.fromEncoded

方法

方法	返回值	说明
deleteVertex(index:Number)	None	使用多边形中指定的索引删除顶点并相应更新多边形的形状。必须已通过 GMap2.addOverlay() 将 GPolygon 添加到地图中。（自 2.111开始）
disableEditing()	None	撤消 enableEditing 的效果，从而删除线上的所有控制点并显示为用户不可编辑。（自 2.111开始）
enableDrawing(opts?:GPolyEditingOptions)	None	允许用户通过点击地图上的附加点构造 GPolygon 对象。必须已通过 GMap2.addOverlay() 将 GPolyline 添加到地图中，即使折线最初未填充任何内容，也不包含任何顶点。每点击一次都会向多边形边界添加一个附加“顶点”，可通过双击或点击第一个点来完成形状，从而结束制图。如果多边形顺利绘制完，会在第一个点处触发“endline”事件，否则，会触发“cancelline”事件，但是不会从地图上删除折线。（自 2.111开始）
enableEditing(opts?:GPolyEditingOptions)	None	允许修改现有的 GPolygon 边界。如果启用，则用户可以选择并拖动现有顶点。除非在 maxVertices 中通过 GPolyEditingOptions 指定了小于当前顶点数的顶点限制，否则还将在多边形部分的中点处添加“假性控制”点，从而可让用户通过点击和拖动这些附加顶点加入新顶点。每当添加或移动顶点时，都会触发“lineupdated”事件。（自 2.111开始）
getVertexCount()	Number	返回多边形中的顶点数。（自 2.69开始）
getVertex(index:Number)	GLatLng	返回多边形中指定索引对应的顶点。（自 2.69开始）
getArea()	Number	返回以平方米表示的多边形面积（假定地球是一个球形）。（自 2.85开始）
getBounds()	GLatLngBounds	返回此多边形的边界。（自 2.85开始）
hide()	None	如果多边形可见并且 GPolygon.supportsHide 返回 true ，则隐藏该多边形。请注意，如果当前多边形可见，则此函数会触发 GPolygon.visibilitychanged 事件。（自 2.87开始）
insertVertex(index:Number, latlng:GLatLng)	None	在多边形中的指定索引处插入一个新点。必须已通过 GMap2.addOverlay() 将 GPolygon 添加到地图中。（自 2.111开始）
isHidden()	Boolean	如果当前多边形不可见，则返回 true 。否则，返回 false 。（自 2.87开始）
show()	None	如果当前多边形不可见，则显示该多边形。请注意，如果当前多边形不可见，则此函数会触发 GPolygon.visibilitychanged 事件。（自 2.87开始）
supportsHide()	Boolean	如果当前环境下支持 GPolygon 对象的 GPolygon.hide() ，则返回 true 。否则，返回 false 。（自 2.87开始）
setFillStyle(style:GPolyStyleOptions)	None	更改多边形的填充样式。必须已通过 GMap2.addOverlay() 将 GPolygon 添加到地图中。（自 2.111开始）
setStrokeStyle(style:GPolyStyleOptions)	None	更改多边形的线条样式。必须已通过 GMap2.addOverlay() 将 GPolygon 添加到地图中。（自 2.111开始）

事件

事件	说明
remove()	使用 GMap2.removeOverlay() 或 GMap2.clearOverlays() 从地图删除多边形时会触发此事件。
visibilitychanged(isVisible:Boolean)	当多边形的可见性状态从可见更改为不可见或从不可见更改为可见时会触发此事件。 isVisible 参数反映完成此可见性状态的更改后多边形的状态。（自 2.87开始）
click(latlng:GLatLng)	点击多边形时会触发此事件，从而通过其 latlng 参数传入多边形的已点击坐标。请注意，此事件随后还会触发地图上的“click”事件，在该事件中多边形作为 overlay 参数传递。（自 2.88开始）
mouseover()	鼠标移动到多边形区域时会触发此事件。（自 2.111开始）
mouseout()	鼠标离开多边形区域时会触发此事件。（自 2.111开始）
lineupdated()	更新多边形的样式或形状时会触发此事件。（自 2.111开始）
endline()	用户完成多边形的绘制（通过调用 GPolyline.enableDrawing 开始）时会触发此事件。（自 2.111开始）
cancelline()	用户完成多边形的绘制（通过调用 GPolyline.enableDrawing 开始）时会触发此事件。（自 2.111开始）

GPolygonOptions 类

此类的实例用于

GPolygon

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

属性

正如此类的名称所指明的一样，所有属性都是可选的。

属性	类型	说明
clickable	Boolean	切换以选择多边形是否可点击。此选项的默认值为 true ，即未指定该选项时，多边形可点击。（自 2.91开始）

GScreenOverlay类

该对象显示地图上的矩形图像叠加层，其位置不会随视口的改变而变化。用于 ScreenOverlays 的示例有圆规、徽标和智能显示技术。

构造函数

构造函数	说明
GScreenOverlay(imageUrl:String, screenXY:GScreenPoint, overlayXY:GScreenPoint, size:GScreenSize)	创建来自某个图像网址的屏幕叠加层，并按照 screenXY 、 overlayXY 和 size 参数的指定将其显示在屏幕上。 overlayXY 参数确定叠加层图像上（或图像外）的点，该点坐标为 screenXY 。这可用于有效“修剪”图像。 screenXY 参数相对于屏幕原点（左下角）确定该叠加层图像所对应的点。（自 2.92开始）

说明

GScreenOverlay(imageUrl:String, screenXY:GScreenPoint, overlayXY:GScreenPoint, size:GScreenSize)

创建来自某个图像网址的屏幕叠加层，并按照

screenXY

、

overlayXY

和

size

参数的指定将其显示在屏幕上。

overlayXY

参数确定叠加层图像上（或图像外）的点，该点坐标为

screenXY

。这可用于有效“修剪”图像。

screenXY

参数相对于屏幕原点（左下角）确定该叠加层图像所对应的点。
（自 2.92开始）

方法

方法	返回值	说明
hide()	None	如果当前屏幕叠加层可见，则隐藏它。请注意，如果当前屏幕叠加层可见，则此函数会触发 GScreenOverlay.visibilitychanged 事件。（自 2.92开始）
isHidden()	Boolean	如果当前屏幕叠加层不可见，则返回 true 。否则，返回 false 。（自 2.92开始）
show()	None	如果当前屏幕叠加层不可见，则显示该叠加层。请注意，如果当前屏幕叠加层不可见，则此函数会触发 GScreenOverlay.visibilitychanged 事件。（自 2.92开始）
supportsHide()	Boolean	总是返回 true 。（自 2.92开始）

事件

事件	说明
visibilitychanged(isVisible:Boolean)	当屏幕叠加层的可见性状态从可见更改为不可见或从不可见更改为可见时会触发此事件。 isVisible 参数反映完成此可见性状态的更改后屏幕叠加层的状态。（自 2.92开始）

GScreenPoint 类

GScreenPoint

通过 X 和 Y 坐标标识地图视口上的点，其中每个坐标都可以根据可选构造函数参数的值表示相对或绝对定位。

构造函数

构造函数	说明
GScreenPoint(x:Number, y:Number, xunits?:String, yunits?:String)	创建 GScreenPoint 对象。 x 和 y 坐标也可以通过将“fraction”或“pixels”传入 xunits 和 yunits 参数中表示相对或绝对定位。这些参数的默认值为“pixels”。（自 2.92开始）

说明

GScreenPoint(x:Number, y:Number, xunits?:String, yunits?:String)

创建

GScreenPoint

对象。

和

坐标也可以通过将“fraction”或“pixels”传入

xunits

和

yunits

参数中表示相对或绝对定位。这些参数的默认值为“pixels”。
（自 2.92开始）

属性

属性	类型	说明
x	Number	x 坐标向左增大。
y	Number	y 坐标向下增大。
xunits	String	指定用于 x坐标的单位类型。将该单位设置为“fraction”表示相对于地图大小的相对位置，而设置为“pixels”表示绝对定位。默认情况下为绝对定位。
yunits	String	指定用于 y坐标的单位类型。将该单位设置为“fractional”表示相对于地图大小的相对位置，而设置为“pixels”表示绝对定位。默认情况下为绝对定位。

GScreenSize 类

GScreenSize

表示由

width

和

height

参数确定的地图的矩形区域大小。这些参数中的每个参数都可以根据可选构造函数参数的值表示相对或像素大小。

构造函数

构造函数	说明
GScreenSize(width:Number, height:Number, xunits?:String, yunits?:String)	创建 GScreenSize 对象。 width 和 height 坐标可以通过“fraction”或“pixel”传递到 xunits 和 yunits 参数中表示相对或像素大小。 width 和 height 参数的默认值为“pixel”。（自 2.92开始）

说明

GScreenSize(width:Number, height:Number, xunits?:String, yunits?:String)

创建

GScreenSize

对象。

width

和

height

坐标可以通过“fraction”或“pixel”传递到

xunits

和

yunits

参数中表示相对或像素大小。

width

和

height

参数的默认值为“pixel”。
（自 2.92开始）

属性

属性	类型	说明
width	Number	屏幕实际使用面积的宽度参数。注意，该值可以根据 GScreen.yunits 属性的值表示相对或绝对像素值。
height	Number	屏幕实际使用面积的高度参数。注意，该值可以根据 GScreen.yunits 属性的值表示相对或绝对像素值。
xunits	String	指定用于 GScreenSize.width 属性的单位类型。将该单位设置为“fractional”表示相对于地图大小的相对位置，而设置为“pixel”表示像素定位。默认情况下为像素定位。
yunits	String	指定用于 GScreenSize.height 属性的单位类型。将该单位设置为“fractional”表示相对于地图大小的相对位置，而设置为“pixel”表示像素定位。默认情况下为像素定位。

GGroundOverlay类

此对象可在地图中创建矩形图像叠加层，其边界由

GLatLngBounds

定义。

构造函数

构造函数	说明
GGroundOverlay(imageUrl:String, bounds:GLatLngBounds)	根据图像网址及其边界创建底面叠加层。（自 2.79开始）

方法

方法	返回值	说明
hide()	None	如果当前底面叠加层可见，则隐藏它。请注意，如果当前底面叠加层可见，则此函数会触发 GGroundOverlay.visibilitychanged 事件。（自 2.87开始）
isHidden()	Boolean	如果当前底面叠加层不可见，则返回 true 。否则，返回 false 。（自 2.87开始）
show()	None	如果当前底面叠加层不可见，则显示它。请注意，如果当前底面叠加层不可见，则此函数会触发 GGroundOverlay.visibilitychanged 事件。（自 2.87开始）
supportsHide()	Boolean	总是返回 true 。（自 2.87开始）

事件

事件	说明
visibilitychanged(isVisible:Boolean)	当底面叠加层的可见性状态从可见更改为不可见或从不可见更改为可见时会触发此事件。 isVisible 参数反映完成此可见性状态的更改后底面叠加层的状态（自 2.77开始）

GIcon 类

图标指定用来在地图上显示

GMarker

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

G_DEFAULT_ICON

。

构造函数

说明

GIcon(copy?:GIcon, image?:String)

创建新图标对象。如果可选的

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	Number[]	表示图像地图 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

表示。

在 Google 地图坐标系统中，

坐标向右增大，

坐标“向下”增大，不过如果愿意，您也可以使用

GPoint

坐标。

注意：尽管

GPoint

的两个参数可以作为属性

和

访问，但是请勿修改它们，而是在创建新对象时使用不同的参数。

构造函数

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

属性

属性	类型	说明
x	Number	x 坐标。（在 Google 地图坐标系统中，该值向右增大。）
y	Number	y 坐标。（在 Google 地图坐标系统中，该值向下增大。）

方法

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

GSize 类

GSize

是地图矩形区域的大小（以像素表示）。大小对象有两个参数：

width

和

height

。宽度是点的 x坐标的差值，高度是 y坐标的差值。

注意：尽管

GSize

的两个参数可以作为属性

width

和

height

访问，但是请勿修改它们，而是在创建新对象时使用不同的参数。

构造函数

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

属性

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

方法

方法	返回值	说明
equals(other:GSize)	Boolean	当且仅当另一大小的分量完全相同时，返回 true 。
toString()	String	返回包含宽度和高度参数的字符串，先宽度后高度，之间用逗号分隔。

GBounds 类

GBounds

是以像素坐标表示的地图矩形区域。请注意，“地理坐标”中的矩形可用

GLatLngBounds

表示。

构造函数

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

属性

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

方法

方法	返回值	说明
toString()	String	返回包含框的左上角点坐标和右下角点坐标的字符串，先左上后右下，中间用逗号分隔，前后用圆括号括起来。
equals(other:GBounds)	Boolean	在此矩形中的所有参数都等于另一矩形中的参数时返回 true。（自 2.98开始）
mid()	GPoint	返回矩形区域的中心点像素坐标。（自 2.88开始）
min()	GPoint	返回矩形区域的左上角像素坐标。
max()	GPoint	返回矩形区域的右下角像素坐标。
containsBounds(other:GBounds)	Boolean	如果传入的矩形区域完全包含于此矩形区域中，则返回 true 。
containsPoint(point:GPoint)	Boolean	如果矩形区域（含边界）本身包含像素坐标，则返回 true 。（自 2.88开始）
extend(point:GPoint)	None	放大此框，使该点也包括在框中。

GLatLng 类

GLatLng

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

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

另请注意，不能修改

GLatLng

的坐标。如果想要计算另一个点，必须新建一个。

构造函数

说明

GLatLng(lat:Number, lng:Number, unbounded?:Boolean)

注意纬度和经度的顺序。如果

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:GLatLng)	Boolean	当且仅当其他大小具有相同分量（在一定的舍入范围内）时返回 true 。
distanceFrom(other:GLatLng)	Number	返回从此点到某个指定点的距离（以米为单位）。地球近似一个球体，因此距离可能会有不会超过 0.3% 的误差。请参见以下信息。（自 2.89开始不推荐使用）
distanceFrom(other:GLatLng, radius?:Number)	Number	返回从此点到某个指定点的距离（以米为单位）。在默认情况下，根据地球赤道半径的默认值 6378137米计算此距离。地球近似一个球体，因此距离可能会有不超过 0.3% 的误差（尤其在两极）。也可以传递可选的 radius 参数计算不同于地球半径的球体的 GLatLng 坐标之间的距离。（自 2.89开始）
toUrlValue()	String	不推荐使用此版本的方法，而使用能传递可选 precision 参数的修订版方法（如下所示）。（自 2.78开始不要使用）
toUrlValue(precision?:Number)	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?:GLatLng, ne?:GLatLng)	根据西南角和东北角两个点构建矩形。

方法

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

接口 GControl

所有控件都实现此接口。您可以实现此接口，以便为地图提供自定义控件。使用

GMap2.addControl()

方法向地图添加控件。

与叠加层不同（其相对于地图定位），控件相对于地图视图位置而定位，即移动地图时控件不移动。

构造函数

说明

GControl(printable?:Boolean, selectable?:Boolean)

为新控件类创建原型实例。标志

printable

表示控件在地图的打印输出中应可见。标志

selectable

表示控件包含可选择的文本。

方法

当使用

GMap2.addControl()

向地图中添加控件时，地图会调用这些方法。因此，您无法调用这些方法，但可以实现这些方法。

方法	返回值	说明
printable()	Boolean	如果可以打印控件，则返回至地图。
selectable()	Boolean	如果控件包含可选择文本，则返回至地图。
initialize(map:GMap2)	Node	地图将调用该方法，因此控件可自我初始化。该控件将使用 GMap2.getContainer() 方法获取包含地图的 DOM 元素，并将自己添加到 DOM 元素中。它返回添加的元素。
getDefaultPosition()	GControlPosition	向地图返回默认情况下控件在地图视图中出现的位置。这会由 GMap2.addControl() 的第二个参数所覆盖。

GControlPosition 类

此类描述了地图视图中控件的位置。它由相对于控件所在位置的角和确定此位置的偏移量组成。它可以作为可选参数

position

传入方法

GMap2.addControl()

，也可以从方法

GControl.getDefaultPosition()

中返回。

构造函数

构造函数	说明
GControlPosition(anchor:enum GControlAnchor, offset:GSize)	创建控件位置规范。

枚举 GControlAnchor

常数

常数	说明
G_ANCHOR_TOP_RIGHT	控件将锚定到地图的右上角。
G_ANCHOR_TOP_LEFT	控件将锚定到地图的左上角。
G_ANCHOR_BOTTOM_RIGHT	控件将锚定到地图的右下角。
G_ANCHOR_BOTTOM_LEFT	控件将锚定到地图的左下角。

GControl 类

存在

interface GControl

的实现方法。

构造函数

构造函数	说明
GSmallMapControl()	创建带有可在四个方向平移、放大和缩小的按钮的控件。
GLargeMapControl()	创建带有可在四个方向平移、放大、缩小的按钮以及缩放滑块的控件。
GSmallZoomControl()	创建带有放大和缩小按钮的控件。
GScaleControl()	创建显示地图比例尺的控件。
GMapTypeControl()	创建一个标准地图类型控件，通过按钮在受支持地图类型之间进行选择和切换。
GMenuMapTypeControl()	创建一个下拉地图类型控件，在受支持地图类型之间切换。
GHierarchicalMapTypeControl()	创建一个“嵌套”地图类型控件，通过按钮和嵌套复选框在受支持地图类型之间进行选择和切换。
GOverviewMapControl()	在主地图的一角创建可折叠的迷你型概览地图，以便通过拖动提供位置参考和导航。 GOverviewMapControl 创建单像素黑边界的概览地图。注意：与其他控件不同，您只能将此控件放在地图的右下角 ( G_ANCHOR_BOTTOM_RIGHT )。

GMapTypeControl 类

GMapTypeControl

提供用于通过按钮在受支持地图类型之间进行选择和切换的控件。必须在构造这些控件时将其设置为可用于当前附加到地图的所有地图类型。

默认情况下，地图支持

G_DEFAULT_MAP_TYPES

集合；地图还可以通过

GMap2.addMapType()

显式地添加地图类型。为了节省地图空间，您可以改为使用

GHierarchicalMapTypeControl

显示“嵌套”地图类型或使用

GMenuMapTypeControl

显示下拉地图类型。

构造函数

说明

GMapTypeControl(useShortNames?:Boolean)

如果

GMapTypeControl

设置为 true，就使用短名称创建

useShortNames

，默认是使用长名称。

GMenuMapTypeControl 类

GMenuMapTypeControl

提供用于通过下拉菜单在受支持地图类型之间进行选择和切换的控件。必须在构造这些控件时将其设置为可用于当前附加到地图的所有地图类型。

默认情况下，地图支持

G_DEFAULT_MAP_TYPES

集合；地图还可以通过

GMap2.addMapType()

显式地添加地图类型。

构造函数

说明

GMenuMapTypeControl(useShortNames?:Boolean)

如果

GMenuMapTypeControl

设置为 true，就使用短名称创建

useShortNames

，默认是使用长名称。

GHierarchicalMapTypeControl 类

GHierarchicalMapTypeControl

提供通过按钮和嵌套复选框在受支持地图类型之间进行选择和切换的“嵌套”地图类型控件。必须在构造这些控件时将其设置为可用于当前附加到地图的所有地图类型。

添加到地图中的地图类型显示为如常规

GMapTypeControl

中所示的按钮。但是，设置为其他地图类型子类型的地图类型（参见下面的

addRelationship()

方法）将显示为父按钮下的复选框子菜单项。

默认情况下，地图支持

G_DEFAULT_MAP_TYPES

集合；地图还可以通过

GMap2.addMapType()

显式地添加地图类型。必须在构造这些控件时将其设置为可用于当前附加到地图的所有地图类型。请注意，因为子类型显示为复选框，您可以使用子菜单中的其父类型或同级类型对外观进行切换。

构造函数

说明

GHierarchicalMapTypeControl()

构造该控件。默认情况下，

G_HYBRID_MAP

地图类型生成一个

G_SATELLITE_MAP

地图类型的子类型。如果不需要，可以通过调用

clearRelationships()

方法删除该关系。

方法

返回值

说明

addRelationship(parentType:GMapType, childType:GMapType, childText?:String, isDefault?:Boolean)

None

使用该控件在地图类型之间注册父/子关系。如果给出

childText

，则它会显示在该子地图类型（而非名称）复选框的旁边。如果

isDefault

为 true，则默认选择该子地图类型。请注意，在添加控件前必须设置所有关系。（添加控件后再添加关系是无效的。）
（自 2.94开始）

removeRelationship(mapType:GMapType)

None

从控件中删除与某个地图类型有关的所有关系。
（自 2.94开始）

clearRelationships()

None

从控件中删除所有关系。
（自 2.94开始）

GMapType 类

Google 提供部分预定义地图类型 - 此类用于定义自定义地图类型。要在地图中显示地图类型，请使用

GMap2

构造函数或

GMap2.addMapType()

方法。要添加到（而不是整个替换）地图的图块层，另请参阅

GTileLayerOverlay

。

还可以对此类进行细分。如果构造函数参数实例化为原型，则可省略它。子类构造函数必须使用

call()

调用

GMapType

构造函数。

构造函数

构造函数	说明
GMapType(layers:GTileLayer[], projection:GProjection, name:String, opts?:GMapTypeOptions)	用指定的图块层、投影、名称和可选参数构造一个地图类型。

方法

这些方法多数由此地图类型传递到的目标地图调用，但部分方法可能也从地图外调用，比如

getBoundsZoomLevel()

。

方法	返回值	说明
getSpanZoomLevel(center:GLatLng, span:GLatLng, viewSize:GSize)	Number	向地图返回缩放级别，由中心和跨度定义的地图部分按这一缩放级别适合于指定大小（以像素表示）的地图视图。
getBoundsZoomLevel(bounds:GLatLngBounds, viewSize:GSize)	None	向地图返回缩放级别，由边界定义的地图部分按这一缩放级别适合于指定大小（以像素表示）的地图视图。
getName(short?:Boolean)	String	向地图返回要在 GMapTypeControl 中用作按钮标签的地图类型名称。
getProjection()	GProjection	向地图返回此地图类型的投影。
getTileSize()	Number	向地图返回此地图类型的地图图块大小（以像素表示）。这些图块的结构假定为二次的。所有图块层的图块大小相同。
getTileLayers()	GTileLayer[]	向地图返回图块层数组。
getMinimumResolution()	Number	向地图返回定义此地图类型的最低缩放级别。
getMaximumResolution()	Number	向地图返回定义此地图类型的最高缩放级别。
getTextColor()	String	向地图返回地图上覆盖文本的最适用颜色。用于版权控件所显示的版权消息文本的颜色。
getLinkColor()	String	向地图返回地图上覆盖的超链接的最适用颜色。用于版权控件所显示的使用条款链接的颜色。
getErrorMessage()	String	向地图返回区域中显示的错误消息，或有关此地图类型无地图图块处的区域或缩放级别的错误消息。
getCopyrights(bounds:GLatLngBounds, zoom:Number)	String[]	向地图返回版权消息，该消息适用于由 bounds 描述的指定缩放级别的地区。这用于地图上的版权消息。
getUrlArg()	String	向地图返回一个值，用作当前地图视图的永久链接中识别此地图类型的网址参数值。目前，这仅由地图应用程序使用。
getAlt()	String	向地图返回此地图类型的备选文本。（自 2.86开始）

常数

常数	说明
G_NORMAL_MAP	该地图类型（默认地图类型）显示普通的街道地图。
G_SATELLITE_MAP	该地图类型显示卫星图像。
G_HYBRID_MAP	该地图类型显示卫星图像上的主要街道透明层。
G_PHYSICAL_MAP	该地图类型显示带有自然特征（如地形和植被）的地图。默认情况下，该地图类型不显示在地图类型控件中。（自 2.94开始）
G_MOON_ELEVATION_MAP	该地图类型显示月球表面按海拔进行彩色编码的带阴影地形地图。默认情况下，该地图类型不显示在地图类型控件中。（自 2.95开始）
G_MOON_VISIBLE_MAP	此地图类型显示来自月球轨道的照片。默认情况下，该地图类型不显示在地图类型控件中。（自 2.95开始）
G_MARS_ELEVATION_MAP	该地图类型显示火星表面按海拔进行彩色编码的带阴影地形地图。默认情况下，该地图类型不显示在地图类型控件中。（自 2.95开始）
G_MARS_VISIBLE_MAP	此地图类型显示来自火星轨道的照片。默认情况下，该地图类型不显示在地图类型控件中。（自 2.95开始）
G_MARS_INFRARED_MAP	此地图类型显示火星表面带阴影的红外线地图，其中较热地区以亮色显示，较冷地区以暗色显示。（自 2.95开始）
G_SKY_VISIBLE_MAP	该地图类型显示覆盖整个天体的天空拼接。（自 2.95开始）
G_SATELLITE_3D_MAP	结合 Google 地球浏览器插件，此地图类型可以通过卫星图像显示地球的完全交互式三维模型。默认情况下，该地图类型不显示在地图类型控件中。如果将此地图类型添加到您的地图，不仅会为 Google 地球地图类型添加控件，还会在点击用户控件后处理该地图类型的初始化。如果用户当前没有在浏览器中安装 Google 地球插件，则用户第一次选择该地图类型时，系统会提示该用户下载安装该插件并重新启动浏览器。对于尚未安装该插件的用户，选择此地图类型会为地图创建 Google 地球实例并显示 Google 地球的三维视图。您可以使用 GMap2.getEarthInstance() 检索此 Google 地球实例并使用 Google 地球 API 对其进行处理。目前，标记、信息窗口和折线都可用于此三维地图类型，但是尚不支持其他功能。我们计划在以后的版本中支持更多功能。（自 2.113开始）
G_DEFAULT_MAP_TYPES	上述前三种预定义地图类型数组（G_NORMAL_MAP、G_SATELLITE_MAP和 G_HYBRID_MAP）。
G_MOON_MAP_TYPES	上述两种月球类型数组（G_MOON_ELEVATION_MAP和 G_MOON_VISIBLE_MAP）。
G_MARS_MAP_TYPES	上面定义的三种火星地图类型数组（G_MARS_ELEVATION_MAP、G_MARS_VISIBLE_MAP和 G_MARS_INFRARED_MAP）。
G_SKY_MAP_TYPES	上面定义的一种天空地图类型数组 (G_SKY_VISIBLE_MAP)。

事件

事件	说明
newcopyright(copyright:GCopyright)	当向此地图类型中所包含的某个图块层的版权集合添加新版权时会触发此事件。

GMapTypeOptions 类

此类的实例用作

GMapType

构造函数的

opts?

参数。此类不存在构造函数。但是，此类可以实例化为 javascript 对象常量。

属性

属性	类型	说明
shortName	String	设置从 GMapType.getName(true) 中返回的地图类型的短名称。默认值与 name 相同。
urlArg	String	设置从 GMapType.getUrlArg() 中返回的地图类型的网址参数。默认值为空字符串。
maxResolution	Number	设置由 GMapType.getMaximumResolution() 返回的地图类型的最高缩放级别。默认值为所有图块层的最大值。
minResolution	Number	设置由 GMapType.getMinimumResolution() 返回的地图类型的最低缩放级别。默认值为所有图块层的最小值。
tileSize	Number	设置由 GMapType.getTileSize() 返回的图块大小。默认值是 256 。
textColor	String	设置由 GMapType.getTextColor() 返回的文本颜色。默认值是 "black" 。
linkColor	String	设置由 GMapType.getLinkColor() 返回的文本颜色。默认值是 "#7777cc" 。
errorMessage	String	设置由 GMapType.getErrorMessage() 返回的错误消息。默认值为空字符串。
alt	String	对 GMapType.getAlt() 返回的地图类型设置备选文本。默认值为空字符串。（自 2.64开始）
radius	Number	按传递的 Number （以米表示）设置地图类型的半径。默认值是 6378137，这是地球的赤道半径（以米表示）。（自 2.89开始）

GLayer 类

此类可以实例化预定义的“layer”叠加层（包含相关项目的集合）。它实现

GOverlay

接口，因此可使用

GMap2.addOverlay()

方法添加到地图中。

构造函数

构造函数	说明
GLayer(layerId:String)	使用指定的唯一层 ID 创建层。http://spreadsheets.google.com/pub?key=p9pdwsai2hDN-cAocTLhnag 包含当前受支持的层列表。

方法

方法	返回值	说明
hide()	None	隐藏此叠加层使之不可见，但保留它在叠加层堆栈中的位置。
show()	None	显示之前隐藏的 GLayer。

静态方法

方法

返回值

说明

GLayer.isHidden(layerId:String)

None

如果层叠加层隐藏或未使用

GMap2.addOverlay()

方法添加到地图中，则返回

true

。否则，返回

false

。

接口 GTileLayer

您可以实现此接口，以通过

GMapType

或

GTileLayerOverlay

提供自定义的地图图块层。此接口的实现应使用

GTileLayer

实例作为原型，因为这样可以为您实现版权处理。

构造函数

说明

GTileLayer(copyrights:GCopyrightCollection, minResolution:Number, maxResolution:Number, options?:GTileLayerOptions)

如果构造函数参数实例化为原型，则可省略它。子类构造函数必须使用

call()

调用此构造函数。可选

options

参数指定应作为对象常量传递的

GTileLayerOptions

集合。

方法

地图和此图块层传递到的地图类型会调用这些方法。当实现自定义图块层时，您需要实现标记为抽象的方法。

方法	返回值	说明
minResolution()	Number	向地图类型返回此图块层的最低缩放级别。
maxResolution()	Number	向地图类型返回此图块层的最高缩放级别。
getTileUrl(tile:GPoint, zoom:Number)	String	抽象。向地图返回地图图块的网址，图块索引由 GPoint 的 x 和 y 属性在指定的缩放级别提供。
isPng()	Boolean	抽象。向地图返回图块的图像格式是否为 PNG，以及是否因此可能为透明的。否则，假定是 GIF。
getOpacity()	Number	抽象。向地图返回显示此图块层所用的不透明度。1.0为不透明，0.0为透明。
getCopyright(bounds:GLatLngBounds, zoom:Number)	String	抽象。向地图返回此图块层的版权消息，这与指定缩放级别的指定地图地区有关。这用于生成此图块层所属的 GMapType 的版权消息。（自 2.89开始）

事件

事件	说明
newcopyright(copyright:GCopyright)	当向此图块层的版权集合添加新版权时会触发此事件。

GTileLayerOptions 类

此类代表

GTileLayer

接口的可选参数。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
opacity	Number	设置图块的不透明度，范围是 0.0（不可见）到 1.0（不透明）。默认值为 1.0。
isPng	Boolean	指明图块的格式是否为 PNG。
tileUrlTemplate	String	指定图块网址模板，该模板可以针对每个图块请求而展开，以根据现有的图块坐标系引用唯一的图块。将模板置于 GTileLayer 构造函数中可允许您使用此坐标系动态检索图块，检索方式类似于 Google 地图检索图块的方式。模板的格式应该为： http://host/tile?x={X}&y={Y}&z={Z}.png ，其中 X 和 Y 分别指纬度和经度图块坐标，Z 指缩放级别，比如 http://host/tile?x=3&y=27&z=5.png 。
draggingCursor	String	拖动地图时显示的光标。（自 2.59开始）

GTileLayerOverlay类

GTileLayerOverlay

通过

GTileLayer

放大地图。它实现

GOverlay

接口，因此可使用

GMap2.addOverlay()

方法添加到地图中。在现有的地图图像之上显示

GTileLayer

，以替换该图像，将

GTileLayer

放置于自定义的

GMapType

中。

构造函数

说明

GTileLayerOverlay(tileLayer:GTileLayer, opts?:GTileLayerOverlayOptions)

创建封装

GOverlay

的

tileLayer

。
（自 2.61开始）

方法

方法	返回值	说明
hide()	None	隐藏此叠加层使之不可见，但保留它在叠加层堆栈中的位置。（自 2.71开始）
isHidden()	None	如果图块层叠加层不可见，则返回 true 。否则，返回 false 。（自 2.87开始）
show()	None	显示先前不可见的 GTileLayerOverlay 。（自 2.71开始）
refresh()	None	重新加载所有添加到此 GTileLayerOverlay 的可见图块。（自 2.132开始）
supportsHide()	None	总是返回 true 。（自 2.87开始）
getTileLayer()	None	返回此叠加层所使用的图块层。（自 2.83开始）

GTileLayerOverlayOptions 类

此类代表

GTileLayerOverlayOptions

构造函数的可选参数。它没有构造函数，但可实例化为对象常量。

属性

类型

说明

zPriority

Number

zPriority

包含确定此

TileLayerOverlay

的相对 z 顺序的值。优先级较高的图块层将显示在优先级较低的图块层之上。
（自 2.110开始）

GCopyrightCollection 类

您可以使用此类管理自定义地图类型的地图上显示的版权消息。如果不实现自定义地图类型，则无需使用此类。版权集合包含以下信息：在哪个缩放级别的地图上为哪个地区显示哪个版权。这对显示异源数据（如卫星地图类型）的地图类型非常重要。

构造函数

构造函数	说明
GCopyrightCollection(prefix?:String)	从此版权集合所产生的版权消息包含以参数形式给出的通用前缀。示例：“Imagery(C) 2006”

方法

方法	返回值	说明
addCopyright(copyright:GCopyright)	None	将版权信息对象添加到集合中。
getCopyrights(bounds:GLatLngBounds, zoom:Number)	String[]	返回所有版权字符串，它与指定缩放级别的指定地图地区有关。示例：[ "Google", "Keyhole" ]
getCopyrightNotice(bounds:GLatLngBounds, zoom:Number)	String	返回前缀和所有相关的版权字符串，它们与指定缩放级别的指定地图地区有关。示例：“Imagery(C) 2006Google, Keyhole”

事件

事件	说明
newcopyright(copyright:GCopyright)	当向此版权集合添加新的版权时会触发此事件。

GCopyright 类

版权对象包含以下信息：哪个版权消息适用于指定缩放级别的矩形地图地区。只有在实现自定义地图类型或图块层时，才需要此对象。

构造函数

构造函数	说明
GCopyright(id:Number, bounds:GLatLngBounds, minZoom:Number, text:String)	用指定的属性创建版权信息对象。

属性

属性	类型	说明
id	Number	此版权信息的唯一标识符。
minZoom	Number	此信息所适用的最低缩放级别。
bounds	GLatLngBounds	此信息所适用的地区。
text	String	版权消息文本。

接口 GProjection

这是地图投影接口。将地图投影实例传递到

GMapType

构造函数中。

class GMercatorProjection

是通过此接口实现的，所有预定义地图类型都可使用。如果希望用不同的地图投影定义地图类型，则可实现此接口。

方法

这些方法由地图调用。您需要实现它们。

方法	返回值	说明
fromLatLngToPixel(latlng:GLatLng, zoom:Number)	GPoint	返回指定的缩放级别上指定的地理坐标对应的点的地图坐标（以像素表示）。
fromPixelToLatLng(pixel:GPoint, zoom:Number, unbounded?:Boolean)	GLatLng	返回指定缩放级别上指定的地图坐标点（以像素表示）的地理坐标。标志 unbounded 在地理经度坐标超出 -180或 180度子午线时使地理经度坐标不重叠。
tileCheckRange(tile:GPoint, zoom:Number, tilesize:Number)	Boolean	向地图返回图块索引是否在地图类型的有效范围内。否则，地图将会显示空图块。如果地图包含多个地球副本，它还可修改指向相同图块的另一实例的 tile 索引，从而修改不同图块坐标的同一图块。
getWrapWidth(zoom:Number)	Number	向地图返回 x方向的周期，即地图绕地球一周所需的像素数。默认情况下，返回 Infinity ，即地图不会重复。地图使用该方法在包含多个地球副本的地图视图上计算叠加层的放置位置（这种情况通常只出现在缩放级别较低时）。（自 2.46开始）

GMercatorProjection 类

所有预定义的地图类型都可以使用墨卡托投影的

GProjection

接口的这一实现方法。

构造函数

构造函数	说明
GMercatorProjection(zoomlevels:Number)	为指定的缩放级别数创建墨卡托投影。

方法

方法	返回值	说明
fromLatLngToPixel(latlng:GLatLng, zoom:Number)	GPoint	请参见 GProjection 。
fromPixelToLatLng(pixel:GPoint, zoom:Number, unbounded?:Boolean)	GLatLng	请参见 GProjection 。
tileCheckRange(tile:GPoint, zoom:Number, tilesize:Number)	None	请参见 GProjection 。
getWrapWidth(zoom:Number)	None	请参见 GProjection 。墨卡托投影在经度方向是周期性的，因此它返回指定缩放级别下的整个地球的地图宽度（以像素表示）。（自 2.46开始）

命名空间 GEvent

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

GEvent.trigger()

内部触发的自定义事件。

静态方法

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

事件

说明

clearlisteners(event?:String)

调用对象上的

clearListeners()

或

clearInstanceListeners()

时，会在该对象上触发此事件。当然，在执行函数“前”也会触发该事件。

GEventListener 类

此类是不透明的。它不包含方法和构造函数。其实例从

GEvent.addListener()

或

GEvent.addDomListener()

返回并最终传递回

GEvent.removeListener()

。

命名空间 GXmlHttp

此命名空间提供一种工厂方法，可以用一种与浏览器无关的方式创建

XmlHttpRequest

实例。

静态方法

方法	返回值	说明
GXmlHttp.create()	GXmlHttp	创建 XmlHttpRequest 新实例的工厂。

命名空间 GXml

此命名空间提供一种静态方法，可用于处理 XML 文档和文档片段。

静态方法

方法	返回值	说明
GXml.parse(xmltext:String)	Node	将指定的字符串解析为 XML 文本并返回 DOM 表示。如果浏览器不支持本地 XML 解析，则会返回空 DIV 元素的 DOM 节点。
GXml.value(xmlnode:Node)	String	返回以 DOM 表示的 XML 文档片段的文本值（即仅纯文本内容）。

GXslt 类

此类提供的方法可以用一种与浏览器无关的方式将 XSLT 应用于 XML。

静态方法

方法

返回值

说明

GXslt.create(xsltnode:Node)

GXslt

从以 DOM 表示的 XSLT 样式表创建

GXslt

实例。

GXslt.transformToHtml(xmlnode:Node, htmlnode:Node)

Boolean

使用在此

GXslt

实例的构造函数中指定的 XSLT 样式表，转换

xmlnode

中以 DOM 表示的 XML 文档。将产生的 HTML 文档片段追加到指定的

htmlnode

中。只有在浏览器本身支持 XSL 转换的情况下才可实现上述转换，它将返回

true

。否则，此函数不起任何作用，并返回

false

。

命名空间 GLog

此命名空间包含部分静态方法，可帮助您调试网络应用程序。当第一次使用其中一种

write*()

方法时，页面上将打开浮动窗口并显示写入的消息。

静态方法

方法	返回值	说明
GLog.write(message:String, color?:String)	None	将消息以纯文本形式写入日志窗口。对 HTML 标记字符进行转义，使其成为可见字符。
GLog.writeUrl(url:String)	None	将指定网址的链接写入日志窗口。
GLog.writeHtml(html:String)	None	将文本以 HTML 形式写入日志窗口。

GDraggableObject 类

此类使 DOM 元素可拖动。更改拖动光标的静态成员会影响随后创建的所有可拖动对象，如地图、缩放控制滑块和概览地图矩形。每个实例成员仅影响其特定的实例。例如，在创建地图前，您可以调用

GDraggableObject.setDraggableCursor('default')

和

GDraggableObject.setDraggingCursor('move')

来获取 API 2.56之前的样式。或者，地图构造函数可采用一些选项来设置其 DraggableObject 的光标样式。有关允许的光标值，请参见 W3C CSS 规范。

构造函数

构造函数	说明
GDraggableObject(src:Node, opts?:GDraggableObjectOptions)	设置事件处理程序，以使源元素可拖动。将元素视需要放置于左上位置，可选的容器用作边界框。（自 2.59开始）

静态方法

方法	返回值	说明
GDraggableObject.setDraggableCursor(cursor:String)	None	为随后创建的可拖动对象设置可拖动光标。（自 2.59开始）
GDraggableObject.setDraggingCursor(cursor:String)	None	为随后创建的可拖动对象设置拖动光标。（自 2.59开始）
GDraggableObject.getDraggingCursor()	String	返回地图当前正在使用的拖动光标。如果不通过 setDraggingCursor() 静态方法进行设置，则将返回地图在控件和标记中使用的默认光标。（自 2.87开始）
GDraggableObject.getDraggableCursor()	String	返回地图当前正在使用的可拖动光标。如果不通过 setDraggableCursor() 静态方法进行设置，则将返回地图在控件和标记中使用的默认光标。（自 2.87开始）

方法

方法	返回值	说明
setDraggableCursor(cursor:String)	None	设置鼠标置于此可拖动对象之上时的光标。（自 2.59开始）
setDraggingCursor(cursor:String)	None	设置按下鼠标并拖动此可拖动对象时的光标。（自 2.59开始）
moveTo(point:GPoint)	None	将 GDraggableObject 移动到指定的绝对位置。该位置以相对于父节点的像素坐标表示。此方法使用 DOM 坐标系，即 X 坐标向左增大，Y 坐标向下增大。（自 2.89开始）
moveBy(size:GSize)	None	将 GDraggableObject 移动指定的大小偏移量。此方法使用 DOM 坐标系，即宽度向左增大，高度向下增大。（自 2.89开始）

事件

事件	说明
mousedown()	触发此事件以响应 DOM mousedown 事件。处理此事件将阻止 DOM mousedown 事件的默认操作。（自 2.84开始）
mouseup()	触发此事件在可拖动对象上响应 DOM mouseup 事件。处理此事件将阻止 DOM mouseup 事件的默认操作。（自 2.84开始）
click()	点击可拖动对象时会触发此事件。（自 2.84开始）
dragstart()	可拖动对象的拖动事件开始时（当用户通过点击并拖动可拖动对象来启动拖动时）会触发此事件。（自 2.84开始）
drag()	当用户拖动可拖动对象时会重复触发此事件。（自 2.84开始）
dragend()	在可拖动对象的拖动事件结束时（用户释放拖动时）会触发此事件。（自 2.84开始）

GDraggableObjectOptions 类

此类代表

GDraggableObject

构造函数的可选参数。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
left	Number	对象的左侧起始位置（自 2.59开始）
top	Number	对象的顶端起始位置。（自 2.59开始）
container	Node	充当可拖动对象边界框的 DOM 元素（自 2.59开始）
draggableCursor	String	在鼠标悬停时显示的光标。（自 2.59开始）
draggingCursor	String	拖动时显示的光标。（自 2.59开始）
delayDrag	Boolean	默认情况下，可拖动 DOM 元素上触发的 DOM mousedown 事件时会触发 dragstart 事件。同样，当触发 DOM mouseup 事件时会触发 dragend 事件。将此值设置为 true 会延迟触发拖动事件，直到鼠标从生成 mousedown 或 mouseup 的位置移开为止。此属性的默认值为 false 。（自 2.84开始）

枚举 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开始）
G_GEO_TOO_MANY_QUERIES = 620	指定的密钥超出了 24小时的请求限制或在过短的一段时间内提交了过多的请求。如果您要同时或循环发送多个请求，请在代码中使用计时器或暂停以确保不会过快地发送请求。（自 2.55开始）

枚举 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开始）
9	建筑物（楼房名称、物业名称、购物中心等）级准确度。（自 2.105开始）

GClientGeocoder 类

此类用于和 Google 服务器建立直接通信，以获取用户指定地址的地址解析。另外，地址解析器可维护自己的地址缓存，可以无需往返于服务器而回答重复的查询。作为常用的最佳做法，建议不要在回路中使用

GClientGeocoder

函数。有多个地址要进行地址解析的开发人员或许应改为使用我们的 HTTP 地址解析器。

构造函数

构造函数	说明
GClientGeocoder(cache?:GGeocodeCache)	创建地址解析器的新实例，直接与 Google 服务器对话。可选的缓存参数允许指定已知地址的自定义客户端缓存。如果未指定缓存，则使用 GFactualGeocodeCache 。（自 2.55开始）

方法

方法	返回值	说明
getLatLng(address:String, callback:function)	None	向 Google 服务器发送请求，对指定的地址进行地址解析。如果地址已成功定位，则用 GLatLng 点调用用户指定的回调函数。否则，向回调函数提供一个 null 点。如果地址不明确，则仅向回调函数传递最匹配的点。（自 2.55开始）
getLocations(query:String\|GLatLng, callback:function)	None	此方法向 Google 地址解析服务发送请求，要求该服务对指定的 query 进行解析并在指定的 callback 中处理响应。“地址解析”是指将用户可读的地址转换成经度/纬度值。Google 地址解析服务还支持“反向地址解析”，其中提供的地理点会转换成用户可读的地址。要使用此地址解析服务，请调用此方法将其传递给 query 以进行地址解析。如果将查询作为可寻址的 String 提供，则该服务将进行标准的地址解析。但是，如果 query 包含 GLatLng ，则该服务将进行反转地址解析。此方法需要调用 Google 服务器，因此您还必须传递 callback 方法以处理响应。此响应将包含 Status 代码，如果成功，则会包含一个或多个 Placemark 对象。与 GClientGeocoder.getLatLng 方法不同，此回调函数可以通过检查 Status 字段来确定失败的原因。（自 2.55开始）
getCache()	GGeocodeCache	返回当前使用的地址解析缓存或 null （如果不执行客户端缓存）。（自 2.55开始）
setCache(cache:GGeocodeCache)	None	设置新的客户端缓存。如果用设置为 null 的缓存调用此方法，则禁用客户端缓存。设置新的缓存将会放弃以前存储的地址。（自 2.55开始）
setViewport(bounds:GLatLngBounds)	None	设置地址解析器以便在指定的视口内或附近放大地址解析结果。该视口表示为 GLatLngBounds 矩形。请注意，尽管设置视口会提升结果优先级，但不会将结果限制到该边界框内。（自 2.82开始）
getViewport()	GLatLngBounds	返回视口，用于放大该地址解析器内的地址解析结果。该视口表示为 GLatLngBounds 矩形。（自 2.82开始）
setBaseCountryCode(countryCode:String)	None	设置地址解析器以偏移搜索结果，就像这些搜索结果是从指定国家/地区代码顶级域 (ccTLD) 指定的域发送而来。地址解析仅在 Google 地图本身支持地址解析的那些国家/地区中受支持。多数 ccTLD 代码与 ISO 3166-1代码相同，但有部分例外应予以注意。例如，英国的 ccTLD 为“uk”( .co.uk )，而其 ISO 3166-1代码为“GB”。请注意，默认域是最初从中载入地图 API 的域。国家/地区代码不区分大小写。（自 2.82开始）
getBaseCountryCode()	String	返回指定地址解析器使用的当前国家/地区代码。（如果无有效国家/地区代码，则此方法返回 null 。）（自 2.82开始）
reset()	None	重置地址解析器。具体而言，如果此地址解析器使用客户端缓存，则此方法对其调用 GGeocodeCache.reset() 方法。（自 2.55开始）

GGeocodeCache 类

此类维护从地址到已知地点的地图。当此类完全生效时，它可作为一个从中派生更完善的缓存的基类。

构造函数

构造函数	说明
GGeocodeCache()	创建新的缓存，以便存储从地址到地点的地图。构造函数立即调用 GGeocodeCache.reset 方法。（自 2.55开始）

方法

方法	返回值	说明
get(address:String)	Object	返回指定 address 下存储的答复。如果未曾为指定的地址存储过答复，则此方法返回 null 。（自 2.55开始）
isCachable(reply:Object)	Boolean	返回是否应缓存指定的答复。默认情况下，对 reply 对象执行初步检查。具体而言，此类将确保对象不为 null 并且具有 name 字段。可以通过扩展类以提供有关 reply 对象的更准确的条件，来覆盖此方法。（自 2.55开始）
put(address:String, reply:Object)	None	在指定的 address 下存储指定的 reply 。此方法将调用 GGeocodeCache.isCachable 方法来验证是否可以缓存 reply 。如果得到允许，此方法会在借助 GGeocodeCache.toCanoninical 方法规范化的地址下缓存 reply 。（自 2.55开始）
reset()	None	从缓存中清除所有答复。在此方法返回后，缓存为空。（自 2.55开始）
toCanonical(address:String)	String	返回认为是规范的地址版本。该地址版本将 address 参数转换为小写，用空格替换逗号并用一个空格替换多个空格。（自 2.55开始）

GFactualGeocodeCache 类

此类通过对缓存答复设定更严格的条件来进一步优化基本的

GGeocodeCache

类。它仅缓存短期内更改可能性极小的答复。

构造函数

构造函数	说明
GFactualGeocodeCache()	创建新的缓存，仅存储视为实际存在的答复。（自 2.55开始）

方法

返回值

说明

isCachable(reply:Object)

Boolean

覆盖此方法的默认实现，以便对状态代码执行更彻底的检查。只有

Status.code

设置为

G_GEO_SUCCESS

的答复或确认无效的答复才视为可缓存。不缓存超时或导致常规服务器错误的答复。
（自 2.55开始）

GMarkerManager 类

此类可根据地图的当前视口和缩放级别管理地图上数百个标记的可见性。不推荐使用此类，建议开发人员改为使用开源 MarkerManager。

构造函数

构造函数	说明
GMarkerManager(map:GMap, opts?:GMarkerManagerOptions)	创建新的标记管理器，控制指定地图的标记可见性。（自 2.67开始）

方法

方法	返回值	说明
addMarkers(markers:GMarker[], minZoom:Number, maxZoom?:Number)	None	向此标记管理器添加一批标记。直到调用 refresh() 方法时，才会向地图添加这批标记。将标记置于地图中后，如果这些标记都在地图的当前视口范围内并且地图的缩放级别高于或等于指定的 minZoom ，则显示标记。如果给出了 maxZoom ，则在地图的缩放级别高于或等于指定级别时自动删除标记。（自 2.67开始）
addMarker(marker:GMarker, minZoom:Number, maxZoom?:Number)	None	向此管理器控制的标记集合添加单个标记。如果标记的位置在地图的当前视口范围内，并且地图的缩放级别属于指定的缩放级别范围，则立即向地图添加标记。与 addMarkers 方法类似， minZoom 和可选的 maxZoom 参数指定显示标记的缩放级别范围。（自 2.67开始）
refresh()	None	强制管理器更新地图上显示的标记。如果是使用 addMarkers 方法添加的标记，则必须调用此方法。（自 2.67开始）
getMarkerCount(zoom:Number)	Number	返回在指定缩放级别潜在可见的标记总数。这可能包括较低缩放级别的标记。（自 2.67开始）

事件

事件	说明
changed(bounds:GBounds, markerCount:Number)	在地图中添加或删除了管理器所管理的标记后，会触发此事件。。事件处理程序函数应准备接受两个参数。第一个参数是定义可见网格边界的矩形。第二个参数传递地图上当前显示的标记数目。

GMarkerManagerOptions 类

此类代表

GMarkerManager

构造函数的可选参数。它没有构造函数，但可实例化为对象常量。

属性

类型

说明

borderPadding

Number

指定管理器所监控的地图当前视口以外的额外填充（以像素表示）。即使此额外填充范围内的标记不完全可见，也会将它们添加到地图中。
（自 2.67开始）

maxZoom

Number

设置标记管理器所监控的最高缩放级别。如果未指定，则管理器采用最高地图缩放级别。如果将标记添加到管理器时没有使用可选

maxZoom

参数，也要使用此值。
（自 2.67开始）

trackMarkers

Boolean

指定标记管理器是否应跟踪标记移动。如果希望使用

setPoint

方法移动受管理的标记，则应将此选项设置为

true

。默认值为

false

。
（自 2.67开始）

GGeoXml 类

GGeoXml

对象将可公开访问的网络服务器上托管的 XML 文件（如 KML 文件）中的地理内容添加到地图上。它实现

GOverlay

接口，因此可使用

GMap2.addOverlay()

方法添加到地图中。

构造函数

说明

GGeoXml(urlOfXml:String, callback?:function)

创建表示该 XML 文件的

GOverlay

。当

GGeoXml

对象完成载入 XML 文件时会调用可选的回调函数。。
（自 2.108开始不推荐使用）

GGeoXml(urlOfXml:String)

创建表示该 XML 文件的

GOverlay

。
（自 2.108开始）

方法

方法	返回值	说明
getTileLayerOverlay()	GTileLayerOverlay	GGeoXml 对象可创建图块叠加层，在某些情况下可起到优化作用。此方法将返回此图块层叠加层（如果有）。请注意，如果不需要图块叠加层或 GGeoXml 文件尚未完成载入，则图块叠加层可能 null 。（自 2.84开始）
getDefaultCenter()	GLatLng	以 lat/lng 返回默认视口的中心点。只有在载入完文件后才可调用此函数。（自 2.84开始）
getDefaultSpan()	GLatLng	以 lat/lng 返回默认视口的跨度。只有在载入完文件后才可调用此函数。（自 2.84开始）
getDefaultBounds()	GLatLngBounds	返回默认视口的边界框。只有在载入完文件后才可调用此函数。（自 2.84开始）
gotoDefaultViewport(map:GMap2)	None	将地图的视口设置为 XML 文件的默认视口。（自 2.84开始）
hasLoaded()	Boolean	检查 XML 文件是否已完成载入，如果完成则返回 true 。如果尚未载入完 XML 文件，则此方法返回 false 。（自 2.84开始）
hide()	None	如果叠加层当前可见并且叠加层的 supportsHide() 方法返回 true，则隐藏 GGeoXml 对象创建的子叠加层。请注意，此方法会针对每个触发了该事件（例如 GMarker.visibilitychanged 和 GGroundOverlay.visibilitychanged 等）的子叠加层分别触发 visibilitychanged 事件。如果当前没有使 supportsHide() 返回 true 的可见叠加层，则此方法无效。（自 2.87开始）
isHidden()	Boolean	如果 GGeoXml 对象当前因被 GGeoXml.hide() 方法进行了更改而不可见，则返回 true 。否则，返回 false 。（自 2.87开始）
loadedCorrectly()	Boolean	检查 XML 文件是否已正确载入，如果是，则返回 true 。如果 XML 文件未正确载入，则此方法返回 false 。如果 XML 文件尚未完成载入，则此方法的返回值是“undefined”。（自 2.84开始）
show()	None	如果 GGeoXml 对象创建的子叠加层当前不可见，则显示它们。请注意，此方法会针对每个触发了该事件（例如 GMarker.visibilitychanged 和 GGroundOverlay.visibilitychanged 等）的子叠加层分别触发 visibilitychanged 事件。（自 2.87开始）
supportsHide()	Boolean	总是返回 true 。（自 2.87开始）

事件

事件	说明
load()	已完整载入 GGeoXml 的 XML 文件并且所有关联的叠加层已在地图上显示时，或者 XML 文件未正确载入时，会触发此事件。（自 2.108开始）

函数 GDownloadUrl

此函数提供一种便利方式，可异步检索按网址标识的资源。请注意，由于 XmlHttpRequest 对象用于执行请求，因此它受跨站脚本的同源限制，即网址必须指向与当前执行此代码的文档的网址相同的服务器。因此，对

url

参数使用绝对网址通常是多余的，最好仅使用绝对或相对路径。处理抛出的任何异常（如安全错误）都是调用者的职责。

函数

方法

返回值

说明

GDownloadUrl(url:String, onload:Function, postBody?:String, postContentType?:String)

None

从指定的网址中检索资源，然后通过将文档文本作为第一参数、将 HTTP 响应状态代码作为第二参数来调用

onload

函数。如果请求超时，则可将 null 作为第一参数、-1作为第二参数调用 onload 函数。此函数在默认情况下会发送 HTTP GET 请求。要发送 HTTP POST 请求，请传递可选

postBody

参数中的数据。如果发送的数据的类型不是“application/x-www-form-urlencoded”，则将内容类型作为字符串传递到

postContentType

参数中。此方法受跨站脚本限制。请注意，此方法使用浏览器的底层

XmlHttpRequest

实现。

函数 GBrowserIsCompatible

此函数确定地图 API 是否可用于当前的浏览器中。

函数

方法	返回值	说明
GBrowserIsCompatible()	Boolean	如果当前浏览器支持地图 API 库，则返回 true 。

函数 GUnload

您可调用此函数使地图 API 清理内部数据结构以释放内存。这有助于解除可导致网络应用程序中内存泄漏的各种浏览器故障。您应在页面的

unload

事件处理程序中调用此函数。调用此函数后，在此页面中创建的地图对象会出现功能混乱。

函数

方法	返回值	说明
GUnload()	None	删除所有注册的事件处理程序以防止内存泄漏。应作为 unload 事件的处理程序进行调用。

GDirections 类

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

构造函数

说明

GDirections(map?:GMap2, panel?:Element)

创建行车路线对象的新实例，以请求和存储行车路线的结果。如果使用

GDirections.load()

方法进行查询，则此行车路线对象可创建行车路线。

构造函数采用可选的地图对象（显示计算出的行车路线的折线）和/或面板 DIV 元素（以文本形式显示行车路线结果）。

如果传递了

map

参数，则只要计算出新的行车路线结果，与结果关联的折线和标记就会作为叠加层自动添加到地图上。同样，传递了

panel

参数后，与结果关联的文本格式的行车路线就会添加到指定的 DIV 中，以替换 DIV 中任何现有内容。

如果上述参数中有任何一个为 null，则直到使用

GDirections.load()

方法发出显式请求后才检索相关元素。（如下所示。）
此外，该对象还包含三个事件侦听器，可以截获：

“

load

”：通过

GDirections.load()

发布的行车路线查询结果可用时会触发此事件。请注意，

load()

方法会启动一个新的查询，该查询一旦完成载入又会触发一个“load”事件。将任何叠加层元素添加到地图/面板之前都会触发“load”事件。

“

addoverlay

”：在将折线和/或文本格式的行车路线组件添加到地图和/或 DIV 元素之后会触发此事件。请注意，如果不将其中任何一个元素附加到

GDirections

对象，则不会触发“addoverlay”事件。

“

error

”：如果行车路线请求导致错误，则触发此事件。调用者可以使用

GDirections.getStatus()

获取有关该错误的详细信息。当发生“error”事件时，不会触发“load”或“addoverlay”事件。

（自 2.81开始）

方法

方法	返回值	说明
load(query:String, queryOpts?:GDirectionsOptions)	None	此方法将发布新的行车路线查询。 query 参数为字符串，包含所有有效的行车路线查询，例如，“from: Seattle to: San Francisco”或“from: Toronto to: Ottawa to: New York”。默认情况下，如果在构造 GDirections 对象时指定了地图，则该查询将请求折线结果。同样，如果指定了文本面板，该查询也会请求详细的文本结果。否则，结果只包含已找到路线的摘要信息。为了覆盖此行为（比如，即使未将地图附加到此对象，也可请求折线信息），调用者可使用 queryOpts 可选参数。有关详细信息，请参见 GDirectionsOptions 文档。收到行车路线结果时，此对象清除旧结果，代之以新结果并用新结果更新地图和/或面板。行车路线结果由多条路线组成（ GRoute 类型的对象），查询中指定的每个连续路标/地址对都有一条路线。而路线又由多个路段组成（ GStep 类型的对象）。如果在重新调用 load() 时还未完成前一 load() 请求，则取消先前的请求。因此，可以使用单个 GDirections 对象连续发布行车路线请求，但要并行生成多个请求则必须使用多个 GDirections 对象。（自 2.81开始）
loadFromWaypoints(waypoints:Array, queryOpts?:GDirectionsOptions)	None	使用路标数组（而不是单一查询字符串）作为输入来发布新的行车路线查询。此数组最多可包含 25个路标条目。数组中的每一项都是一个表示输入地址或（纬度，经度）点的字符串。有关此方法行为的详细信息，请参见 GDirections.load() 。（自 2.81开始）
clear()	None	清除全部现有的行车路线结果，从地图和面板中删除叠加层，并取消任何未决 load() 请求。（自 2.81开始）
getStatus()	Object	返回行车路线请求状态。返回的对象具有以下形式： { code: 200 request: "directions" } 该状态代码可以采用 GGeoStatusCode 中定义的任意值。（自 2.81开始）
getBounds()	GLatLngBounds	此方法用于获取此行车路线查询结果的边界框。如果无法提供成功的结果，则返回 GLatLngBounds 对象或 null。（自 2.81开始）
getNumRoutes()	Number	返回结果中可用的路线数目。对于成功的查询，该数目应该是输入路标总数减 1。当没有可用结果时（因为未发布查询或先前的查询失败），此方法返回 0。（自 2.81开始）
getRoute(i:Number)	GRoute	在响应中为第 i 条路线返回 GRoute 对象。（自 2.81开始）
getNumGeocodes()	Number	返回结果中可用的地址解析项的数目。对于成功的查询，此数目应等于输入路标的总数目。当不存在可用结果时（因为未发布查询或先前的查询失败），此方法返回 0。（自 2.81开始）
getGeocode(i:Number)	Object	返回第 i 个路标的地址解析结果。此对象的结构与 GClientGeocoder 对象的响应中单个地标的结构相同。（自 2.81开始）
getCopyrightsHtml()	String	返回 HTML 字符串，它包含此结果的版权信息。（自 2.81开始）
getSummaryHtml()	String	返回包含对整个行车路线请求的距离和时间的概述的 HTML 代码段。请注意，此摘要是返回给构造时无关联地图或 DIV 元素的 GDirections 对象的唯一信息。（自 2.81开始）
getDistance()	Object	返回一个表示行车路线请求总距离（跨所有路线）的对象常量。对象包含两个字段：一个是称为“meters”的数字，表示距离的数值（以米为单位）；一个是称为“html”的字符串，包含本地化的距离字符串表示（以此行车路线组合的出发国家/地区的通用度量单位为单位）。（自 2.81开始）
getDuration()	Object	返回一个表示行车路线请求总时间（跨所有路线）的对象常量。对象包含两个字段：一个是称为“seconds”的数字，表示时间的数值（以秒为单位），另一个是称为“html”的字符串，包含时间的本地化字符串表示。（自 2.81开始）
getPolyline()	GPolyline	返回与整个行车路线响应相关联的 GPolyline 对象。请注意，在响应中有一条表示所有路线的折线。只有在载入了行车路线结果（即触发“load”事件）后，才能定义此对象。（自 2.81开始）
getMarker(i:Number)	GMarker	返回与第 i 条地址解析相关联的标记。只有在载入了行车路线结果（即触发“load”事件）后，此方法才能返回非空值。（自 2.81开始）

GDirectionsOptions 类

此类表示

GDirections.load()

和

GDirections.loadFromWaypoints()

方法的可选参数。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
locale	String	用于行车路线结果的区域。例如：“en_US”、“fr”和“fr_CA”等。
travelMode	GTravelModes	出行模式，如驾车（默认值）或步行。（自 2.129开始）
avoidHighways	Boolean	如果为 true ，则行车路线会在计算行车路线时试图排除高速公路。请注意，如果没有可行方案，则行车路线可能仍会选择高速公路。（自 2.124开始）
getPolyline	Boolean	默认情况下，仅在地图与 GDirections 对象关联时， GDirections.load*() 方法才会抓取折线数据。此字段可用于覆盖此行为，使得即使地图不与 Directions 对象关联也可检索折线数据。
getSteps	Boolean	默认情况下，仅在面板与 GDirections.load*() 对象关联时， GDirections 方法才会抓取步骤数据。此字段可用于覆盖此行为，使得即使不向 Directions 对象添加面板也可检索路段数据。
preserveViewport	Boolean	默认情况下，当 Directions 对象包含地图时，地图将处于中心位置并缩放到行车路线结果的边界框大小。当此选项设置为 true 时，只为此请求保留视口（除非在第一个位置从未设置它）。

枚举 GTravelModes

常数

常数	说明
G_TRAVEL_MODE_WALKING	步行（自 2.129开始）
G_TRAVEL_MODE_DRIVING	驾车（自 2.129开始）

GRoute 类

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

方法

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

GStep 类

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

方法

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

GTrafficOverlay类

GTrafficOverlay

对象将显示道路交通信息的叠加层添加到地图中。它实现

GOverlay

接口，因此可使用

GMap2.addOverlay()

方法添加到地图中，并可使用

GMap2.removeOverlay()

方法删除。

GTrafficOverlay

仅显示受支持城市的交通信息。

构造函数

构造函数	说明
GTrafficOverlay(opts?:GTrafficOverlayOptions)	创建新的 GTrafficOverlay 对象，显示道路交通信息。（自 2.81开始）

方法

方法	返回值	说明
hide()	None	隐藏交通叠加层。（自 2.81开始）
show()	None	显示交通叠加层。（自 2.81开始）

事件

说明

changed(hasTrafficInView:Boolean)

在当前的视口中更改交通数据的状态时会触发此事件。在含有交通数据和不含有交通数据的两个地区之间移动地图时，或向地图添加

GTrafficOverlay

导致交通数据显示在当前视口中时，会触发此事件。如果视口包含交通数据，则

hasTrafficInView

参数为

true

，否则为

false

。不管是隐藏还是显示该层，此事件都会起作用。
（自 2.85开始）

GTrafficOverlayOptions 类

此类代表

GTrafficOverlay

构造函数的可选参数。它没有构造函数，但可实例化为对象常量。

属性

类型

说明

incidents

Boolean

设置为

true

时，表示

GTrafficOverlay

应在地图相应位置上显示交通事故。默认情况下，该值设置为

false

。
（自 2.121开始）

hide

Boolean

设置为

true

时，表示地图不应一开始就显示

GTrafficOverlay

。要打开叠加层，请调用

GTrafficOverlay.show()

。默认情况下，该值设置为

false

。
（自 2.121开始）

GAdsManager 类

GAdsManager

对象抓取 AdSense 广告并将它们显示在指定的地图中。广告显示为

GMarker

，点击它可在标记信息窗口显示广告。

GAdsManager

根据当前视口大小和周围的页面文本内容选择 AdSense 广告。请注意，向地图添加

GAdsManager

时，还必须使用

enable()

方法专门启用它。

构造函数

说明

GAdsManager(map:GMap2, publisherId:String, adsManagerOptions?:GAdsManagerOptions)

创建新的

GAdsManager

对象，从 Google 服务器请求 AdSense 广告。

map

参数可识别此

GAdsManager

应在其上显示广告的地图。

publisherId

参数指定开发人员的 AdSense 帐户。

adsManagerOptions

参数是

GAdsManagerOptions

对象常量。
（自 2.85开始）

方法

方法	返回值	说明
enable()	None	启用抓取广告。默认情况下，不抓取广告。（自 2.85开始）
disable()	None	禁用抓取广告。（自 2.85开始）

GAdsManagerOptions 类

此类存储

GAdsManager

构造函数的可选参数。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
maxAdsOnMap	Number	任何时候可在地图上显示的最大广告数。默认值是 3。（自 2.85开始）
channel	Number	用于抓取广告的 AdSense 渠道数。渠道是 AdSense 发行人可用来从多个来源跟踪广告收入的可选功能。（自 2.85开始）
minZoomLevel	Number	显示广告的最低缩放级别。默认值是 6。（自 2.85开始）

GStreetviewPanorama 类

GStreetviewPanorama

对象包含 Flash? Street View Panorama 查看器的实例。此类的每个对象都包含一个单独的实例，显示唯一视图。该对象通常嵌入诸如

DIV

的容器对象中，并且可以使用此类的方法更改其视图。并不是所有位置都有街道视图数据。使用

GStreetviewClient

对象或

GStreetviewOverlay

对象确定是否有您的位置的街道视图数据。

构造函数

说明

GStreetviewPanorama(container:Node, opts?:GStreetviewPanoramaOptions)

使用所提供容器中相应的 flash 查看器创建新的

GStreetviewPanorama

对象。在可选的

GStreetviewPanoramaOptions

opts

对象中或通过调用

setLocationAndPOV

指定位置之前，将不会显示该查看器。
（自 2.104开始）

方法

方法	返回值	说明
remove()	None	从 DOM 中删除当前与此对象关联的 flash 查看器的实例。在删除 HTML 容器元素之前必须调用此函数，否则有些浏览器将无法对该flash 查看器进行垃圾收集。（自 2.104开始）
setContainer(container:Node)	None	为该 flash 查看器设置容器元素，如果该查看器当前是打开的，则从其旧位置对它进行移动。（自 2.104开始）
checkResize()	None	通知 flash 查看器其容器大小已更改。在更改了容器 DOM 对象的大小后调用此方法，以便查看器能够适合于新的大小。（自 2.104开始）
hide()	None	隐藏该 flash 查看器。要删除该查看器，请调用 .remove()。（自 2.104开始）
show()	None	显示该 flash 查看器。（自 2.104开始）
isHidden()	boolean	如果与此对象相关联的 flash 查看器不可见，则返回 true ，否则返回 false 。（自 2.104开始）
getPOV()	GPov	返回该 flash 查看器中显示的当前视点 (POV)。（自 2.104开始）
setPOV(pov:GPov)	None	在不更改其位置的情况下更改该 flash 查看器中显示的当前视点 (POV)。（自 2.104开始）
panTo(pov:GPov, opt_longRoute:Boolean)	None	在不更改其位置的情况下更改该 flash 查看器中显示的当前视点 (POV)。执行从当前 POV 到新 POV 的平滑动画。如果设置了 opt_longRoute，则动画会沿球体的长路线，否则沿最短的路线。（自 2.104开始）
setLocationAndPOV(latlng:GLatLng, opt_pov:GPov)	None	设置该 flash 查看器的位置和 POV。调用该函数后，查看器会显示距离提供的 latlng（若存在）最近的位置。如果该位置没有数据，那么该 flash 播放器会保持不变并显示错误代码。有关可能的响应代码，请参见 GStreetviewClient.ReturnValues 。（自 2.104开始）
followLink(yaw:Number)	None	点击从当前全景到相邻全景的链接。 yaw 指定相邻全景的方向；如果存在多个相邻全景，则采用最近的匹配。（自 2.104开始）

事件

事件	说明
yawchanged(yaw:Number)	flash 查看器中显示的偏角更改时触发该事件。（自 2.104开始）
pitchchanged(pitch:Number)	flash 查看器中显示的倾斜度更改时触发该事件。（自 2.104开始）
zoomchanged(zoom:Number)	flash 查看器的缩放级别更改时触发该事件。（自 2.104开始）
error(errorCode:GStreetviewPanorama.ErrorValues)	发生错误时触发该事件。有关错误类型的列表，请参见 GStreetviewPanorama.ErrorValues 。（自 2.104开始）
initialized(location:GStreetviewLocation)	移动到新位置后初始化全景时触发该事件。该位置是一个 GStreetviewLocation 对象。注意：首次显示全景时不会发送 initialized 事件；这是一个已知问题，我们计划在以后的版本中对其进行修正。（自 2.104开始）

GStreetviewPanoramaOptions 类

此类表示传递到

GStreetviewPanorama

构造函数的选项。该类没有构造函数，但可实例化为对象常量。所有属性都是“可选的”。

属性

属性	类型	说明
latlng	GLatLng	打开 flash 查看器的 latlng。（自 2.104开始）
pov	GPov	打开 flash 查看器的照相机方向。（自 2.104开始）

GStreetviewOverlay类

GStreetviewOverlay

对象是一个图块集，突出显示有街道视图数据的位置。此类实现

GOverlay

接口，并且可使用

map.addOverlay

添加到地图中，使用

map.removeOverlay

删除。

构造函数

说明

GStreetviewOverlay()

创建实现

GOverlay

接口的新

GStreetviewOverlay

。
（自 2.104开始）

事件

说明

changed(hasStreetviewData:Boolean)

当前视口中街道视图数据的状态变化时会触发此事件。将地图从具有街道视图数据的区域移动到没有街道视图数据的区域时会触发此事件，反之亦然。当向地图添加

GStreetviewOverlay

导致在视口中显示街道视图数据时也会触发此事件。如果视口包含街道视图数据，则

hasStreetviewData

参数为

true

，否则为

false

。
（自 2.120开始）

GStreetviewClient 类

GStreetviewClient

对象基于传递到其方法的参数搜索街道视图数据。

构造函数

构造函数	说明
GStreetviewClient()	创建新的 GStreetviewClient （自 2.104开始）

方法

方法	返回值	说明
getNearestPanoramaLatLng(latlng:GLatLng, callback:Function(GLatLng))	None	查找离指定点最近的全景的 GLatLng ，并将其传递给提供的回调函数。如果附近没有全景，或者服务器发生错误，则为提供的回调函数传递 null 值。（自 2.104开始）
getNearestPanorama(latlng:GLatLng, callback:Function(GStreetviewData))	None	检索离指定的 latlng最近的全景的数据，并将其作为 GStreetviewData 对象传递给提供的回调函数。（自 2.104开始）
getPanoramaById(panoId:string, callback:Function(GStreetviewData))	None	检索指定全景 ID 的数据，并将其作为 GStreetviewData 对象传递给提供的回调函数。每个全景的 ID 是唯一的，在某个会话的生命期内是稳定的，但是很有可能在不同会话之间会改变。（自 2.104开始）

枚举 GStreetviewClient.ReturnValues

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

常数

常数	说明
SUCCESS = 200	成功（自 2.104开始）
SERVER_ERROR = 500	服务器没有响应查询。（自 2.104开始）
NO_NEARBY_PANO = 600	没有找到全景数据。（自 2.104开始）

GStreetviewData 类

此类表示与全景相关的数据。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
location	GStreetviewLocation	位置数据。（自 2.104开始）
copyright	String	本地化的版权归属。（自 2.104开始）
links	GStreetviewLink[]	到相邻全景的链接（如果有）。（自 2.104开始）
code	GStreetviewClient.ReturnValues	状态代码。请参见 GStreetviewClient.ReturnValues. （自 2.104开始）

GStreetviewLocation 类

此类表示一个街道视图位置。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
latlng	GLatLng	全景的 latlng。（自 2.104开始）
pov	GPov	初始视点。（自 2.104开始）
description	String	描述该位置的本地化字符串。（自 2.104开始）
panoId	String	全景的唯一标识符。该标识符在某个会话内是稳定的，但是在会话之间不稳定。（自 2.104开始）

GStreetviewLink 类

此类表示从一个

GStreetviewLocation

到相邻

GStreetviewLocation

的链接。它没有构造函数，但可实例化为对象常量。

属性

属性	类型	说明
yaw	Number	从当前位置到相邻位置的偏角。（自 2.104开始）
description	String	描述相邻位置的本地化字符串。（自 2.104开始）
panoId	String	相邻全景的唯一标识符。该标识符在某个会话内是稳定的，但是在会话之间不稳定。（自 2.104开始）

GPov 类

此类表示街道视图所使用的照相机视点结构。它没有构造函数，但可实例化为对象常量。所有属性都是“可选的”。

属性

属性	类型	说明
yaw	Number	相对于正北方的照相机偏角。正北方为 0度，东方为 90度，南方为 180度，西方为 270度。（自 2.104开始）
pitch	Number	相对于街道视图工具的照相机偏角（度数）。范围从90度（垂直向上）到 -90度（垂直向下）。（自 2.104开始）
zoom	Number	缩放级别。完全缩小为 0级别，放大会增大级别。（自 2.104开始）

枚举 GStreetviewPanorama.ErrorValues

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

常数

常数	说明
NO_NEARBY_PANO = 600	没有找到全景数据。（自 2.104开始）
FLASH_UNAVAILABLE = 603	flash 查看器不可用，通常是因为用户的浏览器不支持 flash。（自 2.104开始

出处：http://liongis.cnblogs.com/

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航