Class WeatherModule

氣候模組 (需先設定氣象資料開放平台授權碼才能成功獲得資料)

Hierarchy

Module
- WeatherModule

Index

Accessors

apiServer authorization layers proxy

Methods

addRadarReflectivityHistoryLayer addWeatherImageLayer getCurrentFluidParam getFishFarmData getLayerByName getObservationData getRadarReflectivityHistoryValidTimeSpan removeAllLayer removeLayer

Accessors

apiServer

get apiServer(): string
氣象資料開放平台伺服器位址。

Returns string
- Defined in webgl/module/weatherModule/ov-Weather.ts:31

authorization

get authorization(): string
氣象資料開放平台授權碼，需先設定有效的氣象資料開放平台授權碼才能成功獲得資料。

Returns string
- Defined in webgl/module/weatherModule/ov-Weather.ts:24

layers

get layers(): WeatherLayer[]
取得全部圖層陣列

Returns WeatherLayer[]
- Defined in webgl/module/weatherModule/ov-Weather.ts:45

proxy

get proxy(): null | string
代理伺服器，需支援TLS1.2以上。

Returns null | string
- Defined in webgl/module/weatherModule/ov-Weather.ts:38

Methods

addRadarReflectivityHistoryLayer

addRadarReflectivityHistoryLayer(parameter, callback?): void
新增雷達回波歷史圖層。
Parameters
- parameter: AddRadarReflectivityHistoryLayerParameter
  參數物件。
- Optional callback: ((result) => void)
  完成後的回呼函式。
  - - (result): void
    - Parameters
      result: string | WeatherLayer
      Returns void
Returns void
- Defined in webgl/module/weatherModule/ov-Weather.ts:78

addWeatherImageLayer

addWeatherImageLayer(parameter, callback?): void
新增氣候觀測影像圖層，目前支援png/jpeg/網格資料。
Parameters
- parameter: AddWeatherImageLayerParameter
  參數物件。
- Optional callback: ((result) => void)
  完成後的回呼函式。成功時回傳氣候圖層物件，失敗則回傳錯誤訊息。
  - - (result): void
    - Parameters
      result: string | WeatherLayer
      Returns void
Returns void
- Defined in webgl/module/weatherModule/ov-Weather.ts:59

getCurrentFluidParam

getCurrentFluidParam(parameter, callback?): void
取得台灣海域海流預報的流體資料。
Parameters
- parameter: GetCurrentFluidParamParameter
  參數物件。
- Optional callback: ((result) => void)
  完成後的回呼函式。成功則回傳流體參數，失敗則回傳錯誤訊息。流體參數可以直接丟給流體模組的參數物件。
  - - (result): void
    - Parameters
      result: any
      Returns void
Returns void
- Defined in webgl/module/weatherModule/ov-Weather.ts:115

getFishFarmData

getFishFarmData(): any[]
取得臺灣定置網範圍資料。

Returns any[]
臺灣定置網範圍資料。
- Defined in webgl/module/weatherModule/ov-Weather.ts:123

getLayerByName

getLayerByName(name): null | WeatherLayer
取得第一個符合名稱的氣候圖層。
Parameters
- name: string
Returns null | WeatherLayer
氣候圖層物件或null。
- Defined in webgl/module/weatherModule/ov-Weather.ts:131

getObservationData

getObservationData(parameter, callback?): void
取得氣候觀測站資料。
Parameters
- parameter: GetObservationDataParameter
  參數物件。
- Optional callback: ((result) => void)
  完成後的回呼函式。成功則回傳氣候觀測站資料陣列，失敗則回傳錯誤訊息。
  - - (result): void
    - Parameters
      result: string | ObservationDataSet
      Returns void
Returns void
- Defined in webgl/module/weatherModule/ov-Weather.ts:105

getRadarReflectivityHistoryValidTimeSpan

getRadarReflectivityHistoryValidTimeSpan(callback?): undefined | string | Date[]
取得雷達回波歷史可用時間區間。
Parameters
- Optional callback: ((res) => void)
  完成後的回呼函式，成功回傳可用區間的起迄時間，失敗則回傳錯誤訊息。若未給 callback 則為同步(注意若在網速較慢的環境可能會卡很久)
  - - (res): void
    - Parameters
      res: string | Date[]
      Returns void
Returns undefined | string | Date[]
未給 callback 時同步
- Defined in webgl/module/weatherModule/ov-Weather.ts:96

removeAllLayer

removeAllLayer(): void
移除所有氣候圖層。

Returns void
- Defined in webgl/module/weatherModule/ov-Weather.ts:158

removeLayer

removeLayer(layer): boolean
移除指定氣候圖層。
Parameters
- layer: WeatherLayer
Returns boolean
是否移除成功。
- Defined in webgl/module/weatherModule/ov-Weather.ts:148

Generated using TypeDoc