Class WxLayer`Internal`

Used in WxLayerBaseImplementation to manipulate the the layer's style, data and time

Hierarchy

WxLayer

Index

Constructors

constructor

new WxLayer(wxLayerOptions: WxLayerOptions): WxLayer
Parameters
- wxLayerOptions: WxLayerOptions
Returns WxLayer
- Defined in src/wxlayer/wxlayer.ts:143

Properties

`Internal` CLUT

CLUT: RawCLUT

Current "Color lookup table" object

`Protected` `Readonly` `Internal` _loader

_loader: Loader = ...

Loader object to load and preprocess tiles

`Protected` `Readonly` `Internal` _painter

_painter: Painter = ...

Painter object to render tiles

`Protected` `Internal` _time

_time: string

Current time

`Internal` coarseLevel

coarseLevel: number = 0

current coarsing zoom level

`Internal` currentVariableMeta

currentVariableMeta: WxVariableMeta

Current variable's Meta data of the layer

`Internal` style

style: WxColorStyleStrict

current Style Object

`Internal` tilesRasterCache

tilesRasterCache: TilesCache = ...

cahce: URI->rendered data on canvases

`Internal` tilesURIs

tilesURIs: WxURIs

current URIs to fetch tiles

`Readonly` `Internal` variables

variables: WxLayerVarsNames

Variables to be displayed by the layer

`Readonly` `Internal` wxdatasetManager

wxdatasetManager: WxDataSetManager

Data manager created this layer

Accessors

nonanimatable

get nonanimatable(): boolean
Check if the layer is vector and may be animated according to style

Returns boolean
- Defined in src/wxlayer/wxlayer.ts:175

Methods

clearCache

clearCache(): void
Internal
Clear the cache of tiles Not to use when loading is in progress.

Returns void
- Defined in src/wxlayer/wxlayer.ts:217

getBoundaries

getBoundaries(): undefined | WxAllBoundariesMeta
Internal
Get boundaries zoom according to the layer's Dataset manager

Returns
boundaries

Returns undefined | WxAllBoundariesMeta
- Defined in src/wxlayer/wxlayer.ts:200

getCoarseMaxZoom

getCoarseMaxZoom(): number
Returns number
- Defined in src/wxlayer/wxlayer.ts:190

getCurrentStyleObjectCopy

getCurrentStyleObjectCopy(): WxColorStyleStrict
Internal
Returns WxColorStyleStrict
- Defined in src/wxlayer/wxlayer.ts:224

getMaxZoom

getMaxZoom(): number
Internal
Get maximum zoom according to the layer's Dataset manager

Returns
maximum zoom

Returns number
- Defined in src/wxlayer/wxlayer.ts:185

getPaintedCanvas

getPaintedCanvas(data: WxRasterData, animation: boolean, seed: number): HTMLCanvasElement
Parameters
- data: WxRasterData
- animation: boolean
- seed: number
Returns HTMLCanvasElement
- Defined in src/wxlayer/wxlayer.ts:259

getTileData

getTileData(tileCoord: XYZ, tilePixel: {
x: number;
y: number;
}): undefined | WxTileInfo
Internal
Used by getLayerInfoAtLatLon
Parameters
- tileCoord: XYZ
- tilePixel: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
Returns undefined | WxTileInfo
- Defined in src/wxlayer/wxlayer.ts:236

getTime

getTime(): string
Internal
Get the current time step of the layer

Returns
time step in the dataset meta's format

Returns string
- Defined in src/wxlayer/wxlayer.ts:208

loadTile

loadTile(tile: XYZ, requestInit?: WxRequestInit): Promise<null | WxRasterData>
Internal
load, cache, draw the tile. Abortable
Parameters
- tile: XYZ
- Optional requestInit: WxRequestInit
Returns Promise<null | WxRasterData>
- Defined in src/wxlayer/wxlayer.ts:267

preloadTime

preloadTime(time_: WxDate, tiles: XYZ[], requestInit?: WxRequestInit): Promise<void>
Internal
cache given time step for faster access when needed. Resolved when done.

Returns
Parameters
- time_: WxDate
  
  time step to cache
- tiles: XYZ[]
- Optional requestInit: WxRequestInit
  
  request options
Returns Promise<void>
- Defined in src/wxlayer/wxlayer.ts:278

reloadTiles

reloadTiles(tiles: XYZ[], requestInit?: WxRequestInit): Promise<void>
Internal
Load all tiles, draw it on canvas, save to cache and return. Resolved when done.

Returns
Parameters
- tiles: XYZ[]
- Optional requestInit: WxRequestInit
Returns Promise<void>
- Defined in src/wxlayer/wxlayer.ts:290

setURLsAndTime

setURLsAndTime(time_?: WxDate): void
Internal
reassign URIs and a time step with a new given time step
Parameters
- Optional time_: WxDate
Returns void
- Defined in src/wxlayer/wxlayer.ts:250

updateCurrentStyleObject

updateCurrentStyleObject(style?: WxColorStyleWeak): void
Internal
Parameters
- Optional style: WxColorStyleWeak
Returns void
- Defined in src/wxlayer/wxlayer.ts:230

Class WxLayerInternal

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wxLayerOptions: WxLayerOptions

Returns WxLayer

Properties

Internal CLUT

Protected Readonly Internal _loader

Protected Readonly Internal _painter

Protected Internal _time

Internal coarseLevel

Internal currentVariableMeta

Internal style

Internal tilesRasterCache

Internal tilesURIs

Readonly Internal variables

Readonly Internal wxdatasetManager

Accessors

nonanimatable

Returns boolean

Methods

clearCache

Returns void

getBoundaries

Returns

Returns undefined | WxAllBoundariesMeta

getCoarseMaxZoom

Returns number

getCurrentStyleObjectCopy

Returns WxColorStyleStrict

getMaxZoom

Returns

Returns number

getPaintedCanvas

Parameters

data: WxRasterData

animation: boolean

seed: number

Returns HTMLCanvasElement

getTileData

Parameters

tileCoord: XYZ

tilePixel: { x: number; y: number; }

x: number

y: number

Returns undefined | WxTileInfo

getTime

Returns

Returns string

loadTile

Parameters

tile: XYZ

Optional requestInit: WxRequestInit

Returns Promise<null | WxRasterData>

preloadTime

Returns

Parameters

time_: WxDate

tiles: XYZ[]

Optional requestInit: WxRequestInit

Returns Promise<void>

reloadTiles

Returns

Parameters

tiles: XYZ[]

Optional requestInit: WxRequestInit

Returns Promise<void>

setURLsAndTime

Parameters

Optional time_: WxDate

Returns void

updateCurrentStyleObject

Parameters

Class WxLayer`Internal`

`Internal` CLUT

`Protected` `Readonly` `Internal` _loader

`Protected` `Readonly` `Internal` _painter

`Protected` `Internal` _time

`Internal` coarseLevel

`Internal` currentVariableMeta

`Internal` style

`Internal` tilesRasterCache

`Internal` tilesURIs

`Readonly` `Internal` variables

`Readonly` `Internal` wxdatasetManager

tilePixel: {
x: number;
y: number;
}

`Optional` requestInit: WxRequestInit

`Optional` requestInit: WxRequestInit

`Optional` requestInit: WxRequestInit

`Optional` time_: WxDate

`Optional` style: WxColorStyleWeak