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 度子午線相交的矩形。
構造函數
構造函數 | 說明 |
---|---|
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) 2006 Google, 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 |
未出現錯誤,已對地址成功地進行了解析,並返回其地址解析。
(自 2.55 開始) |
G_GEO_BAD_REQUEST |
無法成功解析行車路線請求。例如,如果此請求包含的路標數大於允許的最大最大數,則該請求可能已被拒絕。
(自 2.81 開始) |
G_GEO_SERVER_ERROR |
無法成功處理地址解析或行車路線請求,但是確切的失敗原因未知。
(自 2.55 開始) |
G_GEO_MISSING_QUERY |
HTTP q 參數缺失或沒有值。對於地址解析請求,這意味着將空地址指定爲輸入。對於行車路線請求,這意味着在輸入中未指定查詢。
(自 2.81 開始) |
G_GEO_MISSING_ADDRESS |
G_GEO_MISSING_QUERY 的同義名。
(自 2.55 開始) |
G_GEO_UNKNOWN_ADDRESS |
找不到指定地址的對應地理位置。這可能是地址比較新,或地址不正確。
(自 2.55 開始) |
G_GEO_UNAVAILABLE_ADDRESS |
由於合法性或合同原因,無法返回指定地址的地址解析或指定行車路線查詢的路線。
(自 2.55 開始) |
G_GEO_UNKNOWN_DIRECTIONS |
Gdirections 對象無法計算查詢中提到的兩點之間的行車路線。這通常是因爲兩點之間無可用路線,或我們沒有該地區的路線數據。
(自 2.81 開始) |
G_GEO_BAD_KEY |
指定的密鑰無效或與指定的域不匹配。
(自 2.55 開始) |
G_GEO_TOO_MANY_QUERIES |
指定的密鑰超出了 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”( 請注意,默認域是最初從中載入地圖 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() 方法發出顯式請求後才檢索相關元素。(如下所示。)
此外,該對象還包含三個事件偵聽器,可以截獲:
(自 2.81 開始) |
方法
方法 | 返回值 | 說明 |
---|---|---|
load(query:String, queryOpts?:GDirectionsOptions) |
None |
此方法將發佈新的行車路線查詢。query 參數爲字符串,包含所有有效的行車路線查詢,例如,“from: Seattle to: San Francisco”或“from: Toronto to: Ottawa to: New York”。默認情況下,如果在構造GDirections 對象時指定了地圖,則該查詢將請求折線結果。同樣,如果指定了文本面板,該查詢也會請求詳細的文本結果。否則,結果只包含已找到路線的摘要信息。爲了覆蓋此行爲(比如,即使未將地圖附加到此對象,也可請求折線信息),調用者可使用 queryOpts 可選參數。有關詳細信息,請參見 GDirectionsOptions 文檔。
收到行車路線結果時,此對象清除舊結果,代之以新結果並用新結果更新地圖和/或面板。行車路線結果由多條路線組成(
如果在重新調用 (自 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 |
成功
(自 2.104 開始) |
SERVER_ERROR |
服務器沒有響應查詢。
(自 2.104 開始) |
NO_NEARBY_PANO |
沒有找到全景數據。
(自 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 |
沒有找到全景數據。
(自 2.104 開始) |
FLASH_UNAVAILABLE |
flash 查看器不可用,通常是因爲用戶的瀏覽器不支持 flash。
(自 2.104 開始) |