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

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.

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

`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 FrameworkParentClass.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[]
- 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
- 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 WxLayerBaseAPI.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 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:161

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

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
Inherited from FrameworkParentClass.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
Inherited from FrameworkParentClass.on
- Defined in src/wxsource/wxsourcetypes.ts:54

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
Inherited from FrameworkParentClass.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 WxLayerBaseAPI.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 WxLayerBaseAPI.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 WxLayerBaseAPI.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 WxLayerBaseAPI.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 WxLayerBaseAPI.startAnimation
- Defined in src/wxlayer/WxImplementation.ts:204

stopAnimation

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

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

Class WxLayerBaseImplementation

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wxLayerOptions: WxLayerOptions

frwOptions: FrameworkOptions

Returns WxLayerBaseImplementation

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

getMetadata

Deprecated

Returns

Returns WxVariableMeta

getTime

Returns

Returns string

getVariablesNames

Returns

Returns WxLayerVarsNames

off

Returns

Type Parameters

T extends "changed"

Parameters

type: T

listener: ListenerMethod

Returns void

on

Returns

Type Parameters

T extends "changed"

Parameters

type: T

listener: ListenerMethod

Returns void

once

`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` time: WxDate

`Optional` requestInit: WxRequestInit

`Optional` redraw: boolean

`Optional` style: WxColorStyleWeak

`Optional` requestInit: WxRequestInit