Observations Archive

Object

aeris.wxblox.views.ArchiveObservations

Data Usage

The ArchiveObservations view displays the past weather conditions for a single day (hourly observations) or an entire month (daily summaries) at a particular location.

Examples

Display the observation history for Minneapolis, MN for 5/25/2017:

const view = new aeris.wxblox.views.ArchiveObservations('#wxblox', {
    range: {
        from: '5/25/2017'
    }
});
view.load({
    p: 'minneapolis,mn'
});

Display the daily observation summaries for Houston, TX for the month of December 2016:

const view = new aeris.wxblox.views.ArchiveObservations('#wxblox', {
    summary: true,
    range: {
        from: '12/1/2016'
    }
});
view.load({
    p: 'houston,tx'
});

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`summary`	Type: `boolean` (undefined)Whether or not to display observation summaries (used for monthly history). If `false`, then hourly observations will be displayed.	`false`
`range.from`	Type: `string` (undefined)The starting date to display observation history for in the format `MM/DD/YYYY`. For daily history, use the requested date. For monthly history, the first of the requested month is enforced (e.g. `6/1/2017`).	`{today_date}`
`range.to`	Type: `string` (undefined)(optional) The ending date to display observation history for in the format `MM/DD/YYYY`. This value is typically only used if you want to display a different range other than a single month or day. If `undefined`, this value is automatically calculated for a single month or day based on the value of summary	``
`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`

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