@maptiler/weather/dist/layers/WindLayer/WindLayer.d.ts

Weather layers for MapTiler Cloud and MapTiler SDK

import { Map as MapSDK } from '@maptiler/sdk';
import { ColorRamp } from '../../core/ColorRamp';
import { ParticleLayer } from '../ParticleLayer/ParticleLayer';
import { WindLayerOptions, WindPickAt } from './types';
/**
 * The WindLayer shows the atmospheric wind in millibar (or hectopascal)
 */
declare class WindLayer extends ParticleLayer {
    private constructorOptions;
    private isSourceReady;
    private colorRamp;
    constructor(options?: WindLayerOptions);
    onAdd(map: MapSDK, gl: WebGLRenderingContext | WebGL2RenderingContext): Promise<void>;
    /**
     * Check if the data source that fuels the layer has been fully fetched and processed
     * @returns
     */
    getIsSourceReady(): boolean;
    /**
     * Get the wind speed and direction in multiple measurement units at a given location
     * @param lng
     * @param lat
     * @param options: bilinear interpolation (boolean) is disabled by default for better performance
     * @returns
     */
    pickAt(lng: number, lat: number, options?: {
        bilinear?: boolean;
    }): WindPickAt | null;
    /**
     * Get the color ramp in use by the layer
     * @returns
     */
    getColorRamp(): Readonly<ColorRamp>;
    /**
     * Async function corresponding to the "sourceReady" event.
     * Resolves directly if source is already ready, or awaits the "sourceReady"
     * event if not.
     */
    onSourceReadyAsync(): Promise<void>;
}
export { WindLayer };