Windy Plugins Guide

Appearance

@windy/rootScope ​

Global constants and variables used in Windy.

Table of contents ​

Variables ​

Variables ​

airPointProducts ​

• Const airPointProducts: ("mblue" | "gfs" | "ecmwf" | "ecmwfWaves" | "gfsWaves" | "icon" | "cams" | "namConus" | "namHawaii" | "namAlaska" | "iconEu" | "iconD2" | "arome" | "aromeAntilles" | "aromeFrance" | "aromeReunion" | "canHrdps" | "canRdwpsWaves" | "camsEu" | "czeAladin" | "iconEuWaves" | "hrrrAlaska" | "hrrrConus" | "bomAccess" | "bomAccessAd" | "bomAccessBn" | "bomAccessDn" | "bomAccessNq" | "bomAccessPh" | "bomAccessSy" | "bomAccessVt" | "ukv" | "jmaMsm" | "jmaCwmWaves")[]

Point products that have air point forecast

airQualityProducts ​

• Const airQualityProducts: readonly ["cams", "camsEu"]

identifiers of air quality product

assets ​

• Const assets: string

Where all the assets (libs,fonts,plugins,lang files) are located

autoOpenArticleImportance ​

• Const autoOpenArticleImportance: ArticleImportance = 'whatsNew'

Articles of this importance are opened automatically on app start

detailDefaults ​

• Const detailDefaults: Object

Type declaration ​

NameType
forecastDaysLengthnumber
pointFcstDisplayDetailDisplayType

device ​

• Const device: Device = detectDevice.device

Device

fallbackAirProducts ​

• Const fallbackAirProducts: readonly ["gfs", "ecmwf", "jmaMsm", "canHrdps", "iconEu"]

These products are allowed as preferred fallback air product. It is here just for easy typings so feel free to add any

globalPointProducts ​

• Const globalPointProducts: readonly ["mblue", "gfs", "ecmwf", "icon"]

Identifiers of global products, that have point forecast

globalProducts ​

• Const globalProducts: readonly ["gfs", "ecmwf", "ecmwfAnalysis", "radar", "ecmwfWaves", "gfsWaves", "icon", "capAlerts", "avalancheDanger", "cams", "efi", "satellite", "cmems", "drought", "fireDanger", "activeFires", "topoMap"]

Identifiers of global products

iconsDir ​

• Const iconsDir: string

Directory containing latest weather icons

isDesktop ​

• Const isDesktop: boolean

Indicates that that browsing device is desktop

isDesktopOrTablet ​

• Const isDesktopOrTablet: boolean

Indicates that browsing device is tablet or desktop

isMobile ​

• Const isMobile: boolean

IndicatesIndicates that that browsing device is mobile

isMobileOrTablet ​

• Const isMobileOrTablet: boolean

Indicates that browsing device is mobile or tablet

isRetina ​

• Const isRetina: boolean

Indicates that browsing device has retina display

isTablet ​

• Const isTablet: boolean

Indicates that browsing device is tablet

isolinesType ​

• Const isolinesType: readonly ["pressure", "gh", "temp", "deg0"]

List of valid isoline identifiers

Note

this will crash Markdown parser

levels ​

• Const levels: readonly ["surface", "100m", "975h", "950h", "925h", "900h", "850h", "800h", "700h", "600h", "500h", "400h", "300h", "250h", "200h", "150h", "10h"]

Supported list of weather levels

levelsData ​

• Const levelsData:

Valid levels, their identifier and display string

Note

this will crash Markdown parser

localPointProducts ​

• Const localPointProducts: readonly ["namConus", "namHawaii", "namAlaska", "iconD2", "iconEu", "iconEuWaves", "arome", "aromeAntilles", "aromeFrance", "aromeReunion", "canHrdps", "canRdwpsWaves", "camsEu", "czeAladin", "hrrrAlaska", "hrrrConus", "bomAccess", "bomAccessAd", "bomAccessBn", "bomAccessDn", "bomAccessNq", "bomAccessPh", "bomAccessSy", "bomAccessVt", "ukv", "jmaMsm", "jmaCwmWaves"]

identifiers of local products, that have point forecast

localProducts ​

• Const localProducts: readonly ["nems", "namConus", "namHawaii", "namAlaska", "iconEu", "iconD2", "arome", "aromeAntilles", "aromeFrance", "aromeReunion", "canHrdps", "canRdwpsWaves", "camsEu", "czeAladin", "iconEuWaves", "hrrrAlaska", "hrrrConus", "bomAccess", "bomAccessAd", "bomAccessBn", "bomAccessDn", "bomAccessNq", "bomAccessPh", "bomAccessSy", "bomAccessVt", "ukv", "jmaMsm", "jmaCwmWaves"]

Identifier of products that cover only certain area

maxFavPoisDesktop ​

• Const maxFavPoisDesktop: 7

Maximum number of fav POIs displayed in the GUI

overlays ​

• Const overlays: readonly ["radar", "satellite", "wind", "gust", "gustAccu", "turbulence", "icing", "rain", "rainAccu", "snowAccu", "snowcover", "ptype", "thunder", "temp", "dewpoint", "rh", "deg0", "wetbulbtemp", "solarpower", "uvindex", "clouds", "hclouds", "mclouds", "lclouds", "fog", "cloudtop", "cbase", "visibility", "cape", "ccl", "waves", "swell1", "swell2", "swell3", "wwaves", "sst", "currents", "currentsTide", "wavePower", "aqi", "no2", "pm2p5", "aod550", "gtco3", "tcso2", "go3", "cosc", "dustsm", "pressure", "efiTemp", "efiWind", "efiRain", "capAlerts", "avalancheDanger", "soilMoisture40", "soilMoisture100", "moistureAnom40", "moistureAnom100", "drought40", "drought100", "fwi", "dfm10h", "dfm100h", "dfm1000h", "heatmaps", "topoMap", "hurricanes"]

List of valid overlay identifiers

platform ​

• Const platform: Platform = detectDevice.platform

Platform

pluginsLocation ​

• Const pluginsLocation: string

Location of internal Windy plugins

poiGroups ​

• Const poiGroups: Partial<Record<keyof typeof pois, keyof typeof pois[]>>

pointForecastOnlyGlobalProducts ​

• Const pointForecastOnlyGlobalProducts: readonly ["mblue"]

Specific point only produc

pointProducts ​

• Const pointProducts: readonly ["ecmwfWaves", "gfsWaves", "iconEuWaves", "jmaCwmWaves", "canRdwpsWaves", "mblue", "gfs", "ecmwf", "icon", "namConus", "namHawaii", "namAlaska", "iconD2", "iconEu", "iconEuWaves", "arome", "aromeAntilles", "aromeFrance", "aromeReunion", "canHrdps", "canRdwpsWaves", "camsEu", "czeAladin", "hrrrAlaska", "hrrrConus", "bomAccess", "bomAccessAd", "bomAccessBn", "bomAccessDn", "bomAccessNq", "bomAccessPh", "bomAccessSy", "bomAccessVt", "ukv", "jmaMsm", "jmaCwmWaves", "cams", "camsEu"]

Identifiers of all point products combines

pois ​

• Const pois: Object

Valid POI layers, their name and icon

Note

this will crash Markdown parser

Type declaration ​

NameType
airq{ icon: "" = ICON_FACTORY; title: "POI_AIRQ" = 'POI_AIRQ' }
airq.icon""
airq.title"POI_AIRQ"
cams{ icon: "l" = ICON_VIDEO_CAMERA; title: "POI_CAMS" = 'POI_CAMS' }
cams.icon"l"
cams.title"POI_CAMS"
cities{ icon: "&" = ICON_CLOUD_SUN; title: "POI_FCST" = 'POI_FCST' }
cities.icon"&"
cities.title"POI_FCST"
empty{ icon: "t" = ICON_CROSS_MARK; title: "POI_EMPTY" = 'POI_EMPTY' }
empty.icon"t"
empty.title"POI_EMPTY"
favs{ icon: "k" = ICON_HEART; title: "POI_FAVS" = 'POI_FAVS' }
favs.icon"k"
favs.title"POI_FAVS"
firespots{ icon: "" = ICON_FIRE; title: "ACTIVE_FIRES" = 'ACTIVE_FIRES' }
firespots.icon""
firespots.title"ACTIVE_FIRES"
kitespots{ icon: "" = ICON_KITE; title: "POI_KITE" = 'POI_KITE' }
kitespots.icon""
kitespots.title"POI_KITE"
metars{ icon: "Q" = ICON_PLANE; title: "POI_AD" = 'POI_AD' }
metars.icon"Q"
metars.title"POI_AD"
pgspots{ icon: "" = ICON_PARAGLIDER; title: "POI_PG" = 'POI_PG' }
pgspots.icon""
pgspots.title"POI_PG"
precip{ icon: "H" = ICON_UMBRELLA_SMALL; title: "POI_PRECIP" = 'POI_PRECIP'; titleShort: "POI_PRECIP_SHORT" = 'POI_PRECIP_SHORT' }
precip.icon"H"
precip.title"POI_PRECIP"
precip.titleShort"POI_PRECIP_SHORT"
radiosonde{ icon: "" = ICON_RADIOSONDE; title: "POI_RADIOSONDE" = 'POI_RADIOSONDE' }
radiosonde.icon""
radiosonde.title"POI_RADIOSONDE"
stations{ icon: "" = ICON_AIR_SOCK; title: "POI_STATIONS" = 'POI_STATIONS' }
stations.icon""
stations.title"POI_STATIONS"
surfspots{ icon: "{" = ICON_SURFER; title: "POI_SURF" = 'POI_SURF' }
surfspots.icon"{"
surfspots.title"POI_SURF"
temp{ icon: "" = ICON_THERMOMETER_DETAILED; title: "POI_TEMP" = 'POI_TEMP'; titleShort: "POI_TEMP_SHORT" = 'POI_TEMP_SHORT' }
temp.icon""
temp.title"POI_TEMP"
temp.titleShort"POI_TEMP_SHORT"
tide{ icon: "q" = ICON_BOAT; title: "POI_TIDE" = 'POI_TIDE' }
tide.icon"q"
tide.title"POI_TIDE"
wind{ icon: "|" = ICON_WIND; title: "POI_WIND" = 'POI_WIND'; titleShort: "POI_WIND_SHORT" = 'POI_WIND_SHORT' }
wind.icon"|"
wind.title"POI_WIND"
wind.titleShort"POI_WIND_SHORT"

pollenProducts ​

• Const pollenProducts: Record<keyof PollenDataHash2, [longTranslation: keyof LoadedTranslations, shortTranslation: keyof LoadedTranslations]>

products ​

• Const products: readonly ["mblue", "gfs", "ecmwf", "ecmwfAnalysis", "radar", "ecmwfWaves", "gfsWaves", "icon", "capAlerts", "avalancheDanger", "cams", "efi", "satellite", "cmems", "drought", "fireDanger", "activeFires", "topoMap", "nems", "namConus", "namHawaii", "namAlaska", "iconEu", "iconD2", "arome", "aromeAntilles", "aromeFrance", "aromeReunion", "canHrdps", "canRdwpsWaves", "camsEu", "czeAladin", "iconEuWaves", "hrrrAlaska", "hrrrConus", "bomAccess", "bomAccessAd", "bomAccessBn", "bomAccessDn", "bomAccessNq", "bomAccessPh", "bomAccessSy", "bomAccessVt", "ukv", "jmaMsm", "jmaCwmWaves", "cams", "camsEu", "ecmwfWaves", "gfsWaves", "iconEuWaves", "jmaCwmWaves", "canRdwpsWaves"]

Identifiers of all land products combined

seaProducts ​

• Const seaProducts: readonly ["ecmwfWaves", "gfsWaves", "iconEuWaves", "canRdwpsWaves", "cmems", "jmaCwmWaves"]

Identifiers of sea products

server ​

• Const server: string

Server used to download weather data files. DO NOT PUT TRAILING "/" TO THE URL

supportedLanguages ​

• Const supportedLanguages: readonly ["en", "zh-TW", "zh", "ja", "fr", "ko", "it", "ru", "nl", "cs", "tr", "pl", "sv", "fi", "ro", "el", "hu", "hr", "ca", "da", "ar", "fa", "hi", "ta", "sk", "uk", "bg", "he", "is", "lt", "et", "vi", "sl", "sr", "id", "th", "sq", "pt", "nb", "es", "de", "bn"]

List of Windy's supported languages

target ​

• Const target: "index" | "mobile" | "lib" | "embed"

Target

Deprecated

Use TARGET env variable instead.

version ​

• Const version: `${number}.${number}.${number}`

Version of Windy.com client (as taken from package.json)

Deprecated

Use VERSION env variable instead.

waveProducts ​

• Const waveProducts: readonly ["ecmwfWaves", "gfsWaves", "iconEuWaves", "jmaCwmWaves", "canRdwpsWaves"]

Identifiers of wave products, if product is not here, it will be considered as air product