Class WxDataSetManager

Class for managing a WX dataset and its related operations.

Instances of this class handle metadata, variables, valid times, zoom levels, and URI construction for WX datasets. @metoceanapi/wxtiles-common/managers/BaseDatasetManager/BaseDatasetManager

Usage Note: Do not create instances directly using the constructor. Use createDatasetManager instead.

Example

async function fetchWxDataset() {
  try {
    const wxapi = new WxAPI({ dataServerURL: "https://example.com" });
    const wxDatasetManager = await wxapi.createDatasetManager("gfs.global");

    console.log(wxDatasetManager.getAllVariables());
  } catch (error) {
    console.error("Error fetching dataset:", error);
  }
}

fetchWxDataset();

Hierarchy

BaseDatasetManager
- WxDataSetManager

Index

Constructors

constructor

new WxDataSetManager(options: WxDataSetManagerOptions): WxDataSetManager
Do not use this constructor directly. Use createDatasetManager instead.
Parameters
- options: WxDataSetManagerOptions
  
  Dataset manager options.
Returns WxDataSetManager
Inherited from BaseDatasetManager.constructor
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:57

Properties

`Readonly` datasetName

datasetName: string

The name of the dataset being managed.

`Readonly` `Internal` wxAPI

wxAPI: WxAPI

A reference to the WX API instance that created this manager.

Methods

`Protected` _checkCombineVariableIfVector

_checkCombineVariableIfVector(variable: string): WxLayerVarsNames
Internal
Checks if variable is a vector component.

Argument
variable - variable name

Returns
- [variable] or [variable.eastward, variable.northward]
Parameters
- variable: string
Returns WxLayerVarsNames
Inherited from BaseDatasetManager._checkCombineVariableIfVector
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:255

createSourceLayer

createSourceLayer(options: WxSourceLayerOptions, frwOptions: FrameworkOptions): WxTileSource
Creates a source layer for this dataset.

Returns
- A new tile source ready for rendering.
Example
```
const sourceLayer = wxDatasetManager.createSourceLayer(
  { variable: "temperature" },
  { framework: "leaflet" }
);
```
Parameters
- options: WxSourceLayerOptions
  
  Layer-specific options (e.g., variables).
- frwOptions: FrameworkOptions
  
  Framework-specific options.
Returns WxTileSource
- Defined in wxtiles-leaflet/src/wxAPI/WxDataSetManager.ts:53

createURI

createURI(variable: string, validTime: string, ext??: "webp"): string
Constructs the URI for fetching dataset tiles.

Returns
- A URI ready for fetching tiles.
Throws
- If the variable is invalid.
Example
```
const uri = wxDatasetManager.createURI("temperature", "2024-06-10T12:00:00Z");
console.log(uri);
```
Parameters
- variable: string
  
  The variable name (e.g., "temperature").
- validTime: string
  
  The valid time step for the dataset.
- Optional ext: "webp" = "webp"
  
  File extension (must be 'webp').
Returns string
Inherited from BaseDatasetManager.createURI
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:208

getAllTimes

getAllTimes(): string[]
Retrieves all available time steps for the dataset.

Returns
- A copy of the dataset's time steps.
Returns string[]
Inherited from BaseDatasetManager.getAllTimes
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:121

getAllVariables

getAllVariables(): string[]
Retrieves all available variables for the dataset.

Returns
- List of all variable names in the dataset.
Returns string[]
Inherited from BaseDatasetManager.getAllVariables
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:131

getBoundaries

getBoundaries(): undefined | WxAllBoundariesMeta
Get dataset's boundaries.

Returns
- dataset's boundaries
Returns undefined | WxAllBoundariesMeta
Inherited from BaseDatasetManager.getBoundaries
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:177

getInstanceMeta

getInstanceMeta(instance?: string): WxDatasetMeta
Get dataset's metadata for the given instance.

Returns
Parameters
- Optional instance: string
Returns WxDatasetMeta
Inherited from BaseDatasetManager.getInstanceMeta
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:187

getInstanceVariableMeta

getInstanceVariableMeta(variable: string, instance?: string): undefined | WxVariableMeta
Get the variable meta from the instanced dataset.

Argument
variable - variable name

Argument
instance - instance name

Returns
- dataset variable's meta for the given instance
Parameters
- variable: string
- Optional instance: string
Returns undefined | WxVariableMeta
Inherited from BaseDatasetManager.getInstanceVariableMeta
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:154

getMaxZoom

getMaxZoom(): number
Get dataset's native maximum zoom level.

Returns
- maximum zoom level of the dataset
Returns number
Inherited from BaseDatasetManager.getMaxZoom
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:168

getNearestValidTime

getNearestValidTime(time??: WxDate): string
Finds the nearest valid time in the dataset based on the input.
- If time is an empty string, the last available time is returned.
- If time is a string matching a valid time, that time is returned.
- If time is a number:
  - Negative: Returns the first time.
  - Within range: Returns the corresponding indexed time.
- Otherwise, finds the closest time in milliseconds.
Returns
- The nearest valid time from the dataset's time steps.
Example
```
const nearestTime = wxDatasetManager.getNearestValidTime("2024-06-10T12:00:00Z");
console.log(nearestTime); // Closest valid time
```
Parameters
- Optional time: WxDate = ...
  
  Input time as a string, number, or Date object.
Returns string
Inherited from BaseDatasetManager.getNearestValidTime
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:93

getVariableCurrentMeta

getVariableCurrentMeta(variable: string): undefined | WxVariableMeta
Get the variable's meta from the dataset.

Argument
variable - variable name

Returns
- dataset variable's meta
Parameters
- variable: string
Returns undefined | WxVariableMeta
Inherited from BaseDatasetManager.getVariableCurrentMeta
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:141

isInstanced

isInstanced(): boolean
Internal
Get dataset's current instance.

Returns
- true if dataset is instanced
Returns boolean
Inherited from BaseDatasetManager.isInstanced
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:245

isVariableValid

isVariableValid(variable: string): boolean
Check if given variable is available in the dataset.

Argument
variable - variable name

Returns
- true if variable is available in the dataset
Parameters
- variable: string
Returns boolean
Inherited from BaseDatasetManager.isVariableValid
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:225

update

update(): Promise<void>
Internal
Update dataset's meta data.

Returns Promise<void>
Inherited from BaseDatasetManager.update
- Defined in wxtiles-common/managers/BaseDatasetManager.ts:235

Class WxDataSetManager

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: WxDataSetManagerOptions

Returns WxDataSetManager

Properties

Readonly datasetName

Readonly Internal wxAPI

Methods

Protected _checkCombineVariableIfVector

Argument

Returns

Parameters

variable: string

Returns WxLayerVarsNames

createSourceLayer

Returns

Example

Parameters

options: WxSourceLayerOptions

frwOptions: FrameworkOptions

Returns WxTileSource

createURI

Returns

Throws

Example

Parameters

variable: string

validTime: string

Optional ext: "webp" = "webp"

Returns string

getAllTimes

Returns

Returns string[]

getAllVariables

Returns

Returns string[]

getBoundaries

Returns

Returns undefined | WxAllBoundariesMeta

getInstanceMeta

Returns

Parameters

Optional instance: string

Returns WxDatasetMeta

getInstanceVariableMeta

Argument

Argument

Returns

Parameters

variable: string

Optional instance: string

Returns undefined | WxVariableMeta

getMaxZoom

Returns

Returns number

getNearestValidTime

Returns

Example

Parameters

Optional time: WxDate = ...

Returns string

getVariableCurrentMeta

Argument

Returns

Parameters

variable: string

Returns undefined | WxVariableMeta

isInstanced

Returns

Returns boolean

isVariableValid

Argument

`Readonly` datasetName

`Readonly` `Internal` wxAPI

`Protected` _checkCombineVariableIfVector

`Optional` ext: "webp" = "webp"

`Optional` instance: string

`Optional` instance: string

`Optional` time: WxDate = ...