Map Listing

Object

aeris.wxblox.views.MapListing

Data Usage

None

The MapListing view displays a listing or menu of maps based on specific map categories or map types. This view is typically used alongside a MapViewer or MapController view to control the current weather data layers being displayed.

Examples

Display a menu just for layers in the Radar/Satellite category as a simple list:

const view = new aeris.wxblox.views.MapListing('#wxblox', {
    categories: ['radar/sat']
});
view.load();

Display a menu for a specific set of layers as a thumbnail grid:

const view = new aeris.wxblox.views.MapListing('#wxblox', {
    type: 'thumbs',
    codes: ['radar', 'temperatures', 'alerts']
});
view.load();

Display a menu for specific categories and set of layers as a thumbnail grid:

const view = new aeris.wxblox.views.MapListing('#wxblox', {
    type: 'thumbs',
    categories: ['radar/sat'],
    codes: ['alerts', 'stormcells', 'stormreports']
});
view.load();

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`type`	Type: `string` (undefined)The format of the listing, either as a simple vertical list (`list`) or a grid of thumbnails (`thumbs`).	`list`
`categories`	Type: `array` (undefined)An array of map categories to include in the listing.	``
`codes`	Type: `array` (undefined)An array of map layer codes to include in the listing..	``
`links`	Type: `boolean` (undefined)Determines whether or not the component should use links when an item is selected or trigger an event. If set to `false`, you are responsible for updating your page and/or map content based on the selected item in the listing.	`false`
`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:

set(:string)

setRegion(:string)

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:

select

render

render:before

render:after

load:start

load:done

load:error

change:units

Views