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

# Type Alias WeatherVariable

Details about a specific weather variable

type WeatherVariable \= {  
    ["@version"](#version): string;  
    [bounds](#bounds): [Bounds](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/Bounds/);  
    [keyframes](#keyframes): [Keyframe](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/Keyframe/)\[\];  
    [metadata](#metadata): {  
        bounds: [Bounds](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/Bounds/);  
        center: number\[\];  
        format: "jpeg" | "png" | "webp" | "pbf" | "quantized-mesh-1.0";  
        maxzoom: number;  
        minzoom: number;  
        scale?: number;  
        scheme: string;  
        title: string;  
        weather\_variable: {  
            attribution: string;  
            decoding: { channels: [UsedRgbChannel](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/UsedRgbChannel/); max: number; min: number };  
            description: string;  
            name: string;  
            release\_timestamp: string;  
            timestamp: string;  
            unit: string;  
            variable\_id: [WeatherVariableIDValue](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/WeatherVariableIDValue/);  
        };  
    };  
    [spatial\_ref\_sys](#spatial_ref_sys): [SpatialReferenceSystem](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/SpatialReferenceSystem/);  
    [tile\_format](#tile_format): "jpeg"  
    | "png"  
    | "webp"  
    | "pbf"  
    | "quantized-mesh-1.0";  
    [tile\_matrix\_set](#tile_matrix_set): [TileMatrixSet](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/TileMatrixSet/);  
    [tile\_type](#tile_type): "raster" | "raster-dem" | "vector" | "terrain";  
    [type](#type): "mtpkg" | "virtual" | "mbtiles" | "geopackage";  
}

##### Index

### Properties

[@version](#version) [bounds](#bounds) [keyframes](#keyframes) [metadata](#metadata) [spatial\_ref\_sys](#spatial_ref_sys) [tile\_format](#tile_format) [tile\_matrix\_set](#tile_matrix_set) [tile\_type](#tile_type) [type](#type)

## Properties

### @version[](#version)

"@version": string

Version of the specification

### bounds[](#bounds)

bounds: [Bounds](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/Bounds/)

Geographical extent of the tileset representing the bounds (in Mercator units)

### keyframes[](#keyframes)

keyframes: [Keyframe](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/Keyframe/)\[\]

Tileset per time tick

### metadata[](#metadata)

metadata: {  
    bounds: [Bounds](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/Bounds/);  
    center: number\[\];  
    format: "jpeg" | "png" | "webp" | "pbf" | "quantized-mesh-1.0";  
    maxzoom: number;  
    minzoom: number;  
    scale?: number;  
    scheme: string;  
    title: string;  
    weather\_variable: {  
        attribution: string;  
        decoding: { channels: [UsedRgbChannel](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/UsedRgbChannel/); max: number; min: number };  
        description: string;  
        name: string;  
        release\_timestamp: string;  
        timestamp: string;  
        unit: string;  
        variable\_id: [WeatherVariableIDValue](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/WeatherVariableIDValue/);  
    };  
}

#### Type Declaration

-   ##### bounds: [Bounds](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/Bounds/)
    
    Bounds in WGS84
    
-   ##### center: number\[\]
    
    Center of the bounds
    
-   ##### format: "jpeg" | "png" | "webp" | "pbf" | "quantized-mesh-1.0"
    
    Format of the tile
    
-   ##### maxzoom: number
    
    Maximal zool level this tileset contains. Cannot be higher than 22, but mostl likely lower
    
-   ##### minzoom: number
    
    Minimal zoom level this tileset contains. Cannot be lower than 0, but could be higher
    
-   ##### `Optional`scale?: number
    
    Factor of `256` reprensting the size of raster tiles. (`1` means tiles are 256x256px, `2` means 512x512px) The scale is received as a string.
    
-   ##### scheme: string
    
    TODO
    
-   ##### title: string
    
    TODO
    
-   ##### weather\_variable: {  
        attribution: string;  
        decoding: { channels: [UsedRgbChannel](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/UsedRgbChannel/); max: number; min: number };  
        description: string;  
        name: string;  
        release\_timestamp: string;  
        timestamp: string;  
        unit: string;  
        variable\_id: [WeatherVariableIDValue](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/WeatherVariableIDValue/);  
    }
    
    Description of the weather variable
    
    -   ##### attribution: string
        
        Attribution to credit the source for this weather data
        
    -   ##### decoding: { channels: [UsedRgbChannel](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/UsedRgbChannel/); max: number; min: number }
        
        Information to decode the values of this specific weather variable
        
        -   ##### channels: [UsedRgbChannel](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/UsedRgbChannel/)
            
            Channel or combination of image channels that is/are used to encode this weather variable within each tile's pixel.
            
        -   ##### max: number
            
            The minimum value in real world unit. This is mapped to the 255 in the uint8 range.
            
        -   ##### min: number
            
            The minimum value in real world unit. This is mapped to the 0 in the uint8 range.
            
    -   ##### description: string
        
        Human friendly description of this weather variable
        
    -   ##### name: string
        
        Human friendly name of the weather variable (eg. "Temperature")
        
    -   ##### release\_timestamp: string
        
        Release data of the dataset. Date in ISO8601 format.
        
    -   ##### timestamp: string
        
    -   ##### unit: string
        
        Real world unit used for this variable
        
    -   ##### variable\_id: [WeatherVariableIDValue](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/WeatherVariableIDValue/)
        
        Identifier of this weather variable
        

### spatial\_ref\_sys[](#spatial_ref_sys)

spatial\_ref\_sys: [SpatialReferenceSystem](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/SpatialReferenceSystem/)

Description of the tileset's spatial reference system (aka. CRS)

### tile\_format[](#tile_format)

tile\_format: "jpeg" | "png" | "webp" | "pbf" | "quantized-mesh-1.0"

Encoding type of each individual tile

### tile\_matrix\_set[](#tile_matrix_set)

tile\_matrix\_set: [TileMatrixSet](https://docs.maptiler.com/sdk-js/modules/weather/api-reference/types/TileMatrixSet/)

Description of the tile matrix at each zoom level

### tile\_type[](#tile_type)

tile\_type: "raster" | "raster-dem" | "vector" | "terrain"

The type of tile

### type[](#type)

type: "mtpkg" | "virtual" | "mbtiles" | "geopackage"

Type of tileset