Monthly Observations Layout
Object
aeris.wxblox.layouts.local.MonthlyObservations
Data Usage
The MonthlyObservations local layout is a full-page layout containing an embedded ArchiveObservations view to display daily observation summaries for the specified month with additional page controls for changing dates.
![Monthly Observations Layout](/docs/weatherblox/img/layout-monthly-obs.png)
Examples
Display a full daily observation summary view for Seattle, WA for June 2017:
const view = new aeris.wxblox.layouts.local.MonthlyObservations('#wxblox', {
obs: {
range: {
from: '6/1/2017'
}
}
});
view.load({
p: 'seattle,wa'
});
Configuration
The following configuration options are supported by this view:
Option | Description | Default |
---|---|---|
obs | Type: object (undefined)Configuration for the internal ObsHistory component | `` |
months.items | Type: array (undefined)An array of month options to display in the month selector interface element. | `` |
years.from | Type: number (undefined)The starting year for the available range of years the user can select |
|
years.to | Type: number (undefined)The ending year for the available range of years the user can select. If undefined , then the current year will use |
|
years.items | Type: array (undefined)An array of specific years to allow the user to select. If defined, then values for from and to will be ignored. |
|
selectors.years | Type: string (undefined)The DOM selector target for the year selector component |
|
selectors.months | Type: string (undefined)The DOM selector target for the month selector component |
|
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. |
|
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. |
|
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