Air Quality

Object

aeris.wxblox.views.AirQuality

Data Usage

The AirQuality view displays current AQI data for a single location. Additionally, configuration options allow you to access the extended forecast and nearby station views.

Examples

Display current Air Quality Index data for London, UK:

const view = new aeris.wxblox.views.AirQuality('#wxblox');
view.load({
    p: 'london,uk'
});

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`dataType`	Type: `string` (undefined)Configuration for the view to display. Passing `forecast` will render an extended forecast view. Passing `nearby` will render the nearby stations view.	`obs`
`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.	`airnow`
`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.	`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