Class WxAPI

WxAPI is an initialisation object for the library. See WxAPIOptions for options.

Example

import { WxAPI } from 'wx-tiles';
const wxapi = new WxAPI({
    dataServerURL: 'https://server.com/',
    // other options
});

Hierarchy

  • WxAPI

Constructors

constructor

Properties

dataServerURL ext initDone loadMaskFunc maskChannel maskDepth maskURL qtree requestInit?

Methods

createDatasetManager filterDatasetsByVariableName getAllDatasetsNames getDatasetAllVariables

Constructors

constructor

Properties

Readonly dataServerURL

dataServerURL: string

see WxAPIOptions

Readonly ext

ext: string

see WxAPIOptions

Readonly initDone

initDone: Promise<void>

resolved when WxAPI is ready to be used

Readonly loadMaskFunc

loadMaskFunc: ((__namedParameters: XYZ) => Promise<ImageData>)

Type declaration

    • (__namedParameters: XYZ): Promise<ImageData>
    • Internal

      function to load mask tiles

      Parameters

      • __namedParameters: XYZ

      Returns Promise<ImageData>

Readonly Internal maskChannel

maskChannel: number

see WxAPIOptions

Readonly Internal maskDepth

maskDepth: number

see WxAPIOptions

Readonly Internal maskURL

maskURL: string

see WxAPIOptions

Readonly Internal qtree

qtree: QTree

instance of the qtree object

Optional Readonly requestInit

requestInit?: RequestInit

see WxAPIOptions

Methods

createDatasetManager

  • Creates a new instance of the WxDataSetManager class WxDataSetManager for the given dataset name.

    Returns

    • A new instance of the WxDataSetManager class for the given dataset name.

    Throws

    • If the dataset or instance is not found.

    Parameters

    • datasetName: string

      The name of the dataset to create a manager for.

    Returns Promise<WxDataSetManager>

filterDatasetsByVariableName

  • Filters the list of all available datasets' names by the given variable name.

    Returns

    • A list of all available datasets' names that have the given variable name.

    Parameters

    • varName: string

      The variable name to filter by.

    Returns Promise<string[]>

getAllDatasetsNames

  • Returns a list of all available datasets' names.

    Returns

    • A list of all available datasets' names.

    Returns Promise<string[]>

getDatasetAllVariables

  • Returns the list of all available variables for the given dataset name.

    Returns

    • A list of all available variables for the given dataset name, or undefined if the dataset is not found.

    Parameters

    • datasetName: string

      The name of the dataset to get the variables for.

    Returns Promise<undefined | string[]>

Settings

Member Visibility

Theme

Generated using TypeDoc