View: Observations

The Observations view displays the current weather conditions for a single location. Additionally, current active weather advisories and threats can be displayed.

JavaScript: Aeris.wxblox.views.Observations

Server Path: views/observations/[place]

Data API/AMP Usage: 1 - 3 API calls based on configuration

Supported Plans API Developer,  API Basic,  API Premium

Configuration

The following configuration options are supported by this view:

Option Default Description
advisories (object) Configuration for the internal advisories view
advisories.enabled true (boolean) Whether or not to include active advisories in the view (requires 1 additional API hit)
threats (object) Configuration for the internal threats view
threats.enabled true (boolean) Whether or not to include current weather threats in the view (requires 1 additional API hit)
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 Aeris 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 (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):

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 the current observations for Minneapolis, MN including advisories and threats as needed:

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

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

<script>
Aeris.wxblox.setAccess('CLIENT_KEY', 'CLIENT_SECRET');

// Insert view / layout code below

var view = new Aeris.wxblox.views.Observations('#wxblox');
view.load({
p: 'minneapolis,mn'
});

// End view / layout code </script>

Display the current observations for Houston, TX including advisories but without threats:

var view = new Aeris.wxblox.views.Observations('#wxblox', {
threats: {
enabled: false
}
});
view.load({
p: 'houston,tx'
});

Display the current observations for Minneapolis, MN including advisories and threats as needed:

$view = new Aeris\WxBlox\View(‘views/observations’, ‘seattle,wa’);
$content = $view->html();
echo $content;

Display the current observations for Houston, TX including advisories but without threats:

$view = new Aeris\WxBlox\View(‘views/observations’, ‘seattle,wa’, array(
‘threats’ => array(
‘enabled’ => false
)
));
$content = $view->html();
echo $content;

Display the current observations for Minneapolis, MN including advisories and threats as needed:
https://wxblox.aerisapi.com/[api_key]/[secret_key]/views/observations/seattle,wa

Display the current observations for Houston, TX including advisories but without threats:
https://wxblox.aerisapi.com/[api_key]/[secret_key]/views/observations/houston,tx?opts=%7B%22threats%22%3A%7B%22enabled%22%3Afalse%7D%7D