Almanac

Object

aeris.wxblox.views.Almanac

Data Usage

The Almanac view displays the average weather metrics for the queried location compared to current, and yesterdays, conditions.

Examples

Display current and yesterdays observations compared to the average weather for Boulder, CO.

const view = new aeris.wxblox.views.Almanac('#wxblox');
view.load({
    p: 'boulder,co'
});

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.	``

The following methods are supported by instances of this view:

rendered()

show()

hide()

params()

setUnits(:number)

units()

enabled()

setMetric(:boolean)

load(:object)

refresh()

isMetric()

The following events are triggered by instances of this view:

render

render:before

render:after

load:start

load:done

load:error

change:units