類別 WeatherModule

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

層級 (查看層級一覽)

Module
- WeatherModule

索引

方法

addRadarReflectivityHistoryLayer addWeatherImageLayer getCurrentFluidParam getFishFarmData getLayerByName getObservationData getRadarReflectivityHistoryValidTimeSpan removeAllLayer removeLayer

訪問器屬性

apiServer authorization layers proxy

方法

addRadarReflectivityHistoryLayer

addRadarReflectivityHistoryLayer(
parameter: AddRadarReflectivityHistoryLayerParameter,
callback?: (result: string | WeatherLayer) => void,
): void
新增雷達回波歷史圖層。
參數
- parameter: AddRadarReflectivityHistoryLayerParameter
  參數物件。
- 可選callback: (result: string | WeatherLayer) => void
  完成後的回呼函式。
回傳 void
- 定義於 webgl/module/weatherModule/ov-Weather.ts:75

addWeatherImageLayer

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

getCurrentFluidParam

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

getFishFarmData

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

回傳 WeatherFishFarm[]
臺灣定置網範圍資料。
- 定義於 webgl/module/weatherModule/ov-Weather.ts:122

getLayerByName

getLayerByName(name: string): null | WeatherImageLayer | WeatherHistoryLayer
取得第一個符合名稱的氣候圖層。
參數
- name: string
回傳 null | WeatherImageLayer | WeatherHistoryLayer
氣候圖層物件或null。
- 定義於 webgl/module/weatherModule/ov-Weather.ts:130

getObservationData

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

getRadarReflectivityHistoryValidTimeSpan

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

removeAllLayer

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

回傳 void
- 定義於 webgl/module/weatherModule/ov-Weather.ts:159

removeLayer

removeLayer(layer: WeatherLayer): boolean
移除指定氣候圖層。
參數
- layer: WeatherLayer
回傳 boolean
是否移除成功。
- 定義於 webgl/module/weatherModule/ov-Weather.ts:149

訪問器屬性

apiServer

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

回傳 string
- 定義於 webgl/module/weatherModule/ov-Weather.ts:30

authorization

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

回傳 string
- 定義於 webgl/module/weatherModule/ov-Weather.ts:23

layers

get layers(): (null | WeatherImageLayer | WeatherHistoryLayer)[]
取得全部圖層陣列

回傳 (null | WeatherImageLayer | WeatherHistoryLayer)[]
- 定義於 webgl/module/weatherModule/ov-Weather.ts:44

proxy

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

回傳 null | string
- 定義於 webgl/module/weatherModule/ov-Weather.ts:37