PilotGaea 2D O'view
    正在準備搜尋索引...

    類別 CMapDocument

    地圖文件。

    索引

    方法

    SetBaseWMSLayer NewWMSLayer NewSingleTileLayer NewSingleTileLayerRotate NewSingleTileLayerByWorldFile SetBaseWMSLayerFromPilotGaea NewWMSLayerFromPilotGaea SetBaseTileMapLayerByPatternName NewTileMapLayerByPatternName SetBaseTileMapLayerByMatrixSet NewTileMapLayerByMatrixSet SetBaseTileMapLayerFromPilotGaea NewTileMapLayerFromPilotGaea SetBaseVectorTileLayer NewVectorTileLayer SetBaseVectorTileLayerFromPilotGaea NewVectorTileLayerFromPilotGaea NewVectorLayer RemoveLayerByName RemoveLayer MoveLayer RemoveAllLayers FindLayerByName DoCommand DoCommandFromPilotGaea DoCommandFromPilotGaea2 DoCommandAsync DoCommandAsync_GetProgress DoCommandAsync_GetData DoCommandAsync_Abort GetShowLayersName GetLayerInfoJson

    構造函數

    constructor

    訪問器屬性

    IsBind length BaseLayer HasBaseLayer Boundary LayerNames Layers MaxResolution MinResolution epsg

    方法

    • 指定圖台底圖為 WMSLayer2D

      參數

      • url: string

        圖層來源網址

      • layerName: string | string[]

        伺服器端的真實圖層名稱，可給單一字串或字串陣列(會依序合併作畫)

      • imageFormat: ENUM_IMAGE_FORMAT = ENUM_IMAGE_FORMAT.PNG

        影像列舉ENUM_IMAGE_FORMAT，非必要。(預預設是 ENUM_IMAGE_FORMAT.PNG)

      • 可選boundary: GeoBoundary

        圖層的範圍，非必要。不給會用 MapDocument.epsg 的整體範圍，建議給，效能會比較好。

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CWMSLayer

      圖層本身(失敗回傳 0)

    • 新增 網路地圖圖層

      參數

      • name: string

        客戶端自訂的圖層名稱

      • url: string

        圖層來源網址

      • layerName: string | string[]

        伺服器端的真實圖層名稱，可給單一字串或字串陣列(會依序合併作畫)

      • imageFormat: ENUM_IMAGE_FORMAT

        影像格式，非必要。(預預設是 ENUM_IMAGE_FORMAT.PNG)

      • 可選boundary: GeoBoundary

        圖層的範圍，非必要。不給會用 MapDocument.epsg 的整體範圍，建議給，效能會比較好。

      • index: number = -1

        插入索引，非必要。(預設是 -1，插入最後)

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CWMSLayer

      圖層本身 (失敗回傳 0)

      const wmsLayer = mapDoc.NewWMSLayer("我的行政區界圖", "http://127.0.0.1:8080/wms?", ["行政區界圖"], ENUM_IMAGE_FORMAT.JPEG);

    • 新增單一影像地圖圖層

      參數

      • layerName: string

        客戶端自訂的圖層名稱

      • url: string

        圖層來源網址

      • boundary: GeoBoundary

        圖層範圍的 GeoBoundary

      • index: number = -1

        插入索引，非必要。(預設是 -1，插入最後)

      回傳 0 | CSingleTileLayer

      圖層本身 (失敗回傳 0)

      const singleTileLayer = mapDoc.NewSingleTileLayer("rabbit", "兔子.png", new GeoBoundary(13149614, 2504688, 13775786, 3130860));

    • 新增單一旋轉影像地圖圖層

      參數

      • layerName: string

        客戶端自訂的圖層名稱

      • url: string

        圖層來源網址

      • boundary: GeoBoundary

        圖層範圍的 GeoBoundary

      • angle: number

        以左上為基準的旋轉角度

      • callback: (layer: CSingleTileLayer) => void

        圖層新增完成後的回呼函式

      • index: number = -1

        插入索引，非必要。(預設是 -1，插入最後)

      回傳 void

      const singleTileLayer = mapDoc.NewSingleTileLayerRotate("rabbit", "兔子.png", new GeoBoundary(13149614, 2504688, 13775786, 3130860), 90);

    • 使用 WorldFile 新增單一影像地圖圖層

      參數

      • layerName: string

        客戶端自訂的圖層名稱

      • url: string

        圖層來源網址

      • epsg: number

        WorldFile 所使用的EPSG

      • worldFile: WorldFile

        WorldFile 參數

      • callback: (layer: CSingleTileLayer) => void

        圖層新增完成後的回呼函式

      • index: number = -1

        插入索引，非必要。(預設是 -1，插入最後)

      回傳 void

    • 指定圖台底圖為WMSLayer

      參數

      • host: string

        IP字串

      • port: number

        埠號數字

      • layerName: string | string[]

        伺服器端的真實圖層名稱，可給單一字串或字串陣列(會依序合併作畫)

      • imageFormat: ENUM_IMAGE_FORMAT = ENUM_IMAGE_FORMAT.PNG

        影像格式，非必要。(預預設是 ENUM_IMAGE_FORMAT.PNG)

      • 可選boundary: GeoBoundary

        圖層的範圍，非必要。不給會用 MapDocument.epsg 的整體範圍，建議給，效能會比較好。

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CWMSLayer

      圖層本身(失敗回傳 0)

    • 用 PilotGaea 格式給 WMS 參數，非 MapServer 也許無法正常取到圖

      參數

      • layerName: string

        客戶端自訂的圖層名稱

      • ip: string

        IP字串

      • port: number

        埠號數字

      • identifier: string | string[]

        伺服器端的真實圖層名稱，可給單一字串或字串陣列(會依序合併作畫)

      • imageFormat: ENUM_IMAGE_FORMAT = ENUM_IMAGE_FORMAT.PNG

        影像格式，非必要。 (預預設是 ENUM_IMAGE_FORMAT.PNG)

      • 可選boundary: GeoBoundary

        圖層的範圍，非必要。不給會用 MapDocument.epsg 的整體範圍，建議給，效能會比較好。

      • 可選index: number

        插入索引，非必要。 (預設是 -1，插入最後)

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CWMSLayer

      圖層本身 (失敗回傳 0)

    • 指定圖台底圖為TileMapLayer

      參數

      • url: string

        服務項目，目前支援:"BING_MAP"、"OSM"

      • 可選identifier: string

        服務類型

        • BING_MAP: 支援"VECTOR"、"IMAGE"和"VECTOR_IMAGE"
        • OSM: 可以不給
      • 可選proxy: string | boolean

        代理網址，輸入true使用 "oview.aspx"

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CTileMapLayer

      圖層本身 (失敗回傳 0)

    • 加入PilotGaea內建支援的外部服務圖層

      參數

      • name: string

        客戶端自訂的圖層名稱

      • url: string

        服務項目，目前支援:"BING_MAP"、"OSM"

      • identifier: undefined | string

        服務類型

        • BING_MAP: 支援"VECTOR"、"IMAGE"和"VECTOR_IMAGE"
        • OSM: 不用給
      • 可選index: number

        插入索引，非必要。(預設是 -1，插入最後)

      • 可選proxy: string | boolean

        代理網址，輸入true使用 "oview.aspx"

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CTileMapLayer

      圖層本身(失敗回傳 0)

    • 指定圖台底圖為 圖磚圖層

      參數

      • urlPatterns: string[]

        圖層來源字串陣列

      • matrixSet: CMatrixSet

        矩陣資訊

      • 可選proxy: string

        代理網址，輸入true使用 "oview.aspx"

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CTileMapLayer

      圖層本身(失敗回傳 0)

    • 用矩陣資訊新增圖磚圖層

      參數

      • layerName: string

        客戶端自訂的圖層名稱

      • urlPatterns: string[]

        圖層來源字串陣列

      • matrixSet: CMatrixSet

        矩陣資訊

      • index: number = -1

        插入索引，非必要。(預設是 -1，插入最後)

      • 可選proxy: string

        代理網址，輸入true使用 "oview.aspx"

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CTileMapLayer

      成功回傳圖層本身(失敗回傳 0)

      const matrixSet = CMatrixSet.MakeByEPSG(3826)
      const tileMapLayer = myMapDoc.NewTileMapLayerByMatrixSet(
      	"我的行政區界圖",
      	["http://127.0.0.1/wmts?Layer=行政區界圖&style=default&TileMatrixSet=EPSG%3A3826&Service=WMTS&Request=GetTile&Version=1.0.0&Format=image%2Fpng&TileMatrix={TileZ}&TileCol={TileC}&TileRow={TileR}"],
      	matrixSet,
      	0,
      	"test"
      );

    • 指定圖台底圖為 TileMapLayer2D

      參數

      • host: string

        IP字串

      • port: number

        埠號數字

      • id: string

        伺服器端的真實圖層名稱

      • imageFormat: ENUM_IMAGE_FORMAT = ENUM_IMAGE_FORMAT.PNG

        影像格式，非必要。(預預設是 ENUM_IMAGE_FORMAT.PNG)

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CTileMapLayer

      圖層本身 (失敗回傳 0)

    • 用 PilotGaea 格式給 WMTS 參數，非 MapServer 也許無法正常取到圖

      參數

      • name: string

        客戶端自訂的圖層名稱

      • host: string

        IP字串

      • port: number

        埠號數字

      • layerName: string

        伺服器端的真實圖層名稱

      • imageFormat: ENUM_IMAGE_FORMAT = ENUM_IMAGE_FORMAT.PNG

        影像格式，非必要。(預預設是 ENUM_IMAGE_FORMAT.PNG)

      • 可選index: number

        插入索引，非必要。(預設是 -1，插入最後)

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CTileMapLayer

      圖層本身(失敗回傳 0)

    • 指定圖台底圖為 VectorTileLayer2D

      參數

      • urlPatterns: string[]

        圖層來源字串陣列

      • 可選token: string

        若有需要提供，Token

      回傳 number | CVectorTileLayer

      圖層本身(失敗回傳 0)

    • 新增向量圖磚圖層

      參數

      • name: string

        客戶端自訂的圖層名稱

      • urlPatterns: string[]

        圖層來源字串陣列

      • 可選index: number

        插入索引，非必要。(預設是 -1，插入最後)

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CVectorTileLayer

      圖層本身(失敗回傳 0)

      const vectorLayer = mapDoc.NewVectorTileLayer("向量圖磚", [ "http://127.0.0.1:8080/WMTS/{z}/{x}/{y}.vector.mvt" ], 0)
      const vectorLayer = mapDoc.NewVectorTileLayer("向量圖磚", [ "http://127.0.0.1:8080/3826/WMTS/{z}/{x}/{y}.vector.mvt"] , 0)

    • 指定圖台底圖為 VectorTileLayer2D

      參數

      • host: string

        IP字串

      • port: number

        埠號數字

      • layerName: string

        伺服器端的真實圖層名稱

      • 可選epsg: number

        EPSG代碼，非必要。(預設跟 MapDocument.epsg 相同)

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CVectorTileLayer

      圖層本身(失敗回傳 0)

    • 用 PilotGaea 格式給 VectorTile 參數，非 MapServer 也許無法正常取到圖

      參數

      • name: string

        客戶端自訂的圖層名稱

      • host: string

        IP字串

      • port: number

        埠號數字

      • layerName: string

        伺服器端的真實圖層名稱

      • 可選epsg: number

        EPSG代碼，非必要。(預設跟 MapDocument.epsg 相同)

      • 可選index: number

        插入索引，非必要。(預設是 -1，插入最後)

      • 可選token: string

        若有需要提供，Token

      回傳 0 | CVectorTileLayer

      圖層本身(失敗回傳 0)

      var vLayerId = myMapDoc.NewVectorTileLayerFromPilotGaea("向量圖磚", '127.0.0.1', 8080, 'WMTS')
       var vLayerId = myMapDoc.NewVectorTileLayerFromPilotGaea("向量圖磚", '127.0.0.1', 8080, 'WMTS', 3826)

    • 新增向量圖層

      參數

      • options:
            | string
            | {
                Name: string;
                Index: number;
                UseCluster?: boolean;
                ClusterDistance: number;
                maxResolution?: number;
                minResolution?: number;
            }

        圖層名稱或設定選項

        • string
        • {
              Name: string;
              Index: number;
              UseCluster?: boolean;
              ClusterDistance: number;
              maxResolution?: number;
              minResolution?: number;
          }
          • Name: string

            圖層名稱

          • Index: number

            插入索引

          • 可選UseCluster?: boolean

            是否使用叢集機制，使用叢集只能加入點幾何，否則會有例外

          • ClusterDistance: number

            叢集的距離

          • 可選maxResolution?: number
          • 可選minResolution?: number
      • 可選index: number

        插入索引，非必要。(預設是 -1，插入最後)

      回傳 0 | CVectorLayer

      圖層本身(失敗回傳 0)

    • 依圖層名稱移除圖層

      參數

      • layerName: string

        圖層名稱

      回傳 boolean

      若找不到指定圖層，return false

    • 移除指定圖層

      參數

      回傳 boolean

      若找不到指定圖層，return false

    • 移動圖層順序

      參數

      • layer: CLayer2D

        指定要更動順序的圖層

      • index: number

        新的圖層順序

      回傳 boolean

      更動是否成功，不論是沒有指定圖層、index 為 -1 或超出索引都會造成失敗

    • 移除所有圖層

      回傳 void

    • 依圖層名稱尋找圖層

      參數

      • name: string

        指定圖層名稱

      回傳 undefined | CLayer2D

      圖層。不存在回傳undefined。

    • 執行指令

      參數

      • url: string

        指令完整網址

      • param: object

        參數物件

      • callback: () => void

        回呼函式，有給值(不為null)會進入非同步模式，結果會由Callback返回；無給值為同步模式，結果會由DoCommand返回。

      • compress: boolean

        快速模式，只能在非同步下運作，傳輸會是 blob 比較少，預設為false傳JSON物件。

      回傳 unknown

      同步時回傳答案，失敗回傳null，若非同步則不會回傳。

    • 用PilotGaea習慣的參數執行指令

      參數

      • host: string

        IP字串

      • port: number

        埠號數字

      • command: string

        指令名稱

      • param: object

        參數物件

      • callback: () => void

        回呼函式，非同步必給，同步可不給或給null

      • fastMode: boolean

        快速模式，只能在非同步下運作，傳輸會是Binary比較少，預設為false傳JSON物件

      回傳 unknown

      同步時回傳答案，失敗回傳null，若非同步則不會回傳。

    • 用PilotGaea習慣的參數執行指令

      參數

      回傳 unknown

      同步時回傳答案，失敗回傳null，若非同步則不會回傳。

    • 用PilotGaea習慣的參數執行非同步指令

      參數

      回傳 { success: boolean; Id: number } | { success: boolean; Id?: undefined }

      回傳的值有[success],[ID]可取得值。

    • 取得非同步的進度

      參數

      回傳 unknown

      同步時回傳答案，失敗回傳null，若非同步則不會回傳。

    • 取得非同步指令的資料(無論是否完成)

      參數

      回傳 unknown

      同步時回傳答案，失敗回傳null，若非同步則不會回傳。

    • 要求停止非同步指令

      參數

      回傳 unknown

      同步時回傳答案，失敗回傳null，若非同步則不會回傳。

    • 取得當前所有顯示的圖層名陣列

      回傳 string[]

      圖層名陣列

    • 取得列印所需的圖層資訊以 JSON 字串表示

      參數

      • 可選layerNames: string

        用逗號分隔的圖層名，若為 undefined，拿所有顯示的圖層資訊。

      回傳 string

      列印所需的圖層資訊以 JSON 字串表示

    構造函數

    • 地圖文件。

      參數

      • epsg: number

        預設坐標系統編碼

      回傳 CMapDocument

      const mapDocument = new CMapDocument(3826);
      mapDocument.NewXXXXXX();

    訪問器屬性

    • get IsBind(): boolean

      是否已綁定。

      回傳 boolean

    • get length(): number

      圖層的數量。

      回傳 number

    • get BaseLayer(): undefined | CLayer2D

      取得底圖。

      回傳 undefined | CLayer2D

    • get HasBaseLayer(): boolean

      是否有底圖。

      回傳 boolean

    • get Boundary(): GeoBoundary

      所有圖層範圍的總和。

      範圍總和為 0 時回傳EPSG座標範圍。

      回傳 GeoBoundary

    • get LayerNames(): null | string[]

      所有圖層名稱。

      回傳 null | string[]

    • get Layers(): null | CLayer2D[]

      所有圖層手柄。

      回傳 null | CLayer2D[]

    • get MaxResolution(): number

      所有圖層中，最大的最大解析度。

      回傳 number

    • get MinResolution(): number

      所有圖層中，最小的最小解析度

      回傳 number

    • get epsg(): number

      坐標系統編碼

      回傳 number

    顯示設定

    成員可見性

    目錄

    方法
    構造函數
    訪問器屬性