Layout: Local

The Main local view is a full-page layout containing multiple individual weather blox containing a variety of current and forecast weather information for a single location.

JavaScript: Aeris.wxblox.layouts.local.Main

Server Path: layouts/local/[place]

Data API/AMP Usage: 18 API hits + requested AMP map units usage

Supported Plans API Developer,  API Basic,  API Premium,  AMP Developer,  AMP Basic,  AMP Premium

Configuration

The following configuration options are supported by this view:

Option Default Description
obs (object) Configuration for the internal Observations component
outlook (object) Configuration for the internal Phrases component to display the short term outlook phrasing
obsNearby (object) Configuration for the internal NearbyObs component
almanac (object) Configuration for the internal Almanac component
shortterm (object) Configuration for the internal DayNightForecast component to display the forecast for the next 36 hours
forecast (object) Configuration for the internal Forecast component for full 7 day forecast
maps (object) Configuration for the internal MapViewer component to display local weather map data
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.

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 a full local weather layout view for Seattle, WA:

<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.layouts.local.Main('#wxblox');
view.load({
p: 'seattle,wa'
});

// End view / layout code </script>

Display a full local weather layout view for Seattle, WA:

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

Display a full local weather layout view for Seattle, WA:
https://wxblox.aerisapi.com/[api_key]/[secret_key]/layouts/local/seattle,wa