Advisories Layout

Object

aeris.wxblox.layouts.local.Advisories

Data Usage

/places (1)
/alerts (1)
/alerts/summary (1)
Raster Maps usage based on size of map and total layers.

The Advisories layout is a full page layout with detailed information regarding active advisories for a specific location.

Examples

Display the full advisories layout for Houston, TX containing all active advisory details and the default local advisory/radar map:

const view = new aeris.wxblox.layouts.local.Advisories('#wxblox');
view.load({
    p: 'houston,tx'
});

Display the full advisories layout for New York, NY with custom map data layer options:

const view = new aeris.wxblox.layouts.local.Advisories('#wxblox', {
    maps: {
        controls: {
            layers: [{
                code: 'alerts',
                title: 'Advisories'
            },{
                code: 'radar',
                title: 'Radar'
            },{
                code: 'stormreports',
                title: 'Storm Reports'
            }]
        }
    }
});
view.load({
    p: 'new+york,ny'
});

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`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`

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