Class WxTileSource

A custom layer source implementation It is used to load and display weather data from the WxTiles server. NOTE Dont use this directly, use createSourceLayer instead

Example

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

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

// create a layer source
// Scalar example.For vector variables use either of the vector components (e.g. 'wind.eastward.at-10m')
const variable = 'air.temperature.at-2m'; 
const wxsource = wxdatasetManager.createSourceLayer({ variable }, { id: 'wxsource', attribution: 'WxTiles' }); //new WxTileSource(wxLayerOptions, mboxSourceOptions);

Hierarchy

WxLayerBaseImplementation
- WxTileSource

Implements

WxLayerAPI
CustomSourceInterface<any>

Constructors

constructor

new WxTileSource(wxLayerOptions: WxLayerOptions, frwOptions: FrameworkOptions): WxTileSource
Internal
Creates a new instance of the WxTileSource class.
Parameters
- wxLayerOptions: WxLayerOptions
  
  The options for the WxLayerBaseImplementation.
- frwOptions: FrameworkOptions
  
  The options for the framework.
Returns WxTileSource
Overrides WxLayerBaseImplementation.constructor
- Defined in src/wxsource/wxsource.ts:38

Properties

`Protected` _needUpdateDSManager

_needUpdateDSManager: boolean = false

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

`Optional` `Readonly` attribution

attribution?: string

MAPBOX API

`Optional` `Readonly` bounds

bounds?: [number, number, number, number]

MAPBOX API

`Readonly` dataType

dataType: "raster" = 'raster'

MAPBOX API required

`Readonly` id

id: string

MAPBOX API required

`Optional` `Readonly` maxzoom

maxzoom?: number

MAPBOX API

`Optional` `Readonly` opacity

opacity?: number

`Readonly` tileSize

tileSize: number = 256

MAPBOX API required. only 256

`Readonly` type

type: "custom" = 'custom'

MAPBOX API required

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` fire

fire<T>(type: T, data: WxEventType[T]): void
Fires an event of the specified type with the given data. Calls all listeners for the type asynchronously.

Returns
Type Parameters
- T extends "changed"
Parameters
- type: T
  
  The event type.
- data: WxEventType[T]
  
  The data to pass to the listeners.
Returns void
Inherited from WxLayerBaseImplementation.fire
- Defined in src/wxsource/wxsourcetypes.ts:94

getAllTimes

getAllTimes(): string[]
Get all available times for the source.

Returns
An array of all available times for the source.

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

getCache

getCache(): TilesCache
Internal
Get the raster data cache of the layer. Used in CustomWxTilesLayer.render.

Returns
The raster data cache of the layer.

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

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:152

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 the map.

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

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:161

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

loadTile

loadTile(coords: XYZ, requestInit?: WxRequestInit): Promise<any>
Internal
Loads a tile with the given coordinates and request options. Used by framework. Creates a representation of a tile for the framework. It rethrows 'AbortError' errors. It returns empty tile during datasetManager update or in case of any other error (e.g. network error, not found, etc.) It tries to update datasetManager if e.reason === 'instance-not-found' and update the layer

Returns
- A promise that resolves with the loaded tile.
Parameters
- coords: XYZ
  
  The tile coordinates to be loaded.
- Optional requestInit: WxRequestInit
  
  The request options.
Returns Promise<any>
Implementation of mapboxgl.CustomSourceInterface.loadTile
- Defined in src/wxsource/wxsource.ts:113

off

off<T>(type: T, listener: ListenerMethod): void
Removes a listener for the event.

Returns
Type Parameters
- T extends "changed"
Parameters
- type: T
  
  The event name.
- listener: ListenerMethod
  
  The listener function to remove.
Returns void
Implementation of WxLayerAPI.off

Inherited from WxLayerBaseImplementation.off
- Defined in src/wxsource/wxsourcetypes.ts:65

on

on<T>(type: T, listener: ListenerMethod): void
add a listener for the event

Returns
Type Parameters
- T extends "changed"
Parameters
- type: T
  
  event name
- listener: ListenerMethod
  
  listener function
Returns void
Implementation of WxLayerAPI.on

Inherited from WxLayerBaseImplementation.on
- Defined in src/wxsource/wxsourcetypes.ts:54

onRemove

onRemove(map: any): void
Internal
Called when the layer is removed from the map.

Returns
Parameters
- map: any
  
  The map instance.
Returns void
Implementation of mapboxgl.CustomSourceInterface.onRemove
- Defined in src/wxsource/wxsource.ts:124

once

once<T>(type: T, listener: ListenerMethod): void
Adds a listener for the event that will be executed only once. After the event is fired, the listener will be removed.

Returns
Type Parameters
- T extends "changed"
Parameters
- type: T
  
  The event name.
- listener: ListenerMethod
  
  The listener function to add.
Returns void
Implementation of WxLayerAPI.once

Inherited from WxLayerBaseImplementation.once
- Defined in src/wxsource/wxsourcetypes.ts:77

preloadTime

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

Returns
A promise that resolves when the tiles are preloaded.
Parameters
- time: WxDate
  
  The time to preload.
- Optional requestInit: WxRequestInit
  
  Request options for fetch.
Returns Promise<void>
Implementation of WxLayerAPI.preloadTime

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

setCoarseLevel

setCoarseLevel(level?: number): Promise<void>
Set the coarse maximum zoom level to make tiles load faster during animation.

Returns
A promise that resolves when the coarse maximum zoom level is set.
Parameters
- level: number = 2
  
  The coarse maximum zoom level to set.
Returns Promise<void>
Implementation of WxLayerAPI.setCoarseLevel

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

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:263

setTime

setTime(time?: WxDate, requestInit?: WxRequestInit, redraw?: boolean): 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.
- Optional redraw: boolean
Returns Promise<string>
Implementation of WxLayerAPI.setTime

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

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:204

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:235

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:252

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:275

Class WxTileSource

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wxLayerOptions: WxLayerOptions

frwOptions: FrameworkOptions

Returns WxTileSource

Properties

Protected _needUpdateDSManager

Optional Readonly attribution

Optional Readonly bounds

Readonly dataType

Readonly id

Optional Readonly maxzoom

Optional Readonly opacity

Readonly tileSize

Readonly type

Accessors

wxdatasetManager

Returns

Returns WxDataSetManager

Methods

clearCache

Returns void

Protected fire

Returns

Type Parameters

T extends "changed"

Parameters

type: T

data: WxEventType[T]

Returns void

getAllTimes

Returns

Returns string[]

getCache

Returns

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

loadTile

Returns

Parameters

coords: XYZ

Optional requestInit: WxRequestInit

Returns Promise<any>

off

Returns

Type Parameters

T extends "changed"

`Protected` _needUpdateDSManager

`Optional` `Readonly` attribution

`Optional` `Readonly` bounds

`Readonly` dataType

`Readonly` id

`Optional` `Readonly` maxzoom

`Optional` `Readonly` opacity

`Readonly` tileSize

`Readonly` type

`Protected` fire

`Optional` requestInit: WxRequestInit

`Optional` requestInit: WxRequestInit

`Optional` time: WxDate

`Optional` requestInit: WxRequestInit

`Optional` redraw: boolean

`Optional` style: WxColorStyleWeak

`Optional` requestInit: WxRequestInit