View: Advisories

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.

Use our wizard to customize this view

JavaScript:	`aeris.wxblox.views.Advisories`
Server Path:	`/views/advisories/[place]`
Data API/AMP Usage:	1 /alerts call
Supported Plans	API Developer, API Basic, API Premium

Configuration

The following configuration options are supported by this view:

Option	Default	Description
fullDetails	`false`	(boolean) 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
modal	`true`	(boolean) Whether or not clicking on an advisory title should display advisory details within a modal view. Option is not used when `fullDetails` is `true`
enabled	`true`	(boolean) Whether or not this view is enabled. If `false` then the view will not be rendered and it's required data will not be requested. This option is typically only applicable for views contained within a parent layout.
metric	`false`	(boolean) 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.
renderNoData	`true`	(boolean) Whether or not the view should be rendered if data was not returned or not available
request	`undefined`	(object) An object containing the default AerisWeather 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 (JavaScript method only):

`enabled()`	[boolean] Whether or not the component is currently enabled. When false, the component will not be rendered and data required for the component will not be requested.
`hide()`	Hides the component's DOM element.
`isMetric()`	[boolean] Whether or not the component is currently displaying Metric units.
`load(:object)`	Requests data required by the component and renders the result. For components that don't require remote data requests, this method will call render() immediately. An optional object of request parameters can be provided to use for the request.
`params()`	[object] Returns the latest request parameters used when loading data.
`refresh()`	Re-renders the component using the cached data that was previously loaded.
`rendered()`	[boolean] Whether or not the component has rendered.
`setMetric(:boolean)`	Convenience method for setUnits() to toggle Metric units, where true sets the component's units to Metric and false uses Imperial.
`setUnits(:number)`	Updates the unit type being displayed by the component, where 0 is Imperial and 1 is Metric.
`show()`	Shows the component's DOM element.
`units()`	[number] The current unit type being displayed, where 0 is Imperial and 1 is Metric.

Events

The following events are triggered by instances of this view (JavaScript method only):

`click:advisory`	Triggered when an advisory is clicked/tapped when fullDetails is false. The advisory data and index will be passed to the event's data property.
`change:units`	Triggered when the component's unit type has changed (e.g. metric or imperial).
`load:done`	Triggered after the component's data has loaded but before rendering the component.
`load:error`	Triggered when an error occurs while requesting the component's data.
`load:start`	Triggered immediately before the component's data request begins loading.
`render`	Alias for render:after.
`render:after`	Triggered after the component has rendered and any additional DOM elements and/or events have been setup as needed for the component.
`render:before`	Triggered immediately before the component is rendered, allowing you to access and modify the data used in the template before getting rendered.

Examples

Use the following examples to assist with getting started using this view. Select your WeatherBlox integration method for example code specific to that usage.

JavaScript

API via Package

API via URL

The first example below can be pasted into the body of your HTML document. For each additional snippet, you can replace the snippet within the first example which is located between the JavaScript comments.

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

<link href="https://cdn.aerisapi.com/wxblox/latest/aeris-wxblox.css" rel="stylesheet"/>
<script src="https://cdn.aerisapi.com/wxblox/latest/aeris-wxblox.js"></script>

<!-- DOM target where the WeatherBlox view will be rendered -->
<div id="wxblox"></div>

<script>
const aeris = new AerisWeather('CLIENT_KEY', 'CLIENT_SECRET');
aeris.on('ready', () => {
	// Insert view / layout code below
	var view = new aeris.wxblox.views.Advisories('#wxblox');

	view.load({

	    p: 'seattle,wa'

	});	// End view / layout code
});
</script>

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'

});

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

$view = new Aeris\WxBlox\View(‘views/advisories’, ‘seattle,wa’);

$content = $view->html();

echo $content;

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

$view = new Aeris\WxBlox\View(‘views/advisories’, ‘austin,tx’, array(

	‘fullDetails’ => true

));

$content = $view->html();

echo $content;

Display a minimal view listing only the advisories currently in effect for Seattle, WA:
https://wxblox.aerisapi.com/[api_key]/[secret_key]/views/advisories/seattle,wa

Display full advisory details for advisories currently in effect for Austin, TX:
https://wxblox.aerisapi.com/[api_key]/[secret_key]/views/advisories/austin,tx?opts=%7B%22fullDetails%22%3Atrue%7D

Last modified: March 09, 2020