類別 CMapView

地圖視圖。

索引

屬性

`靜態`DefaultSnapSetting

DefaultSnapSetting: SnapSetting = ...

鎖點預設設定。

方法 - OpenLayers

CreateScaleLine

CreateScaleLine(id: string): ol.control.ScaleLine
在指定外部的元素上加入比例尺，比例尺class為ol-scale-line。
參數
- id: string
  元素的 id。
回傳 ol.control.ScaleLine
OpenLayers ol.control.ScaleLine 手柄。
範例
```
mapView.CreateScaleLine("scale");
```
- 定義於 src/openlayers/MapView.ts:964

RemoveScaleLine

RemoveScaleLine(scaleLine: ol.control.ScaleLine): boolean
在指定外部的元素移除特定比例尺。
參數
- scaleLine: ol.control.ScaleLine
  OpenLayers 手柄。
回傳 boolean
範例
```
mapView.RemoveScaleLine("scale");
```
- 定義於 src/openlayers/MapView.ts:982

方法 - Openlayers

CreateOverlay

CreateOverlay(
    position: GeoPoint | Position,
    id: undefined | string | number,
    elementTagName: string,
    callback: (element: HTMLElement) => void,
): Overlay
在地圖上建立 ol.Overlay 元件。
參數
- position: GeoPoint | Position
  [x, y]或 GeoPoint。
- id: undefined | string | number
  Overlay 元件 id。
- elementTagName: string
  元件的DOM標籤名稱。
- callback: (element: HTMLElement) => void
  回呼函式。
回傳 Overlay
Openlayers ol.Overlay 元件。
範例
```
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";
});
```
- 定義於 src/openlayers/MapView.ts:1139

RemoveOverlay

RemoveOverlay(overlay: Overlay): void
從地圖上移除 ol.Overlay 元件。
參數
- overlay: Overlay
  Openlayers ol.Overlay 元件。
回傳 void
- 定義於 src/openlayers/MapView.ts:1166

GetOverlayById

GetOverlayById(id: string | number): Overlay
透過 id 取得地圖上的 ol.Overlay 元件。
參數
- id: string | number
  Overlay 元件 id。
回傳 Overlay
Openlayers ol.Overlay 元件。
- 定義於 src/openlayers/MapView.ts:1177

方法 - Other

Bind

Bind(mapDocument: CMapDocument, initBoundary?: GeoBoundary): boolean
綁定 MapDocument。
參數
- mapDocument: CMapDocument
  要綁定的地圖文件。
- 可選initBoundary: GeoBoundary
  初始化視域，綁定後畫面會自動移動到該範圍，並限制圖台移動範圍。
回傳 boolean
是否綁定成功。
- 定義於 src/openlayers/MapView.ts:316

Unbind

Unbind(): void
解除與 MapDocument 的綁定。

回傳 void
- 定義於 src/openlayers/MapView.ts:337

UpdateScreen

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

回傳 void
- 定義於 src/openlayers/MapView.ts:342

AddEventListener

AddEventListener<K extends keyof MapViewEventMap>(
type: K,
listener: MapViewEventMap[K],
): boolean
加入事件監聽。
類型參數
- K extends keyof MapViewEventMap
參數
- type: K
  事件名稱。
- listener: MapViewEventMap[K]
  當事件觸發要呼叫的函式。
回傳 boolean
事件名稱是否存在。
- 定義於 src/openlayers/MapView.ts:350

RemoveEventListener

RemoveEventListener<K extends keyof MapViewEventMap>(
type: K,
listener: MapViewEventMap[K],
): boolean
移除指定的事件監聽。
類型參數
- K extends keyof MapViewEventMap
參數
- type: K
  事件名稱。
- listener: MapViewEventMap[K]
  要移除的函式。
回傳 boolean
事件名稱是否存在並且已移除。
- 定義於 src/openlayers/MapView.ts:360

ZoomWindow

ZoomWindow(): void
框選並移動視域到該範圍，呼叫後會自動進入輸入框模式。

回傳 void
- 定義於 src/openlayers/MapView.ts:367

ZoomIn

ZoomIn(): void
地圖比例尺放大一級。

回傳 void
- 定義於 src/openlayers/MapView.ts:374

ZoomOut

ZoomOut(): void
地圖比例尺縮小一級。

回傳 void
- 定義於 src/openlayers/MapView.ts:381

ZoomScale

ZoomScale(scaleRatio: number): void
縮放到指定的比例尺 (分母) 下。
參數
- scaleRatio: number
  比例尺 (分母)。
回傳 void
範例
```
mapView.ZoomScale(25000); // 縮放到 1:25000 (兩萬五千分之一) 的比例尺
```
- 定義於 src/openlayers/MapView.ts:393

ZoomCenter

ZoomCenter(center: GeoPoint): void
平移到指定的中心點。
參數
- center: GeoPoint
  指定的中心點。
回傳 void
範例
```
let p = new GeoPoint(121, 22);
mapView.ZoomCenter(p);
```
- 定義於 src/openlayers/MapView.ts:406

ZoomAll

ZoomAll(): void
地圖移動到最大可視範圍。

回傳 void
- 定義於 src/openlayers/MapView.ts:413

ZoomNone

ZoomNone(): void
取消縮放模式。

回傳 void
- 定義於 src/openlayers/MapView.ts:420

ZoomPreview

ZoomPreview(): void
地圖移動到前一畫面。

回傳 void
- 定義於 src/openlayers/MapView.ts:427

WindowToViewport

WindowToViewport(obj: number | GeoPoint | GeoBoundary): undefined | number
將 Window 座標轉至 Viewport 座標，若為 GeoPoint 與 GeoBoundary ，則直接轉換傳入的參數，若是 number，則將轉換後的長度傳回。
參數
- obj: number | GeoPoint | GeoBoundary
  欲轉換的座標。
回傳 undefined | number
若參數為 number，則傳回轉換後的長度。
- 定義於 src/openlayers/MapView.ts:436

ViewportToWindow

ViewportToWindow(obj: number | GeoPoint | GeoBoundary): undefined | number
將 Viewport 座標轉至 Window 座標，若為 GeoPoint 與 GeoBoundary ，則直接轉換傳入的參數，若是 number，則將轉換後的長度傳回。
參數
- obj: number | GeoPoint | GeoBoundary
  欲轉換的座標。
回傳 undefined | number
若參數為 number，則傳回轉換後的長度。
- 定義於 src/openlayers/MapView.ts:445

InputPoint

InputPoint<T extends undefined | object>(
    onComplete: (geo: GeoPoint, obj: T) => void,
    onAbort: (obj: T) => void,
    optThis: object,
    obj?: T,
): boolean
在地圖上輸入點，點擊左鍵一下就結束輸入，點擊右鍵一下放棄輸入。

不會自動畫輸入的幾何，也不會自動搜尋，所有功能須透過 onComplete 拿到的幾何實現。
類型參數
- T extends undefined | object
參數
- onComplete: (geo: GeoPoint, obj: T) => void
  結束輸入時的回呼函數。
- onAbort: (obj: T) => void
  放棄輸入時的回呼函數。
- optThis: object
  任意物件，會取代回呼函數作用範圍的this。
- 可選obj: T
  任意物件，會傳遞到結束或放棄輸入的函數裡面。
回傳 boolean
範例
```
const onComplete = (geo, memo) => {
    if(obj === "point"){
        alert("輸入點成功");
    }
    // ......
}
const onAbort = (memo) {
    if(memo === "point"){
        alert("放棄輸入點");
    }
    // ......
}
const memo = "point";
mapView.InputPoint(onComplete , onAbort, this, memo);
```
- 定義於 src/openlayers/MapView.ts:475

InputPolyline

InputPolyline<T extends undefined | object>(
    onComplete: (geo: GeoPolyline, obj: T) => void,
    onAbort: (obj: T) => void,
    optThis: object,
    obj?: T,
    minDeltaPixel?: number,
): boolean
在地圖上輸入線，點擊左鍵一下加入點，點擊左鍵兩下結束輸入，點擊右鍵一下放棄輸入。

不會自動畫輸入的幾何，也不會自動搜尋，所有功能須透過 onComplete 拿到的幾何實現。
類型參數
- T extends undefined | object
參數
- onComplete: (geo: GeoPolyline, obj: T) => void
  結束輸入時的回呼函數。
- onAbort: (obj: T) => void
  放棄輸入時的回呼函數。
- optThis: object
  任意物件，會取代回呼函數作用範圍的 this。
- 可選obj: T
  任意物件，會傳遞到結束或放棄輸入的函數裡面。
- 可選minDeltaPixel: number
  兩次點擊相離多少像素內即結束。
回傳 boolean
範例
```
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);
```
- 定義於 src/openlayers/MapView.ts:509

InputPolygon

InputPolygon<T extends undefined | object>(
    onComplete: (geo: GeoPolygon, obj: T) => void,
    onAbort: (obj: T) => void,
    optThis: object,
    obj?: T,
    minDeltaPixel?: number,
): boolean
在地圖上輸入面，點擊左鍵一下加入點，點擊左鍵兩下結束輸入，點擊右鍵一下放棄輸入。

不會自動畫輸入的幾何，也不會自動搜尋，所有功能須透過 onComplete 拿到的幾何實現。
類型參數
- T extends undefined | object
參數
- onComplete: (geo: GeoPolygon, obj: T) => void
  結束輸入時的回呼函數。
- onAbort: (obj: T) => void
  放棄輸入時的回呼函數。
- optThis: object
  任意物件，會取代回呼函數作用範圍的 this。
- 可選obj: T
  任意物件，會傳遞到結束或放棄輸入的函數裡面。
- 可選minDeltaPixel: number
  兩次點擊相離多少像素內即結束。
回傳 boolean
範例
```
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);
```
- 定義於 src/openlayers/MapView.ts:543

InputRectangle

InputRectangle<T extends undefined | object>(
    onComplete: (geo: GeoBoundary, obj: T) => void,
    onAbort: (obj: T) => void,
    optThis: object,
    obj?: T,
    minDeltaPixel?: number,
): boolean
在地圖上輸入框，點擊左鍵一下開始，移動滑鼠改變形狀，再左鍵一下結束輸入，點擊右鍵一下放棄輸入。

不會自動畫輸入的幾何，也不會自動搜尋，所有功能須透過 onComplete 拿到的幾何實現。
類型參數
- T extends undefined | object
參數
- onComplete: (geo: GeoBoundary, obj: T) => void
  結束輸入時的回呼函數。
- onAbort: (obj: T) => void
  放棄輸入時的回呼函數。
- optThis: object
  任意物件，會取代回呼函數作用範圍的 this。
- 可選obj: T
  任意物件，會傳遞到結束或放棄輸入的函數裡面。
- 可選minDeltaPixel: number
  兩次點擊相離多少像素內即結束。
回傳 boolean
範例
```
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);
```
- 定義於 src/openlayers/MapView.ts:575

InputCircle

InputCircle<T extends undefined | object>(
    onComplete: (geo: object, obj: T) => void,
    onAbort: (obj: T) => void,
    optThis: object,
    obj?: T,
    minDeltaPixel?: number,
): boolean
在地圖上輸入圓，點擊左鍵一下開始，移動滑鼠決定半徑，再左鍵一下結束輸入，點擊右鍵一下放棄輸入。

不會自動畫輸入的幾何，也不會自動搜尋，所有功能須透過 onComplete 拿到的幾何實現。
類型參數
- T extends undefined | object
參數
- onComplete: (geo: object, obj: T) => void
  結束輸入時的回呼函數。
- onAbort: (obj: T) => void
  放棄輸入時的回呼函數。
- optThis: object
  任意物件，會取代回呼函數作用範圍的 this。
- 可選obj: T
  任意物件，會傳遞到結束或放棄輸入的函數裡面。
- 可選minDeltaPixel: number
  兩次點擊相離多少像素內即結束。
回傳 boolean
範例
```
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);
```
- 定義於 src/openlayers/MapView.ts:607

AbortInput

AbortInput(): boolean
放棄當前輸入幾何的動作。

回傳 boolean
- 定義於 src/openlayers/MapView.ts:615

SetMinMaxScaleDenominator

SetMinMaxScaleDenominator(
minScaleDenominator: number,
maxScaleDenominator: number,
): boolean
設定影響 ZoomIn、ZoomOut、滾輪的最小和最大比例尺分母。
參數
- minScaleDenominator: number
  最小比例尺分母，須大於等於0，限制縮放無法小於最小比例尺，0代表不限制。
- maxScaleDenominator: number
  最大比例尺分母，須大於等於0，限制縮放無法大於最大比例尺，0代表不限制。
回傳 boolean
是否設定成功。最小或最大比例尺小於0，或數值的大小關係不符邏輯都會回傳 false。
- 定義於 src/openlayers/MapView.ts:626

MeasureLength

MeasureLength<T>(
    onComplete?: null | ((geo: GeoPolyline, value: number, obj: T) => void),
    obj?: T,
    minDeltaPixel?: number,
): boolean
量測距離。參數皆為選用。
類型參數
- T
參數
- 可選onComplete: null | ((geo: GeoPolyline, value: number, obj: T) => void)
  結束時的回呼函數。
- 可選obj: T
  任意物件，給 onComplete 辨識或傳遞物件用。
- 可選minDeltaPixel: number
  兩次點擊相離多少像素內即結束，預設值為5。
回傳 boolean
回傳啟動測量是否成功。
- 定義於 src/openlayers/MapView.ts:637

MeasureArea

MeasureArea<T>(
    onComplete?:
        | null
        | (
            (
                geo: GeoPolygon,
                value: { Area: number; Length: number },
                obj: T,
            ) => void
        ),
    obj?: T,
    minDeltaPixel?: number,
    measureLength?: boolean,
): boolean
量測面積。參數皆為選用。
類型參數
- T
參數
- 可選onComplete:
      | null
      | (
          (
              geo: GeoPolygon,
              value: { Area: number; Length: number },
              obj: T,
          ) => void
      )
  結束時的回呼函數。
- 可選obj: T
  任意物件，給 onComplete 辨識或傳遞物件用。
- 可選minDeltaPixel: number
  兩次點擊相離多少像素內即結束，可以不給，預設值為5。
- 可選measureLength: boolean
  開啟鎖點時，測量面積只有兩點當作測距離，預設true。
回傳 boolean
回傳啟動測量是否成功
- 定義於 src/openlayers/MapView.ts:650

EndMeasure

EndMeasure(): boolean
直接結束測量，如果輸入點少於需求數會放棄該次測量。

回傳 boolean
- 定義於 src/openlayers/MapView.ts:659

AbortMeasure

AbortMeasure(): boolean
放棄當前測量。

回傳 boolean
- 定義於 src/openlayers/MapView.ts:667

ClearMeasure

ClearMeasure(): void
清除測量標記。

回傳 void
- 定義於 src/openlayers/MapView.ts:675

PanTo

PanTo(
    coordinate: GeoPoint | Position,
    duration?: number,
    easing?: (t: number) => number,
): void
平移到指定位置。
參數
- coordinate: GeoPoint | Position
  [x, y]或 GeoPoint。
- duration: number = 2000
  時間，預設 2000 (毫秒)。
- 可選easing: (t: number) => number
  緩動函數，預設線性。
回傳 void
範例
```
mapView.PanTo([0, 0])
mapView.PanTo(new GeoPoint(0, 0));
```
- 定義於 src/openlayers/MapView.ts:737

ElasticTo

ElasticTo(coordinate: GeoPoint | Position, duration?: number): void
彈到指定位置 (類似彈簧的方式)。
參數
- coordinate: GeoPoint | Position
  [x, y]或 GeoPoint。
- duration: number = 2000
  時間，預設 2000 (毫秒)。
回傳 void
範例
```
mapView.ElasticTo([0, 0])
mapView.ElasticTo(new GeoPoint(0,0));
```
- 定義於 src/openlayers/MapView.ts:763

BounceTo

BounceTo(coordinate: GeoPoint | Position, duration?: number): void
彈跳到指定位置 (類似彈力球)。
參數
- coordinate: GeoPoint | Position
  [x, y]或 GeoPoint。
- duration: number = 2000
  時間，預設 2000 (毫秒)。
回傳 void
範例
```
mapView.BounceTo([0, 0])
mapView.BounceTo(new GeoPoint(0,0));
```
- 定義於 src/openlayers/MapView.ts:789

SpinTo

SpinTo(coordinate: GeoPoint | Position, duration?: number): void
旋轉到指定位置。
參數
- coordinate: GeoPoint | Position
  [x, y]或 GeoPoint。
- duration: number = 2000
  時間，預設 2000 (毫秒)。
回傳 void
範例
```
mapView.SpinTo([0, 0])
mapView.SpinTo(new GeoPoint(0, 0));
```
- 定義於 src/openlayers/MapView.ts:814

FlyTo

FlyTo(coordinate: GeoPoint | Position, duration?: number): void
飛到到指定位置。
參數
- coordinate: GeoPoint | Position
  [x, y]或 GeoPoint。
- duration: number = 2000
  時間，預設 2000 (毫秒)。
回傳 void
範例
```
mapView.FlyTo([0, 0])
mapView.FlyTo(new GeoPoint(0,0));
```
- 定義於 src/openlayers/MapView.ts:846

GoTo

GoTo(boundary: GeoBoundary | BBox, duration?: number): void
飛到到指定範圍。
參數
- boundary: GeoBoundary | BBox
  範圍。
- duration: number = 2000
  時間，預設 2000 (毫秒)。
回傳 void
範例
```
mapView.GoTo([0, 0, 1, 1])
mapView.GoTo(new GeoBoundary(0, 0, 1, 1));
```
- 定義於 src/openlayers/MapView.ts:878

SpiralTo

SpiralTo(coordinate: GeoPoint | Position, duration?: number): void
以螺旋方式到指定位置。
參數
- coordinate: GeoPoint | Position
  [x, y]或 GeoPoint。
- duration: number = 2000
  時間，預設 2000 (毫秒)。
回傳 void
範例
```
mapView.SpiralTo([0, 0]);
mapView.SpiralTo(new GeoPoint(0, 0));
```
- 定義於 src/openlayers/MapView.ts:925

SetSnapPointSetting

SetSnapPointSetting(
    layerName?: null | string,
    pixel?: number,
    type?: string,
    radius?: number,
    fillColor?: string,
    strokeColor?: string,
    proxyUrl?: string,
): void
設定鎖點功能。
參數
- 可選layerName: null | string
  從指定的客戶端圖層名稱取鎖點，多圖層名用逗號分隔，若有值則啟動鎖點功能，無則關閉功能 (其他參數無作用)，預設關閉。
- 可選pixel: number
  搜尋鎖點範圍，單位像素 (px)，預設5。
- 可選type: string
  指定鎖點類型，預設"node"，支援：
  
  "node" - 取最近的幾何 (點) 作為鎖點。
  
  "perpendicular_foot" - 取最近的垂足作為鎖點。
- 可選radius: number
  鎖點半徑大小，單位像素 (px)，預設3。
- 可選fillColor: string
  鎖點填滿顏色，預設紅色。
- 可選strokeColor: string
  鎖點外框顏色，預設黑色。
- 可選proxyUrl: string
  代理網址，預設無。
回傳 void
範例
```
mapView.SetSnapPointSetting("wmts", 10, "node", 3, "rgba(255, 0, 0, 1)", "rgba(0, 0, 0, 1)") // 自動開啟
mapView.SetSnapPointSetting() // 關閉鎖點功能
```
- 定義於 src/openlayers/MapView.ts:1004

StoreCurrentSnapPointSetting

StoreCurrentSnapPointSetting(): void
紀錄當前的鎖點設定。

回傳 void
- 定義於 src/openlayers/MapView.ts:1015

RestorePreviousSnapPointSetting

RestorePreviousSnapPointSetting(): void
回復上一個鎖點設定，若沒有上一個則恢復預設值。

回傳 void
- 定義於 src/openlayers/MapView.ts:1022

SetOnServerNotify

SetOnServerNotify(urls: string | string[], delay?: number): void
設定監聽伺服器功能。
參數
- urls: string | string[]
  指定伺服器端的網址。
- 可選delay: number
  時間間隔 (毫秒)。
回傳 void
- 定義於 src/openlayers/MapView.ts:1031

SetGetTileProgress

SetGetTileProgress(delay?: number): void
設定取圖進度相關參數。
參數
- 可選delay: number
  時間間隔 (毫秒)。
回傳 void
- 定義於 src/openlayers/MapView.ts:1046

GetCanvasOverMap

GetCanvasOverMap(id: string): HTMLCanvasElement
取得一個剛好覆蓋整個 Map 的 <canvas>。
參數
- id: string
  <canvas>的 id。
回傳 HTMLCanvasElement
<canvas> HTML元素。
- 定義於 src/openlayers/MapView.ts:1055

RemoveElement

RemoveElement(id: string): void
移除指定的元素。
參數
- id: string
  元素Id。
回傳 void
- 定義於 src/openlayers/MapView.ts:1085

QueryFeatureInfoWithMark

QueryFeatureInfoWithMark(
    layerNames: string,
    strokeColor: string,
    fillColor: string,
    queryType: QUERY_TYPE,
    callback?: (queryFeatures: unknown) => void,
    proxy?: string,
): void
查詢圖層屬性。
參數
- layerNames: string
  圖層名稱，多個用逗號隔開。
- strokeColor: string
  線框顏色。
- fillColor: string
  填滿顏色。
- queryType: QUERY_TYPE
  查詢類型，目前支援：
  
  QUERY_TYPE.CLICK: 點擊拿最上層的唯一圖素。
  
  QUERY_TYPE.INCLUDE: 框選所有圖素。
- 可選callback: (queryFeatures: unknown) => void
  回呼函式。
- 可選proxy: string
  代理網址，預設無。
回傳 void
- 定義於 src/openlayers/MapView.ts:1100

ClearMarkFeatureInfo

ClearMarkFeatureInfo(): void
手動清除所有查詢標記。

回傳 void
- 定義於 src/openlayers/MapView.ts:1107

BeginTooltip

BeginTooltip(): void
啟動提示功能。

回傳 void
- 定義於 src/openlayers/MapView.ts:1112

EndTooltip

EndTooltip(): void
關閉提示功能。

回傳 void
- 定義於 src/openlayers/MapView.ts:1117

ExportMap

ExportMap(
    options: {
        FileName?: string;
        FileType?: string;
        FileCompressedQuality?: number;
    },
): void
取得當前圖台截圖。
參數
- options: { FileName?: string; FileType?: string; FileCompressedQuality?: number }
  參數物件。
  - 可選FileName?: string
    檔案名稱，預設 "map.png"。
  - 可選FileType?: string
    檔案類型，預設 "image/png"。
  - 可選FileCompressedQuality?: number
    JPEG下的壓縮率，預設 1.0。
回傳 void
範例
```
mapView.ExportMap({ FileName: "map.png", FileType: "image/png" });
```
- 定義於 src/openlayers/MapView.ts:1193

構造函數

constructor

new CMapView(id: string, epsg: number): CMapView
地圖可視元件。
參數
- id: string
  網頁元素 id。
- epsg: number
  預設坐標系統編碼。
回傳 CMapView
- 定義於 src/openlayers/MapView.ts:157

訪問器屬性 - Openlayers

ScaleLineOn

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

回傳 boolean
- 定義於 src/openlayers/MapView.ts:238
set ScaleLineOn(value: boolean): void
比例尺開關。若為 true 則開啟比例尺圖示，否則關閉，比例尺 className 為 "ol-scale-line"。
參數
- value: boolean
回傳 void
- 定義於 src/openlayers/MapView.ts:246

Map

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

回傳 undefined | Map
- 定義於 src/openlayers/MapView.ts:267

View

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

回傳 undefined | View
- 定義於 src/openlayers/MapView.ts:272

訪問器屬性 - Other

IsBind

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

回傳 boolean
- 定義於 src/openlayers/MapView.ts:164

Viewport

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

回傳 GeoBoundary
- 定義於 src/openlayers/MapView.ts:169
set Viewport(value: GeoBoundary): void
設定目前視埠。
參數
- value: GeoBoundary
回傳 void
- 定義於 src/openlayers/MapView.ts:173

Boundary

get Boundary(): GeoBoundary
地圖的作畫範圍。

回傳 GeoBoundary
- 定義於 src/openlayers/MapView.ts:178

Width

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

回傳 number
- 定義於 src/openlayers/MapView.ts:183

Height

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

回傳 number
- 定義於 src/openlayers/MapView.ts:188

MouseWheelZoomCenter

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

回傳 boolean
- 定義於 src/openlayers/MapView.ts:193
set MouseWheelZoomCenter(value: boolean): void
設定滾輪縮放是否使用中心點 (預設 false，即以滑鼠位置縮放圖台)。
參數
- value: boolean
回傳 void
- 定義於 src/openlayers/MapView.ts:199

MeasureProperty

get MeasureProperty(): Partial<MapViewMeasureProperty>
測量功能相關參數設定。

回傳 Partial<MapViewMeasureProperty>
- 定義於 src/openlayers/MapView.ts:206

ZoomByMatrixSet

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

回傳 boolean
- 定義於 src/openlayers/MapView.ts:222
set ZoomByMatrixSet(value: boolean): void
地圖依照預設或指定的矩陣資訊縮放。若為 true，呼叫 ZoomIn / ZoomOut 的時候會依照指定的矩陣資訊縮放比例尺，否則依照下一級為原來比例尺的 0.65 倍縮放。
參數
- value: boolean
回傳 void
- 定義於 src/openlayers/MapView.ts:229

EnableRange

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

回傳 boolean
- 定義於 src/openlayers/MapView.ts:253
set EnableRange(value: boolean): void
是否允許限制範圍，是否不可移動到整個Viewport的範圍 (ViewportRange) 之外。
參數
- value: boolean
回傳 void
- 定義於 src/openlayers/MapView.ts:257

SelectFeatureOn

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

回傳 boolean | MapViewSelectFeatureOn
- 定義於 src/openlayers/MapView.ts:278
set SelectFeatureOn(value: boolean | MapViewSelectFeatureOn): void
選取圖素事件設定。輸入 boolean 則開啟選取圖素功能，否則關閉。
參數
- value: boolean | MapViewSelectFeatureOn
回傳 void
- 定義於 src/openlayers/MapView.ts:283

HoverFeatureOn

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

回傳 boolean
- 定義於 src/openlayers/MapView.ts:288
set HoverFeatureOn(value: boolean): void
是否開啟可移到圖素模式。
參數
- value: boolean
回傳 void
- 定義於 src/openlayers/MapView.ts:292

FreezeUserControl

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

回傳 boolean
- 定義於 src/openlayers/MapView.ts:297
set FreezeUserControl(value: boolean): void
凍結使用者輸入控制對 Viewport 的控制 (凍結滑鼠與鍵盤)。
參數
- value: boolean
回傳 void
- 定義於 src/openlayers/MapView.ts:301

epsg

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

回傳 number
- 定義於 src/openlayers/MapView.ts:306

類別 CMapView

索引

屬性

方法 - OpenLayers

方法 - Openlayers

方法 - Other

構造函數

訪問器屬性 - Openlayers

訪問器屬性 - Other

屬性

靜態DefaultSnapSetting

方法 - OpenLayers

CreateScaleLine

參數

回傳 ol.control.ScaleLine

範例

RemoveScaleLine

參數

回傳 boolean

範例

方法 - Openlayers

CreateOverlay

參數

回傳 Overlay

範例

RemoveOverlay

參數

回傳 void

GetOverlayById

參數

回傳 Overlay

方法 - Other

Bind

參數

回傳 boolean

Unbind

回傳 void

UpdateScreen

回傳 void

AddEventListener

類型參數

參數

回傳 boolean

RemoveEventListener

類型參數

參數

回傳 boolean

ZoomWindow

回傳 void

ZoomIn

回傳 void

ZoomOut

回傳 void

ZoomScale

參數

回傳 void

範例

ZoomCenter

參數

回傳 void

範例

ZoomAll

回傳 void

ZoomNone

回傳 void

ZoomPreview

回傳 void

WindowToViewport

參數

回傳 undefined | number

ViewportToWindow

參數

回傳 undefined | number

InputPoint

類型參數

參數

回傳 boolean

範例

InputPolyline

類型參數

`靜態`DefaultSnapSetting