WeatherBlox - Maps Layout

Object

aeris.wxblox.layouts.local.Maps

Data Usage

Raster Maps usage based on size of map and total layers.

The Maps layout displays and manages a MapController view along with a MapListing menu for changing data layers and a map region menu for updating the active bounds for the map.

Examples

Display a weather map view using the default configuration with custom options for layers (MapListing) component:


const view = new aeris.wxblox.layouts.Maps('#wxblox', {
    layers: {
        categories: [],
        codes: ['radar', 'alerts', 'temperatures']
    }
});
view.load();

Display a weather map view using a custom region selector menu and different categories for the maps listing:


const view = new aeris.wxblox.layouts.Maps('#wxblox', {
    layers: {
        categories: ['radar/sat', 'severe', 'observations']
    },
    regions: {
        items: {
            us: {
                label: 'United States'
            },
            region: {
                us: aeris.wxblox.regions.asArray(['usne','usse','usnc','ussc','usnw','ussw'], {
                    label: 'name',
                    value: 'code'
                })
            }
        }
    }
});
view.load();

Configuration

The following configuration options are supported by this view:

Option	Description	Default
`controller`	Type: `object` ()
`controller.viewer`	Type: `object` ()
`controller.viewer.map`	Type: `object` ()
`controller.viewer.map.layers`	Type: `object` ()
`controller.viewer.map.layers.base`	Type: `array` ()	`['flat']`
`controller.viewer.map.layers.data`	Type: `array` ()	`undefined`
`controller.viewer.map.layers.overlays`	Type: `array` ()	`['admin']`
`controller.viewer.map.size`	Type: `object` ()	`{}`
`controller.viewer.map.size.width`	Type: `number` ()	`"auto"`
`controller.viewer.map.size.height`	Type: `number` ()	`"auto"`
`controller.viewer.map.size.factor`	Type: `number` ()	`0.75`
`controller.viewer.animation`	Type: `object` ()
`controller.viewer.animation.enabled`	Type: `boolean` ()	`true`
`controller.viewer.animation.autoplay`	Type: `boolean` ()	`false`
`controller.viewer.animation.alwaysShowPast`	Type: `boolean` ()	`false`
`controller.viewer.animation.alwaysShowFuture`	Type: `boolean` ()	`false`
`controller.viewer.animation.duration`	Type: `number` ()	`2`
`controller.viewer.animation.endDelay`	Type: `number` ()	`1`
`controller.viewer.animation.intervals`	Type: `number` ()	`10`
`controller.viewer.overlays`	Type: `object` ()
`controller.viewer.overlays.timestamp`	Type: `string` ()	`MM/DD/YYYY hh:mm A`
`controller.viewer.overlays.branding`	Type: `object` ()
`controller.viewer.overlays.branding.img`	Type: `string` ()	`undefined`
`controller.viewer.overlays.branding.html`	Type: `string` ()	`undefined`
`controller.range`	Type: `object` ()
`controller.range.intervals`	Type: `string` ()	`-24, -12, -6, -2, 0, 2, 6, 12, 24`
`controller.range.init`	Type: `object` ()
`controller.range.init.from`	Type: `number` ()	`-2`
`controller.range.init.to`	Type: `number` ()	`0`
`regions`	Type: `object` ()	`{}`
`layers`	Type: `object` ()
`layers.categories`	Type: `string` ()	`undefined`
`layers.codes`	Type: `string` ()	`undefined`
`layers.type`	Type: `string` ()	`"list"`
`layers.links`	Type: `boolean` ()	`false`
`selectors`	Type: `object` ()
`selectors.controller`	Type: `string` ()	`.awxs-view-map`
`selectors.regions`	Type: `string` ()	`.awxs-nav-regions`
`selectors.layers`	Type: `string` ()	`.awxs-nav-layers`
`init`	Type: `object` ()
`init.regions`	Type: `object` ()	`{}`
`init.regions.key`	Type: `string` ()	`undefined`
`init.layers`	Type: `object` ()	`{}`
`init.layers.value`	Type: `string` ()	`undefined`
`enabled`	Type: `boolean` ()	`true`
`metric`	Type: `boolean` ()	`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