Calendar

Object

aeris.wxblox.views.Calendar

Data Usage

/places (1)
/observations/summary (1)
/forecasts (1)
/normals (1)

The Calendar component displays past daily summaries alongside extended forecast information for the requested month at a particular location in a calendar layout.

Examples

Display a calendar view for Minneapolis, MN for 9/25/2017:

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

Display the calendar view for Seattle, WA for the month of November 2016:

const view = new aeris.wxblox.views.Calendar('#wxblox', {
    summary: true,
    range: {
        from: '11/1/2016'
    }
});
view.load({
    p: 'seattle,wa'
});

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`range.from`	Type: `string` (undefined)The starting date to display weather data for in the format `MM/DD/YYYY`. Since this is a monthly view, the first of the requested month is enforced (e.g. `6/1/2017`). The default value is today's date resulting in the current month being displayed.	`{today_date}`
`range.to`	Type: `string` (undefined)(optional) The ending date to display weather data 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. If `undefined`, this value is automatically calculated for a single month using the `range.from` value.	``
`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