Windy Plugins Guide

Appearance

@windy/broadcast ​

Major Windy's event emitter (instance of class Evented), used for announcing the most important events.

Example

js
import broadcast from '@windy/broadcast';

const listener = params => console.log('Params has changed', params);

broadcast.on('redrawFinished', listener );

broadcast.once('metricChanged', params => {
    // This method will be called just once
});

// Do not forget to unsubscribe any listener
broadcast.off('redrawFinished', listener);

// Let's fire some event
broadcast.emit('rqstOpen', 'menu');

Type parameters ​

NameType
Textends keyof Plugins

Hierarchy ​

Table of contents ​

Properties ​

Properties ​

alertChanged ​

• alertChanged: []

Indicates that user added, removed or rename his alert

Inherited from ​

BasicBcastTypes.alertChanged

dependenciesResolved ​

• dependenciesResolved: []

Basically most important broadcast of all, triggered just once, when Windy.com has been successfully loaded and all modules are ready to be consumed

Inherited from ​

BasicBcastTypes.dependenciesResolved

externalPluginChanged ​

• externalPluginChanged: []

Indicates that user added or removed external plugin

Inherited from ​

BasicBcastTypes.externalPluginChanged

favChanged ​

• favChanged: []

Indicates that user added, removed or rename his fav

Inherited from ​

BasicBcastTypes.favChanged

globe-poi-airq ​

• globe-poi-airq: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-airq

globe-poi-cams ​

• globe-poi-cams: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-cams

globe-poi-cities ​

• globe-poi-cities: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-cities

globe-poi-empty ​

• globe-poi-empty: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-empty

globe-poi-favs ​

• globe-poi-favs: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-favs

globe-poi-firespots ​

• globe-poi-firespots: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-firespots

globe-poi-kitespots ​

• globe-poi-kitespots: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-kitespots

globe-poi-metars ​

• globe-poi-metars: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-metars

globe-poi-pgspots ​

• globe-poi-pgspots: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-pgspots

globe-poi-precip ​

• globe-poi-precip: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-precip

globe-poi-radiosonde ​

• globe-poi-radiosonde: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-radiosonde

globe-poi-stations ​

• globe-poi-stations: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-stations

globe-poi-surfspots ​

• globe-poi-surfspots: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-surfspots

globe-poi-temp ​

• globe-poi-temp: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-temp

globe-poi-tide ​

• globe-poi-tide: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-tide

globe-poi-wind ​

• globe-poi-wind: [HTMLElement, MonkeyPatchedFavs]

Inherited from ​

BcastTypesNonGeneric.globe-poi-wind

metricChanged ​

• metricChanged: [MetricIdent, MetricItem]

Indicates that user changed any of the units (wind, temp, ...).

Inherited from ​

BasicBcastTypes.metricChanged

paramsChanged ​

• paramsChanged: [WeatherParameters, keyof WeatherParameters | "path"]

When user changes some parameters (overlay, level, date etc...). Do not not use this event to start any intensive action since Windy now must load and render all the data. We recommend to use redrawFinished instead.

Inherited from ​

BasicBcastTypes.paramsChanged

pluginClosed ​

• pluginClosed: [string]

Plugin was successfully loaded and closed

Inherited from ​

BasicBcastTypes.pluginClosed

pluginHalfOpened ​

• pluginHalfOpened: [keyof Plugins, boolean]

Indicates that mobile ui of plugin using BottomSlide was half opened

Inherited from ​

BasicBcastTypes.pluginHalfOpened

pluginOpened ​

• pluginOpened: [string]

Plugin was successfully closed

Inherited from ​

BasicBcastTypes.pluginOpened

redrawFinished ​

• redrawFinished: [WeatherParameters]

Triggered when Windy has successfully loaded and rendered requested data. Use this for triggering your own tasks.

Inherited from ​

BasicBcastTypes.redrawFinished

redrawLayers ​

• redrawLayers: [] | [{ noCache: boolean }]

Forces various renderers to render layers, for example after reconfiguring color gradient, or changing particle animation settings.

Inherited from ​

BasicBcastTypes.redrawLayers

revealLiveAlertsWarning ​

• revealLiveAlertsWarning: []

Asks the live-alerts app-only warning banner to un-dismiss itself

Inherited from ​

BasicBcastTypes.revealLiveAlertsWarning

routerParsed ​

• routerParsed: [void | `windy-plugin-${string}` | keyof Plugins, ParsedStartupValues]

Indicates that router has parsed new route, used to trigger opening plugins based on url

Inherited from ​

BasicBcastTypes.routerParsed

rqstClose ​

• rqstClose: [string | T]

Request to close plugin (either internal or external)

Inherited from ​

BasicBcastTypes.rqstClose

rqstHalfOpen ​

• rqstHalfOpen: [ident: keyof Plugins, value: boolean, emit: boolean]

Request to half open plugin, used in BottomSlide

Inherited from ​

BasicBcastTypes.rqstHalfOpen

rqstOpen ​

• rqstOpen: [string | T, PluginsOpenParams[T]]

Request to open plugin (either internal or external)

Inherited from ​

BasicBcastTypes.rqstOpen