Class WxLayerBaseImplementation

Implementation of universal methods for the layer (for Mapbox and Leaflet) To be extended by framework specific implementation Wrapps some methods of WxLayer

Hierarchy

FrameworkParentClass
- WxLayerBaseImplementation
  - WxTileSource

Implements

WxLayerBaseAPI

Index

Constructors

constructor

new WxLayerBaseImplementation(wxLayerOptions: WxLayerOptions, frwOptions: FrameworkOptions): WxLayerBaseImplementation
Internal
Do not use this constructor directly
Parameters
- wxLayerOptions: WxLayerOptions
- frwOptions: FrameworkOptions
Returns WxLayerBaseImplementation
Overrides FrameworkParentClass.constructor
- Defined in src/wxlayer/WxImplementation.ts:84

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 WxLayerBaseAPI.wxdatasetManager
- Defined in src/wxlayer/WxImplementation.ts:94

Methods

clearCache

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

Returns void
Implementation of WxLayerBaseAPI.clearCache
- Defined in src/wxlayer/WxImplementation.ts:134

getAllTimes

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

getCache

getCache(): TilesCache
Returns TilesCache
- 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 WxLayerBaseAPI.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 WxLayerBaseAPI.getCurrentVariableMeta
- Defined in src/wxlayer/WxImplementation.ts:103

getDatasetMeta

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

getMetadata

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

Deprecated

Returns
- The metadata of the current variable.
Returns WxVariableMeta
- 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 WxLayerBaseAPI.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 WxLayerBaseAPI.getVariablesNames
- Defined in src/wxlayer/WxImplementation.ts:126

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 WxLayerBaseAPI.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 WxLayerBaseAPI.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 WxLayerBaseAPI.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 WxLayerBaseAPI.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 WxLayerBaseAPI.startAnimation
- Defined in src/wxlayer/WxImplementation.ts:195

stopAnimation

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

Returns Promise<void>
Implementation of WxLayerBaseAPI.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 WxLayerBaseAPI.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 WxLayerBaseAPI.updateCurrentStyleObject
- Defined in src/wxlayer/WxImplementation.ts:262

Class WxLayerBaseImplementation

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wxLayerOptions: WxLayerOptions

frwOptions: FrameworkOptions

Returns WxLayerBaseImplementation

Properties

Protected _needUpdateDSManager

id

Accessors

wxdatasetManager

Returns

Returns WxDataSetManager

Methods

clearCache

Returns void

getAllTimes

Returns string[]

getCache

Returns TilesCache

getCurrentStyleObjectCopy

Returns

Returns WxColorStyleStrict

getCurrentVariableMeta

Returns

Returns WxVariableMeta

getDatasetMeta

Returns WxDatasetMeta

getMetadata

Deprecated

Returns

Returns WxVariableMeta

getTime

Returns

Returns string

getVariablesNames

Returns

Returns WxLayerVarsNames

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

Returns Promise<void>

setTime

Returns

Parameters

Optional time: WxDate

Optional requestInit: WxRequestInit

Returns Promise<string>

startAnimation

Returns void

stopAnimation

Returns Promise<void>

unsetCoarseLevel

Returns Promise<void>

updateCurrentStyleObject

Returns

Parameters

Optional style: WxColorStyleWeak

reload: boolean = true

Optional requestInit: WxRequestInit

`Protected` _needUpdateDSManager

`Optional` requestInit: WxRequestInit

`Optional` time: WxDate

`Optional` requestInit: WxRequestInit

`Optional` style: WxColorStyleWeak

`Optional` requestInit: WxRequestInit