Threats

Object

aeris.wxblox.views.Threats

Data Usage

The Threats view displays information about threatening weather in or approaching your area, such as precipitation intensity, lightning, hail and other severe weather conditions.

Note: If there are no current threats for the requested location, the result of this request will be empty.

Examples

Display the current nearby or approaching threats for Atlanta, GA:

const view = new aeris.wxblox.views.Threats('#wxblox');
view.load({
    p: 'atlanta,ga'
});

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`enabled`	Type: `boolean` (undefined)Whether or not the view is enabled. If `false` then the view will not be rendered and data required for the view will not be requested. This option is typically only applicable for views contained within a parent layout.	`true`
`metric`	Type: `boolean` (undefined)Whether or not to display units in metric. The method `setUnits()` can be used at runtime once a view has rendered to change the units currently displayed.	`false`
`renderNoData`	Type: `boolean` (undefined)Whether or not the view should be rendered if data was not returned or not available.	`true`
`request`	Type: `object` (undefined)An object containing the default Weather API request options to use for the views's data request where applicable. These parameters can also be overriden in the `load(:params)` method when rendering the view using the JavaScript method.	``

Methods

The following methods are supported by instances of this view:

rendered()

show()

hide()

params()

setUnits(:number)

units()

enabled()

setMetric(:boolean)

load(:object)

refresh()

isMetric()

Events

The following events are triggered by instances of this view:

render

render:before

render:after

load:start

load:done

load:error

change:units

Views