Local Layout
Object
aeris.wxblox.layouts.local.MainData Usage
/places (2)
/observations (5)
/alerts (1)
/threats (1)
/phrases/summary (1)
/forecasts (3)
/observations/summary (2)
/sunmoon (1)
/normals (1)
Raster Maps usage based on size of map and total layers.
/observations (5)
/alerts (1)
/threats (1)
/phrases/summary (1)
/forecasts (3)
/observations/summary (2)
/sunmoon (1)
/normals (1)
Raster Maps usage based on size of map and total layers.
The Main local view is a full-page layout containing multiple individual weather blox containing a variety of current and forecast weather information for a single location.
Examples
Display a full local weather layout view for Seattle, WA:
const view = new aeris.wxblox.layouts.local.Main('#wxblox');
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 Observations component | `` |
outlook | Type: object (undefined)Configuration for the internal Phrases component to display the short term outlook phrasing | `` |
obsNearby | Type: object (undefined)Configuration for the internal NearbyObs component | `` |
almanac | Type: object (undefined)Configuration for the internal Almanac component | `` |
shortterm | Type: object (undefined)Configuration for the internal DayNightForecast component to display the forecast for the next 36 hours | `` |
forecast | Type: object (undefined)Configuration for the internal Forecast component for full 7 day forecast | `` |
maps | Type: object (undefined)Configuration for the internal MapViewer component to display local weather map data | `` |
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:
renderrender:beforerender:afterload:startload:doneload:errorchange:units