Map Controller
Object
aeris.wxblox.views.MapControllerData Usage
Raster Maps usage based on size of map and total layers.
A MapController view displays a single MapViewer instance with additional animation and timeline controls for adjusting a map's animation range and current time offsets.
Configuration
The following configuration options are supported by this view:
| Option | Description | Default |
|---|---|---|
viewer | Type: object (undefined)Configuration for the internal MapViewer component. | `` |
timeline | Type: object (undefined)Configuration for the internal Timeline element. | `` |
range | Type: object (undefined)Configuration for the internal range element. | `` |
selectors | Type: object (undefined)An object containing the DOM selectors to use when querying for render targets within the rendered component. | `` |
selectors.viewer | Type: string (undefined)The DOM target where the MapViewer component will be rendered. | |
selectors.timeline | Type: string (undefined)The DOM target where the Timeline will be rendered. | |
selectors.range | Type: string (undefined)The DOM target where the RangeControl will be rendered. | |
selectors.btnAnimate | Type: string (undefined)The DOM target for the MapViewers playback toggle control. | |
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. | |
renderNoData | Type: boolean (undefined)Whether or not the view should be rendered if data was not returned or not available. | |
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:
viewer()timeline()range()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