Google Map API(转)
2010-07-15 10:23 破狼 阅读(3211) 评论(0) 编辑 收藏 举报
Google 地图 API 参考
Google 地图 API 现在与 Google AJAX API 载入器集成,后者创建了一个公共命名空间,以便载入和使用多个 Google AJAX API。该框架可让您将可选 google.maps.*
命名空间用于当前在 Google 地图 API 中使用的所有类、方法和属性,使用此命名空间替换常规 G
前缀。不要担心,现有 G
命名空间仍能得到支持。
例如,Google 地图 API 中的 GMap2
对象还可以定义为 google.maps.Map2
。
请注意,此参考文档仅指现有 G
命名空间。
如果只是要使用地图显示内容,则需要了解以下类、类型和函数:
如果您要通过实现自己的控件、叠加层或地图类型来扩展地图 API 的功能,则还需要了解以下类和类型:
GMap2 类
对 GMap2
类进行实例化以创建地图。这是 API 中的中心类。其他都是辅助类。
构造函数
构造函数 | 说明 |
---|---|
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() 使用。 |
地图类型
方法 | 返回值 | 说明 |
---|---|---|
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 -1 0 +1, dy:one of -1 0 +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*() 方法的信息窗口标签数据结构。 |
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 开始) |
方法
将标记添加到地图中后,才能调用这些方法。
方法 | 返回值 | 说明 |
---|---|---|
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.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.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 开始) |
方法
方法 | 返回值 | 说明 |
---|---|---|
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 开始) |
属性
属性 | 类型 | 说明 |
---|---|---|
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 开始) |
属性
属性 | 类型 | 说明 |
---|---|---|
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 地图坐标系统中,x
坐标向右增大,y
坐标“向下”增大,不过如果愿意,您也可以使用 GPoint
坐标。
注意:尽管 GPoint
的两个参数可以作为属性 x
和 y
访问,但是请勿修改它们,而是在创建新对象时使用不同的参数。
构造函数
构造函数 | 说明 |
---|---|
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 度子午线相交的矩形。
构造函数
方法
方法 | 返回值 | 说明 |
---|---|---|
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
|
作者:破 狼
出处:http://www.cnblogs.com/whitewolf/
本文版权归作者,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。该文章也同时发布在我的独立博客中-个人独立博客、博客园--破狼和51CTO--破狼。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 地球OL攻略 —— 某应届生求职总结
· 提示词工程——AI应用必不可少的技术
· Open-Sora 2.0 重磅开源!
· 周边上新:园子的第一款马克杯温暖上架