Overview of WeatherLayers GL
maindeck.gl. It is used to integrate complex weather data visualizations into mapping applications using the deck.gl framework.repository·main·Indexed 41 days ago
https://github.com/weatherlayers/weatherlayers-glA library providing specialized weather visualization layers and controls specifically built for integration with deck.gl. Version 2026.9.0-alpha.1 includes a Client API for managing STAC catalogs, loading weather datasets, and configuring specialized layers such as contour, grid, high-low, and particle layers.
deck.gl. It is used to integrate complex weather data visualizations into mapping applications using the deck.gl framework.When using the Library to visualize data (including self-hosted data), the User is responsible for ensuring they have sufficient legal authorization to use that data.
Key obligations:
The package and its source code are dual-licensed. Users can choose between:
For specific licensing inquiries, contact support@weatherlayers.com.
The License grants a non-exclusive right to use the Library and Technical Documentation for internal purposes. Users are prohibited from the following:
The Library is available under several license types, each with different scopes and restrictions:
The purchase of a paid License includes 1 year of Services (support and maintenance) starting from the date the License is provided.
Service Details:
When developing a production application, it is recommended to enable type-aware lint rules in your ESLint configuration. This involves updating parserOptions to point to your tsconfig files and switching to type-checked plugin recommendations.
Steps to update configuration:
parserOptions with ecmaVersion, sourceType, project (pointing to your tsconfig files), and tsconfigRootDir.plugin:@typescript-eslint/recommended with plugin:@typescript-eslint/recommended-type-checked or plugin:@typescript-eslint/strict-type-checked.plugin:@typescript-eslint/stylistic-type-checked.eslint-plugin-react and add plugin:react/recommended and plugin:react/jsx-runtime to the extends list.export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: __dirname,
},
}To use the Library, you must first purchase a License. You can do this by concluding a contract via email or through a user account in the WeatherLayers Web Application.
Steps to obtain the Library:
The StacCollection interface supports standard STAC properties, but also includes specific extensions used by the WeatherLayers Cloud Client to configure how weather data is rendered and controlled.
When implementing or consuming a STAC Collection, you can include these custom keys in the object:
weatherLayers:imageType: Defines the type of image data.weatherLayers:imageUnscale: An array [number, number] or null used to unscale raster values.weatherLayers:units: An array of UnitDefinition objects.weatherLayers:layers: A DatasetLayersConfig object for layer management.weatherLayers:controls: A DatasetControlsConfig object for dataset controls.The DatasetLayersConfig interface is used to configure different types of weather dataset layers. You can optionally specify configurations for contourLayer, gridLayer, highLowLayer, and particleLayer. Each layer type has its own specific configuration requirements.
const config: DatasetLayersConfig = {
contourLayer: {
interval: 1,
majorInterval: 5
},
gridLayer: {
style: myGridStyle,
iconBounds: [-10, -10, 10, 10]
},
highLowLayer: {
radius: 50
},
particleLayer: {
speedFactor: 1.5,
width: 2
}
};Use loadCatalog() to retrieve a list of available dataset IDs (STAC Collection IDs) from the service.
const datasetIds = await client.loadCatalog();
// Returns an array of strings, e.g., ['temperature', 'wind-speed']src/client/index.ts file serves as the primary entrypoint for the WeatherLayers GL client module. It re-exports all functionality from ./client.js and utility functions from ./_utils.js. To use the client, import from the main client entrypoint to access core classes and methods for managing weather layers.