Observations

Object

aeris.wxblox.views.Observations

Data Usage

/observations (1)
/alerts (1, when enabled)
/threats (1, when enabled)

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

Examples

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

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

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

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

Configuration

The following configuration options are supported by this view:

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

render

render:before

render:after

load:start

load:done

load:error

change:units

Views