Advisories

Object

aeris.wxblox.views.Advisories

Data Usage

The Advisories view displays currently active alerts for a single location within the United States. Additional details about any active alerts can be viewed either modally from this view or using a static link to another URL depending on the view's configuration.

Examples

Display a minimal view listing only the advisories currently in effect for Seattle, WA.

const view = new aeris.wxblox.views.Advisories('#wxblox');
view.load({
    p: 'seattle,wa'
});

Display full advisory details for advisories currently in effect for Austin, TX.

var view = new aeris.wxblox.views.Advisories('#wxblox', {
    fullDetails: true
});
view.load({
    p: 'austin,tx'
});

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`fullDetails`	Type: `boolean` (undefined)Whether or not full body details for each advisory are displayed. If `false`, then the component will just display a minimal element with just advisory names and timestamps	`false`
`modal`	Type: `boolean` (undefined)Whether or not clicking on an advisory title should display advisory details within a modal view. Option is not used when `fullDetails` is `true`	`true`
`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:

click:advisory

render

render:before

render:after

load:start

load:done

load:error

change:units

Views