地圖視圖。

成員

  • 地圖可視元件。

    Parameters

    • id: string

      網頁元素 id

    • epsg: number

      預設坐標系統編碼。

    Returns CMapView

DefaultSnapSetting: SnapSetting = ...

鎖點預設設定。

  • get EnableRange(): boolean
  • 是否允許限制範圍,是否不可移動到整個Viewport的範圍 (ViewportRange) 之外。

    Returns boolean

  • set EnableRange(value): void
  • 是否允許限制範圍,是否不可移動到整個Viewport的範圍 (ViewportRange) 之外。

    Parameters

    • value: boolean

    Returns void

  • get FreezeUserControl(): boolean
  • 凍結使用者輸入控制對 Viewport 的控制 (凍結滑鼠與鍵盤)。

    Returns boolean

  • set FreezeUserControl(value): void
  • 凍結使用者輸入控制對 Viewport 的控制 (凍結滑鼠與鍵盤)。

    Parameters

    • value: boolean

    Returns void

  • get Height(): number
  • 作畫的 <div> 元素高度。

    Returns number

  • get HoverFeatureOn(): boolean
  • 是否開啟可移到圖素模式。

    Returns boolean

  • set HoverFeatureOn(value): void
  • 是否開啟可移到圖素模式。

    Parameters

    • value: boolean

    Returns void

  • get IsBind(): boolean
  • 是否已綁定。

    Returns boolean

  • get MouseWheelZoomCenter(): boolean
  • 取得滾輪縮放是否使用中心點 (預設 false,即以滑鼠位置縮放圖台)。

    Returns boolean

  • set MouseWheelZoomCenter(value): void
  • 設定滾輪縮放是否使用中心點 (預設 false,即以滑鼠位置縮放圖台)。

    Parameters

    • value: boolean

    Returns void

  • get SelectFeatureOn(): boolean | MapViewSelectFeatureOn
  • 選取圖素事件設定。 輸入 boolean 則開啟選取圖素功能,否則關閉。

    Returns boolean | MapViewSelectFeatureOn

  • set SelectFeatureOn(value): void
  • 選取圖素事件設定。 輸入 boolean 則開啟選取圖素功能,否則關閉。

    Parameters

    Returns void

  • get Viewport(): GeoBoundary
  • 取得目前視埠。

    Returns GeoBoundary

  • set Viewport(value): void
  • 設定目前視埠。

    Parameters

    Returns void

  • get Width(): number
  • 作畫的<div>元素寬度。

    Returns number

  • get ZoomByMatrixSet(): boolean
  • 地圖依照預設或指定的矩陣資訊縮放。 若為 true,呼叫 ZoomIn / ZoomOut 的時候會依照指定的矩陣資訊縮放比例尺,否則依照下一級為原來比例尺的 0.65 倍縮放。

    Returns boolean

  • set ZoomByMatrixSet(value): void
  • 地圖依照預設或指定的矩陣資訊縮放。 若為 true,呼叫 ZoomIn / ZoomOut 的時候會依照指定的矩陣資訊縮放比例尺,否則依照下一級為原來比例尺的 0.65 倍縮放。

    Parameters

    • value: boolean

    Returns void

  • get epsg(): number
  • 坐標系統編碼。

    Returns number

  • 放棄當前輸入幾何的動作。

    Returns boolean

  • 放棄當前測量。

    Returns boolean

  • 加入事件監聽。

    Type Parameters

    Parameters

    • type: K

      事件名稱。

    • listener: MapViewEventMap[K]

      當事件觸發要呼叫的函式。

    Returns boolean

    事件名稱是否存在。

  • 啟動提示功能。

    Returns void

  • 綁定 MapDocument

    Parameters

    • mapDocument: CMapDocument

      要綁定的地圖文件。

    • Optional initBoundary: GeoBoundary

      初始化視域,綁定後畫面會自動移動到該範圍,並限制圖台移動範圍。

    Returns boolean

    是否綁定成功。

  • 彈跳到指定位置 (類似彈力球)。

    Parameters

    Returns void

    Example

    mapView.BounceTo([0, 0])
    mapView.BounceTo(new GeoPoint(0,0));
  • 手動清除所有查詢標記。

    Returns void

  • 清除測量標記。

    Returns void

  • 彈到指定位置 (類似彈簧的方式)。

    Parameters

    Returns void

    Example

    mapView.ElasticTo([0, 0])
    mapView.ElasticTo(new GeoPoint(0,0));
  • 直接結束測量,如果輸入點少於需求數會放棄該次測量。

    Returns boolean

  • 關閉提示功能。

    Returns void

  • 取得當前圖台截圖。

    Parameters

    • options: {
          FileCompressedQuality?: number;
          FileName?: string;
          FileType?: string;
      }

      參數物件。

      • Optional FileCompressedQuality?: number

        JPEG下的壓縮率,預設 1.0

      • Optional FileName?: string

        檔案名稱,預設 "map.png"

      • Optional FileType?: string

        檔案類型,預設 "image/png"

    Returns void

    Example

    mapView.ExportMap({ FileName: "map.png", FileType: "image/png" });
    
  • 飛到到指定位置。

    Parameters

    Returns void

    Example

    mapView.FlyTo([0, 0])
    mapView.FlyTo(new GeoPoint(0,0));
  • 取得一個剛好覆蓋整個 Map 的 <canvas>

    Parameters

    • id: string

      <canvas>的 id。

    Returns HTMLCanvasElement

    <canvas> HTML元素。

  • 飛到到指定範圍。

    Parameters

    • boundary: GeoBoundary | BBox

      範圍。

    • duration: number = 2000

      時間,預設 2000 (毫秒)。

    Returns void

    Example

    mapView.GoTo([0, 0, 1, 1])
    mapView.GoTo(new GeoBoundary(0, 0, 1, 1));
  • 在地圖上輸入圓,點擊左鍵一下開始,移動滑鼠決定半徑,再左鍵一下結束輸入,點擊右鍵一下放棄輸入。

    不會自動畫輸入的幾何,也不會自動搜尋,所有功能須透過 onComplete 拿到的幾何實現。

    Type Parameters

    • T extends undefined | object

    Parameters

    • onComplete: ((geo, obj) => void)

      結束輸入時的回呼函數。

        • (geo, obj): void
        • Parameters

          • geo: object
          • obj: T

          Returns void

    • onAbort: ((obj) => void)

      放棄輸入時的回呼函數。

        • (obj): void
        • Parameters

          • obj: T

          Returns void

    • optThis: object

      任意物件,會取代回呼函數作用範圍的 this

    • Optional obj: T

      任意物件,會傳遞到結束或放棄輸入的函數裡面。

    • Optional minDeltaPixel: number

      兩次點擊相離多少像素內即結束。

    Returns boolean

    Example

    const onComplete = (geo, memo) => {
    // ......
    else if(memo === "circle") {
    alert("輸入圓成功");
    }
    }
    const onAbort = (memo) => {
    // ......
    else if(memo === "circle") {
    alert("放棄輸入圓");
    }
    }
    const memo = "circle";
    MapView.InputCircle(onComplete, onAbort, this, memo);
  • 在地圖上輸入點,點擊左鍵一下就結束輸入,點擊右鍵一下放棄輸入。

    不會自動畫輸入的幾何,也不會自動搜尋,所有功能須透過 onComplete 拿到的幾何實現。

    Type Parameters

    • T extends undefined | object

    Parameters

    • onComplete: ((geo, obj) => void)

      結束輸入時的回呼函數。

        • (geo, obj): void
        • Parameters

          Returns void

    • onAbort: ((obj) => void)

      放棄輸入時的回呼函數。

        • (obj): void
        • Parameters

          • obj: T

          Returns void

    • optThis: object

      任意物件,會取代回呼函數作用範圍的this

    • Optional obj: T

      任意物件,會傳遞到結束或放棄輸入的函數裡面。

    Returns boolean

    Example

    const onComplete = (geo, memo) => {
    if(obj === "point"){
    alert("輸入點成功");
    }
    // ......
    }
    const onAbort = (memo) {
    if(memo === "point"){
    alert("放棄輸入點");
    }
    // ......
    }
    const memo = "point";
    mapView.InputPoint(onComplete , onAbort, this, memo);
  • 在地圖上輸入面,點擊左鍵一下加入點,點擊左鍵兩下結束輸入,點擊右鍵一下放棄輸入。

    不會自動畫輸入的幾何,也不會自動搜尋,所有功能須透過 onComplete 拿到的幾何實現。

    Type Parameters

    • T extends undefined | object

    Parameters

    • onComplete: ((geo, obj) => void)

      結束輸入時的回呼函數。

        • (geo, obj): void
        • Parameters

          Returns void

    • onAbort: ((obj) => void)

      放棄輸入時的回呼函數。

        • (obj): void
        • Parameters

          • obj: T

          Returns void

    • optThis: object

      任意物件,會取代回呼函數作用範圍的 this

    • Optional obj: T

      任意物件,會傳遞到結束或放棄輸入的函數裡面。

    • Optional minDeltaPixel: number

      兩次點擊相離多少像素內即結束。

    Returns boolean

    Example

    const onComplete = (geo, memo) => {
    // ......
    else if(memo === "polygon"){
    alert("輸入面成功");
    }
    // ......
    }
    const onAbort = (memo) => {
    // ......
    else if(memo === "polygon"){
    alert("放棄輸入面");
    }
    // ......
    }
    const memo = "polygon";
    mapView.InputPolygon(onComplete, onAbort, this, memo);
  • 在地圖上輸入線,點擊左鍵一下加入點,點擊左鍵兩下結束輸入,點擊右鍵一下放棄輸入。

    不會自動畫輸入的幾何,也不會自動搜尋,所有功能須透過 onComplete 拿到的幾何實現。

    Type Parameters

    • T extends undefined | object

    Parameters

    • onComplete: ((geo, obj) => void)

      結束輸入時的回呼函數。

        • (geo, obj): void
        • Parameters

          Returns void

    • onAbort: ((obj) => void)

      放棄輸入時的回呼函數。

        • (obj): void
        • Parameters

          • obj: T

          Returns void

    • optThis: object

      任意物件,會取代回呼函數作用範圍的 this

    • Optional obj: T

      任意物件,會傳遞到結束或放棄輸入的函數裡面。

    • Optional minDeltaPixel: number

      兩次點擊相離多少像素內即結束。

    Returns boolean

    Example

    const onComplete = (geo , memo) => {
    // ......
    else if(memo === "polyline"){
    alert("輸入線成功");
    }
    // ......
    };
    const onAbort = (memo) => {
    // ......
    else if(memo === "polyline"){
    alert("放棄輸入線");
    }
    // ......
    };
    const memo = "polyline";
    mapView.InputPolyline(onComplete , onAbort, this, memo);
  • 在地圖上輸入框,點擊左鍵一下開始,移動滑鼠改變形狀,再左鍵一下結束輸入,點擊右鍵一下放棄輸入。

    不會自動畫輸入的幾何,也不會自動搜尋,所有功能須透過 onComplete 拿到的幾何實現。

    Type Parameters

    • T extends undefined | object

    Parameters

    • onComplete: ((geo, obj) => void)

      結束輸入時的回呼函數。

        • (geo, obj): void
        • Parameters

          Returns void

    • onAbort: ((obj) => void)

      放棄輸入時的回呼函數。

        • (obj): void
        • Parameters

          • obj: T

          Returns void

    • optThis: object

      任意物件,會取代回呼函數作用範圍的 this

    • Optional obj: T

      任意物件,會傳遞到結束或放棄輸入的函數裡面。

    • Optional minDeltaPixel: number

      兩次點擊相離多少像素內即結束。

    Returns boolean

    Example

    const onComplete = (geo, memo) => {
    // ......
    else if(memo === "boundary"){
    alert("輸入框成功");
    }
    }
    const onAbort = (memo) => {
    // ......
    else if(memo === "boundary"){
    alert("放棄輸入框");
    }
    }
    const memo = "boundary";
    mapView.InputRectangle(onComplete, onAbort, this, memo);
  • 量測面積。參數皆為選用。

    Type Parameters

    • T

    Parameters

    • Optional onComplete: null | ((geo, value, obj) => void)

      結束時的回呼函數。

    • Optional obj: T

      任意物件,給 onComplete 辨識或傳遞物件用。

    • Optional minDeltaPixel: number

      兩次點擊相離多少像素內即結束,可以不給,預設值為5

    • Optional measureLength: boolean

      開啟鎖點時,測量面積只有兩點當作測距離,預設true

    Returns boolean

    回傳啟動測量是否成功

  • 量測距離。參數皆為選用。

    Type Parameters

    • T

    Parameters

    • Optional onComplete: null | ((geo, value, obj) => void)

      結束時的回呼函數。

    • Optional obj: T

      任意物件,給 onComplete 辨識或傳遞物件用。

    • Optional minDeltaPixel: number

      兩次點擊相離多少像素內即結束,預設值為5

    Returns boolean

    回傳啟動測量是否成功。

  • 平移到指定位置。

    Parameters

    • coordinate: GeoPoint | Position

      [x, y]GeoPoint

    • duration: number = 2000

      時間,預設 2000 (毫秒)。

    • Optional easing: ((t) => number)

      緩動函數,預設線性。

        • (t): number
        • Parameters

          • t: number

          Returns number

    Returns void

    Example

    mapView.PanTo([0, 0])
    mapView.PanTo(new GeoPoint(0, 0));
  • 查詢圖層屬性。

    Parameters

    • layerNames: string

      圖層名稱,多個用逗號隔開。

    • strokeColor: string

      線框顏色。

    • fillColor: string

      填滿顏色。

    • queryType: QUERY_TYPE

      查詢類型,目前支援:

    • Optional callback: ((queryFeatures) => void)

      回呼函式。

        • (queryFeatures): void
        • Parameters

          • queryFeatures: unknown

          Returns void

    • Optional proxy: string

      代理網址,預設無。

    Returns void

  • 移除指定的元素。

    Parameters

    • id: string

      元素Id。

    Returns void

  • 移除指定的事件監聽。

    Type Parameters

    Parameters

    Returns boolean

    事件名稱是否存在並且已移除。

  • 回復上一個鎖點設定,若沒有上一個則恢復預設值。

    Returns void

  • 設定取圖進度相關參數。

    Parameters

    • Optional delay: number

      時間間隔 (毫秒)。

    Returns void

  • 設定影響 ZoomInZoomOut、滾輪的最小和最大比例尺分母。

    Parameters

    • minScaleDenominator: number

      最小比例尺分母,須大於等於0,限制縮放無法小於最小比例尺,0代表不限制。

    • maxScaleDenominator: number

      最大比例尺分母,須大於等於0,限制縮放無法大於最大比例尺,0代表不限制。

    Returns boolean

    是否設定成功。最小或最大比例尺小於0,或數值的大小關係不符邏輯都會回傳 false

  • 設定監聽伺服器功能。

    Parameters

    • urls: string | string[]

      指定伺服器端的網址。

    • Optional delay: number

      時間間隔 (毫秒)。

    Returns void

  • 設定鎖點功能。

    Parameters

    • Optional layerName: null | string

      從指定的客戶端圖層名稱取鎖點,多圖層名用逗號分隔,若有值則啟動鎖點功能,無則關閉功能 (其他參數無作用),預設關閉。

    • Optional pixel: number

      搜尋鎖點範圍,單位像素 (px),預設5

    • Optional type: string

      指定鎖點類型,預設"node",支援:

      • "node" - 取最近的幾何 (點) 作為鎖點。
      • "perpendicular_foot" - 取最近的垂足作為鎖點。
    • Optional radius: number

      鎖點半徑大小,單位像素 (px),預設3

    • Optional fillColor: string

      鎖點填滿顏色,預設紅色。

    • Optional strokeColor: string

      鎖點外框顏色,預設黑色。

    • Optional proxyUrl: string

      代理網址,預設無。

    Returns void

    Example

    mapView.SetSnapPointSetting("wmts", 10, "node", 3, "rgba(255, 0, 0, 1)", "rgba(0, 0, 0, 1)") // 自動開啟
    mapView.SetSnapPointSetting() // 關閉鎖點功能
  • 旋轉到指定位置。

    Parameters

    Returns void

    Example

    mapView.SpinTo([0, 0])
    mapView.SpinTo(new GeoPoint(0, 0));
  • 以螺旋方式到指定位置。

    Parameters

    Returns void

    Example

    mapView.SpiralTo([0, 0]);
    mapView.SpiralTo(new GeoPoint(0, 0));
  • 紀錄當前的鎖點設定。

    Returns void

  • 解除與 MapDocument 的綁定。

    Returns void

  • 強制更新畫面,如果作畫範圍 (<div>) 有改變,也會重新計算視域。

    Returns void

  • 將 Viewport 座標轉至 Window 座標,若為 GeoPointGeoBoundary ,則直接轉換傳入的參數,若是 number,則將轉換後的長度傳回。

    Parameters

    Returns undefined | number

    若參數為 number,則傳回轉換後的長度。

  • 將 Window 座標轉至 Viewport 座標,若為 GeoPointGeoBoundary ,則直接轉換傳入的參數,若是 number,則將轉換後的長度傳回。

    Parameters

    Returns undefined | number

    若參數為 number,則傳回轉換後的長度。

  • 地圖移動到最大可視範圍。

    Returns void

  • 平移到指定的中心點。

    Parameters

    Returns void

    Example

    let p = new GeoPoint(121, 22);
    mapView.ZoomCenter(p);
  • 地圖比例尺放大一級。

    Returns void

  • 取消縮放模式。

    Returns void

  • 地圖比例尺縮小一級。

    Returns void

  • 地圖移動到前一畫面。

    Returns void

  • 縮放到指定的比例尺 (分母) 下。

    Parameters

    • scaleRatio: number

      比例尺 (分母)。

    Returns void

    Example

    mapView.ZoomScale(25000); // 縮放到 1:25000 (兩萬五千分之一) 的比例尺
    
  • 框選並移動視域到該範圍,呼叫後會自動進入輸入框模式。

    Returns void

OpenLayers

  • 在指定外部的元素上加入比例尺,比例尺classol-scale-line

    Parameters

    • id: string

      元素的 id

    Returns ScaleLine

    OpenLayers ol.control.ScaleLine 手柄。

    Example

    mapView.CreateScaleLine("scale");
    
  • 在指定外部的元素移除特定比例尺。

    Parameters

    Returns boolean

    Example

    mapView.RemoveScaleLine("scale");
    

Openlayers

  • get Map(): undefined | Map
  • Openlayers 的 ol.Map

    Returns undefined | Map

  • get ScaleLineOn(): boolean
  • 比例尺開關。 若為 true 則開啟比例尺圖示,否則關閉,比例尺 className"ol-scale-line"

    Returns boolean

  • set ScaleLineOn(value): void
  • 比例尺開關。 若為 true 則開啟比例尺圖示,否則關閉,比例尺 className"ol-scale-line"

    Parameters

    • value: boolean

    Returns void

  • get View(): undefined | View
  • Openlayers 的 ol.View

    Returns undefined | View

  • 在地圖上建立 ol.Overlay 元件。

    Parameters

    • position: GeoPoint | Position

      [x, y]GeoPoint

    • id: undefined | string | number

      Overlay 元件 id

    • elementTagName: string

      元件的DOM標籤名稱。

    • callback: ((element) => void)

      回呼函式。

        • (element): void
        • Parameters

          • element: HTMLElement

          Returns void

    Returns Overlay

    Openlayers ol.Overlay 元件。

    Example

    const overlay = mapView.CreateOverlay([13465046.15542, 2709138.0502025], "overlay", "div", (element) => {
    const content = document.createElement("div");
    element.appendChild(content);
    content.innerHTML = "testContent";
    element.className = "ol-popup";
    });
  • 透過 id 取得地圖上的 ol.Overlay 元件。

    Parameters

    • id: string | number

      Overlay 元件 id

    Returns Overlay

    Openlayers ol.Overlay 元件。

  • 從地圖上移除 ol.Overlay 元件。

    Parameters

    Returns void

Generated using TypeDoc