Class CMapDocument

地圖文件

Param: EPSGNum

{number} 預設坐標系統編碼

Example

var a = new CMapDocument(3826);
a.NewXXXXXX();

Methods

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

Methods

DoCommand

  • DoCommand(url, Parm, callback, FastMode): object

  • 執行指令

    Parameters

    • url: string

      指令完整網址

    • Parm: object

      參數物件

    • callback: any

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

    • FastMode: boolean

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

    Returns object

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

DoCommandAsync

  • DoCommandAsync(Url, Command, Parm): object

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

    Parameters

    Returns object

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

DoCommandAsync_Abort

  • DoCommandAsync_Abort(Url, ID): object

  • 要求停止非同步指令

    Parameters

    Returns object

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

DoCommandAsync_GetData

  • DoCommandAsync_GetData(Url, ID): object

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

    Parameters

    Returns object

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

DoCommandAsync_GetProgress

  • DoCommandAsync_GetProgress(Url, ID): object

  • 取得非同步的進度

    Parameters

    Returns object

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

DoCommandFromPilotGaea

  • DoCommandFromPilotGaea(IP, Port, Command, Parm, callback, FastMode): object

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

    Parameters

    • IP: string

      IP字串

    • Port: number

      埠號數字

    • Command: string

      指令名稱

    • Parm: object

      參數物件

    • callback: any

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

    • FastMode: boolean

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

    Returns object

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

DoCommandFromPilotGaea2

  • DoCommandFromPilotGaea2(Url, Command, Parm): object

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

    Parameters

    Returns object

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

FindLayerByName

  • FindLayerByName(Name): null | CLayer2D

  • 依圖層名稱尋找圖層

    Parameters

    • Name: string

      指定圖層名稱

    Returns null | CLayer2D

    若圖層不存在，回傳null

GetLayerInfoJson

  • GetLayerInfoJson(LayerNames): string

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

    Parameters

    • LayerNames: undefined | string

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

    Returns string

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

GetShowLayersName

  • GetShowLayersName(): string[]

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

    Returns string[]

    圖層名陣列

MoveLayer

  • MoveLayer(pLayer, Index): boolean

  • 移動圖層順序

    Parameters

    • pLayer: CLayer2D

      指定要更動順序的圖層

    • Index: number

      新的圖層順序

    Returns boolean

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

NewSingleTileLayer

  • NewSingleTileLayer(Name, Url, Box, index): number | CSingleTileLayer

  • 新增單一影像地圖圖層

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • Url: string

      圖層來源網址

    • Box: GeoBoundary

      圖層範圍的GeoBoundary

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    Returns number | CSingleTileLayer

    圖層本身(失敗回傳0)

    Example

    var layer1Id = MapDoc.NewSingleTileLayer("rabbit", "兔子.png", new GeoBoundary(13149614,2504688, 13775786, 3130860));

NewSingleTileLayerByWorldFile

  • NewSingleTileLayerByWorldFile(Name, Url, Epsg, WorldFile, Callback, index): void

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

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • Url: string

      圖層來源網址

    • Epsg: number

      WorldFile所使用的EPSG

    • WorldFile: {
          A: number;
          B: number;
          C: number;
          D: number;
          E: number;
          F: number;
      }

      World File參數

      • A: number

        x方向比例(World File第1行)

      • B: number

        x方向偏斜(World File第3行)

      • C: number

        圖片左上角x座標(World File第5行)

      • D: number

        y方向偏斜(World File第2行)

      • E: number

        y方向比例，通常為負值(World File第4行)

      • F: number

        圖片左上角y座標(World File第6行)

    • Callback: Function

      圖層新增完成後的回呼函式，function(layer)

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    Returns void

NewSingleTileLayerRotate

  • NewSingleTileLayerRotate(Name, Url, Box, Angle, Callback, index): void

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

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • Url: string

      圖層來源網址

    • Box: GeoBoundary

      圖層範圍的GeoBoundary

    • Angle: number

      以左上為基準的旋轉角度

    • Callback: Function

      圖層新增完成後的回呼函式，function(layer)

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    Returns void

    Example

    var layer1Id = MapDoc.NewSingleTileLayerRotate("rabbit", "兔子.png", new GeoBoundary(13149614,2504688, 13775786, 3130860), 90);

NewTileMapLayerByMatrixSet

  • NewTileMapLayerByMatrixSet(Name, UrlPatterns, MatrixSet, index, WMTSProxy, Token): number | CTileMapLayer

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

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • UrlPatterns: string[]

      圖層來源字串陣列

    • MatrixSet: CMatrixSet

      矩陣資訊

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    • WMTSProxy: boolean

      是否使用代理，若輸入為字串則會當作代理網址直接串接，預設為false

    • Token: string

      若有需要提供，Token

    Returns number | CTileMapLayer

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

    Example

    var m = CMatrixSet.MakeByEPSG(3826)
     var vLayerId = 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}"],m , 0, "test")

NewTileMapLayerByPatternName

  • NewTileMapLayerByPatternName(Name, URL, Identifier, index, WMTSProxy, Token): number | CTileMapLayer

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

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • URL: string

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

    • Identifier: null | string

      服務類型，BING_MAP:支援"VECTOR"、"IMAGE"和"VECTOR_IMAGE"，OSM則給null即可

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    • WMTSProxy: boolean

      是否使用代理，若輸入為字串則會當作代理網址直接串接，預設為false

    • Token: string

      若有需要提供，Token

    Returns number | CTileMapLayer

    圖層本身(失敗回傳0)

NewTileMapLayerFromPilotGaea

  • NewTileMapLayerFromPilotGaea(Name, IP, Port, ID, ImageFormat?, index, Token): number | CTileMapLayer

  • 用PilotGaea習慣的方式給WMTS參數，非PGMapServer也許無法正常取到圖

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • IP: string

      IP字串

    • Port: number

      埠號數字

    • ID: string

      伺服器端的真實圖層名稱

    • Optional ImageFormat: number

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

    • index: number

      插入索引，非必要。(預設是-1，也就是Add)

    • Token: string

      若有需要提供，Token

    Returns number | CTileMapLayer

    圖層本身(失敗回傳0)

NewVectorLayer

  • NewVectorLayer(options, index): number | CVectorLayer

  • 新增向量圖層

    Parameters

    • options: string | object

      圖層名稱或設定選項

    • index: number

      插入索引，非必要。(預設是-1，也就是Add)

    Returns number | CVectorLayer

    圖層本身(失敗回傳0)

NewVectorTileLayer

  • NewVectorTileLayer(Name, UrlPatterns, index, Token): number | CVectorTileLayer

  • 新增向量圖磚圖層

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • UrlPatterns: string[]

      圖層來源字串陣列

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    • Token: string

      若有需要提供，Token

    Returns number | CVectorTileLayer

    圖層本身(失敗回傳0)

    Example

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

NewVectorTileLayerFromPilotGaea

  • NewVectorTileLayerFromPilotGaea(Name, IP, Port, ID, EPSGCode, index, Token): number | CVectorTileLayer

  • 用PilotGaea習慣的方式給VectorTile參數，非PGMapServer也許無法正常取到圖

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • IP: string

      IP字串

    • Port: number

      埠號數字

    • ID: string

      伺服器端的真實圖層名稱

    • EPSGCode: undefined | number

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

    • index: number

      插入索引，非必要。(預設是-1，也就是Add)

    • Token: string

      若有需要提供，Token

    Returns number | CVectorTileLayer

    圖層本身(失敗回傳0)

    Example

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

NewWMSLayer

  • NewWMSLayer(Name, Url, LayerName, ImageFormat, Box, index, Token): number | CWMSLayer

  • 新增網路地圖圖層

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • Url: string

      圖層來源網址

    • LayerName: string | string[]

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

    • ImageFormat: number

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

    • Box: null | GeoBoundary

      圖層範圍的GeoBoundary，非必要。不給會用MapDocument預設EPSG的整體範圍，建議給的出還是給吧，效能會比較好。

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    • Token: string

      若有需要提供，Token

    Returns number | CWMSLayer

    圖層本身(失敗回傳0)

    Example

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

NewWMSLayerFromPilotGaea

  • NewWMSLayerFromPilotGaea(Name, IP, Port, LayerName, ImageFormat, Box, index, Token): number | CWMSLayer

  • 用PilotGaea習慣的方式給WMS參數，非PGMapServer也許無法正常取到圖

    Parameters

    • Name: string

      客戶端自訂的圖層名稱

    • IP: string

      IP字串

    • Port: number

      埠號數字

    • LayerName: string | string[]

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

    • ImageFormat: number

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

    • Box: null | GeoBoundary

      圖層範圍的GeoBoundary，非必要。不給會用MapDocument預設EPSG的整體範圍，建議給的出還是給吧，效能會比較好。

    • index: null | number

      插入索引，非必要。(預設是-1，也就是Add)

    • Token: string

      若有需要提供，Token

    Returns number | CWMSLayer

    圖層本身(失敗回傳0)

RemoveAllLayers

  • RemoveAllLayers(): void

  • 移除所有圖層

    Returns void

RemoveLayer

  • RemoveLayer(Layer): boolean

  • 移除指定圖層

    Parameters

    Returns boolean

    若找不到指定圖層，return false

RemoveLayerByName

  • RemoveLayerByName(Name): boolean

  • 依圖層名稱移除圖層

    Parameters

    • Name: string

      圖層名稱

    Returns boolean

    若找不到指定圖層，return false

SetBaseTileMapLayerByMatrixSet

  • SetBaseTileMapLayerByMatrixSet(UrlPatterns, MatrixSet, WMTSProxy, Token): number | CTileMapLayer

  • 指定圖台底圖為TileMapLayer

    Parameters

    • UrlPatterns: string[]

      圖層來源字串陣列

    • MatrixSet: CMatrixSet

      矩陣資訊

    • WMTSProxy: boolean

      是否使用代理，若輸入為字串則會當作代理網址直接串接，預設為false

    • Token: string

      若有需要提供，Token

    Returns number | CTileMapLayer

    圖層本身(失敗回傳0)

SetBaseTileMapLayerByPatternName

  • SetBaseTileMapLayerByPatternName(URL, Identifier, WMTSProxy, Token?): number | CTileMapLayer

  • 指定圖台底圖為TileMapLayer

    Parameters

    • URL: string

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

    • Identifier: null | string

      服務類型，BING_MAP:支援"VECTOR"、"IMAGE"和"VECTOR_IMAGE"，OSM則給null即可

    • WMTSProxy: string | boolean

      是否使用代理，若輸入為字串則會當作代理網址直接串接，預設為false

    • Optional Token: string

      若有需要提供，Token

    Returns number | CTileMapLayer

    圖層本身(失敗回傳0)

SetBaseTileMapLayerFromPilotGaea

  • SetBaseTileMapLayerFromPilotGaea(IP, Port, ID, ImageFormat, Token): number | CTileMapLayer

  • 指定圖台底圖為TileMapLayer

    Parameters

    • IP: string

      IP字串

    • Port: number

      埠號數字

    • ID: string

      伺服器端的真實圖層名稱

    • ImageFormat: number

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

    • Token: string

      若有需要提供，Token

    Returns number | CTileMapLayer

    圖層本身(失敗回傳0)

SetBaseVectorTileLayer

  • SetBaseVectorTileLayer(UrlPatterns, Token): number | CVectorTileLayer

  • 指定圖台底圖為VectorTileLayer

    Parameters

    • UrlPatterns: string[]

      圖層來源字串陣列

    • Token: string

      若有需要提供，Token

    Returns number | CVectorTileLayer

    圖層本身(失敗回傳0)

SetBaseVectorTileLayerFromPilotGaea

  • SetBaseVectorTileLayerFromPilotGaea(IP, Port, ID, EPSGCode, Token): number | CVectorTileLayer

  • 指定圖台底圖為VectorTileLayer

    Parameters

    • IP: string

      IP字串

    • Port: number

      埠號數字

    • ID: string

      伺服器端的真實圖層名稱

    • EPSGCode: undefined | number

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

    • Token: string

      若有需要提供，Token

    Returns number | CVectorTileLayer

    圖層本身(失敗回傳0)

SetBaseWMSLayer

  • SetBaseWMSLayer(Url, LayerName, ImageFormat, Box, Token): number | CWMSLayer

  • 指定圖台底圖為WMSLayer

    Parameters

    • Url: string

      圖層來源網址

    • LayerName: string | string[]

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

    • ImageFormat: number

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

    • Box: null | GeoBoundary

      圖層範圍的GeoBoundary，非必要。不給會用MapDocument預設EPSG的整體範圍，建議給的出還是給吧，效能會比較好。

    • Token: string

      若有需要提供，Token

    Returns number | CWMSLayer

    圖層本身(失敗回傳0)

SetBaseWMSLayerFromPilotGaea

  • SetBaseWMSLayerFromPilotGaea(IP, Port, LayerName, ImageFormat, Box, Token): number | CWMSLayer

  • 指定圖台底圖為WMSLayer

    Parameters

    • IP: string

      IP字串

    • Port: number

      埠號數字

    • LayerName: string | string[]

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

    • ImageFormat: number

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

    • Box: null | GeoBoundary

      圖層範圍的GeoBoundary，非必要。不給會用MapDocument預設EPSG的整體範圍，建議給的出還是給吧，效能會比較好。

    • Token: string

      若有需要提供，Token

    Returns number | CWMSLayer

    圖層本身(失敗回傳0)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc