Air Quality Layout
Object
aeris.wxblox.layouts.local.AirQualityData Usage
The AirQuality local layout provides a full-page layout containing AQI data ranging from current, hourly forecast, and nearby stations. Additionally, this layout includes a Leaflet map with point data for nearby AQI stations.
Examples
Display current Air Quality data for Shanghai, CN
const view = new aeris.wxblox.layouts.local.AirQuality('#wxblox', {
request: {
p: 'shanghai,cn'
}
});
view.load();Configuration
The following configuration options are supported by this view:
| Option | Description | Default |
|---|---|---|
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 overridden in the load(:params) method when rendering the view using the JavaScript method. | `` |
request.filter | Type: string (undefined)Filter that is passed to the Weather API query. You can use india or china for these air quality tiers. See the /airquality endpoint for more details. | |
request.p | Type: string (undefined)The location that air quality data will be requested for. See supported places for more details. | `` |
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