<acronym id="ucqu5"><label id="ucqu5"></label></acronym>

<pre id="ucqu5"><del id="ucqu5"><xmp id="ucqu5"></xmp></del></pre>
  • <td id="ucqu5"><option id="ucqu5"></option></td>

    一鍵發布離線地圖

    離線地圖服務開發文檔

    用法示例 示例

    // 使用id為map的div容器初始化地圖,同時指定地圖的中心點和縮放級別
        BM.Config.HTTP_URL = '';
    var map = BM.map('map','mapid', {
        center: [51.505, -0.09],
        zoom: 13
    });
    

    創建

    構造 描述
    BM.map( <String> id, <String> mapid, <Map options> options?) 給定<div>元素的DOM ID 以及可選的對象文字的實例化地圖對象Map options。
    BM.map( <HTMLElement> el, <String> mapid, <Map options> options?) 給定<div>HTML元素實例和可選的對象文字實例化地圖對象Map options。

    選項

    配置 類型 默認 描述
    preferCanvas Boolean false 是否Path應在渲染Canvas渲染s 。默認情況下,所有Paths都在SVG渲染器中呈現。

    控制選項

    配置 類型 默認 描述
    attributionControl Boolean true 默認情況下是否將歸因控件添加到地圖中。
    zoomControl Boolean true 默認情況下是否將縮放控件添加到地圖中。

    交互選項

    配置 類型 默認 描述
    closePopupOnClick Boolean true false如果您不希望在用戶單擊地圖時關閉彈出窗口,請將其設置為。
    zoomSnap Number 1 強制地圖的縮放級別始終為此的倍數,尤其是在fitBounds()縮放或縮放后。默認情況下,縮放級別會捕捉到最接近的整數; 較低的值(例如0.50.1)允許更大的粒度。0 表示縮放后的縮放級別fitBounds或者縮放縮放。
    zoomDelta Number 1 控制地圖的縮放級別多少后改變 zoomIn(),zoomOut(),壓制+-在鍵盤上,或者使用縮放控件。小于1(例如0.5)的允許更大的粒度。
    trackResize Boolean true 地圖是否自動處理瀏覽器窗口調整大小以更新自身。
    boxZoom Boolean true 是否可以在按住Shift鍵的同時通過拖動鼠標將地圖縮放到指定的矩形區域。
    doubleClickZoom Boolean|String true 是否可以通過雙擊放大地圖并通過雙擊同時按住縮放來縮小地圖。如果通過 'center',雙擊縮放將縮放到視圖的中心,無論鼠標位于何處。
    dragging Boolean true 是否可以使用鼠標/觸摸拖動地圖。

    映射狀態選項

    配置 類型 默認 描述
    crs CRS BM.CRS.EPSG3857 要使用坐標參考系統。如果您不確定這意味著什么,請不要更改此項。
    center LatLng undefined 地圖的初始地理中心
    zoom Number undefined 初始地圖縮放級別
    minZoom Number * 地圖的最小縮放級別。如果未指定且至少有一個GridLayerTileLayer在地圖中,minZoom則將使用其中最低的選項。
    maxZoom Number * 地圖的最大縮放級別。如果未指定且至少有一個GridLayerTileLayer在地圖中,maxZoom則將使用其中最高的選項。
    layers Layer[] [] 最初將添加到地圖的圖層數組
    maxBounds LatLngBounds null 設置此選項后,地圖會將視圖限制為給定的地理邊界,如果用戶嘗試在視圖外平移,則會將用戶反彈回來。要動態設置限制,請使用 setMaxBounds方法。
    renderer Renderer * 在地圖上繪制矢量圖層的默認方法。BM.SVGBM.Canvas默認情況下取決于瀏覽器支持。

    動畫選項

    配置 類型 默認 描述
    zoomAnimation Boolean true 是否啟用地圖縮放動畫。默認情況下,除了Android之外,所有支持CSS3過渡的瀏覽器都啟用了它。
    zoomAnimationThreshold Number 4 如果縮放差異超過此值,則不會設置縮放動畫。
    fadeAnimation Boolean true 是否啟用了平鋪淡入淡出動畫。默認情況下,除了Android之外,所有支持CSS3過渡的瀏覽器都啟用了它。
    markerZoomAnimation Boolean true 標記是否使用縮放動畫為其縮放設置動畫,如果禁用,它們將在動畫的長度內消失。默認情況下,除了Android之外,所有支持CSS3過渡的瀏覽器都啟用了它。
    transform3DLimit Number 2^23 定義CSS轉換變換的最大大小。除非Web瀏覽器在執行大型操作后將圖層放在錯誤的位置,否則不應更改默認值panBy。

    平移慣性選項

    配置 類型 默認 描述
    inertia Boolean * 如果啟用,則平移地圖將具有慣性效果,其中地圖在拖動時構建動量并且繼續在相同方向上移動一段時間。在觸摸設備上感覺特別好。除非在舊的Android設備上運行,否則默認啟用。
    inertiaDeceleration Number 3000 慣性運動減速的速率,以像素/秒為單位。
    inertiaMaxSpeed Number Infinity 慣性運動的最大速度,以像素/秒為單位。
    easeLinearity Number 0.2
    worldCopyJump Boolean false 啟用此選項后,地圖會跟蹤您平移到世界的另一個“副本”并無縫跳轉到原始地圖,以便所有疊加層(如標記和矢量圖層)仍然可見。
    maxBoundsViscosity Number 0.0 如果maxBounds設置,則此選項將控制拖動地圖時邊界的實體程度。默認值0.0允許用戶以正常速度拖動邊界外,較高的值將減慢地圖拖動外部邊界,1.0并使邊界完全固定,防止用戶拖出邊界外。

    鍵盤導航選項

    配置 類型 默認 描述
    keyboard Boolean true 使地圖可聚焦,并允許用戶使用鍵盤箭頭和+/ -導航地圖。
    keyboardPanDelta Number 80 按箭頭鍵時平移的像素數量。

    鼠標滾輪選項

    配置 類型 默認 描述
    scrollWheelZoom Boolean|String true 是否可以使用鼠標滾輪縮放地圖。如果通過'center',它將縮放到視圖的中心,無論鼠標在哪里。
    wheelDebounceTime Number 40 限制車輪可以發射的速率(以毫秒為單位)。默認情況下,用戶不能每40毫秒更頻繁地通過滾輪進行縮放。
    wheelPxPerZoomLevel Number 60 多少個滾動像素(由BM.DomEvent.getWheelDelta報告)表示更改一個完整縮放級別。較小的值將使輪縮放更快(反之亦然)。

    觸摸互動選項

    配置 類型 默認 描述
    tap Boolean true 支持移動黑客支持即時點擊(在iOS / Android上修復200毫秒點擊延遲)和觸摸保持(觸發contextmenu事件)。
    tapTolerance Number 15 用戶在觸摸期間可以移動手指的最大像素數,以將其視為有效的抽頭。
    touchZoom Boolean|String * 是否可以通過用兩個手指觸摸拖動來縮放地圖。如果通過'center',它將縮放到視圖的中心,無論觸摸事件(手指)在哪里。支持具有觸摸功能的Web瀏覽器,但舊的Androids除外。
    bounceAtZoomLimits Boolean true 如果您不希望地圖縮放超過最小/最大縮放,然后在縮放縮放時反彈,則將其設置為false。

    活動

    圖層事件

    事件 數據 描述
    baselayerchange LayersControlEvent 通過圖層控件更改基礎圖層時觸發。
    overlayadd LayersControlEvent 通過圖層控件選擇疊加層時觸發。
    overlayremove LayersControlEvent 通過圖層控件取消選擇疊加層時觸發。
    layeradd LayerEvent 將新圖層添加到地圖時觸發。
    layerremove LayerEvent 從地圖中刪除某個圖層時觸發

    映射狀態更改事件

    事件 數據 描述
    zoomlevelschange Event 由于添加或刪除圖層而改變地圖上的縮放級別數時觸發。
    resize ResizeEvent 調整地圖大小時觸發。
    unload Event 使用remove方法銷毀地圖時觸發。
    viewreset Event 當地圖需要重繪其內容時觸發(這通常發生在地圖縮放或加載)。對于創建自定義疊加層非常有用。
    load Event 初始化地圖時(第一次設置中心和縮放時)觸發。
    zoomstart Event 當地圖縮放即將改變時觸發(例如在縮放動畫之前)。
    movestart Event 在地圖視圖開始更改時觸發(例如,用戶開始拖動地圖)。
    zoom Event 在縮放級別的任何變化期間反復觸發,包括縮放和飛行動畫。
    move Event 在地圖的任何移動過程中反復發射,包括平移和飛行動畫。
    zoomend Event 在地圖發生變化后,在任何動畫之后觸發。
    moveend Event 當地圖中心停止變化時觸發(例如,用戶停止拖動地圖)。

    彈出事件

    事件 數據 描述
    popupopen PopupEvent 在地圖中打開彈出窗口時觸發
    popupclose PopupEvent 關閉地圖中的彈出窗口時觸發
    autopanstart Event 打開彈出窗口時地圖開始自動平移時觸發。

    工具提示事件

    事件 數據 描述
    tooltipopen TooltipEvent 在地圖中打開工具提示時觸發。
    tooltipclose TooltipEvent 關閉地圖中的工具提示時觸發。

    位置活動

    事件 數據 描述
    locationerror ErrorEvent 地理定位(使用該locate方法)失敗時觸發。
    locationfound LocationEvent 地理定位(使用locate方法)成功時觸發。

    互動活動

    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)地圖時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)地圖時觸發。
    mousedown MouseEvent 當用戶在地圖上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶在地圖上釋放鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入地圖時觸發。
    mouseout MouseEvent 鼠標離開地圖時觸發。
    mousemove MouseEvent 鼠標在地圖上移動時觸發。
    contextmenu MouseEvent 當用戶在地圖上按下鼠標右鍵時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    keypress KeyboardEvent 當用戶在聚焦地圖時從鍵盤按下鍵時觸發。
    preclick MouseEvent 鼠標在地圖上單擊之前觸發(有時在任何現有點擊處理程序開始運行之前需要點擊某些內容時有用)。

    其他方法

    事件 數據 描述
    zoomanim ZoomAnimEvent 在縮放動畫的每一幀上都會被觸發

    方法

    方法 返回 描述
    getRenderer( <Path> layer) Renderer

    返回Renderer應該用于呈現給定 的實例Path。它將確保renderer地圖和路徑選項得到遵守,并且渲染器確實存在于地圖上。

    層和控件方法

    方法 返回 描述
    addControl( <Control> control) this

    添加控件至地圖視圖

    removeControl( <Control> control) this

    移除控件

    addLayer( <Layer> layer) this

    添加層至地圖視圖

    removeLayer( <Layer> layer) this

    移除層

    hasLayer( <Layer> layer) Boolean

    查詢是否有指定的層

    eachLayer( <Function> fn, <Object> context?) this

    迭代映射的層,可選地指定迭代器函數的上下文。

    map.eachLayer(function(layer){
        layer.bindPopup('Hello');
    });
    
    openPopup( <Popup> popup) this

    關閉先前打開時打開指定的彈出窗口(以確保一次只能打開一個以獲得可用性)。

    openPopup( <String|HTMLElement> content, <LatLng> latlng, <Popup options> options?) this

    創建具有指定內容和選項的彈出窗口,并在地圖上的給定點中打開它。

    closePopup( <Popup> popup?) this

    關閉先前使用openPopup(或給定的)打開的彈出窗口。

    openTooltip( <Tooltip> tooltip) this

    打開指定的工具提示。

    openTooltip( <String|HTMLElement> content, <LatLng> latlng, <Tooltip options> options?) this

    創建具有指定內容和選項的工具提示并將其打開。

    closeTooltip( <Tooltip> tooltip?) this

    關閉作為參數給出的工具提示。

    地圖狀態修改

    方法 返回 描述
    setView( <LatLng> center, <Number> zoom, <Zoom/pan options> options?) this

    設置地圖位置(地理位置和縮放級別))

    setZoom( <Number> zoom, <Zoom/pan options> options?) this

    設置縮放級別

    zoomIn( <Number> delta?, <Zoom options> options?) this

    通過deltazoomDelta默認情況下)增加地圖的縮放比例。

    zoomOut( <Number> delta?, <Zoom options> options?) this

    通過deltazoomDelta默認情況下)減小地圖的縮放比例。

    setZoomAround( <LatLng> latlng, <Number> zoom, <Zoom options> options) this

    縮放地圖,同時使地圖上的指定地理點保持靜止(例如,在內部用于滾動縮放和雙擊縮放)。

    setZoomAround( <Point> offset, <Number> zoom, <Zoom options> options) this

    放大地圖,同時保持地圖上的指定像素(相對于左上角)靜止不動。

    fitBounds( <LatLngBounds> bounds, <fitBounds options> options?) this

    限定地圖可移動區域

    fitWorld( <fitBounds options> options?) this

    設置一個地圖視圖,該視圖主要包含可能具有最大縮放級別的整個世界。

    panTo( <LatLng> latlng, <Pan options> options?) this

    移動地圖到新的中心點

    panBy( <Point> offset, <Pan options> options?) this

    按給定數量的像素(動畫)平移地圖。

    flyTo( <LatLng> latlng, <Number> zoom?, <Zoom/pan options> options?) this

    移動至新的位置(中心和縮放)

    flyToBounds( <LatLngBounds> bounds, <fitBounds options> options?) this

    平滑移動值新的位置,, flyTo但是接受一個類似于的邊界參數fitBounds。

    setMaxBounds( <Bounds> bounds) this

    將地圖視圖限制為給定邊界(請參閱maxBounds選項)。

    setMinZoom( <Number> zoom) this

    設置最小可用縮放級別(參照minZoom配置)

    setMaxZoom( <Number> zoom) this

    設置最大可用縮放級別(參照maxZoom配置)

    panInsideBounds( <LatLngBounds> bounds, <Pan options> options?) this

    將地圖平移到位于給定邊界內的最近視圖(如果它還沒有),使用特定選項(如果有)控制動畫。

    invalidateSize( <Zoom/pan options> options) this

    檢查地圖容器大小是否更改并更新地圖(如果是這樣) - 在動態更改地圖大小后調用它,默認情況下也為動畫設置動畫。如果options.panfalse,則不會發生平移。如果options.debounceMoveendtrue,它將延遲moveend事件,以便即使連續多次調用該方法也不會經常發生。

    invalidateSize( <Boolean> animate) this

    檢查地圖容器大小是否更改并更新地圖(如果是這樣) - 在動態更改地圖大小后調用它,默認情況下也為動畫設置動畫。

    stop() this

    停止當前運行的動畫(panToflyTo

    地理定位方法

    方法 返回 描述
    locate( <Locate options> options?) this

    嘗試使用Geolocation API定位用戶,觸發包含locationfound 成功位置數據或locationerror失敗事件的事件,并可選擇將地圖視圖設置為用戶關于檢測準確性的位置(如果地理位置失敗,則設置為世界視圖)。請注意,如果您的網頁未使用HTTPS,則此方法將在現代瀏覽器中失?。?/font>Chrome 50及更高版本)有關Locate options詳細信息,請參閱。

    stopLocate() this

    停止觀看之前發起的位置map.locate({watch: true}) ,如果調用了map.locate,則中止重置地圖視圖 {setView: true}。

    其它方法

    方法 返回 描述
    addHandler( <String> name, <Function> HandlerClass) this

    Handler在給定其名稱和構造函數的情況下,向地圖添加新內容。

    remove() this

    銷毀地圖并清楚所有相關的事件監聽器。

    createPane( <String> name, <HTMLElement> container?) HTMLElement

    如果已存在,則創建具有給定名稱的新地圖窗格,然后返回該窗格。container如果未設置,窗格將創建為主地圖窗格的子窗口或子窗口。

    getPane( <String|HTMLElement> pane) HTMLElement

    給出其名稱或其HTML元素(其標識)地圖窗格。

    getPanes() Object

    返回一個普通對象,其中包含所有窗格的名稱作為鍵,窗格作為值。

    getContainer() HTMLElement

    返回包含地圖的HTML元素。

    whenReady( <Function> fn, <Object> context?) this

    fn使用視圖(中心和縮放)和至少一個圖層初始化地圖時運行給定函數,或者如果已經初始化,則立即運行給定函數,可選地傳遞函數上下文。

    獲取地圖狀態方法

    方法 返回 描述
    getCenter() LatLng

    獲取當前中心點

    getZoom() Number

    獲取當前縮放級別

    getBounds() LatLngBounds

    獲取當前視圖可見邊界

    getMinZoom() Number

    獲取當前最小縮放級別(如果在minZoom地圖或任何圖層選項中設置),或0默認情況下。

    getMaxZoom() Number

    獲取當前最大縮放級別(如果在maxZoom地圖或任何圖層選項中設置)。

    getBoundsZoom( <LatLngBounds> bounds, <Boolean> inside?) Number

    返回給定邊界完全適合地圖視圖的最大縮放級別。如果inside(可選)設置為true,則該方法將返回地圖視圖完全適合給定邊界的最小縮放級別。

    getSize() Point

    獲取當前容器大?。╬x單位)

    getPixelBounds() Bounds

    返回投影像素坐標中當前地圖視圖的邊界(有時在圖層和疊加層實現中很有用)。

    getPixelOrigin() Point

    返回地圖圖層左上角點的投影像素坐標(在自定義圖層和疊加層實現中很有用)。

    getPixelWorldBounds( <Number> zoom?) Bounds

    返回縮放級別的像素坐標中的世界邊界zoom。如果zoom省略,則使用地圖的當前縮放級別。

    轉換方法

    方法 返回 描述
    getZoomScale( <Number> toZoom, <Number> fromZoom) Number

    返回要應用于從縮放級別fromZoom的地圖過渡的比例因子 toZoom。內部用于幫助縮放動畫。

    getScaleZoom( <Number> scale, <Number> fromZoom) Number

    返回地圖最終的縮放級別,如果它處于fromZoom 等級并且所有內容都按比例縮放scale。逆的 getZoomScale。

    project( <LatLng> latlng, <Number> zoom) Point

    項目的地理坐標LatLng根據地圖的CRS的投影,則根據其刻度zoom和CRS的 Transformation。結果是相對于CRS原點的像素坐標。

    unproject( <Point> point, <Number> zoom) LatLng

    逆的project。

    layerPointToLatLng( <Point> point) LatLng

    給定相對于原點像素的像素坐標,返回相應的地理坐標(對于當前縮放級別)。

    latLngToLayerPoint( <LatLng> latlng) Point

    給定地理坐標,返回相對于原始像素的對應像素坐標。

    wrapLatLng( <LatLng> latlng) LatLng

    如果它們在CRS的邊界之外,則返回一個LatLngwhere lat并且lng已根據地圖的CRS wrapLatwrapLng屬性進行包裝。默認情況下,這意味著經度纏繞在日期線上,因此其值介于-180和+180度之間。

    wrapLatLngBounds( <LatLngBounds> bounds) LatLngBounds

    返回LatLngBounds與給定大小相同的大小,確保其中心位于CRS的邊界內。默認情況下,這意味著中心經度圍繞日期線纏繞,因此其值介于-180和+180度之間,并且大多數邊界與CRS的邊界重疊。

    distance( <LatLng> latlng1, <LatLng> latlng2) Number

    根據地圖的CRS返回兩個地理坐標之間的距離。默認情況下,它以米為單位測量距離

    containerPointToLayerPoint( <Point> point) Point

    給定相對于地圖容器的像素坐標,返回相對于原始像素的對應像素坐標。

    layerPointToContainerPoint( <Point> point) Point

    給定相對于原始像素的像素坐標,返回相對于地圖容器的對應像素坐標。

    containerPointToLatLng( <Point> point) LatLng

    給定相對于地圖容器的像素坐標,返回相應的地理坐標(對于當前縮放級別)。

    latLngToContainerPoint( <LatLng> latlng) Point

    給定地理坐標,返回相對于地圖容器的對應像素坐標。

    mouseEventToContainerPoint( <MouseEvent> ev) Point

    給定MouseEvent對象,返回相對于發生事件的地圖容器的像素坐標。

    mouseEventToLayerPoint( <MouseEvent> ev) Point

    給定MouseEvent對象,返回相對于發生事件原點像素的像素坐標。

    mouseEventToLatLng( <MouseEvent> ev) LatLng

    給定MouseEvent對象,返回事件發生的地理坐標。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    屬性

    處理程序

    屬性 類型 描述
    boxZoom Handler 框(用鼠標移動拖動)縮放處理程序。
    doubleClickZoom Handler 雙擊縮放處理程序。
    dragging Handler 映射拖動處理程序(通過鼠標和觸摸)。
    keyboard Handler 鍵盤導航處理程序
    scrollWheelZoom Handler 滾輪變焦處理程序。
    tap Handler 移動觸摸黑客(快速點擊和觸摸保持)處理程序。
    touchZoom Handler 觸摸變焦處理程序

    地圖窗格

    窗格是用于控制地圖上圖層排序的DOM元素。您可以使用map.getPanemap.getPanes方法訪問窗格。可以使用該map.createPane方法創建新窗格 。每個地圖都有以下默認窗格,這些窗格僅在zIndex中有所不同。
    窗格 類型 Z-指數 描述
    mapPane HTMLElement 'auto' 包含所有其他地圖窗格的窗格
    tilePane HTMLElement 200 適用于GridLayers和TileLayers的窗格
    overlayPane HTMLElement 400 矢量窗格(Paths,Polylines和Polygons),ImageOverlays和VideoOverlays
    shadowPane HTMLElement 500 疊加陰影的窗格(例如Marker陰影)
    markerPane HTMLElement 600 窗格IconMarker小號
    tooltipPane HTMLElement 650 Pane for Tooltips。
    popupPane HTMLElement 700 Pane for Popups。

    找到選項

    一些地理位置方法Map在取options參數。這是一個普通的javascript對象,包含以下可選組件:
    配置 類型 默認 描述
    watch Boolean false 如果true,使用W3C watchPosition方法開始連續觀察位置變化(而不是檢測一次)。您可以稍后停止使用map.stopLocate()方法觀看 。
    setView Boolean false 如果true,根據檢測準確性自動將地圖視圖設置為用戶位置,或者如果地理位置失敗則自動將地圖視圖設置為世界視圖。
    maxZoom Number Infinity 使用setView選項時自動視圖設置的最大縮放。
    timeout Number 10000 在觸發locationerror事件之前等待地理定位響應的毫秒數 。
    maximumAge Number 0 檢測到的位置的最大年齡。如果小于自上次地理位置響應以來經過的毫秒數,locate則將返回緩存位置。
    enableHighAccuracy Boolean false 實現高精度,請參閱W3C規范中的說明。

    縮放選項

    Map修改縮放級別的一些方法采用options 參數。這是一個普通的javascript對象,包含以下可選組件:
    配置 類型 默認 描述
    animate Boolean 如果未指定,如果縮放原點位于當前視圖內,則會發生縮放動畫。如果true,地圖將嘗試動畫縮放,而忽略縮放原點的位置。設置false將使其始終在沒有動畫的情況下完全重置視圖。

    平移選項

    Map修改地圖中心的一些方法采用options 參數。這是一個普通的javascript對象,包含以下可選組件:
    配置 類型 默認 描述
    animate Boolean 如果true,如果可能的話,平移將始終是動畫。如果false,它不會動畫平移,如果平移超過屏幕,則重置地圖視圖,或者僅為地圖窗格設置新的偏移(除了panBy 后者總是如此)。
    duration Number 0.25 動畫平移的持續時間,以秒為單位。
    easeLinearity Number 0.25 平移動畫緩動的曲率因子(Cubic Bezier曲線的第三個參數 )。1.0表示線性動畫,數字越小,曲線越彎曲。
    noMoveStart Boolean false 如果true,平移不會movestart在啟動時觸發事件(內部用于平移慣性)。

    縮放/平移選項

    配置 類型 默認 描述
    animate Boolean 如果未指定,如果縮放原點位于當前視圖內,則會發生縮放動畫。如果true,地圖將嘗試動畫縮放,而忽略縮放原點的位置。設置false將使其始終在沒有動畫的情況下完全重置視圖。
    配置 類型 默認 描述
    duration Number 0.25 動畫平移的持續時間,以秒為單位。
    easeLinearity Number 0.25 平移動畫緩動的曲率因子(Cubic Bezier曲線的第三個參數 )。1.0表示線性動畫,數字越小,曲線越彎曲。
    noMoveStart Boolean false 如果true,平移不會movestart在啟動時觸發事件(內部用于平移慣性)。

    FitBounds選項

    配置 類型 默認 描述
    paddingTopLeft Point [0, 0] 設置在將視圖設置為適合邊界時不應考慮的地圖容器左上角的填充量。如果您在地圖上有一些控件疊加層(如側邊欄)并且您不希望它們遮擋您要縮放的對象,則非常有用。
    paddingBottomRight Point [0, 0] 地圖右下角也是如此。
    padding Point [0, 0] 相當于將左上角和右下角填充設置為相同的值。
    maxZoom Number null 要使用的最大縮放比例。
    配置 類型 默認 描述
    animate Boolean 如果未指定,如果縮放原點位于當前視圖內,則會發生縮放動畫。如果true,地圖將嘗試動畫縮放,而忽略縮放原點的位置。設置false將使其始終在沒有動畫的情況下完全重置視圖。
    配置 類型 默認 描述
    duration Number 0.25 動畫平移的持續時間,以秒為單位。
    easeLinearity Number 0.25 平移動畫緩動的曲率因子(Cubic Bezier曲線的第三個參數 )。1.0表示線性動畫,數字越小,曲線越彎曲。
    noMoveStart Boolean false 如果true,平移不會movestart在啟動時觸發事件(內部用于平移慣性)。

    標記

    BM.Marker用于在地圖上顯示可點擊/可拖動的圖標。延伸Layer。

    用法示例

    BM.marker([50.5, 30.5]).addTo(map);
    

    創建

    構造 描述
    BM.marker( <LatLng> latlng, <Marker options> options?) 給定地理點和可選的選項對象實例化Marker對象。

    選項

    配置 類型 默認 描述
    icon Icon * 用于渲染標記的圖標實例。有關如何自定義標記圖標的詳細信息,請參閱圖標文檔。如果未指定,BM.Icon.Default則使用公共實例。
    draggable Boolean false 標記是否可以通過鼠標/觸摸進行拖動。
    autoPan Boolean false true如果您希望地圖在標記到達邊緣時執行平移動畫,請將其設置為。
    autoPanPadding Point Point(50, 50) 相當于將左上角和右下角的autopan填充設置為相同的值。
    autoPanSpeed Number 10 地圖應移動的像素數。
    keyboard Boolean true 是否可以使用鍵盤選中標記,然后按Enter鍵單擊。
    title String '' 標記懸停時顯示的瀏覽器工具提示的文本(默認情況下不是工具提示)。
    alt String '' alt圖標圖像屬性的文本(對輔助功能非常有用)。
    zIndexOffset Number 0 默認情況下,標記圖像zIndex會根據其緯度自動設置。如果要將標記放在所有其他標記(或下方)之上,請指定高值1000(或分別為高負值),請使用此選項。
    opacity Number 1.0 標記的不透明度。
    riseOnHover Boolean false 如果true,當您將鼠標懸停在其上時,標記將會顯示在其他標記之上。
    riseOffset Number 250 用于該riseOnHover功能的z-index偏移量。
    pane String 'markerPane' Map pane 將添加標記圖標的位置。
    bubblingMouseEvents Boolean false 何時true,此標記上的鼠標事件將在地圖上觸發相同的事件(除非BM.DomEvent.stopPropagation使用)。
    配置 類型 默認 描述
    interactive Boolean true 如果false,圖層不會發出鼠標事件,并將作為底層地圖的一部分。
    配置 類型 默認 描述
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    除了共享層的方法addTo(),并remove()彈出方法等bindPopup()也可以使用以下方法:
    事件 數據 描述
    move Event setLatLng通過拖動移動標記時觸發。新舊坐標包含在事件參數中oldLatLng,如latlng。

    拖動事件

    事件 數據 描述
    dragstart Event 用戶開始拖動標記時觸發。
    movestart Event 標記開始移動時觸發(因為拖動)。
    drag Event 用戶拖動標記時反復觸發。
    dragend DragEndEvent 用戶停止拖動標記時觸發。
    moveend Event 當標記停止移動(因拖動)時觸發。
    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)圖層時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)圖層時觸發。
    mousedown MouseEvent 當用戶在圖層上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶釋放在圖層上按下的鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入圖層時觸發。
    mouseout MouseEvent 當鼠標離開圖層時觸發。
    contextmenu MouseEvent 當用戶右鍵單擊圖層時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    toGeoJSON() Object

    返回一個 GeoJSON標記的表示(作為GeoJSON Point特征)。

    getLatLng() LatLng

    返回標記的當前地理位置。

    setLatLng( <LatLng> latlng) this

    將標記位置更改為給定點。

    setZIndexOffset( <Number> offset) this

    更改標記zIndex偏移量。

    setIcon( <Icon> icon) this

    更改標記圖標。

    setOpacity( <Number> opacity) this

    更改標記的不透明度。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    屬性

    交互處理程序

    交互處理程序是標記實例的屬性,允許您在運行時控制交互行為,啟用或禁用某些功能,如拖動(請參閱Handler方法)。例:
    marker.dragging.disable();
    
    屬性 類型 描述
    dragging Handler 標記拖動處理程序(通過鼠標和觸摸)。僅在標記位于地圖上時有效(否則設置marker.options.draggable)。

    用于在地圖的某些位置打開彈出窗口。使用Map.openPopup打開彈出窗口,同時確保一次只打開一個彈出窗口(建議用于可用性),或使用Map.addLayer打開任意數量的彈出窗口。

    如果你想將彈出窗口綁定到標記點擊然后打開它,那很簡單:

    marker.bindPopup(popupContent).openPopup();
    

    折線之類的路徑疊加也有一個bindPopup方法。這是在地圖上打開彈出窗口的更復雜方法:

    var popup = BM.popup()
        .setLatLng(latlng)
        .setContent('<p>Hello world!<br />This is a nice popup.</p>')
        .openOn(map);
    
    構造 描述
    配置 類型 默認 描述
    配置 類型 默認 描述
    配置 類型 默認 描述

    活動

    事件 數據 描述
    事件 數據 描述
    事件 數據 描述
    方法 返回 描述
    方法 返回 描述
    方法 返回 描述
    方法 返回 描述
    方法 返回 描述

    提示

    用于在地圖圖層上顯示小文本。

    用法示例

    marker.bindTooltip("my tooltip text").openTooltip();
    

    關于工具提示偏移的注意事項。

    • offset工具提示選項:它默認為[0,0],這是特定于一個工具提示。添加正x偏移以將工具提示向右移動,并使用正y偏移將其移動到底部。負數將移至左側和頂部。
    • tooltipAnchor圖標選項:這只會被視為標記。如果使用自定義圖標,則應調整此值。

    創建

    構造 描述
    BM.tooltip( <Tooltip options> options?, <Layer> source?) 實例化一個Tooltip對象,給定一個options描述其外觀和位置的可選source對象,以及一個可選對象,用于標記工具提示,并引用它引用的Layer。

    選項

    配置 類型 默認 描述
    pane String 'tooltipPane' Map pane 將添加工具提示的位置。
    offset Point Point(0, 0) 工具提示位置的可選偏移量。
    direction String 'auto' 方向在哪里打開工具提示。可能的值有:right,left, top,bottom,center,auto。 auto將之間進行動態切換rightleft根據地圖上的工具提示位置。
    permanent Boolean false 是永久打開工具提示還是僅在鼠標懸停時打開工具提示。
    sticky Boolean false 如果為true,則工具提示將跟隨鼠標而不是固定在要素中心。
    interactive Boolean false 如果為true,則工具提示將偵聽要素事件。
    opacity Number 0.9 工具提示容器不透明度。
    配置 類型 默認 描述
    className String '' 要分配給彈出窗口的自定義CSS類名稱。
    配置 類型 默認 描述
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    TileLayer

    用于在地圖上加載和顯示切片圖層。延伸GridLayer。

    用法示例

    BM.tileLayer('http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
    

    網址模板

    以下形式的字符串:

    'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
    

    {s}裝置可用的子域中的一個(順序地用于幫助每個域限制瀏覽器并行請求;子域值在選項中指定; a,bc通過默認,可省略),{z}-縮放級別,{x}以及{y}-瓷磚坐標。{r}可用于將“@ 2x”添加到URL以加載視網膜圖塊。您可以在模板中使用自定義鍵,這些鍵將從TileLayer選項中進行評估,如下所示:

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

    創建

    擴展方法

    構造 描述
    BM.tilelayer( <String> urlTemplate, <TileLayer options> options?) 在給定a URL template和可選的options對象的情況下實例化tile圖層對象。

    選項

    配置 類型 默認 描述
    minZoom Number 0 顯示此圖層的最小縮放級別(包括)。
    maxZoom Number 18 此圖層將顯示的最大縮放級別(包括)。
    subdomains String|String[] 'abc' 磁貼服務的子域。可以以一個字符串(每個字母是子域名)或字符串數​​組的形式傳遞。
    errorTileUrl String '' 要顯示的圖塊圖像的URL,以代替無法加載的圖塊。
    zoomOffset Number 0 平鋪URL中使用的縮放編號將使用此值進行偏移。
    tms Boolean false 如果true,反轉瓷磚的Y軸編號(為TMS服務啟用此功能)。
    zoomReverse Boolean false 如果設置為true,則平鋪URL中使用的縮放編號將反轉(maxZoom - zoom而不是zoom
    detectRetina Boolean false 如果true和用戶在視網膜顯示器上,它將要求四個指定尺寸的一半的瓷磚和一個更大的縮放級別來代替一個以利用高分辨率。
    crossOrigin Boolean false 如果為true,則所有切片的crossOrigin屬性都將設置為''。如果要訪問切片像素數據,則需要這樣做。
    配置 類型 默認 描述
    tileSize Number|Point 256 網格中瓷磚的寬度和高度。如果寬度和高度相等,則使用數字,BM.point(width, height)否則。
    opacity Number 1.0 瓷磚的不透明度。可以在createTile()函數中使用。
    updateWhenIdle Boolean (depends) 僅在平移結束時加載新圖塊。 true默認情況下在移動瀏覽器上,以避免過多請求并保持平滑導航。 false否則,為了平移期間顯示新的圖塊,因為keepBuffer在桌面瀏覽器中很容易在該選項之外平移 。
    updateWhenZooming Boolean true 默認情況下,平滑縮放動畫(在觸摸縮放期間或a flyTo())將每個整數縮放級別更新網格圖層。將此選項設置為false僅在平滑動畫結束時才更新網格圖層。
    updateInterval Number 200 updateInterval平移時,平鋪每毫秒不會更新一次。
    zIndex Number 1 切片圖層的顯式zIndex。
    bounds LatLngBounds undefined 如果設置,則僅將瓷磚加載到集合中LatLngBounds。
    maxNativeZoom Number undefined 磁貼源可用的最大縮放數。如果指定,則所有縮放級別以上的圖塊maxNativeZoom將從maxNativeZoom級別加載并自動縮放。
    minNativeZoom Number undefined 磁貼源可用的最小縮放編號。如果指定,則所有縮放級別以下的圖塊minNativeZoom將從minNativeZoom級別加載并自動縮放。
    noWrap Boolean false 該層是否包裹在antimeridian周圍。如果true,GridLayer只會以低縮放級別顯示一次。當地圖CRS沒有環繞時沒有效果。可與之配合使用bounds 防止請求超出CRS限制的磁貼。
    pane String 'tilePane' Map pane 將添加網格圖層的位置。
    className String '' 要分配給切片圖層的自定義類名。默認為空。
    keepBuffer Number 2 平移地圖時,請在卸載之前保留此許多行和列的切片。
    配置 類型 默認 描述
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    loading Event 網格圖層開始加載圖塊時觸發。
    tileunload TileEvent 在移除瓷磚時觸發(例如,當瓷磚離開屏幕時)。
    tileloadstart TileEvent 請求磁貼并在開始加載時觸發。
    tileerror TileErrorEvent 加載磁貼時出錯。
    tileload TileEvent 當瓷磚加載時觸發。
    load Event 當網格圖層加載所有可見的圖塊時觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    setUrl( <String> url, <Boolean> noRedraw?) this

    更新圖層的URL模板并重新繪制它(除非noRedraw設置為true)。

    createTile( <Object> coords, <Function> done?) HTMLElement

    僅在內部調用,覆蓋GridLayer createTile() 以返回具有<img>給定的適當圖像URL HTML元素coords。done 在分片已經加載回調被調用。

    擴展方法

    圖層擴展TileLayer可能會重新實現以下方法。
    方法 返回 描述
    getTileUrl( <Object> coords) String

    僅在內部調用,返回給定其坐標的tile的URL。擴展類TileLayer可以覆蓋此函數以提供自定義切片URL命名方案。

    方法 返回 描述
    bringToFront() this

    將切片圖層置于所有切片圖層的頂部。

    bringToBack() this

    將切片圖層置于所有切片圖層的底部。

    getContainer() HTMLElement

    返回包含此圖層的切片的HTML元素。

    setOpacity( <Number> opacity) this

    更改網格圖層不透明度。

    setZIndex( <Number> zIndex) this

    更改網格圖層zIndex。

    isLoading() Boolean

    返回true如果在網格層有塊尚未加載完畢。

    redraw() this

    使圖層清除所有圖塊并再次請求它們。

    getTileSize() Point

    tileSize選項規范化為一個點。createTile()方法使用。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    用于在地圖上將WMS服務顯示為切片圖層。延伸TileLayer。

    用法示例

    var nexrad = BM.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
        layers: 'nexrad-n0r-900913',
        format: 'image/png',
        transparent: true,
        attribution: "Weather data ? 2012 IEM Nexrad"
    });
    

    創建

    構造 描述
    BM.tileLayer.wms( <String> baseUrl, <TileLayer.WMS options> options) 給定WMS服務的基本URL和WMS參數/選項對象,實例化WMS切片層對象。

    選項

    如果使用此處未記錄的任何自定義選項,它們將作為每個請求URL中的額外參數發送到WMS服務器。這對于非標準供應商WMS參數非常有用 。
    配置 類型 默認 描述
    layers String '' (必需)要顯示的以逗號分隔的WMS圖層列表。
    styles String '' 以逗號分隔的WMS樣式列表。
    format String 'image/jpeg' WMS圖像格式('image/png'用于具有透明度的圖層)。
    transparent Boolean false 如果true,WMS服務將返回具有透明度的圖像。
    version String '1.1.1' 要使用的WMS服務的版本
    crs CRS null 坐標參考系統用于WMS請求,默認為映射CRS。如果您不確定這意味著什么,請不要更改此項。
    uppercase Boolean false 如果true,WMS請求參數鍵將為大寫。
    配置 類型 默認 描述
    minZoom Number 0 顯示此圖層的最小縮放級別(包括)。
    maxZoom Number 18 此圖層將顯示的最大縮放級別(包括)。
    subdomains String|String[] 'abc' 磁貼服務的子域。可以以一個字符串(每個字母是子域名)或字符串數​​組的形式傳遞。
    errorTileUrl String '' 要顯示的圖塊圖像的URL,以代替無法加載的圖塊。
    zoomOffset Number 0 平鋪URL中使用的縮放編號將使用此值進行偏移。
    tms Boolean false 如果true,反轉瓷磚的Y軸編號(為TMS服務啟用此功能)。
    zoomReverse Boolean false 如果設置為true,則平鋪URL中使用的縮放編號將反轉(maxZoom - zoom而不是zoom
    detectRetina Boolean false 如果true和用戶在視網膜顯示器上,它將要求四個指定尺寸的一半的瓷磚和一個更大的縮放級別來代替一個以利用高分辨率。
    crossOrigin Boolean false 如果為true,則所有切片的crossOrigin屬性都將設置為''。如果要訪問切片像素數據,則需要這樣做。
    配置 類型 默認 描述
    tileSize Number|Point 256 網格中瓷磚的寬度和高度。如果寬度和高度相等,則使用數字,BM.point(width, height)否則。
    opacity Number 1.0 瓷磚的不透明度。可以在createTile()函數中使用。
    updateWhenIdle Boolean (depends) 僅在平移結束時加載新圖塊。 true默認情況下在移動瀏覽器上,以避免過多請求并保持平滑導航。 false否則,為了平移期間顯示新的圖塊,因為keepBuffer在桌面瀏覽器中很容易在該選項之外平移 。
    updateWhenZooming Boolean true 默認情況下,平滑縮放動畫(在觸摸縮放期間或a flyTo())將每個整數縮放級別更新網格圖層。將此選項設置為false僅在平滑動畫結束時才更新網格圖層。
    updateInterval Number 200 updateInterval平移時,平鋪每毫秒不會更新一次。
    zIndex Number 1 切片圖層的顯式zIndex。
    bounds LatLngBounds undefined 如果設置,則僅將瓷磚加載到集合中LatLngBounds。
    maxNativeZoom Number undefined 磁貼源可用的最大縮放數。如果指定,則所有縮放級別以上的圖塊maxNativeZoom將從maxNativeZoom級別加載并自動縮放。
    minNativeZoom Number undefined 磁貼源可用的最小縮放編號。如果指定,則所有縮放級別以下的圖塊minNativeZoom將從minNativeZoom級別加載并自動縮放。
    noWrap Boolean false 該層是否包裹在antimeridian周圍。如果true,GridLayer只會以低縮放級別顯示一次。當地圖CRS沒有環繞時沒有效果。可與之配合使用bounds 防止請求超出CRS限制的磁貼。
    pane String 'tilePane' Map pane 將添加網格圖層的位置。
    className String '' 要分配給切片圖層的自定義類名。默認為空。
    keepBuffer Number 2 平移地圖時,請在卸載之前保留此許多行和列的切片。
    配置 類型 默認 描述
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    loading Event 網格圖層開始加載圖塊時觸發。
    tileunload TileEvent 在移除瓷磚時觸發(例如,當瓷磚離開屏幕時)。
    tileloadstart TileEvent 請求磁貼并在開始加載時觸發。
    tileerror TileErrorEvent 加載磁貼時出錯。
    tileload TileEvent 當瓷磚加載時觸發。
    load Event 當網格圖層加載所有可見的圖塊時觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    setParams( <Object> params, <Boolean> noRedraw?) this

    使用新參數合并對象并在當前屏幕上重新請求切片(除非noRedraw設置為true)。

    方法 返回 描述
    setUrl( <String> url, <Boolean> noRedraw?) this

    更新圖層的URL模板并重新繪制它(除非noRedraw設置為true)。

    createTile( <Object> coords, <Function> done?) HTMLElement

    僅在內部調用,覆蓋GridLayer createTile() 以返回具有<img>給定的適當圖像URL HTML元素coords。done 在分片已經加載回調被調用。

    方法 返回 描述
    bringToFront() this

    將切片圖層置于所有切片圖層的頂部。

    bringToBack() this

    將切片圖層置于所有切片圖層的底部。

    getContainer() HTMLElement

    返回包含此圖層的切片的HTML元素。

    setOpacity( <Number> opacity) this

    更改網格圖層不透明度。

    setZIndex( <Number> zIndex) this

    更改網格圖層zIndex。

    isLoading() Boolean

    返回true如果在網格層有塊尚未加載完畢。

    redraw() this

    使圖層清除所有圖塊并再次請求它們。

    getTileSize() Point

    tileSize選項規范化為一個點。createTile()方法使用。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    ImageOverlay

    用于在地圖的特定邊界上加載和顯示單個圖像。延伸Layer。

    用法示例

    var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
        imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
    BM.imageOverlay(imageUrl, imageBounds).addTo(map);
    

    創建

    構造 描述
    BM.imageOverlay( <String> imageUrl, <LatLngBounds> bounds, <ImageOverlay options> options?) 給定圖像的URL及其所綁定的地理邊界,以實例化圖像疊加對象。

    選項

    配置 類型 默認 描述
    opacity Number 1.0 圖像疊加層的不透明度。
    alt String '' alt圖像屬性的文本(對輔助功能非常有用)。
    interactive Boolean false 如果true,圖像疊加將在單擊或懸停時發出鼠標事件。
    crossOrigin Boolean false 如果為true,則圖像的crossOrigin屬性設置為''。如果要訪問圖像像素數據,則需要這樣做。
    errorOverlayUrl String '' 顯示覆蓋圖像的URL,代替無法加載的疊加層。
    zIndex Number 1 切片圖層的顯式zIndex。
    className String '' 要分配給圖像的自定義類名。默認為空。
    配置 類型 默認 描述
    bubblingMouseEvents Boolean true 何時true,此圖層上的鼠標事件將在地圖上觸發相同的事件(除非BM.DomEvent.stopPropagation使用)。
    配置 類型 默認 描述
    pane String 'overlayPane' 默認情況下,圖層將添加到地圖的疊加窗格中。覆蓋此選項將導致默認情況下將圖層放置在另一個窗格上。
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    load Event ImageOverlay圖層加載其圖像時觸發
    error Event ImageOverlay圖層加載其圖像時觸發
    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)圖層時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)圖層時觸發。
    mousedown MouseEvent 當用戶在圖層上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶釋放在圖層上按下的鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入圖層時觸發。
    mouseout MouseEvent 當鼠標離開圖層時觸發。
    contextmenu MouseEvent 當用戶右鍵單擊圖層時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    setOpacity( <Number> opacity) this

    設置疊加層的不透明度。

    bringToFront() this

    將圖層置于所有疊加層的頂部。

    bringToBack() this

    將圖層置于所有疊加層的底部。

    setUrl( <String> url) this

    更改圖像的URL。

    setBounds( <LatLngBounds> bounds) this

    更新此ImageOverlay所涵蓋的邊界更改圖像疊加層zIndex。

    getBounds() LatLngBounds

    獲取此ImageOverlay涵蓋的范圍

    getElement() HTMLElement

    返回HTMLImageElement 此疊加層使用的實例。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    VideoOverlay

    用于在地圖的特定邊界上加載和顯示視頻播放器。延伸ImageOverlay。視頻疊加層使用<video> HTML5元素。

    用法示例

    var videoUrl = 'https://www.mapbox.com/bites/00188/patricia_nasa.webm',
        videoBounds = [[ 32, -130], [ 13, -100]];
    BM.VideoOverlay(videoUrl, videoBounds ).addTo(map);
    

    創建

    構造 描述
    BM.videoOverlay( <String|Array|HTMLVideoElement> video, <LatLngBounds> bounds, <VideoOverlay options> options?) 給定視頻的URL(或URL數組,甚至視頻元素)及其所綁定的地理邊界,以實例化圖像疊加對象。

    選項

    配置 類型 默認 描述
    autoplay Boolean true 視頻是否在加載時自動開始播放。
    loop Boolean true 視頻是否會在播放時循環回到開頭。
    配置 類型 默認 描述
    opacity Number 1.0 圖像疊加層的不透明度。
    alt String '' alt圖像屬性的文本(對輔助功能非常有用)。
    interactive Boolean false 如果true,圖像疊加將在單擊或懸停時發出鼠標事件。
    crossOrigin Boolean false 如果為true,則圖像的crossOrigin屬性設置為''。如果要訪問圖像像素數據,則需要這樣做。
    errorOverlayUrl String '' 顯示覆蓋圖像的URL,代替無法加載的疊加層。
    zIndex Number 1 切片圖層的顯式zIndex。
    className String '' 要分配給圖像的自定義類名。默認為空。
    配置 類型 默認 描述
    bubblingMouseEvents Boolean true 何時true,此圖層上的鼠標事件將在地圖上觸發相同的事件(除非BM.DomEvent.stopPropagation使用)。
    配置 類型 默認 描述
    pane String 'overlayPane' 默認情況下,圖層將添加到地圖的疊加窗格中。覆蓋此選項將導致默認情況下將圖層放置在另一個窗格上。
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    load Event 視頻加載完第一幀后觸發
    事件 數據 描述
    error Event ImageOverlay圖層加載其圖像時觸發
    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)圖層時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)圖層時觸發。
    mousedown MouseEvent 當用戶在圖層上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶釋放在圖層上按下的鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入圖層時觸發。
    mouseout MouseEvent 當鼠標離開圖層時觸發。
    contextmenu MouseEvent 當用戶右鍵單擊圖層時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    getElement() HTMLVideoElement

    返回HTMLVideoElement 此疊加層使用的實例。

    方法 返回 描述
    setOpacity( <Number> opacity) this

    設置疊加層的不透明度。

    bringToFront() this

    將圖層置于所有疊加層的頂部。

    bringToBack() this

    將圖層置于所有疊加層的底部。

    setUrl( <String> url) this

    更改圖像的URL。

    setBounds( <LatLngBounds> bounds) this

    更新此ImageOverlay所涵蓋的邊界更改圖像疊加層zIndex。

    getBounds() LatLngBounds

    獲取此ImageOverlay涵蓋的范圍

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    路徑

    一個抽象類,包含矢量疊加(Polygon,Polyline,Circle)之間共享的選項和常量。不要直接使用它。延伸Layer。

    選項

    配置 類型 默認 描述
    stroke Boolean true 是否沿路徑繪制筆劃。將其設置false為禁用多邊形或圓形的邊框。
    color String '#3388ff' 描邊顏色
    weight Number 3 筆畫寬度(以像素為單位)
    opacity Number 1.0 描邊透明度
    lineCap String 'round' 一個字符串,用于定義要在筆劃結束使用的形狀。
    lineJoin String 'round' 一個字符串,用于定義要在筆觸的角使用的形狀。
    dashArray String null 用于定義筆觸虛線圖案的字符串。Canvas某些舊瀏覽器中不適用于動態圖層。
    dashOffset String null 一個字符串,用于定義到破折號模式距離以啟動破折號。Canvas某些舊瀏覽器中不適用于動態圖層。
    fill Boolean depends 是否用顏色填充路徑。將其設置false為禁用填充多邊形或圓形。
    fillColor String * 填色。默認為color選項的值
    fillOpacity Number 0.2 填充不透明度。
    fillRule String 'evenodd' 一個字符串,用于定義如何確定形狀的內部。
    bubblingMouseEvents Boolean true 何時true,此路徑上的鼠標事件將在地圖上觸發相同的事件(除非BM.DomEvent.stopPropagation使用)。
    renderer Renderer 將此特定實例Renderer用于此路徑。優先于地圖的默認渲染器。
    className String null 在元素上設置自定義類名。僅適用于SVG渲染器。
    配置 類型 默認 描述
    interactive Boolean true 如果false,圖層不會發出鼠標事件,并將作為底層地圖的一部分。
    配置 類型 默認 描述
    pane String 'overlayPane' 默認情況下,圖層將添加到地圖的疊加窗格中。覆蓋此選項將導致默認情況下將圖層放置在另一個窗格上。
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)圖層時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)圖層時觸發。
    mousedown MouseEvent 當用戶在圖層上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶釋放在圖層上按下的鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入圖層時觸發。
    mouseout MouseEvent 當鼠標離開圖層時觸發。
    contextmenu MouseEvent 當用戶右鍵單擊圖層時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    redraw() this

    重繪圖層。更改路徑使用的坐標后,有時很有用。

    setStyle( <Path options> style) this

    根據Path options對象中的選項更改Path的外觀。

    bringToFront() this

    將圖層置于所有路徑圖層的頂部。

    bringToBack() this

    將圖層置于所有路徑圖層的底部。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    折線

    用于在地圖上繪制折線疊加層的類。延伸Path。

    用法示例

    // create a red polyline from an array of LatLng points
    var latlngs = [
        [45.51, -122.68],
        [37.77, -122.43],
        [34.04, -118.2]
    ];
    var polyline = BM.polyline(latlngs, {color: 'red'}).addTo(map);
    // zoom the map to the polyline
    map.fitBounds(polyline.getBounds());
    

    您還可以傳遞多維數組來表示MultiPolyline形狀:

    // create a red polyline from an array of arrays of LatLng points
    var latlngs = [
        [[45.51, -122.68],
         [37.77, -122.43],
         [34.04, -118.2]],
        [[40.78, -73.91],
         [41.83, -87.62],
         [32.76, -96.72]]
    ];
    

    創建

    構造 描述
    BM.polyline( <LatLng[]> latlngs, <Polyline options> options?) 在給定地理點數組和可選的選項對象的情況下實例化折線對象。您可以通過傳遞地理點數組的數組來創建Polyline具有多個單獨行(MultiPolyline對象。

    選項

    配置 類型 默認 描述
    smoothFactor Number 1.0 在每個縮放級別上簡化折線的程度。更多意味著更好的性能和更流暢的外觀,更少意味著更準確的表示。
    noClip Boolean false 禁用折線剪裁。
    配置 類型 默認 描述
    stroke Boolean true 是否沿路徑繪制筆劃。將其設置false為禁用多邊形或圓形的邊框。
    color String '#3388ff' 描邊顏色
    weight Number 3 筆畫寬度(以像素為單位)
    opacity Number 1.0 描邊透明度
    lineCap String 'round' 一個字符串,用于定義要在筆劃結束使用的形狀。
    lineJoin String 'round' 一個字符串,用于定義要在筆觸的角使用的形狀。
    dashArray String null 用于定義筆觸虛線圖案的字符串。Canvas某些舊瀏覽器中不適用于動態圖層。
    dashOffset String null 一個字符串,用于定義到破折號模式距離以啟動破折號。Canvas某些舊瀏覽器中不適用于動態圖層。
    fill Boolean depends 是否用顏色填充路徑。將其設置false為禁用填充多邊形或圓形。
    fillColor String * 填色。默認為color選項的值
    fillOpacity Number 0.2 填充不透明度。
    fillRule String 'evenodd' 一個字符串,用于定義如何確定形狀的內部。
    bubblingMouseEvents Boolean true 何時true,此路徑上的鼠標事件將在地圖上觸發相同的事件(除非BM.DomEvent.stopPropagation使用)。
    renderer Renderer 將此特定實例Renderer用于此路徑。優先于地圖的默認渲染器。
    className String null 在元素上設置自定義類名。僅適用于SVG渲染器。
    配置 類型 默認 描述
    interactive Boolean true 如果false,圖層不會發出鼠標事件,并將作為底層地圖的一部分。
    配置 類型 默認 描述
    pane String 'overlayPane' 默認情況下,圖層將添加到地圖的疊加窗格中。覆蓋此選項將導致默認情況下將圖層放置在另一個窗格上。
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)圖層時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)圖層時觸發。
    mousedown MouseEvent 當用戶在圖層上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶釋放在圖層上按下的鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入圖層時觸發。
    mouseout MouseEvent 當鼠標離開圖層時觸發。
    contextmenu MouseEvent 當用戶右鍵單擊圖層時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    toGeoJSON() Object

    返回一個 GeoJSON折線的表示(作為GeoJSON LineStringMultiLineString特征)。

    getLatLngs() LatLng[]

    返回路徑中的點數組,或者在多折線的情況下返回嵌套的點數組。

    setLatLngs( <LatLng[]> latlngs) this

    用給定的地理點數組替換折線中的所有點。

    isEmpty() Boolean

    true如果折線沒有LatLng,則返回。

    closestLayerPoint() Point

    返回最接近p折線的點。

    getCenter() LatLng

    返回折線的中心(質心)。

    getBounds() LatLngBounds

    返回LatLngBounds路徑。

    addLatLng( <LatLng> latlng) this

    將一個給定點添加到折線。默認情況下,在多折線的情況下添加到折線的第一個環,但可以通過將特定環作為LatLng數組(您可以在之前訪問getLatLngs來覆蓋。

    方法 返回 描述
    redraw() this

    重繪圖層。更改路徑使用的坐標后,有時很有用。

    setStyle( <Path options> style) this

    根據Path options對象中的選項更改Path的外觀。

    bringToFront() this

    將圖層置于所有路徑圖層的頂部。

    bringToBack() this

    將圖層置于所有路徑圖層的底部。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    多邊形

    用于在地圖上繪制多邊形疊加層的類。延伸Polyline。請注意,創建多邊形時傳遞的點不應該具有等于第一個點的額外最后一個點 - 最好過濾掉這些點。

    用法示例

    // create a red polygon from an array of LatLng points
    var latlngs = [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]];
    var polygon = BM.polygon(latlngs, {color: 'red'}).addTo(map);
    // zoom the map to the polygon
    map.fitBounds(polygon.getBounds());
    

    您還可以傳遞一系列latlngs數組,第一個數組表示外部形狀,另一個數組表示外部形狀中的孔:

    var latlngs = [
      [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
      [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
    ];
    

    此外,您可以傳遞多維數組以表示MultiPolygon形狀。

    var latlngs = [
      [ // first polygon
        [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
        [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
      ],
      [ // second polygon
        [[41, -111.03],[45, -111.04],[45, -104.05],[41, -104.05]]
      ]
    ];
    

    創建

    構造 描述
    BM.polygon( <LatLng[]> latlngs, <Polyline options> options?)

    選項

    配置 類型 默認 描述
    smoothFactor Number 1.0 在每個縮放級別上簡化折線的程度。更多意味著更好的性能和更流暢的外觀,更少意味著更準確的表示。
    noClip Boolean false 禁用折線剪裁。
    配置 類型 默認 描述
    stroke Boolean true 是否沿路徑繪制筆劃。將其設置false為禁用多邊形或圓形的邊框。
    color String '#3388ff' 描邊顏色
    weight Number 3 筆畫寬度(以像素為單位)
    opacity Number 1.0 描邊透明度
    lineCap String 'round' 一個字符串,用于定義要在筆劃結束使用的形狀。
    lineJoin String 'round' 一個字符串,用于定義要在筆觸的角使用的形狀。
    dashArray String null 用于定義筆觸虛線圖案的字符串。Canvas某些舊瀏覽器中不適用于動態圖層。
    dashOffset String null 一個字符串,用于定義到破折號模式距離以啟動破折號。Canvas某些舊瀏覽器中不適用于動態圖層。
    fill Boolean depends 是否用顏色填充路徑。將其設置false為禁用填充多邊形或圓形。
    fillColor String * 填色。默認為color選項的值
    fillOpacity Number 0.2 填充不透明度。
    fillRule String 'evenodd' 一個字符串,用于定義如何確定形狀的內部。
    bubblingMouseEvents Boolean true 何時true,此路徑上的鼠標事件將在地圖上觸發相同的事件(除非BM.DomEvent.stopPropagation使用)。
    renderer Renderer 將此特定實例Renderer用于此路徑。優先于地圖的默認渲染器。
    className String null 在元素上設置自定義類名。僅適用于SVG渲染器。
    配置 類型 默認 描述
    interactive Boolean true 如果false,圖層不會發出鼠標事件,并將作為底層地圖的一部分。
    配置 類型 默認 描述
    pane String 'overlayPane' 默認情況下,圖層將添加到地圖的疊加窗格中。覆蓋此選項將導致默認情況下將圖層放置在另一個窗格上。
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)圖層時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)圖層時觸發。
    mousedown MouseEvent 當用戶在圖層上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶釋放在圖層上按下的鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入圖層時觸發。
    mouseout MouseEvent 當鼠標離開圖層時觸發。
    contextmenu MouseEvent 當用戶右鍵單擊圖層時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    toGeoJSON() Object

    返回一個 GeoJSON多邊形的表示(作為GeoJSON PolygonMultiPolygonFeature)。

    方法 返回 描述
    getLatLngs() LatLng[]

    返回路徑中的點數組,或者在多折線的情況下返回嵌套的點數組。

    setLatLngs( <LatLng[]> latlngs) this

    用給定的地理點數組替換折線中的所有點。

    isEmpty() Boolean

    true如果折線沒有LatLng,則返回。

    closestLayerPoint() Point

    返回最接近p折線的點。

    getCenter() LatLng

    返回折線的中心(質心)。

    getBounds() LatLngBounds

    返回LatLngBounds路徑。

    addLatLng( <LatLng> latlng) this

    將一個給定點添加到折線。默認情況下,在多折線的情況下添加到折線的第一個環,但可以通過將特定環作為LatLng數組(您可以在之前訪問getLatLngs來覆蓋。

    方法 返回 描述
    redraw() this

    重繪圖層。更改路徑使用的坐標后,有時很有用。

    setStyle( <Path options> style) this

    根據Path options對象中的選項更改Path的外觀。

    bringToFront() this

    將圖層置于所有路徑圖層的頂部。

    bringToBack() this

    將圖層置于所有路徑圖層的底部。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    長方形

    用于在地圖上繪制矩形疊加層的類。延伸Polygon。

    用法示例

    // define rectangle geographical bounds
    var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
    // create an orange rectangle
    BM.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
    // zoom the map to the rectangle bounds
    map.fitBounds(bounds);
    

    創建

    構造 描述
    BM.rectangle( <LatLngBounds> latLngBounds, <Polyline options> options?)

    選項

    配置 類型 默認 描述
    smoothFactor Number 1.0 在每個縮放級別上簡化折線的程度。更多意味著更好的性能和更流暢的外觀,更少意味著更準確的表示。
    noClip Boolean false 禁用折線剪裁。
    配置 類型 默認 描述
    stroke Boolean true 是否沿路徑繪制筆劃。將其設置false為禁用多邊形或圓形的邊框。
    color String '#3388ff' 描邊顏色
    weight Number 3 筆畫寬度(以像素為單位)
    opacity Number 1.0 描邊透明度
    lineCap String 'round' 一個字符串,用于定義要在筆劃結束使用的形狀。
    lineJoin String 'round' 一個字符串,用于定義要在筆觸的角使用的形狀。
    dashArray String null 用于定義筆觸虛線圖案的字符串。Canvas某些舊瀏覽器中不適用于動態圖層。
    dashOffset String null 一個字符串,用于定義到破折號模式距離以啟動破折號。Canvas某些舊瀏覽器中不適用于動態圖層。
    fill Boolean depends 是否用顏色填充路徑。將其設置false為禁用填充多邊形或圓形。
    fillColor String * 填色。默認為color選項的值
    fillOpacity Number 0.2 填充不透明度。
    fillRule String 'evenodd' 一個字符串,用于定義如何確定形狀的內部。
    bubblingMouseEvents Boolean true 何時true,此路徑上的鼠標事件將在地圖上觸發相同的事件(除非BM.DomEvent.stopPropagation使用)。
    renderer Renderer 將此特定實例Renderer用于此路徑。優先于地圖的默認渲染器。
    className String null 在元素上設置自定義類名。僅適用于SVG渲染器。
    配置 類型 默認 描述
    interactive Boolean true 如果false,圖層不會發出鼠標事件,并將作為底層地圖的一部分。
    配置 類型 默認 描述
    pane String 'overlayPane' 默認情況下,圖層將添加到地圖的疊加窗格中。覆蓋此選項將導致默認情況下將圖層放置在另一個窗格上。
    attribution String null 要在歸屬控件中顯示的字符串,描述圖層數據,例如“?Mapbox”。

    活動

    事件 數據 描述
    click MouseEvent 用戶單擊(或點擊)圖層時觸發。
    dblclick MouseEvent 當用戶雙擊(或雙擊)圖層時觸發。
    mousedown MouseEvent 當用戶在圖層上按下鼠標按鈕時觸發。
    mouseup MouseEvent 當用戶釋放在圖層上按下的鼠標按鈕時觸發。
    mouseover MouseEvent 鼠標進入圖層時觸發。
    mouseout MouseEvent 當鼠標離開圖層時觸發。
    contextmenu MouseEvent 當用戶右鍵單擊圖層時觸發,防止默認瀏覽器上下文菜單顯示此事件是否有偵聽器。當用戶持續一次觸摸(也稱為長按)時,也會在手機上觸發。
    事件 數據 描述
    add Event 將圖層添加到地圖后觸發
    remove Event 從地圖中刪除圖層后觸發
    事件 數據 描述
    popupopen PopupEvent 打開綁定到此圖層的彈出窗口時觸發
    popupclose PopupEvent 綁定到此圖層的彈出窗口關閉時觸發
    事件 數據 描述
    tooltipopen TooltipEvent 打開綁定到此圖層的工具提示時觸發。
    tooltipclose TooltipEvent 綁定到此圖層的工具提示關閉時觸發。

    方法

    方法 返回 描述
    setBounds( <LatLngBounds> latLngBounds) this

    使用傳遞的邊界重繪矩形。

    方法 返回 描述
    toGeoJSON() Object

    返回一個 GeoJSON多邊形的表示(作為GeoJSON PolygonMultiPolygonFeature)。

    方法 返回 描述
    getLatLngs() LatLng[]

    返回路徑中的點數組,或者在多折線的情況下返回嵌套的點數組。

    setLatLngs( <LatLng[]> latlngs) this

    用給定的地理點數組替換折線中的所有點。

    isEmpty() Boolean

    true如果折線沒有LatLng,則返回。

    closestLayerPoint() Point

    返回最接近p折線的點。

    getCenter() LatLng

    返回折線的中心(質心)。

    getBounds() LatLngBounds

    返回LatLngBounds路徑。

    addLatLng( <LatLng> latlng) this

    將一個給定點添加到折線。默認情況下,在多折線的情況下添加到折線的第一個環,但可以通過將特定環作為LatLng數組(您可以在之前訪問getLatLngs來覆蓋。

    方法 返回 描述
    redraw() this

    重繪圖層。更改路徑使用的坐標后,有時很有用。

    setStyle( <Path options> style) this

    根據Path options對象中的選項更改Path的外觀。

    bringToFront() this

    將圖層置于所有路徑圖層的頂部。

    bringToBack() this

    將圖層置于所有路徑圖層的底部。

    方法 返回 描述
    addTo( <Map|LayerGroup> map) this

    將圖層添加到給定的地圖或圖層組。

    remove() this

    從當前處于活動狀態的地圖中刪除圖層。

    removeFrom( <Map> map) this

    從給定的地圖中刪除圖層

    getPane( <String> name?) HTMLElement

    返回HTMLElement表示地圖上命名窗格的內容。如果name省略,則返回此圖層的窗格。

    getAttribution() String

    由the使用attribution control,返回歸屬選項。

    方法 返回 描述
    bindPopup( <String|HTMLElement|Function|Popup> content, <Popup options> options?) this

    使用傳遞content彈出窗口綁定到圖層,并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindPopup() this

    刪除以前綁定的彈出窗口bindPopup。

    openPopup( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認彈出錨點處打開綁定彈出窗口。

    closePopup() this

    如果已打開,則關閉綁定到此圖層的彈出窗口。

    togglePopup() this

    打開或關閉綁定到此圖層的彈出窗口,具體取決于其當前狀態。

    isPopupOpen() boolean

    返回true如果綁定到該層的彈出當前處于打開狀態。

    setPopupContent( <String|HTMLElement|Popup> content) this

    設置綁定到此圖層的彈出窗口的內容。

    getPopup() Popup

    返回綁定到此圖層的彈出窗口。

    方法 返回 描述
    bindTooltip( <String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

    使用傳遞content工具提示綁定到圖層并設置必要的事件偵聽器。如果a Function被傳遞,它將接收圖層作為第一個參數,并應返回一個StringHTMLElement。

    unbindTooltip() this

    刪除以前綁定的工具提示bindTooltip。

    openTooltip( <LatLng> latlng?) this

    latlng如果未latlng傳遞,則在指定或默認工具提示錨點處打開綁定工具提示。

    closeTooltip() this

    如果已打開,則關閉綁定到此圖層的工具提示。

    toggleTooltip() this

    打開或關閉綁定到此圖層的工具提示,具體取決于其當前狀態。

    isTooltipOpen() boolean

    返回true綁定到此圖層的工具提示當前是否打開。

    setTooltipContent( <String|HTMLElement|Tooltip> content) this

    設置綁定到此圖層的工具提示的內容。

    getTooltip() Tooltip

    返回綁定到此圖層的工具提示。

    方法 返回 描述
    on( <String> type, <Function> fn, <Object> context?) this

    將偵聽器函數(fn添加到對象的特定事件類型。您可以選擇指定偵聽器的上下文(this關鍵字指向的對象)。您還可以傳遞多個以空格分隔的類型(例如'click dblclick')。

    on( <Object> eventMap) this

    添加一組類型/偵聽器對,例如 {click: onClick, mousemove: onMouseMove}

    off( <String> type, <Function> fn?, <Object> context?) this

    刪除以前添加的偵聽器功能。如果未指定任何函數,它將從對象中刪除該特定事件的所有偵聽器。請注意,如果您將自定義上下文傳遞給on,則必須傳遞相同的上下文off才能刪除偵聽器。

    off( <Object> eventMap) this

    刪除一組類型/偵聽器對。

    off() this

    刪除對象上所有事件的所有偵聽器。

    fire( <String> type, <Object> data?, <Boolean> propagate?) this

    觸發指定類型的事件。您可以選擇提供數據對象 - 偵聽器函數的第一個參數將包含其屬性。該事件可以選擇性地傳播給事件父母。

    listens( <String> type) Boolean

    返回true如果一個特定的事件類型有附帶任何聽眾。

    once() this

    表現為on(…),除了監聽器只會被觸發一次然后被刪除。

    addEventParent( <Evented> obj) this

    添加事件父級 - Evented將接收傳播事件的事件

    removeEventParent( <Evented> obj) this

    刪除事件父級,因此它將停止接收傳播的事件

    addEventListener() this

    別名來 on(…)

    removeEventListener() this

    別名來 off(…)

    clearAllEventListeners() this

    別名來 off()

    addOneTimeEventListener() this

    別名來 once(…)

    fireEvent() this

    別名來 fire(…)

    hasEventListeners() Boolean

    別名來 listens(…)

    用于在地圖上繪制圓形疊加層的類。延伸CircleMarker。這是一個近似值,并開始偏離靠近極點的真實圓(由于投影失真)。

    用法示例

    BM.circle([50.5, 30.5], {radius: 200}).addTo(map);
    

    創建

    構造 描述
    BM.circle( <LatLng> latlng, <Circle options> options?) 實例化給定地理點的圓對象,以及包含圓半徑的選項對象。
    BM.circle( <LatLng> latlng, <Number> radius, <Circle options> options?) 實例化圓圈的過時方式,與0.7.x代碼兼容。不要在新的應用程序或插件中使用。

    選項

    配置 類型 默認 描述
    radius Number 圓的半徑,以米為單位。
    配置 類型 默認 描述
    stroke Boolean true 是否沿路徑繪制筆劃。將其設置false為禁用多邊形或圓形的邊框。
    color String '#3388ff' 描邊顏色
    weight Number 3 筆畫寬度(以像素為單位)
    opacity Number 1.0 描邊透明度
    lineCap String 'round' 一個字符串,用于定義要在筆劃結束使用的形狀。
    lineJoin String 'round' 一個字符串,用于定義要在筆觸的角使用的形狀。
    dashArray String null 用于定義筆觸虛線圖案的字符串。Canvas某些舊瀏覽器中不適用于動態圖層。
    dashOffset String null 一個字符串,用于定義到破折號模式距離以啟動破折號。Canvas某些舊瀏覽器中不適用于動態圖層。
    fill Boolean depends 是否用顏色填充路徑。將其設置false為禁用填充多邊形或圓形。
    fillColor String * 填色。默認為color選項的值
    fillOpacity Number 0.2 填充不透明度。
    fillRule String 'evenodd' 一個字符串,用于定義如何確定形狀的內部。
    bubblingMouseEvents