---
title: "WindLayerOptions | Weather SDK | JavaScript maps SDK"
description: "Documentation for Weather JS"
---

# Type Alias WindLayerOptions

type WindLayerOptions \= {  
    [color](#color)?: [RgbaColor](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/RgbaColor/);  
    [colorMaxKph](#colormaxkph)?: number;  
    [colorMinKph](#colorminkph)?: number;  
    [colorramp](#colorramp)?: [ColorRamp](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/classes/ColorRamp/);  
    [density](#density)?: number;  
    [fadeFactor](#fadefactor)?: number;  
    [fastColor](#fastcolor)?: [RgbaColor](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/RgbaColor/);  
    [fastIsLarger](#fastislarger)?: boolean;  
    [fastSpeed](#fastspeed)?: number;  
    [id](#id)?: string;  
    [maxAmount](#maxamount)?: number;  
    [opacity](#opacity)?: number;  
    [pixelRatio](#pixelratio)?: number;  
    [refreshInterval](#refreshinterval)?: number;  
    [renderTrails](#rendertrails)?: boolean;  
    [size](#size)?: number;  
    [smooth](#smooth)?: boolean;  
    [speed](#speed)?: number;  
}

##### Index

### Properties

[color?](#color) [colorMaxKph?](#colormaxkph) [colorMinKph?](#colorminkph) [colorramp?](#colorramp) [density?](#density) [fadeFactor?](#fadefactor) [fastColor?](#fastcolor) [fastIsLarger?](#fastislarger) [fastSpeed?](#fastspeed) [id?](#id) [maxAmount?](#maxamount) [opacity?](#opacity) [pixelRatio?](#pixelratio) [refreshInterval?](#refreshinterval) [renderTrails?](#rendertrails) [size?](#size) [smooth?](#smooth) [speed?](#speed)

## Properties

### `Optional`color[](#color)

color?: [RgbaColor](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/RgbaColor/)

Color of the particle. RGBA 0-255. Defaults to `[255, 255, 255, 192]`

### `Optional`colorMaxKph[](#colormaxkph)

colorMaxKph?: number

Wind speed (km/h) at or above which particles use [fastColor](#fastcolor). Converted to m/s internally. Default: `144` (equivalent to 40 m/s, previous default ramp top).

### `Optional`colorMinKph[](#colorminkph)

colorMinKph?: number

Wind speed (km/h) at or below which particles use [color](#color). Must be >= 0. Converted to m/s internally for the particle field. Default: `0`.

### `Optional`colorramp[](#colorramp)

colorramp?: [ColorRamp](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/classes/ColorRamp/)

Colormap to use

### `Optional`density[](#density)

density?: number

Number of particles visible per 1000 px^2. Default is `2`.

### `Optional`fadeFactor[](#fadefactor)

fadeFactor?: number

How much the particles fade over time. Default value is `0.1`.

### `Optional`fastColor[](#fastcolor)

fastColor?: [RgbaColor](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/RgbaColor/)

Color of the particle when moving "fast". RGBA 0-255. Defaults to [color](#color)

### `Optional`fastIsLarger[](#fastislarger)

fastIsLarger?: boolean

If this is `true`, the particles gets slighly larger as they become faster. Default: `false`

### `Optional`fastSpeed[](#fastspeed)

fastSpeed?: number

What is considered "fast" (in px/sec) for coloring purposes. Only makes sense when [fastColor](#fastcolor) is used.

### `Optional`id[](#id)

id?: string

ID of the layer

### `Optional`maxAmount[](#maxamount)

maxAmount?: number

Quantity of particles to be created. Default value is `128`. Has to be a power of 2 and at least `4`. The actual exact number will be `particles * particles`. Try to keep this value as low as possible to optimize performance.

The number of actually visible particles is determined by [density](#density).

### `Optional`opacity[](#opacity)

opacity?: number

Opacity of the layer in \[0, 1\]

### `Optional`pixelRatio[](#pixelratio)

pixelRatio?: number

Use more pixels to make particles more smooth (especially when tilted). Defaults to `2` for normal displays and `1` for HiDPI displays.

### `Optional`refreshInterval[](#refreshinterval)

refreshInterval?: number

Time interval (in milliseconds) how often the particles are refreshed to avoid degradation. Random `1/16` of the particles is always randomly reset. Default value is `800`.

### `Optional`renderTrails[](#rendertrails)

renderTrails?: boolean

Whether or not the particles render trails. Default: `true`

### `Optional`size[](#size)

size?: number

Size of the particle. Defaults to `1.5`

### `Optional`smooth[](#smooth)

smooth?: boolean

Whether or not the colorramp shows interpolated colors

### `Optional`speed[](#speed)

speed?: number

Speed factor of the particles. Defaults to `0.001`