Class WxTileSource

A custom layer source implementation It is used to load and display weather data from the WxTiles server.

Example

const wxapi = new WxAPI({ 'http://dataserver.com' });

const datasetName = 'gfs.global';
const variable = 'air.temperature.at-2m'; // Scalar example

// Create a dataset manager (may be used for many layers from this dataset)
const wxdatasetManager = await wxapi.createDatasetManager(datasetName);

// get proper representation of the variable
const variables = wxdatasetManager.checkCombineVariableIfVector(variable);

// create a layer source
const wxsource = new WxTileSource({ wxdatasetManager, variables }, { id: 'wxsource', attribution: 'WxTiles' });

Or use the createSourceLayer method to create a layer/source in one step.

Hierarchy

WxLayerBaseImplementation
- WxTileSource

Implements

WxLayerAPI

Constructors

constructor

new WxTileSource(wxlayeroptions: WxLayerOptions, frameworkOptions: FrameworkOptions): WxTileSource
Parameters
- wxlayeroptions: WxLayerOptions
  
  The options for the WxLayerBaseImplementation.
- frameworkOptions: FrameworkOptions
  
  The options for the framework.
Returns WxTileSource
Overrides WxLayerBaseImplementation.constructor
- Defined in src/wxsource/wxsource.ts:59

Properties

`Protected` _needUpdateDSManager

_needUpdateDSManager: boolean = false

A boolean flag indicating whether the dataset manager needs to be updated or not.

id

id: string

Accessors

wxdatasetManager

get wxdatasetManager(): WxDataSetManager
returns the dataset manager of the source

Returns
the dataset manager of the source

Returns WxDataSetManager
Implementation of WxLayerAPI.wxdatasetManager

Inherited from WxLayerBaseImplementation.wxdatasetManager
- Defined in src/wxlayer/WxImplementation.ts:94

Methods

clearCache

clearCache(): void
Clears the cache of the source.

Returns void
Implementation of WxLayerAPI.clearCache

Inherited from WxLayerBaseImplementation.clearCache
- Defined in src/wxlayer/WxImplementation.ts:134

`Protected` createTile

createTile(coords: Coords, done: DoneCallback): HTMLElement
Internal
Used by framework. Creates a representation of a tile for the framework.

Returns
- A picture of the tile.
Parameters
- coords: Coords
- done: DoneCallback
Returns HTMLElement
Overrides WxLayerBaseImplementation.createTile
- Defined in src/wxsource/wxsource.ts:150

getAllTimes

getAllTimes(): string[]
Returns string[]
Inherited from WxLayerBaseImplementation.getAllTimes
- Defined in src/wxlayer/WxImplementation.ts:161

getCache

getCache(): TilesCache
Returns TilesCache
Inherited from WxLayerBaseImplementation.getCache
- Defined in src/wxlayer/WxImplementation.ts:139

getCurrentStyleObjectCopy

getCurrentStyleObjectCopy(): WxColorStyleStrict
Get a copy of the current style of the source.

Returns
A copy of the current style of the source.

Returns WxColorStyleStrict
Implementation of WxLayerAPI.getCurrentStyleObjectCopy

Inherited from WxLayerBaseImplementation.getCurrentStyleObjectCopy
- Defined in src/wxlayer/WxImplementation.ts:147

getCurrentVariableMeta

getCurrentVariableMeta(): WxVariableMeta
Get the metadata of the current variable(s).

Returns
- The metadata of the current variable.
Returns WxVariableMeta
Implementation of WxLayerAPI.getCurrentVariableMeta

Inherited from WxLayerBaseImplementation.getCurrentVariableMeta
- Defined in src/wxlayer/WxImplementation.ts:103

getDatasetMeta

getDatasetMeta(): WxDatasetMeta
Returns WxDatasetMeta
Inherited from WxLayerBaseImplementation.getDatasetMeta
- Defined in src/wxlayer/WxImplementation.ts:108

getLayerInfoAtLatLon

getLayerInfoAtLatLon(lnglat: WxLngLat, anymap: any): undefined | WxTileInfo
Get comprehensive information about the current point on map.

Returns
Parameters
- lnglat: WxLngLat
  
  Coordinates of the point.
- anymap: any
Returns undefined | WxTileInfo
Implementation of WxLayerAPI.getLayerInfoAtLatLon
- Defined in src/wxsource/wxsource.ts:70

getMetadata

getMetadata(): WxVariableMeta
Get the metadata of the current variable(s).

Deprecated

Returns
- The metadata of the current variable.
Returns WxVariableMeta
Inherited from WxLayerBaseImplementation.getMetadata
- Defined in src/wxlayer/WxImplementation.ts:117

getTime

getTime(): string
Get the current time of the source.

Returns
The current time of the source from array of times.

Returns string
Implementation of WxLayerAPI.getTime

Inherited from WxLayerBaseImplementation.getTime
- Defined in src/wxlayer/WxImplementation.ts:156

getVariablesNames

getVariablesNames(): WxLayerVarsNames
Get current variables (1 or 2) of the source/layer.

Returns
variables of the source.

Returns WxLayerVarsNames
Implementation of WxLayerAPI.getVariablesNames

Inherited from WxLayerBaseImplementation.getVariablesNames
- Defined in src/wxlayer/WxImplementation.ts:126

onRemove

onRemove(map: Map): WxTileSource
Internal
Description
Called when the layer is removed from a map.

Returns
- The WxTileSource instance.
Parameters
- map: Map
  
  The map instance.
Returns WxTileSource
Overrides WxLayerBaseImplementation.onRemove
- Defined in src/wxsource/wxsource.ts:171

preloadTime

preloadTime(time: WxDate, requestInit?: WxRequestInit): Promise<void>
Cache tiles for faster rendering for setTime. If the time is not available, the closest time will be used.

Returns
A promise that resolves when finished preload.
Parameters
- time: WxDate
  
  Time to preload.
- Optional requestInit: WxRequestInit
  
  Request options.
Returns Promise<void>
Implementation of WxLayerAPI.preloadTime

Inherited from WxLayerBaseImplementation.preloadTime
- Defined in src/wxlayer/WxImplementation.ts:187

setCoarseLevel

setCoarseLevel(level?: number): Promise<void>
set coarse maximum zoom level to make tiles load faster during animation
Parameters
- level: number = 2
Returns Promise<void>
Implementation of WxLayerAPI.setCoarseLevel

Inherited from WxLayerBaseImplementation.setCoarseLevel
- Defined in src/wxlayer/WxImplementation.ts:233

setStyleByName

setStyleByName(wxstyleName: string, reload?: boolean): Promise<void>
Set the style of the source by its name from default styles.

Returns
A promise that resolves when the style is set.
Parameters
- wxstyleName: string
  
  Name of the new style to set.
- reload: boolean = true
  
  If true, the source will be reloaded and rerendered.
Returns Promise<void>
Implementation of WxLayerAPI.setStyleByName

Inherited from WxLayerBaseImplementation.setStyleByName
- Defined in src/wxlayer/WxImplementation.ts:250

setTime

setTime(time?: WxDate, requestInit?: WxRequestInit): Promise<string>
Set time and render the source. If the time is not available, the closest time will be used.

Returns
A promise that resolves with current time step when the time is set and the source is loaded and rendered.
Parameters
- Optional time: WxDate
  
  Time to set.
- Optional requestInit: WxRequestInit
  
  Request options for fetch.
Returns Promise<string>
Implementation of WxLayerAPI.setTime

Inherited from WxLayerBaseImplementation.setTime
- Defined in src/wxlayer/WxImplementation.ts:172

startAnimation

startAnimation(): void
Starts the particle animation for wind and currents if sutiable.

Returns void
Implementation of WxLayerAPI.startAnimation

Inherited from WxLayerBaseImplementation.startAnimation
- Defined in src/wxlayer/WxImplementation.ts:195

stopAnimation

stopAnimation(): Promise<void>
Stops the particle animation.

Returns Promise<void>
Implementation of WxLayerAPI.stopAnimation

Inherited from WxLayerBaseImplementation.stopAnimation
- Defined in src/wxlayer/WxImplementation.ts:226

unsetCoarseLevel

unsetCoarseLevel(): Promise<void>
restores to the dataset's maximum zoom level

Returns Promise<void>
Implementation of WxLayerAPI.unsetCoarseLevel

Inherited from WxLayerBaseImplementation.unsetCoarseLevel
- Defined in src/wxlayer/WxImplementation.ts:239

updateCurrentStyleObject

updateCurrentStyleObject(style?: WxColorStyleWeak, reload?: boolean, requestInit?: WxRequestInit): Promise<void>
Update the current style object of the source partially or completely.

Returns
A promise that resolves when the style is set.
Parameters
- Optional style: WxColorStyleWeak
  
  Style's fields to set.
- reload: boolean = true
  
  If true, the source will be reloaded and rerendered.
- Optional requestInit: WxRequestInit
  
  Request options.
Returns Promise<void>
Implementation of WxLayerAPI.updateCurrentStyleObject

Inherited from WxLayerBaseImplementation.updateCurrentStyleObject
- Defined in src/wxlayer/WxImplementation.ts:262

Class WxTileSource

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wxlayeroptions: WxLayerOptions

frameworkOptions: FrameworkOptions

Returns WxTileSource

Properties

Protected _needUpdateDSManager

id

Accessors

wxdatasetManager

Returns

Returns WxDataSetManager

Methods

clearCache

Returns void

Protected createTile

Returns

Parameters

coords: Coords

done: DoneCallback

Returns HTMLElement

getAllTimes

Returns string[]

getCache

Returns TilesCache

getCurrentStyleObjectCopy

Returns

Returns WxColorStyleStrict

getCurrentVariableMeta

Returns

Returns WxVariableMeta

getDatasetMeta

Returns WxDatasetMeta

getLayerInfoAtLatLon

Returns

Parameters

lnglat: WxLngLat

anymap: any

Returns undefined | WxTileInfo

getMetadata

Deprecated

Returns

Returns WxVariableMeta

getTime

Returns

Returns string

getVariablesNames

Returns

Returns WxLayerVarsNames

onRemove

Description

Returns

Parameters

map: Map

Returns WxTileSource

preloadTime

Returns

Parameters

time: WxDate

Optional requestInit: WxRequestInit

Returns Promise<void>

setCoarseLevel

Parameters

level: number = 2

Returns Promise<void>

setStyleByName

Returns

Parameters

wxstyleName: string

reload: boolean = true

`Protected` _needUpdateDSManager

`Protected` createTile

`Optional` requestInit: WxRequestInit

`Optional` time: WxDate

`Optional` requestInit: WxRequestInit

`Optional` style: WxColorStyleWeak

`Optional` requestInit: WxRequestInit