Windy Plugins Guide

Appearance

Properties used in @windy/store ​

Allowed properties, that can be used in @windy/store methods.

Some of the major items you could be interested in are: overlay, level, availLevels, acTime, timestamp, isolines, product, particlesAnim, hourFormat

Table of contents ​

Properties ​

Properties ​

acTime ​

• acTime: DataSpecificationsObject<"next12h" | "next24h" | "next36h" | "next2d" | "next48h" | "next60h" | "next3d" | "next5d" | "next10d">

Rain/snow accumulated time range. Use store.getAllowed('acTime') to get list of allowed values.

animation ​

• animation: DataSpecificationsObject<boolean>

If timeline animation is running

appLocalStorageCounter ​

• appLocalStorageCounter: DataSpecificationsObject<number>

Counter to synchronize Client and native backup data

appReviewDialogLeaveForLater ​

• appReviewDialogLeaveForLater: DataSpecificationsObject<boolean>

archiveOn ​

• archiveOn: DataSpecificationsObject<boolean>

Satellite/Radar archive on

archiveRange ​

• archiveRange: DataSpecificationsObject<number>

Archive time range in hours

archiveTimestamp ​

• archiveTimestamp: DataSpecificationsObject<number>

Timestamp in ms

availAcTimes ​

• availAcTimes: DataSpecificationsObject<("next12h" | "next24h" | "next36h" | "next2d" | "next48h" | "next60h" | "next3d" | "next5d" | "next10d")[]>

Available accumulation times for give overlay and product combination

availLevels ​

• availLevels: DataSpecificationsObject<("surface" | "100m" | "975h" | "950h" | "925h" | "900h" | "850h" | "800h" | "700h" | "600h" | "500h" | "400h" | "300h" | "250h" | "200h" | "150h" | "10h")[]>

List of levels, that are available for current combination of product and overlay.

availProducts ​

• availProducts: DataSpecificationsObject<("drought" | "radar" | "satellite" | "capAlerts" | "gfs" | "ecmwf" | "ecmwfAnalysis" | "ecmwfAifs" | "ecmwfWaves" | "gfsWaves" | "icon" | "iconWaves" | "cams" | "efi" | "cmems" | "fireDanger" | "activeFires" | "nems" | "namConus" | "namHawaii" | "namAlaska" | "iconEu" | "iconD2" | "arome" | "aromeAntilles" | "aromeReunion" | "canHrdps" | "canRdwpsWaves" | "camsEu" | "iconEuWaves" | "hrrrAlaska" | "hrrrConus" | "bomAccess" | "ukv" | "jmaMsm" | "jmaCwmWaves" | "mblue")[]>

Available product for selected overlay

blitzOn ​

• blitzOn: DataSpecificationsObject<boolean>

Visible lightning data on radar

blitzSoundOn ​

• blitzSoundOn: DataSpecificationsObject<boolean>

Sound for lightning flash effect on radar

calendar ​

• calendar: DataSpecificationsObject<Calendar>

Actual calendar (instance of Calendar) for selected overlay/product (if it has calendar)

camsPreviews ​

• camsPreviews: DataSpecificationsObject<boolean>

display previews of webcams on the map

capDisplay ​

• capDisplay: DataSpecificationsObject<"all" | "today" | "tomm" | "later">

Today, tomm, later

changeDetailOnMapDrag ​

• changeDetailOnMapDrag: DataSpecificationsObject<boolean>

Endable/dissable change of detail location, when map is dragged

connection ​

• connection: DataSpecificationsObject<boolean>

Signals if user is currently online or offline, meaning that he has real internet connection

country ​

• country: DataSpecificationsObject<string>

2 letter lowercase Country Code

detail1h ​

• detail1h: DataSpecificationsObject<boolean>

1h step of forecast

detailExtended ​

• detailExtended: DataSpecificationsObject<boolean>

Detail keeps its 10+ days expanded forecast

detailTimestamp ​

• detailTimestamp: DataSpecificationsObject<number>

Timestamp of detail's progress bar or middleFrame

disableWebGL ​

• disableWebGL: DataSpecificationsObject<boolean>

Is WebGL disabled?

displayHeliports ​

• displayHeliports: DataSpecificationsObject<boolean>

Display Heliports that do not report METARs in the POIs layer

email ​

• email: DataSpecificationsObject<string>

Users email

englishLabels ​

• englishLabels: DataSpecificationsObject<boolean>

Show english map labels instead of localized labels

favPois ​

• favPois: DataSpecificationsObject<Pois[]>

Favourite pois

favPoisMobile ​

• favPoisMobile: DataSpecificationsObject<Pois[]>

Favorite POIs on mobile devices

glParticlesOn ​

• glParticlesOn: DataSpecificationsObject<boolean>

Indicates whether glParticles are on or off

globeActive ​

• globeActive: DataSpecificationsObject<boolean>

Globe plugin is active (used for disabling isolines in overlays plugin)

gpsLocation ​

• gpsLocation: DataSpecificationsObject<GeolocationInfo>

Latest received GPS location

graticule ​

• graticule: DataSpecificationsObject<boolean>

Display graticule over the map

homeLocation ​

• homeLocation: DataSpecificationsObject<HomeLocation>

User selected home location

hourFormat ​

• hourFormat: DataSpecificationsObject<"12h" | "24h">

Time format, Set it to 12h or 24h.

ipLocation ​

• ipLocation: DataSpecificationsObject<GeolocationInfo>

Last defined IP/GPS location

isImperial ​

• isImperial: DataSpecificationsObject<boolean>

Is imperial as default settings (computed property)

isolines ​

• isolines: DataSpecificationsObject<Isolines>

Read only value! UTC string containing time of actually rendered data that are available for current overlay and weather model.

lang ​

• lang: DataSpecificationsObject<"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" | "auto">

Desired language for Windy. By default is determined by user's browser setting and set to auto. Use store.getAllowed('lang') to get list of avail langs defined in `supportedLanguages.

lastModified ​

• lastModified: DataSpecificationsObject<number>

Last modified timestamp of just rendered data (read only)

latlon ​

• latlon: DataSpecificationsObject<boolean>

Display lat/lon on picker

level ​

• level: DataSpecificationsObject<"surface" | "100m" | "975h" | "950h" | "925h" | "900h" | "850h" | "800h" | "700h" | "600h" | "500h" | "400h" | "300h" | "250h" | "200h" | "150h" | "10h">

Level used for actually displayed overlay or isolines.

Can be also used to change level by calling for example store.set('level', 'surface') or store.set('level', '500h')

To get list of available levels for current combination of overlay and data provider use store.get('availLevels')

map ​

• map: DataSpecificationsObject<"sznmap" | "sat" | "winter">

Type of map shown in detail

metarsRAW ​

• metarsRAW: DataSpecificationsObject<boolean>

METARs in raw mode

mobileMenuFilter ​

• mobileMenuFilter: DataSpecificationsObject<MenuItems>

Last selected filter in mobile menu

notams ​

• notams: DataSpecificationsObject<Record<string, number>>

NOTAMs marked as read

numDirection ​

• numDirection: DataSpecificationsObject<boolean>

Display directions in Weather picker as number or as a string (for example NW).

overlay ​

• overlay: DataSpecificationsObject<"ptype" | "fwi" | "uvindex" | "radar" | "satellite" | "wind" | "gust" | "gustAccu" | "turbulence" | "icing" | "rain" | "rainAccu" | "snowAccu" | "snowcover" | "thunder" | "temp" | "dewpoint" | "rh" | "deg0" | "wetbulbtemp" | "solarpower" | "clouds" | "hclouds" | "mclouds" | "lclouds" | "fog" | "cloudtop" | "cbase" | "visibility" | "cape" | "ccl" | "waves" | "swell1" | "swell2" | "swell3" | "wwaves" | "sst" | "currents" | "currentsTide" | "no2" | "pm2p5" | "aod550" | "gtco3" | "tcso2" | "go3" | "cosc" | "dustsm" | "pressure" | "efiTemp" | "efiWind" | "efiRain" | "capAlerts" | "soilMoisture40" | "soilMoisture100" | "moistureAnom40" | "moistureAnom100" | "drought40" | "drought100" | "dfm10h">

Color weather overlay, actually displayed on Windy.com.

Can be also used to change overlay by calling for example store.set('overlay', 'gust') or store.set('overlay', 'rain')

Use store.getAllowed('overlay') to get list of allowed values.

particles ​

• particles: DataSpecificationsObject<CustomParticles>

Particles animation settings

particlesAnim ​

• particlesAnim: DataSpecificationsObject<"off" | "on" | "intensive">

Animation of wind/waves particles over the map. Set value to on, or off if you wan to hide or show them.

pickerLocation ​

• pickerLocation: DataSpecificationsObject<LatLon>

Picker last location

pickerMobileTimeout ​

• pickerMobileTimeout: DataSpecificationsObject<PickerMobileTimeout>

How long should picker-mobile stay open after user interaction

pois ​

• pois: DataSpecificationsObject<Pois>

pois layer that user selected

IMPORTANT: Only user can willingly set his poi layer via clicking on poi control.

Plugins and any other parts oc client code can set only poisTemporary that has limited lifespan

poisTemporary ​

• poisTemporary: DataSpecificationsObject<Pois>

pois layer that was automatically activated by some plugin or any part of the code.

Remember to unset the value to empty when closing plugin.

preferredProduct ​

• preferredProduct: DataSpecificationsObject<"gfs" | "ecmwf" | "icon" | "iconEu">

Global fallback product that handles situation when user pans the map out of bounds of local model. Preferred model must have also second wave mode like 'ecmwf' 👉🏻 'ecmwfWaves'

product ​

• product: DataSpecificationsObject<"drought" | "radar" | "satellite" | "capAlerts" | "gfs" | "ecmwf" | "ecmwfAnalysis" | "ecmwfAifs" | "ecmwfWaves" | "gfsWaves" | "icon" | "iconWaves" | "cams" | "efi" | "cmems" | "fireDanger" | "activeFires" | "nems" | "namConus" | "namHawaii" | "namAlaska" | "iconEu" | "iconD2" | "arome" | "aromeAntilles" | "aromeReunion" | "canHrdps" | "canRdwpsWaves" | "camsEu" | "iconEuWaves" | "hrrrAlaska" | "hrrrConus" | "bomAccess" | "ukv" | "jmaMsm" | "jmaCwmWaves" | "mblue">

Product is set of weather data, that have same resolution, boundaries, time range and so on. For simplification, you can think of product as a weather model. Use store.getAllowed('product') to get list of allowed values.

radarAnimation ​

• radarAnimation: DataSpecificationsObject<boolean>

Animation is running

radarCalendar ​

• radarCalendar: DataSpecificationsObject<RadarCalendar>

Radar calendar

radarRange ​

• radarRange: DataSpecificationsObject<"archive" | "long" | "medium" | "short">

Range of displayed radar history

radarSpeed ​

• radarSpeed: DataSpecificationsObject<"medium" | "slow" | "fast">

Animation speed

radarTimestamp ​

• radarTimestamp: DataSpecificationsObject<number>

Timestamp in ms

rhMenuArrangeMode ​

• rhMenuArrangeMode: DataSpecificationsObject<boolean>

satelliteAnimation ​

• satelliteAnimation: DataSpecificationsObject<boolean>

Satellite animation is running

satelliteCalendar ​

• satelliteCalendar: DataSpecificationsObject<SatelliteCalendar>

Satellite calendar

satelliteExtraOn ​

• satelliteExtraOn: DataSpecificationsObject<boolean>

Extrapolate satellite images to future

satelliteInterpolationOverride ​

• satelliteInterpolationOverride: DataSpecificationsObject<boolean>

this override is needed for video capture

satelliteMode ​

• satelliteMode: DataSpecificationsObject<"BLUE" | "VISIR" | "IRBT" | "DBG">

Satellite visualization modes

satelliteRange ​

• satelliteRange: DataSpecificationsObject<"archive" | "long" | "medium" | "short">

Range of displayed satellite history

satelliteSpeed ​

• satelliteSpeed: DataSpecificationsObject<"medium" | "slow" | "fast">

Animation speed

satelliteTimestamp ​

• satelliteTimestamp: DataSpecificationsObject<number>

Timestamp in ms

showWeather ​

• showWeather: DataSpecificationsObject<boolean>

Show 7 days weather on startup

skipAppReviewNecessaryConditions ​

• skipAppReviewNecessaryConditions: DataSpecificationsObject<boolean>

startUp ​

• startUp: DataSpecificationsObject<"gps" | "ip" | "last" | "location">

Type of startup & location

startUpLastOverlay ​

• startUpLastOverlay: DataSpecificationsObject<boolean>

If true, every overlay change is stored as startUpOverlay

startUpLastPosition ​

• startUpLastPosition: DataSpecificationsObject<MapCoordinates>

Last coords to use in startup

startUpLastProduct ​

• startUpLastProduct: DataSpecificationsObject<"drought" | "radar" | "satellite" | "capAlerts" | "gfs" | "ecmwf" | "ecmwfAnalysis" | "ecmwfAifs" | "ecmwfWaves" | "gfsWaves" | "icon" | "iconWaves" | "cams" | "efi" | "cmems" | "fireDanger" | "activeFires" | "nems" | "namConus" | "namHawaii" | "namAlaska" | "iconEu" | "iconD2" | "arome" | "aromeAntilles" | "aromeReunion" | "canHrdps" | "canRdwpsWaves" | "camsEu" | "iconEuWaves" | "hrrrAlaska" | "hrrrConus" | "bomAccess" | "ukv" | "jmaMsm" | "jmaCwmWaves" | "mblue">

Last product to use in startup

startUpLastStep ​

• startUpLastStep: DataSpecificationsObject<1 | 3>

Save forecast resolution step to be used at startup. 1: 1h step 3: 3h step

startUpOverlay ​

• startUpOverlay: DataSpecificationsObject<"ptype" | "fwi" | "uvindex" | "radar" | "satellite" | "wind" | "gust" | "gustAccu" | "turbulence" | "icing" | "rain" | "rainAccu" | "snowAccu" | "snowcover" | "thunder" | "temp" | "dewpoint" | "rh" | "deg0" | "wetbulbtemp" | "solarpower" | "clouds" | "hclouds" | "mclouds" | "lclouds" | "fog" | "cloudtop" | "cbase" | "visibility" | "cape" | "ccl" | "waves" | "swell1" | "swell2" | "swell3" | "wwaves" | "sst" | "currents" | "currentsTide" | "no2" | "pm2p5" | "aod550" | "gtco3" | "tcso2" | "go3" | "cosc" | "dustsm" | "pressure" | "efiTemp" | "efiWind" | "efiRain" | "capAlerts" | "soilMoisture40" | "soilMoisture100" | "moistureAnom40" | "moistureAnom100" | "drought40" | "drought100" | "dfm10h">

User selected overlay/model

startupReverseName ​

• startupReverseName: DataSpecificationsObject<ReverseResult>

Geo reverse name for purpose of startup location

startupWeatherShown ​

• startupWeatherShown: DataSpecificationsObject<boolean>

Information, if startup weather box is shown or not

stationCompareHiddenProducts ​

• stationCompareHiddenProducts: DataSpecificationsObject<("gfs" | "ecmwf" | "ecmwfAifs" | "icon" | "namConus" | "namHawaii" | "namAlaska" | "iconEu" | "iconD2" | "arome" | "aromeAntilles" | "aromeReunion" | "canHrdps" | "canRdwpsWaves" | "iconEuWaves" | "hrrrAlaska" | "hrrrConus" | "bomAccess" | "ukv" | "jmaMsm" | "jmaCwmWaves" | "mblue")[]>

List of products that users do NOT want to see in the weather station compare mode

timestamp ​

• timestamp: DataSpecificationsObject<number>

Timestamp of actual weather moment. Use freely and without hesitation. Must be valid timestamp in ms, that is in the range of current dataset

Example

js
var fiveHours = 5 * 60 * 60 * 1000
store.set('timestamp', Date.now() + fiveHours )

usedLang ​

• usedLang: DataSpecificationsObject<"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">

Finally used language (the one which is successfully loaded in trans module)

visibility ​

• visibility: DataSpecificationsObject<boolean>

Visibility of window/tab

visibleProducts ​

• visibleProducts: DataSpecificationsObject<("drought" | "radar" | "satellite" | "capAlerts" | "gfs" | "ecmwf" | "ecmwfAnalysis" | "ecmwfAifs" | "ecmwfWaves" | "gfsWaves" | "icon" | "iconWaves" | "cams" | "efi" | "cmems" | "fireDanger" | "activeFires" | "nems" | "namConus" | "namHawaii" | "namAlaska" | "iconEu" | "iconD2" | "arome" | "aromeAntilles" | "aromeReunion" | "canHrdps" | "canRdwpsWaves" | "camsEu" | "iconEuWaves" | "hrrrAlaska" | "hrrrConus" | "bomAccess" | "ukv" | "jmaMsm" | "jmaCwmWaves" | "mblue")[]>

Products available for given map boundary

webcamsDaylight ​

• webcamsDaylight: DataSpecificationsObject<boolean>

display webcams on daylight

zuluMode ​

• zuluMode: DataSpecificationsObject<boolean>

Display all times in UTC