Leaflet API 翻譯(一)

摘自:http://jsrookie.iteye.com/blog/2318972

L.Map

  API各種類中的核心部分,用來在頁面中創建地圖並操縱地圖。

Constructor(構造器)

  通過div元素和帶有地圖選項的描述的文字對象來實例化一個地圖對象,其中文字對象是可選的。

Options(選項)

Map State Options(地圖狀態選項)

centre(中心):初始化地圖的地理中心。

zoom(縮放):初始化地圖的縮放。

layers(圖層):初始化後加載到地圖上的圖層。

minZoom(最小視圖):地圖的最小視圖。可以重寫地圖圖層的最小視圖。

maxZoom(最大視圖):地圖的最大視圖。可以重寫地圖圖層的最大視圖。

maxBounds(最大邊界):當這個選項被設置後,地圖被限制在給定的地理邊界內,當用戶平移將地圖拖動到視圖以外的範圍時會出現彈回的效果,並且也不允許縮小視圖到給定範圍以外的區域(這取決於地圖的尺寸)。使用setMaxBounds方法可以動態地設置這種約束。

crs(座標參考系統):使用的座標系,當你不確定座標系是什麼時請不要更改。

Interaction Options(交互操作)

dragging(拖動):決定地圖是否可被鼠標或觸摸拖動。

touchZoom(觸摸縮放):決定地圖是否可被兩隻手指觸摸拖拽縮放。

scrollWheelZoom(滾輪縮放):決定地圖是否被被鼠標滾輪滾動縮放。

doubleClickZoom(雙擊縮放):決定地圖是否可被雙擊縮放。

boxZoom(多邊形縮放):決定地圖是否可被縮放到鼠標拖拽出的矩形的視圖,鼠標拖拽時需要同時按住shift鍵。

trackResize(追蹤尺寸改變):確定地圖在窗口尺寸改變時是否可以自動處理瀏覽器以更新視圖。

worldCopyJump(領域副本跳轉):當這個選項可用時,當你平移地圖到其另一個領域時會被地圖捕獲到,並無縫地跳轉到原始的領域以保證所有標註、矢量圖層之類的覆蓋物仍然可見。

closePopupOnClick(點擊關閉消息彈出框):當你不想用戶點擊地圖關閉消息彈出框時,請將其設置爲false。

Keyboard Navigation Options(鍵盤操縱選項)

keyboard(鍵盤):聚焦到地圖且允許用戶通過鍵盤的方向鍵和加減鍵來漫遊地圖。

keyboardPanOffset(鍵盤平移補償):確定按鍵盤方向鍵時地圖平移的像素。

keyboardZoomOffset(鍵盤縮放補償):確定鍵盤加減鍵對於的縮放級數。

Panning Inertia Options(平移慣性選項)

inertia(慣性):如果該選項可用,在拖動和在某一時間段內持續朝同一方向移動建有動力的地圖時,會有慣性的效果。

inertiaDeceleration(慣性減速):確定慣性移動減速的速率,單位是像素每秒的二次方。

inertiaMaxSpeed(慣性最大速度):慣性移動的最大速度,單位是像素每秒。

inertiaThreshold(慣性閾值):放開鼠標或是觸摸來停止慣性移動與移動停止之間的毫秒數。

Control options(控制選項)

zoomControl(縮放控制):確定縮放控制是否默認加載在地圖上。

attributionControl(屬性控制):確定屬性控制是否默認加載在地圖上。

Animation options(動畫選項)

fadeAnimation(淡出動畫):確定瓦片淡出動畫是否可用。通常默認在所有瀏覽器中都支持CSS3轉場,android例外。

zoomAnimation(縮放動畫):確定瓦片縮放動畫是否可用。通常默認在所有瀏覽器中都支持CSS3轉場,android例外。

markerZoomAnimation(註記縮放動畫):確定註記的縮放是否隨地圖縮放動畫而播放,如果被禁用,註記在動畫中拉長時會消失。通常默認在所有瀏覽器中都支持CSS3轉場,android例外。

Events(事件)

click(點擊):用戶點擊或觸摸地圖時觸發。

dbclick(雙擊):用戶雙擊或連續兩次觸摸地圖時觸發。

mousedown(鼠標按下):用戶按下鼠標按鍵時觸發。

mouseup(鼠標擡起):用戶按下鼠標按鍵時觸發。

mouseover(鼠標經過):鼠標進入地圖時觸發。

mouseout(鼠標移出):鼠標離開地圖時觸發。

mousemove(鼠標移動):鼠標在地圖上移動時觸發。

contextmenu(情景菜單):當用戶在地圖上按下鼠標右鍵時觸發,如果有監聽器在監聽這個時間,則瀏覽器默認的情景菜單被禁用。

focus(聚焦):當用戶在地圖上進行標引、點擊或移動時進行聚焦。

blur(變暗):當地圖失去焦點時觸發。

preclick(預先點擊):當鼠標在地圖上點擊之前觸發。有時會在點擊鼠標時,並在已存在的點擊事件開始處理之前想要某件事情發生時用得到。

load(載入):當地圖初始化時觸發。(當地圖的中心點和縮放初次設置時)

viewreset(視圖重置):當地圖需要重繪內容時觸發。(通常在地圖縮放和載入時發生)這對於創建用戶自定義的疊置圖層非常有用。

movestart(移動開始):地圖視圖開始改變時觸發。(比如用戶開始拖動地圖)

move(移動):所有的地圖視圖移動時觸發。

moveend(移動結束):當地圖視圖結束改變時觸發。(比如用戶停止拖動地圖)

dragstart(拖動開始):用戶開始拖動地圖時觸發。

drag(拖動):用戶拖動地圖時不斷重複地觸發。

dragend(拖動結束):用戶停止拖動時觸發。

zoomstart(縮放開始):當地圖縮放即將發生時觸發。(比如縮放動作開始前)

zoomend(縮放結束):當地圖縮放時觸發。

autopanstart(自動平移開始):打開彈出窗口時地圖開始自動平移時觸發。

layeradd(添加圖層):當一個新的圖層添加到地圖上時觸發。

layerremove(圖層移除):當一些圖層從地圖上移除時觸發。

baselayerchange(基礎圖層改變):當通過圖層控制檯改變基礎圖層時觸發。

locationfound(位置查找):當地理尋址成功時觸發(使用locate方法)。

locationerror(定位錯誤):當地理尋址錯誤時觸發(使用locate方法)。

popupopen(打開彈出框):當彈出框打開時觸發(使用openPopup方法)。

popupclose(關閉彈出框):當彈出框關閉時觸發(使用closePopup方法)。

 

Methods for Modifying Map State(地圖狀態修改)

setView(設定視圖):設定地圖(設定其地理中心和縮放),如果forceReset設置的是true,即使移動和縮放動作是合理的,地圖也會重載,其默認值是fault。

setZoom(設定縮放):設定地圖的縮放。

zoomIn(放大):通過delta變量放大地圖的級別,1是delta的默認值。

zoomOut(縮小):通過delta變量縮小地圖的級別,1是delta的默認值。

fitBounds(使適合邊界):將地圖視圖儘可能大地設定在給定的地理邊界內。

fitWorld(使適合地域範圍):將地圖視圖儘可能大地設定在包含全部地域的級別上。

panTo(平移至中心點):將地圖平移到給定的中心。如果新的中心點在屏幕內與現有的中心點不同則產生平移動作。

panInsideBounds(平移到某邊界內):平移地圖到坐落於給定邊界最接近的視圖內。

panBy(通過像素點平移):通過給定的像素值對地圖進行平移。

invalidateSize(無效的大小):檢查地圖容器的大小是否改變並更新地圖,如果是這樣的話,在動態改變地圖大小後調用,如果animate是true的話,對地圖進行更新。

setMaxBounds(設置最大邊界):將地圖限定在給定的邊界內。

locate(定位):用地理定位接口獲取用戶位置信息,在成功定位或定位出錯產生locationerror後解除location-found事件與定位數據,且將地圖視圖設定到檢測的確切的用戶的位置(如果定位失敗則回到地域視圖)。在Location Options中有更多詳細內容。

stopLocation(停止定位):開始map.locate方法時停止預先檢測位置信息。

Methods for Getting Map State(獲取地圖狀態)

getCenter(獲取地圖中心):返回地圖視圖的地理中心。

getZoom(獲取縮放級別):獲取地圖視圖現在所處的縮放級別。

getMixZoom(獲取最小縮放級別):返回地圖最小的縮放級別。

getMaxZoom(獲取最大縮放級別):返回地圖最大的縮放級別。

getBounds(獲取邊界):返回地圖視圖的經緯度邊界。

getBoundsZoom(獲取邊界縮放級別):返回適應整個地圖視圖邊界的最大縮放級別。如果inside的設置時true,這個方法返回適應整個地圖視圖邊界的最小縮放級別。

getSize(獲取大小):返回現有地圖容器的大小。

getPixelBounds(獲取像素邊界):返回地圖視圖在像素投影座標系下的邊界。(很多時候對用戶自定義圖層和疊加很有用)

getPixelOrigin(獲取像素原點):返回地圖圖層像素投影座標系下的左上角的點。(很多時候對用戶自定義圖層和疊加很有用)

Methods for Layers and Controls(圖層控制)

addlayer(添加圖層):將圖層添加到地圖上。如果insertAtTheBottom的選項爲true,圖層添加時在所以圖層之下。(在切換基底圖時比較有用)

removelayer(移除圖層):將圖層在地圖上移除。

haslayer(是否有此圖層):如果添加的圖層是當前圖層則返回true。

openPopup(打開彈出框):當關閉前一個彈出框時彈出指定的對話框。(確定在同一時間只有一個打開並可用)

closePopup(關閉彈出框):關閉openPopup打開的彈出框。

addControl(添加控制):在地圖上添加控制選項。

removeControl(移除控制):在地圖上移除控制選項。

Conversion Methods(轉換方法)

latlngToLayerPoint(將經緯度添轉變爲圖層上的點):返回地圖圖層上與地理座標相一致的點。(在地圖上進行位置疊加時比較有用)

layerPointToLatLng(將圖層上的點轉換爲經緯度點):返回給定地圖上點的地理座標系。

containerPointToLayerPoint(容器點到圖層點):將於地圖容器相關的點轉換爲地圖圖層相關的點。

layerPointToContainerPoint(圖層點到容器點):將地圖圖層相關的點轉換爲地圖容器相關的點。

LatLngToContainerPoint(經緯度點到容器點):返回與給定地理座標系相符的地圖容器的點。

containerPointToLatLng(容器點轉換爲經緯度點):返回給定地理容器點的地理座標。

project(投影):將地理座標投影到指定縮放級別的像素座標系中。

unproject(反投影):將像素座標系投影到指定縮放級別的地理座標系中。(默認爲當前的縮放級別)

mouseEventToContainerPoint(鼠標點擊事件到地圖容器點):返回鼠標點擊事件對象的像素座標(與地圖左上角相關)。

mouseEventToLayerPoint(鼠標點擊事件到地圖容器點):返回鼠標點擊事件對象的像素座標(與地圖圖層相關)。

mouseEventToLatLng(鼠標點擊事件到經緯度點):返回鼠標點擊事件對象的地理座標。

Other Methods(其他方法)

getContainer(獲取容器):返回地圖容器對象。

getPanes(獲取地圖邊框):返回不同地圖對象的邊框(疊加渲染)

whenReady(準備就緒):當地圖的位置和縮放初始化好或是時間發生之後,運行給定的回調方法,通常傳遞一個函數內容。

Locate options(位置選項)

watch(監聽):如果該值爲真,則開始利用W3C的watchPosition方法監聽位置變化情況(而不是指監聽一次)。你可以通過map.stoplocate()方法來停止監聽。

setView(設置視圖):如果該值爲真,則通過自動將地圖視圖定位到用戶一定精度範圍內的位置,如果地理定位失敗則顯示全部地圖。

maxZoom(最大級別):在使用setView選項時視圖縮放的最大級別。

timeout(超時):在觸發locationerror事件之前等待地理定位的毫秒爲單位的時間。

maximumAge(最大生命週期):位置監聽的最大生命週期。如果比最後定位回覆後毫秒用時短,則locate返回一個緩存位置。

enableHighAccuracy(開啓高精度):開啓高精度,參加W3C SPEC的描述。

Properties(屬性)

地圖屬性包括互動操作,允許你在運行環境中互動地控制地圖行爲,比如通過拖拽和點擊縮放級別顯示和不顯示某要素。

你也可以通過地圖屬性來接受默認的地圖控制項,比如屬性控制。

 

dragging(拖拽):地圖拖拽處理程序,可以通過鼠標和觸摸的形式。

touchZoom(觸摸縮放按鈕):觸摸地圖縮放處理程序。

doubleClickZoom(雙擊縮放):雙擊縮放處理程序。

scrollWheelZoom(滾動縮放):滾動縮放處理程序。

boxZoom(矩形框縮放):矩形框(利用鼠標拖動)縮放處理程序。

keyboard(鍵盤):鍵盤導向處理程序。

zoomControl(縮放控制):縮放控制。

attributionControl(屬性控制):屬性控制。

Map Panes(地圖窗口)

望文思義,這是一個包括可以用來放置自定義圖層的不同的地圖窗口的對象。最大的區別是圖層的疊置。

mapPane(地圖窗口):包含其他地圖窗口的窗口。

tilePane(切片窗口):切片圖層的窗口。

objectsPane(對象窗口):包含除切片窗口以外所有窗口的窗口。

shadowPane(隱含窗口):用來隱藏圖層的窗口(如標註的隱藏)。

overlayPane(圖層窗口):這線段和多邊形一類圖層的窗口。

markerPane(標註窗口):標註圖標的窗口。

popupPane(彈出窗口):彈出的窗口。

L.Marker

用來在地圖中放置註記。

Constructor(構造函數)

L.Marker():通過給定一個地理點和一個具有選項的對象來實例化一個註記。

Options(選項)

icon(圖標):圖標類用來表達註記。參加Icon documentation以瞭解自定義註記圖標的詳細信息。默認設置爲new L.Icon.Default()。

clickable(可點擊):如果是false,註記則不產生鼠標事件並表現爲底層地圖的一部分。

draggable(可拖動):決定註記是否可被鼠標或觸摸拖動。

title(標題):註記旁邊顯示瀏覽器提示的文本信息。

zIndexOffset():默認情況下,註記圖片的疊置順序由緯度自動設置。如果你想將某一註記放置於其他之上可用這個選項,設置一個較大的值即可,比如1000(或是相反地設置一個較大的負值)。

opacity(不透明度):決定註記的不透明度。

riseOnHover(凸顯):如果此值爲true,則當把鼠標放置於註記之上時,註記會顯示與其他註記之上。

riseOffset(凸顯補償):riseOnHover要素凸顯時高度的補償值。

Events(事件)

click(點擊):當鼠標點擊註記時觸發。

dbclick(雙擊):當鼠標雙擊註記時觸發。

mousedown(鼠標按下):當鼠標按下鼠標鍵時觸發。

mouseover(鼠標置於其上):當鼠標在註記上時觸發。

mouseout(鼠標移出):當鼠標離開註記時觸發。

contextmenu(文本菜單):當鼠標右擊註記時觸發。

dragstrat(拖動開始):當用戶拖動註記時觸發。

drag(拖動):當用戶拖動註記時不斷觸發。

dragend(拖動結束):當用戶停止拖動註記時觸發。

move(移動):當註記通過定義經緯度而移動時觸發。新的座標包含事件參數。

remove(刪除):當註記在地圖上被刪除時觸發。

Methods(方法)

addTo():在地圖上添加註記。

getLatLng():返回當前註記的地理位置。

setLatLng():將註記位置更改到給定點。

setIcon():更改註記的圖標。

setZIndexOffset():更改註記的zIndex offset。

setOpacity():更改註記的透明度。

update():更新註記的位置,在直接更改經緯度對象的座標時比較有用。

bindPopup():當點擊一個註記時綁定一個特定的HTML內容的彈出窗口。你也可以用Marker中的openPopup方法打開綁定的彈出窗口。

unbindPopup():將先前用bindPopup方法綁定的註記取消。

openPopup():打開先前用bindPopup方法綁定的彈出框。

closePopup():關閉已打開的註記的彈出框。

Interaction handlers(互操作處理程序)

dragging(拖動):註記拖動處理程序(包括鼠標和觸摸)。

L.Popup

Constructor(函數構造器)

L.Popup():通過給定一些選項構造一個彈出框對象,對象用來描述出現形式和位置還有一個可選對象來根據指向的資源對象標註彈出框。

maxWidth(最大寬度):彈出框的最大寬度。

minWidth(最小寬度):彈出框的最小寬度。

maxHeight(最大高度):設置後,如果內容超過彈出窗口的給定高度則產生一個可以滾動的容器。

autoPan(自動平移):如果你不想地圖自動平移來適應打開的彈出框,就設置其爲false。

closeButton(關閉按鈕):控制彈出窗口中出現的關閉按鈕。

offset(補償值):彈出窗口位置的補償值。在同一圖層中打開彈出窗口時對於控制錨點比較有用。

autoPanPadding(自動平移填補):在地圖視圖自動平移產生後彈出窗口和地圖視圖之間的邊緣。

zoomAnimation:決定是否在所在級別上彈出窗口。如果你在彈出窗口中有flash內容的最好將其設置爲不可用。

Methods(方法)

addTo:將彈出窗口添加到地圖上。

openOn:將彈出窗口添加到地圖上並將之前的一個關閉。與map.oenPopup(popup)方法相同。

setLatLng:設置彈出窗口打開的地理上的點位。

setContent:設置彈出窗口的HTML內容。

L.TileLayer

用來在地圖上載入和顯示切片圖層,用ILayer接口實現。

Constructor(函數構造器)

L.TileLayer():通過給定URL模板和具有選項的對象來實例化一個切片圖層。

URL template(URL模板)

見下面的例子

L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'})

Options(選項)

minZoom:最小級別數

maxZoom:最大級別數

tileSize:切片尺寸(寬度和高度的像素值,假設切片是正方形的)

subdomains:服務的子域。可以傳遞一個字符串(其中每一個字母都是一個子域名稱)或是一個字符串數組。

errorTileUrl:圖片的URL給出加載錯誤的位置。

attribution:用來進行屬性控制的字符串,描述了圖層數據。

tms:如果此值爲true,反轉切片Y軸的編號(對於TMS服務需將此項打開)。

continuousWorld:如果設置爲true,切片的座標系不會被世界範圍的寬度(-180度到180度)所覆蓋,也不會被在世界範圍的高度(-90度到90度)之內。你可以將此用在不反應真是世界的地圖上(比如遊戲、室內或照片的地圖)。

noWrap:如果設置此項爲true,則切片不會用重複填充來表示世界範圍(經度-180到180之間)之外的地方。

zoomOffset:用此值來補償URL中地圖的縮放級別。

zoomReverse:如果此項爲true,URL中的縮放級別會被反轉(用最大到最小縮放級別來替代縮放級別)。

opacity:切片圖層的透明度。

zIndex:切片圖層明確的疊置順序,默認此項不會被設置。

unloadInvisibleTiles:如果此項爲true,在平移後所有看不到的切片都會被移除(用以更好地顯示),在移動設備的webkit中默認是true,其他的默認爲false。

updateWhenIdle:如果此項爲false,在平移過程中新的切片將會載入,其他的在其後載入(用以更好地顯示),在移動設備webKit中默認是true,其他默認false。

detectRetina:如果此項爲true,並且用戶是視網膜顯示模式,會請求規定大小一般的四個切片和一個地區內一個更大的縮放級別來利用高分辨率。

reuseTiles:如果此項爲true,在平移後不可見的切片被放入一個隊列中,在新的切片開始可見時他們會被取回(而不是動態地創建一個新的)。這理論上可以降低內存使用率並可以去除在需要新的切片時預留內存。

Events(事件)

loading:當切片圖層開始加載切片時觸發。

load:當切片圖層加載完可見切片後觸發。

tileload:在加載切片時觸發。

tileunload:在切片被移除時觸發(比如打開了unloadInvisibleTiles)。

Methods(方法)

addTo():將圖層加到地圖上。

bringToFront():將此切片圖層放到所有切片圖層之上。

bringToBack():將此切片圖層放到所有切片圖層之下。

setOpacity():改變切片圖層的透明度。

setZIndex():設置切片圖層的疊放順序。

redraw():清除所有的切片並重新向服務端申請他們。

setUrl():更新圖層的URL模板並重繪他們。

L.TileLayer.WMS

用來顯示地圖上切片圖層的WMS服務,繼承自TileLayer。

Constructor(函數構造器)

L.TileLayer.WMS(): 通過給定一個基本的WMS服務的URL和WMS參數或選項對象來實例化一個WMS切片圖層對象。

Options(選項)

layers:WMS圖層以逗號分隔符隔開的列表。

styles:WMS樣式以逗號分隔符隔開的列表。

format:WMS圖像格式(用“image/png”來顯示透明圖層)。

transparent:如果該項爲true,WMS服務返回透明圖片。

version:WMS服務的版本。

Methods(方法)

setParams():融合新的參數和在當前屏幕中重申請的切片(除非noRedraw設置爲true)。

L.TileLayer.Canvas

用來創建瀏覽器端繪製的切片圖層的底層畫布。

Constructor(函數構造器)

L.TileLayer.Canvas():通過一個具有選項的對象來實例化一個切片圖層畫布對象。

Options(選項)

async:在實例化時可以異步地繪製切片。在全部繪製完後,tileDrawn方法需要在每個切片上使用。

Methods(方法)

drawTile():在創建實例來繪製切片後你需要定義此方法;canvas是你可以繪製的實際上的切片畫布,tilePoint反應了切片的數目,zoom是當前的縮放級別。

tileDrawn():如果async選項被定義,在全部繪製完後,這個函數需要在每個切片上使用。canvas與畫布對象相同,傳遞參數給drawTile。

L.ImageOverlay

用來在地圖上規定範圍內載入和顯示單幅圖像,繼承自ILayer。

Constructor(函數構造器)

L.ImageOverlay():通過給定圖像的URL和相關的地理範圍來實例化一個圖像疊加層對象。

Options(選項)

opacity:圖像疊加層的透明度。

Methods(方法)

addTo():將圖像疊加層添加到地圖上。

setOpacity():設置疊加層的透明度。

bringToFront():將疊加層置於所有層的頂層。

bringToBack():將疊加層置於所有層的底層。

L.Path

是包含選項和與適量疊加層共享常量的抽象類。不可以接使用。

Options(選項)

stroke:路徑是否描邊。設置爲false時,多邊形和圓的邊界將不可見。

color:描邊顏色。

weight:描邊的像素級別的寬度。

opacity:描邊透明度。

fill:路徑是否填充顏色。設置爲false時,多邊形和圓的填充內容不可見。

fillColor:填充顏色。

fillOpacity:填充透明度。

dashArray:定義描邊線型的字符串。這在畫布上不起作用。(比如android 2)

clickable:如果此項爲false,則矢量不產生鼠標事件並表現爲底圖的一部分。

Events(事件)

click:用戶點擊或點觸對象時觸發。

dbclick:用戶雙擊或連續兩次點觸對象時觸發。

mousedown:當用戶在對象上按下鼠標時觸發。

mouseover:當鼠標置於對象上方時觸發。

mouseout:當鼠標離開對象時觸發。

contextmenu:當用戶在對象上點擊鼠標右鍵時觸發,當此事件被監聽時,會阻止彈出瀏覽器本身的右鍵菜單。

add:當路徑被添加在地圖上時觸發。

remove:當路徑在地圖上移除時觸發。

Methods(方法)

addTo():將圖層添加到地圖上。

bindPopup():將具有特定HTML內容的彈出框與點擊路徑綁定起來。

unbindPopup():將之前的彈出框綁定解除。

openPopup():打開之前通過bindPopup方法與路徑上指定點或未指定情況下某一點綁定的彈出框。

closePopup():如果與路徑綁定的彈出框是打開狀態的,則將其關閉。

setStyle():更改給予對象選項對象的路徑的表現形式。

getBounds():返回路徑的經緯度綁定信息。

bringToFront():將此層移至所以路徑層的最上層。

bringToBack():將此層移至所以路徑層的最底層。

redraw():重繪圖層。在更改了路徑的座標時比較有用。

Static properties(靜態屬性)

SVG:如果用SVG來表達矢量,則此值爲true(在當前大多數瀏覽器中是true)。

VML:如果VML用來表達矢量,則此值爲true(在IE 6-8中適用)。

CANVAS:如果canvas用來表達矢量,則此值爲true(在android 2中適用)。你也可以在頁面中載入leaflet之前通過設置全局變量L_PREFER_CANVAS爲true來強制使用此項——有時在表達上千上萬相同的註記時會顯著地提高性能,但目前由於漏洞導致移除圖層非常慢。

CLIP_PADDING:決定地圖視圖周圍裁剪區域延展的大小(與大小相關,比如0.5在每個方向上是屏幕的一半)。較小的值意味着在拖動地圖時你會看到被裁剪路徑的末端,較大值會降低繪製性能。

L.Polyline

繪製疊加在地圖上線段的類。繼承自Path。用Map#addLayer來添加到地圖上。

Constructor(函數構造器)

L.Polyline():通過給定的地理點組成的數組和任意的選項對象實例化一個線段。

Options(選項)

smoothFactor:決定每一個縮放級別上線段簡化程度。如果大的話意味着更好的表現和看起來更光滑,小的話意味更準確地表示。

noClip::不允許線段裁剪。

Methods(方法)

addLatLng():向線段添加一個點。

setLatLngs():用所給的地理點的數組替代線段上的點。

getLatLngs():返回路徑上的點組成的數組。

spliceLatLngs():允許添加、移除和更改線段上的點。同Array#splice的語法一致。返回移除點組成的數組。

getBounds():返回線段的經緯度邊界。

L.MultiPolyline

是FeatureGroup的擴展,用來創建多線(在同一圖層中由多個共享樣式和彈出框的線段組成)。

Constructor(函數構造器)

L.MultiPolyline():通過給定的地理點的二維數組(其中每個一維數組表示一個線段)和選項對象來實例化一個多線對象。

L.Polygon

在地圖上繪製多邊形的類。是Polyline的擴展。用Map#addLayer添加到地圖上。

創建多邊形時經過的點沒有傳統意義上的起點和終點——最好將這種點指出來。

Constructor(函數構造器)

L.Polygon():通過給定地理點組成的數組和選項對象來實例化一個多邊形(同線段構造方法相同)。你也可以通過傳遞經緯度的二維數組來創建一個帶有洞的多邊形,第一個經緯度數組表示外環,剩下的表示裏面的洞。

L.MultiPolygon

是FeatureGroup的擴展,用來創建多多邊形(在同一圖層上由共享樣式和彈出框的多個多邊形組成)。

Constructor(函數構造器)

L.MultiPolygon():通過給定的經緯度的二維數組(每個一維數組表示一個多邊形)和選項對象實例化多多邊形(同多線相同)。

L.Rectangle

在地圖上繪製矩形的類。是多邊形的擴展。用Map#addLayer添加到地圖上。

Constructor(函數構造器)

L.Rectangle():通過給定的地理邊界和選項對象來實例化一個矩形對象。

Methods(方法)

setBounds():根據傳遞的邊界重繪矩形。

L.Circle

在地圖上繪製圓形疊加物的類。是Path的延伸。用Map#addLayer來添加到地圖上。

Constructor(函數構造器)

L.Circle():通過給定的地理點和以米爲單位的半徑和選項對象來實例化一個圓對象。

Methods(方法)

getLatLng():返回圓當前的地理位置。

getRadius():返回圓的半徑,以米爲單位。

setLatLng():將圓放置到一個新的位置。

setRadius():設置圓的半徑,以米爲單位。

L.CircleMarker

是一個特定半徑的圓,半徑單位是像素。是Circle的延伸。通過Map#addLayer添加到地圖上。

Constructor(函數構造器)

L.CircleMarker():通過給定的地理點和選項對象來實例化一個圓註記。默認的半徑是10像素,並且可以通過在路徑選項中傳遞一個半徑參數來修改半徑。

Methods(方法)

setLatLng():將圓註記放置於一個新的位置。

setRadius():設置圓註記的半徑,以像素爲單位。

L.LayerGroup

用來將幾個圖層組成一個組並作爲一個圖層來處理。如果你將其添加到地圖上,組中任何圖層的添加或移除都將使其同樣在地圖添加或刪除。繼承自ILayer接口。

Constructor(函數構造器)

L.LayerGroup():創建一個組,視情況指定一組初始的圖層。

Methods(方法)

addTo():將圖組添加到地圖上。

addLayer():將給定的圖層添加到組中。

removeLayer():將給定的圖層從組中移除:

clearLayer():將組中的圖層清空。

eachLayer():遍歷組中的圖層,需選擇一個符合情況的迭代函數。

L.FeatureGroup

是LayerGroup的擴展,但多了鼠標事件和共享的彈出框方法。繼承自ILayer接口。

Constructor(函數構造器)

L.FeatureGroup():創建一個圖組,視情況指定一組初始圖層。

Methods(方法)

具有LayerGroup所以的方法,還有下面多出的方法:

bindPopup():在組中任意具有bindPopup方法的圖層上綁定一個具有具體HTML內容的彈出框。

getBounds():返回要素組的經緯度邊界(通過他子圖層的邊界和座標獲得)。

setStyle():設置組中具有setStyle方法的圖層的路徑選項。

bringToFront():將圖組置於頂層。

bringToBack():將圖組置於底層。

Events(事件)

click:用戶點擊或觸摸組是觸發。

dbclick:用戶雙擊或連續兩次觸摸組時觸發。

mouseover:當鼠標置於組上方時觸發。

mouseout:當鼠標離開組時觸發。

mousemove:當鼠標經過組時觸發。

contextmenu:當用戶右擊圖層時觸發。

layeradd:當圖層被加入到組時觸發。

layerremove:當圖層從組中移除時觸發。

L.GeoJSON

展示一個GeoJSON的圖層。允許你在地圖上解析並顯示GeoJSON數據。是FeatureGroup的延伸。

由此創建的每個要素層獲取要素與之關聯的GeoJSON數據屬性(因此你隨後可以傳遞它的屬性)。

Constructor(函數構造器)

L.GeoJSON():創建一個GeoJSON圖層。可以任意地接受GeoJSON格式的對象和選項對象並顯示在地圖上(隨後可以選擇用addData方法添加)。

Options(選項)

pointToLayer():在創建GeoJSON點圖層時所用到的函數(如果不特意說明,會創建簡單的註記)。

style():在獲取用來創建GeoJSON要素的矢量圖層的樣式選項時可以用到。

onEachFeature():在每個創建的圖層上都會調用此函數。對於向要素添加事件和彈出框比較有用。

filter():用來決定是否顯示某要素的函數。

Methods(方法)

addData():在圖層中添加GeoJSON對象。

setStyle():通過給定的樣式函數改變GeoJSON矢量圖層的樣式。

resetStyle():將矢量圖層樣式重置爲初始GeoJSON樣式,對於hover事件之後的重置比較有用。

Static methods(靜態方法)

geometryToLayer():通過給定的GeoJSON要素創建圖層。

coordsToLatlng():通過在GeoJSON中表示點的兩個數字組成(分別表示緯度和經度)的數組來創建經緯度對象。如果reverse設置爲true,那麼這兩個數字被顛倒,表經度和緯度。

coordsToLatlngs():通過GeoJSON座標座標的數組創建多維數組。leversDeep指定具體的嵌套級別(0表示點的數組,1表示點數組的數組等等,0爲默認值)。如果reverse設置爲true,這些數組變爲經度和緯度。

L.LatLng

表示通過某一經度和緯度確定的地理上的點。

所以leaflet接受的經緯度對象也接受他們的單一數組的形式(除非在其他方面表明不可以)。

Constructor(函數構造器)

L.LatLng():通過給定的緯度和經度創建表示地理點的對象。

Options(選項)

lat:以度數表示的緯度。

lng:以度數表示的經度。

Methods(方法)

distanceTo():返回到通過半正矢公式計算的經緯度的距離(用米表示)。

equals():如果給定的經緯度在相同的位置(具有較小的容差)則返回true。

toString():返回點的描述信息(用來調試用)。

wrap():返回在經度上left和right邊界覆蓋範圍內(默認爲0180到180)的心的經緯度對象。

Constants(常量)

DEG_TO_RAD:度數轉換爲弧度的乘子。

RAD_TO_DEG:弧度轉換爲度數的乘子。

MAX_MARGIN:判斷相等的容差。

L.LatLngBounds

表示地圖上一個矩形的區域。

所有接受LatLngBounds對象的leaflet方法也接受他們簡單數組的形式(除非另行說明)。

Constructor(函數構造器)

L.LatLngBounds(西南角點,東北角點):通過定義矩形西南角點和東北角點來創建經緯度的矩形框。

L.LatLngBounds():通過定義內在點來創建經緯度的矩形框。當用fitBounds把地圖放到適合某些位置的縮放級別時是比較有用的。

Methods(方法)

extend():將邊界延伸到包含給定點和邊界的範圍。

geSouthWest():返回邊界的西南角點。

getNorthEast():返回邊界的東北角點。

getNorthWest():返回邊界的西北角點。

getSouthEast():返回邊界的東南角點。

getWest():返回邊界的西點。

getSouth():返回邊界的南角點。

getEast():返回邊界的東角點。

getNorth():返回邊界的北角點。

getCenter():返回邊界的中心點。

containg(otherBounds):如果矩形框包含給定的邊界則返回true。

contains(latlng):如果矩形框包含給定的點則返回true。

intersects():如果矩形框與給定的邊界相交則返回true。

equals():如果矩形框與給定的範圍相等(在一定容差範圍內)則返回true。

toBBoxString():返回“西南經度,西南緯度,東北經度,東北緯度”形式的外接矩形的座標。在向網絡服務器提交請求返回地理數據時比較有用。

pad():返回當前範圍擴大一定百分比後的邊界。

isValid():如果邊界可被初始化則返回true。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章