Aeris.js Documentation

The Aeris Weather API is one of the most complete and advanced weather APIs available and quickly gives you access to many different types of weather information.

Out of the box, Aeris.js provides a suite of tools for rendering weather maps and widgets, and using data from the Aeris API. Maps can be rendered using the Google Maps API or OpenLayers.

Usage of the Aeris API requires an Aeris API developer account. Visit hamweather.com to sign up for a free account.

    
/**
 * Aeris.js is currently in beta release.
 * While we will make our best efforts to maintain a stable API,
 * minor changes may be made to the interface while Aeris.js
 * is still in beta.
 *
 *
 * We would love to hear your feedback, thoughts, and dreams for
 * this library.
 *
 * Hey, why not contribute yourself, then open a pull request?!
 */

Downloads

There are several hosted versions of the Aeris.js library, each with a varying set of features.

Weather for Google Maps	Render weather tile layers and data using Google Maps. ~37k gzipped.
Weather for Google Maps +	Includes additional APIs for geolocation, geocoding, and directions. ~39k gzipped.
Weather API only	A javascript interface for the Aeris Weather API.
Weather for OpenLayers	Render weather tile layers and data using OpenLayers. (Coming soon!)

From a CDN

Aeris.js packages are also available from a CDN:

    
<!-- Weather for Google Maps -->
<script type="text/javascript"
        src="//cdn.aerisjs.com/gmaps.min.js">
</script>

<!-- Weather for Google Maps + -->
<script type="text/javascript"
        src="//cdn.aerisjs.com/gmaps-plus.min.js">
</script>

<!-- Weather API Only -->
<script type="text/javascript"
        src="//cdn.aerisjs.com/gmaps-plus.min.js">
</script>

<!-- Most recent Google Maps + build-->
<script type="text/javascript"
        src="//cdn.aerisjs.com/gmaps-plus.min.js">
</script>

Using AMD modules

Aeris.js uses RequireJS to load modules and components. Using RequireJS (or a compatible AMD Loader you can pick and choose which Aeris.js components you would like to use.

See the Aeris.js installation guide on Github for more information on using Aeris.js AMD modules.

Getting Started

Aeris.js provides a simple interface for rendering weather data on a map.


    // Create your map and map overlay objects
var map = new aeris.maps.Map('map-canvas');
var radar = new aeris.maps.layers.Radar();
var earthquakeMarkers = new aeris.maps.markercollections.EarthquakeMarkers()

// Configure your API Keys
aeris.config.set({
  apiId: 'my-api-id',
  apiSecret: 'my-api-secret'
});

// Add your map objects to the map
radar.setMap(map);
earthquakeMarkers.setMap(map);

// Fetch earthquake data
earthquakeMarkers.fetchData();

// Manipulate map objects
radar.setOpacity(0.5);
earthquakeMarkers.on('click', function(latLon, marker) {
  alert('Magnitude ' + marker.getDataAttribute('report.mag') + ' earthquake.');
});

// Query the Aeris API
// Markers will be redrawn when
// the API responds.
earthquakeMarkers.setParams({
  query: 'mag:3.0:5.0'
});
earthquakeMarkers.fetchData();

See our Github page for for more usage examples.

Get an API Key

The Aeris Weather API requires an API key. You can get a free developer key at hamweather.com.

api

.Advisories

constructor

new aeris.api.collections.Advisories(opt_models, opt_options, clientLimit, clientFilter);

Parameter	Type	Description
`opt_models`	Array.<Model>=
`opt_options`	Object=
`clientLimit`	Number=	Max number of models to retain in the client collection.
`clientFilter`	function(AerisApiModel):Boolean	Filter to apply to the client collection.

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.Earthquakes

A representation of earthquake data from the
Aeris API 'earthquake' endpoint.

constructor

new aeris.api.collections.Earthquakes();

methods

Method	Return value	Description
`parse()`

.Fires

A representation of fire data from the
Aeris API 'fires' endpoint.

constructor

new aeris.api.collections.Fires();

methods

Method	Return value	Description
`parse()`

.Lightning

A representation of lighting data from the
Aeris API 'lightning' endpoint.

constructor

new aeris.api.collections.Lightning();

methods

Method	Return value	Description
`parse()`

.Normals

constructor

new aeris.api.collections.Normals(opt_models, opt_options, clientLimit, clientFilter);

Parameter	Type	Description
`opt_models`	Array.<Model>=
`opt_options`	Object=
`clientLimit`	Number=	Max number of models to retain in the client collection.
`clientFilter`	function(AerisApiModel):Boolean	Filter to apply to the client collection.

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.Observations

constructor

new aeris.api.collections.Observations(opt_models, opt_options, clientLimit, clientFilter);

Parameter	Type	Description
`opt_models`	Array.<Model>=
`opt_options`	Object=
`clientLimit`	Number=	Max number of models to retain in the client collection.
`clientFilter`	function(AerisApiModel):Boolean	Filter to apply to the client collection.

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.Places

constructor

new aeris.api.collections.Places(opt_models, opt_options, clientLimit, clientFilter);

Parameter	Type	Description
`opt_models`	Array.<Model>=
`opt_options`	Object=
`clientLimit`	Number=	Max number of models to retain in the client collection.
`clientFilter`	function(AerisApiModel):Boolean	Filter to apply to the client collection.

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.Records

constructor

new aeris.api.collections.Records(opt_models, opt_options, clientLimit, clientFilter);

Parameter	Type	Description
`opt_models`	Array.<Model>=
`opt_options`	Object=
`clientLimit`	Number=	Max number of models to retain in the client collection.
`clientFilter`	function(AerisApiModel):Boolean	Filter to apply to the client collection.

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.StormCells

constructor

new aeris.api.collections.StormCells(opt_models, opt_options, clientLimit, clientFilter);

Parameter	Type	Description
`opt_models`	Array.<Model>=
`opt_options`	Object=
`clientLimit`	Number=	Max number of models to retain in the client collection.
`clientFilter`	function(AerisApiModel):Boolean	Filter to apply to the client collection.

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.StormReports

A representation of storm report data from the
Aeris API 'stormreports' endpoint.

constructor

new aeris.api.collections.StormReports();

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.Tides

constructor

new aeris.api.collections.Tides(opt_models, opt_options, clientLimit, clientFilter);

Parameter	Type	Description
`opt_models`	Array.<Model>=
`opt_options`	Object=
`clientLimit`	Number=	Max number of models to retain in the client collection.
`clientFilter`	function(AerisApiModel):Boolean	Filter to apply to the client collection.

methods

Method	Return value	Description
`setClientFilter(filter: Function():Boolean , opt_ctx: Object= )`		Apply a client-side filter to the collection.
`removeClientFilter()`		Remove all client-side filters from the collection.
`removeClientLimit()`
`getParams()`	Params	Returns the params object used to fetch collection data.
`setParams(key: String\|Object , value: * )`		Updates the requests params included with API requests.
`setFrom(from: Date )`
`setTo(to: Date )`
`setLimit(limit: Number )`
`setBounds(bounds: Bounds )`
`addFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
`removeFilter(filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`resetFilter(opt_filter: string\|Array.<string>\|Filter\|FilterCollection , opt_options: Object= )`		Reset a filter from the Aeris API request. Filters will also be applied client-side, if possible.
`addQuery(query: Query\|Array.<Query> , opt_options: Object= )`		Add a query term to Aeris API request.
`removeQuery(query: Query\|Array.<Query>\|string\|Array.<string> , opt_options: Object= )`		Remove a query from the Aeris API request
`resetQuery(opt_query: Query\|Array.<Query>= , opt_options: Object= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`fetch()`	Promise	Fetch data from the Aeris API. Resolves with API response.

events

Event	Parameters	Description
`'request'`	`object: AerisApiBehavior promise: Promise requestOptions: Object`	A request has been made to fetch data from the Aeris API.
`'sync'`	`object: AerisApiBehavior resp: Object requestOptions: Object`	The AerisAPI has responsed to a request, and the data object has updated with fetched data.

.Advisory

aeris.api.models.Advisory
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.Advisory();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.Earthquake

aeris.api.models.Earthquake
extends aeris.api.models.PointData

constructor

new aeris.api.models.Earthquake();

methods

Method	Return value	Description
`parse()`
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.

.Fire

aeris.api.models.Fire
extends aeris.api.models.PointData

constructor

new aeris.api.models.Fire();

methods

Method	Return value	Description
`parse()`
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.

.Forecast

aeris.api.models.Forecast
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.Forecast();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.Lightning

aeris.api.models.Lightning
extends aeris.api.models.PointData

Represents a lightning data response from the AerisApi

constructor

new aeris.api.models.Lightning();

methods

Method	Return value	Description
`parse()`
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.

.Normal

aeris.api.models.Normal
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.Normal();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.Observation

constructor

new aeris.api.models.Observation();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.Place

aeris.api.models.Place
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.Place();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.Record

aeris.api.models.Record
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.Record();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.StormCell

aeris.api.models.StormCell
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.StormCell();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.StormReport

aeris.api.models.StormReport
extends aeris.api.models.PointData

constructor

new aeris.api.models.StormReport();

methods

Method	Return value	Description
`parse()`
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.

.Sunmoon

aeris.api.models.Sunmoon
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.Sunmoon();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

.Tide

aeris.api.models.Tide
extends aeris.api.models.AerisApiModel

constructor

new aeris.api.models.Tide();

methods

Method	Return value	Description
`testFilter(filter: String )`	Boolean	Tests whether a model is passing an Aeris API filter.
`testFilterCollection(filters: FilterCollection )`	Boolean	Tests whether a model is passing a set of Aeris API filters.
`parse()`

geocode

.GoogleGeocodeService

aeris.geocode.GoogleGeocodeService

constructor

new aeris.geocode.GoogleGeocodeService();

methods

Method	Return value	Description
`geocode(location: String )`	Promise	A promise to return a lat/lon for the geocoded location.

.MapQuestGeocodeService

aeris.geocode.MapQuestGeocodeService

MapQuest Geocoding Service
See http://open.mapquestapi.com/geocoding

constructor

new aeris.geocode.MapQuestGeocodeService(opt_options);

Parameter	Type	Description
`opt_options`	Object=

methods

Method	Return value	Description
`geocode()`
`setJSONP(jsonp: Object )`		Set jsonp service

geolocate

.FreeGeoIPGeolocateService

aeris.geolocate.FreeGeoIPGeolocateService

constructor

new aeris.geolocate.FreeGeoIPGeolocateService(opt_options);

Parameter	Type	Description
`opt_options`	FreeGeoIPServiceOptions

methods

Method	Return value	Description
`getCurrentPosition()`	Promise	A promise to retrieve the user's current position. Promise resolves with a GeolocatePosition object. Promise rejects with a GeolocateServiceError object.
`watchPosition(onsuccess: Function , onerror: Function , opt_options: Object= )`
`clearWatch()`		Stop watching for a changed position.
`isSupported()`

.HTML5GeolocateService

aeris.geolocate.HTML5GeolocateService

constructor

new aeris.geolocate.HTML5GeolocateService(opt_options);

Parameter	Type	Description
`opt_options`	HTML5ServiceOptions=

methods

Method	Return value	Description
`getCurrentPosition()`	Promise	A promise to retrieve the user's current position. Promise resolves with a GeolocatePosition object. Promise rejects with a GeolocateServiceError object.
`watchPosition(onsuccess: Function , onerror: Function , opt_options: Object= )`
`clearWatch()`		Stop watching for a changed position.
`isSupported(opt_navigator: Navigator= )`
`setNavigator(navigator: Navigator )`

.GeolocatePosition

aeris.geolocate.results.GeolocatePosition

Follows HTML5 Postion object specification,
except for the latLon property, which uses the aeris-standard format.

Some position properties may be unavailable - if using
a IP location service, for example. In this case, their
values will be null.

constructor

new aeris.geolocate.results.GeolocatePosition(position);

Parameter	Type	Description
`position`	Object	Gelocated position.

maps

.InfoBox

Representation of an Info Box.

constructor

new aeris.maps.InfoBox(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`setPosition(position: LatLon )`		Set the lat/lon location of the InfoBox on the map.
`setContent(content: String\|HTMLElement )`		Set the HTML content of the InfoBox
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Map

aeris.maps.Map
extends aeris.maps.extensions.MapExtensionObject

An Aeris Map is the base object on which all other map objects live. Any MapObjectInterface object can be added to a map using the `setMap` method:


  var map = new aeris.maps.Map('map-canvas-id');
  mapObject.setMap(map);  // adds the object to the map
  mapobject.setMap(null); // removes the object from the map


Marker and AerisRadar are examples of MapObjectInterface objects which can be set to a map.

constructor

new aeris.maps.Map(el, opt_attrs, opt_options);

Parameter	Type	Description
`el`	HTMLElement\|string	Map canvas element, by reference or id.
`opt_attrs`	Object=	Attributes to set on the map on initialization
`opt_options`	Object=

methods

Method	Return value	Description
`setBounds(bounds: Bounds )`
`getBounds()`	Bounds
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`setCenter(center: LatLon )`
`getCenter()`	LatLon
`setZoom(zoom: Number )`
`getZoom()`	Number
`setBaseLayer(baseLayer: Layer )`
`getBaseLayer()`	Layer
`getElement()`	HTMLElement	Note that this may return unexpected results when the map was created with a view instance, instead of an HTMLElement. The map canvas element
`updateSize()`		To be used when the map canvas element has changed dimensions. This will tell the underlying mapping strategy to refresh appropriately (eg. load new tile images to account for a larger map).
`validate()`
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`destroy()`

events

Event	Parameters	Description
`click`	`latLon: LatLon`
`dblclick`	`latLon: LatLon`
`load`		When base map tiles are loaded.
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.AnimationSync

Animates multiple layers along a single timeline.
Works by running a single 'master' animation, and having
all other animations go to the same time as the master.

The master animation is dynamically set as the animation
with the shortest average interval between time frames. You can
manually set the master animation using the setMaster method, as well.

constructor

new aeris.maps.animations.AnimationSync(opt_options, opt_animations, opt_options.AnimationType_);

Parameter	Type	Description
`opt_options`	Object
`opt_animations`	Array<AnimationLayer\|AnimationInterface>=	Layers/Animations to sync. Animations can also be added using the `add` method.
`opt_options.AnimationType_`	function():AnimationInterface	The type (constructor) of animation object to create when adding a layer to the AnimationSync.

methods

Method	Return value	Description
`preload()`	Promise	Begin preloading assets required to run the animation. Resolves when preloading is complete.
`add(animations_or_layers: Array.<AnimationInterface\|AnimationLayer> )`		Add one or more animations to the sync.
`remove(animations: AnimationInterface\|Array.<AnimationInterface> )`		Stop syncing one or more animations
`getLoadProgress()`	Number	Get the total loading progress of animations within the animation sync. Only considers animations which are set to the map.
`next()`	Undefined	Go to the next step in the animation.
`previous()`	Undefined	Go to the previous step in the animation.
`goToTime(time: Number )`		Go to a specific time in the animation.
`getTimes()`	Array.<number>	UNIX timestamps. Sorted list of availble animation times.
`start()`	Undefined	Start the animation.
`getCurrentTime()`	?Date	Current time of the animation. Returns null if the animation has not yet initialized.
`stop()`	Undefined	Stop the animation.
`pause()`	Undefined	Pause the animation.
`setSpeed(speed: Number )`		Set the animation speed. Every second, [timestep] * [speed] milliseconds of tiles are animated. So with a timestep of 360,000 (6 minutes), and a speed of 2: every second, 12 minutes of tiles will be animated. Setting a negative speed will cause the animation to run in reverse. Also see AbstractAnimation#setTimestamp
`setTimestep(timestep: Number )`		Sets the animation timestep. See AbstractAnimation#setSpeed for more information on how to use setTimestep and setSpeed to affect your animation speed.
`setFrom(from: Date\|number )`
`getFrom()`	Date
`setTo(to: Date\|number )`
`getTo()`	Date
`isAnimating()`	Boolean
`hasMap()`	Boolean	Is the animated object set to a map?

events

Event	Parameters	Description
`autoUpdate`
`load:complete`		Fires when all animation tile frames are loaded. Waiting to start an animation until this event is triggered will ensure smooth animations. If an animation is started before all tile frames are loaded, tiles which are not yet loaded will not render until they are loaded.
`load:progress`	`Percent: Number`	Fires to indicate progress in preloading tiles. Useful for rendering loading UI to the user, or if you want to buffer an animation to a certain % done.
`load:error`	`error: Error`
`load:times`	`A: Array.<number>`	Fires when tile times are loaded for this animation.
`change:time`	`time: Date`	When current time of the animation changes.
`change:from`	`from: Date`
`change:to`	`to: Date`

.TileAnimation

Animates a single AerisTile layer.

constructor

new aeris.maps.animations.TileAnimation(layer, opt_options);

Parameter	Type	Description
`layer`	AerisTile	The layer to animate.
`opt_options`	AnimationOptions

methods

Method	Return value	Description
`loadAnimationLayers()`	Promise	Load the tile layers for the animation. Promise to load all layers.
`preload()`	Promise	Begin preloading assets required to run the animation. Resolves when preloading is complete.
`next()`	Undefined	Go to the next step in the animation.
`previous()`	Undefined	Go to the previous step in the animation.
`goToTime(time: Number )`		Go to a specific time in the animation.
`getLoadProgress()`	Number	Percentage complete loading tile (1.0 is 100% complete).
`hasMap()`	Boolean	Is the animated object set to a map?
`destroy()`		Destroys the tile animation object, clears animation frames from memory.
`getTimes()`	Array.<number>	Returns available times. Note that times are loaded asynchronously from the Aeris Interactive Tiles API, so they will not be immediately available. Wait for the 'load:times' event to fire before attempting to grab times. An array timestamps for which they are available tile frames.
`start()`	Undefined	Start the animation.
`getCurrentTime()`	?Date	Current time of the animation. Returns null if the animation has not yet initialized.
`stop()`	Undefined	Stop the animation.
`pause()`	Undefined	Pause the animation.
`setSpeed(speed: Number )`		Set the animation speed. Every second, [timestep] * [speed] milliseconds of tiles are animated. So with a timestep of 360,000 (6 minutes), and a speed of 2: every second, 12 minutes of tiles will be animated. Setting a negative speed will cause the animation to run in reverse. Also see AbstractAnimation#setTimestamp
`setTimestep(timestep: Number )`		Sets the animation timestep. See AbstractAnimation#setSpeed for more information on how to use setTimestep and setSpeed to affect your animation speed.
`setFrom(from: Date\|number )`
`getFrom()`	Date
`setTo(to: Date\|number )`
`getTo()`	Date
`isAnimating()`	Boolean

events

Event	Parameters	Description
`load:complete`		Fires when all animation tile frames are loaded. Waiting to start an animation until this event is triggered will ensure smooth animations. If an animation is started before all tile frames are loaded, tiles which are not yet loaded will not render until they are loaded.
`load:progress`	`Percent: Number`	Fires to indicate progress in preloading tiles. Useful for rendering loading UI to the user, or if you want to buffer an animation to a certain % done.
`load:error`	`error: Error`
`load:times`	`A: Array.<number>`	Fires when tile times are loaded for this animation.
`change:time`	`time: Date`	When current time of the animation changes.
`change:from`	`from: Date`
`change:to`	`to: Date`

.AnimationOptions

aeris.maps.animations.options.AnimationOptions

constructor

new aeris.maps.animations.options.AnimationOptions();

.Marker

A marked location on a map.

A Marker is a type of ViewModel, which means that it can bind its attributes to a data model (Model or Backbone.Model). This allows you to easily bind data from an API to a marker, or MarkerCollection.

For example, say you have a data model called `Place`, which receives data from an API like so:


   var place = new Place();
   place.fetch();
   //...
   place.toJSON === {
     id: 1,
     description: 'Joe\'s bar and grill.',
     category: 'restaurant',
     location: {
       lat: 45.23,
       long: -90.87
     }
   }


You can now bind a Marker to the place data:


   var placeMarker = new aeris.maps.Marker(null, {
     data: place,

     // Use attribute transforms to translate raw data
     // into marker attributes.
     // Any changes to the Place model will be reflected
     // in the placeMarker, using these attributeTransforms.
     attributeTransforms: {

       // Format position as [lat, lon]
       position: function() {
         return [
           this.getDataAttribute('location.lat'),
           this.getDataAttribute('location.long')
         ];
       },

       // Use data description as marker title
       title: function() {
         return this.getDataAttribute('description');
       },

       // Choose a icon url based on the
       // data category
       url: function() {
         var category = this.getDataAttribute('category');

         if (category === 'restaurant') {
           return 'restaurant_icon.png';
         }
         else {
           return 'some_other_place_icon.png'
         }
       }
     }
   });

constructor

new aeris.maps.markers.Marker(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`setPosition(latLon: LatLon )`
`getPosition()`	LatLon
`setUrl(url: String )`
`getUrl()`	String	Return the url of the marker icon.
`setSelectedUrl(selectedUrl: String )`
`getSelectedUrl()`	String
`getType()`	?string	This method method may be overriden to return an arbitrary "type" category for the marker. Used by MarkerClusterer strategies to split up a single MarkerColection into several cluster sets.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`click`	`latLon: LatLon marker: Marker`
`dragend`	`latLon: LatLon marker: Marker`
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.EarthquakeMarker

constructor

new aeris.maps.markers.EarthquakeMarker(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`getType()`	String	The type category of this marker. Generally, corresponds to a data filter.
`validate()`
`setPosition(latLon: LatLon )`
`getPosition()`	LatLon
`setUrl(url: String )`
`getUrl()`	String	Return the url of the marker icon.
`setSelectedUrl(selectedUrl: String )`
`getSelectedUrl()`	String
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`click`	`latLon: LatLon marker: Marker`
`dragend`	`latLon: LatLon marker: Marker`
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.FireMarker

constructor

new aeris.maps.markers.FireMarker(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`getType()`	String	The type category of this marker. Generally, corresponds to a data filter.
`validate()`
`setPosition(latLon: LatLon )`
`getPosition()`	LatLon
`setUrl(url: String )`
`getUrl()`	String	Return the url of the marker icon.
`setSelectedUrl(selectedUrl: String )`
`getSelectedUrl()`	String
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`click`	`latLon: LatLon marker: Marker`
`dragend`	`latLon: LatLon marker: Marker`
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.LightningMarker

constructor

new aeris.maps.markers.LightningMarker(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`getType()`	String	The type category of this marker. Generally, corresponds to a data filter.
`validate()`
`setPosition(latLon: LatLon )`
`getPosition()`	LatLon
`setUrl(url: String )`
`getUrl()`	String	Return the url of the marker icon.
`setSelectedUrl(selectedUrl: String )`
`getSelectedUrl()`	String
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`click`	`latLon: LatLon marker: Marker`
`dragend`	`latLon: LatLon marker: Marker`
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.StormReportMarker

constructor

new aeris.maps.markers.StormReportMarker(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`getType()`	String	The type category of this marker. Generally, corresponds to a data filter.
`validate()`
`setPosition(latLon: LatLon )`
`getPosition()`	LatLon
`setUrl(url: String )`
`getUrl()`	String	Return the url of the marker icon.
`setSelectedUrl(selectedUrl: String )`
`getSelectedUrl()`	String
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`click`	`latLon: LatLon marker: Marker`
`dragend`	`latLon: LatLon marker: Marker`
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.MarkerCollection

A collection of Marker objects.

By default, marker collections are rendered using a clustering strategy (eg MarkerClustererPlus for google maps).

A MarkerCollection is a type of ViewCollection, which means that it can bind its attributes to a data collection (Collection or Backbone.Collection). Any changes, additions, or deletions to the bound data collection will be reflected in the marker collection.

See Marker documentation for more information on transforming raw data into marker attributes. Note that `attributeTransforms` can be set directly on the MarkerCollection object using the `modelOptions` option:


   var markers = new aeris.maps.markercollections.MarkerCollection(null, {
     modelOptions: {
       attributeTransforms: {
         // ...
       }
     }
   });

constructor

new aeris.maps.markercollections.MarkerCollection(opt_markers, opt_options);

Parameter	Type	Description
`opt_markers`	Array.<Marker>=	Markers to add to the collection.
`opt_options`	Object=

methods

Method	Return value	Description
`getClusterStyle(opt_group: String= )`	Object	Returns a copy of the cluster styles for the specified cluster group. Cluster styles object.
`getClusterOptions()`	Object
`startClustering()`		Starts up the strategy defined by this.clusterStrategy_.
`stopClustering()`		Destroys the clustering strategy started up by #startClustering.
`setMap()`		Set the map on all child MapObjects. Any newly created map objects will be instantiated with the map set here.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean
`_onModelEvent()`		From Backbone.Collection#_onModelEvent

events

Event	Parameters	Description
`cluster:click`	`latLon: LatLon`
`cluster:mouseover`	`latLon: LatLon`	When the mouse enters a cluster.
`cluster:mouseout`	`latLon: LatLon`	When the mouse exits a cluster.
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.EarthquakeMarkers

constructor

new aeris.maps.markercollections.EarthquakeMarkers(opt_markers, opt_options);

Parameter	Type	Description
`opt_markers`	Array.<Marker>=	Markers to add to the collection.
`opt_options`	Object=

methods

Method	Return value	Description
`getParams()`	Params	Return params used to query the Aeris API.
`setParams(params: Object )`		Set params used to query the Aeris API.
`setFrom(from: Date )`		Set the `from` parameter for querying the Aeris API.
`setTo(to: Date )`		Set the `to` parameter for querying the Aeris API.
`setBounds(bounds: Bounds )`		Set the latLon bounds for querying the Aeris API.
`addFilter(filter: string\|Array.<string> )`		Add a filter to the Aeris API request.
`removeFilter(filter: string\|Array.<string> )`		Remove a filter from the Aeris API request.
`resetFilter(opt_filter: string\|Array.<string>= )`		Reset a filter from the Aeris API request.
`addQuery(query: Query\|Array.<Query> )`		Add a query term to Aeris API request.
`removeQuery(Query: Query\|Array.<Query>\|string\|Array.<string> )`		Remove a query from the Aeris API request
`resetQuery(opt_replacementQuery: Query\|Array.<Query>= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`getClusterStyle(opt_group: String= )`	Object	Returns a copy of the cluster styles for the specified cluster group. Cluster styles object.
`getClusterOptions()`	Object
`startClustering()`		Starts up the strategy defined by this.clusterStrategy_.
`stopClustering()`		Destroys the clustering strategy started up by #startClustering.
`setMap()`		Set the map on all child MapObjects. Any newly created map objects will be instantiated with the map set here.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean
`_onModelEvent()`		From Backbone.Collection#_onModelEvent

events

Event	Parameters	Description
`cluster:click`	`latLon: LatLon`
`cluster:mouseover`	`latLon: LatLon`	When the mouse enters a cluster.
`cluster:mouseout`	`latLon: LatLon`	When the mouse exits a cluster.
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.FireMarkers

constructor

new aeris.maps.markercollections.FireMarkers(opt_markers, opt_options);

Parameter	Type	Description
`opt_markers`	Array.<Marker>=	Markers to add to the collection.
`opt_options`	Object=

methods

Method	Return value	Description
`getParams()`	Params	Return params used to query the Aeris API.
`setParams(params: Object )`		Set params used to query the Aeris API.
`setFrom(from: Date )`		Set the `from` parameter for querying the Aeris API.
`setTo(to: Date )`		Set the `to` parameter for querying the Aeris API.
`setBounds(bounds: Bounds )`		Set the latLon bounds for querying the Aeris API.
`addFilter(filter: string\|Array.<string> )`		Add a filter to the Aeris API request.
`removeFilter(filter: string\|Array.<string> )`		Remove a filter from the Aeris API request.
`resetFilter(opt_filter: string\|Array.<string>= )`		Reset a filter from the Aeris API request.
`addQuery(query: Query\|Array.<Query> )`		Add a query term to Aeris API request.
`removeQuery(Query: Query\|Array.<Query>\|string\|Array.<string> )`		Remove a query from the Aeris API request
`resetQuery(opt_replacementQuery: Query\|Array.<Query>= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`getClusterStyle(opt_group: String= )`	Object	Returns a copy of the cluster styles for the specified cluster group. Cluster styles object.
`getClusterOptions()`	Object
`startClustering()`		Starts up the strategy defined by this.clusterStrategy_.
`stopClustering()`		Destroys the clustering strategy started up by #startClustering.
`setMap()`		Set the map on all child MapObjects. Any newly created map objects will be instantiated with the map set here.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean
`_onModelEvent()`		From Backbone.Collection#_onModelEvent

events

Event	Parameters	Description
`cluster:click`	`latLon: LatLon`
`cluster:mouseover`	`latLon: LatLon`	When the mouse enters a cluster.
`cluster:mouseout`	`latLon: LatLon`	When the mouse exits a cluster.
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.LightningMarkers

constructor

new aeris.maps.markercollections.LightningMarkers(opt_markers, opt_options);

Parameter	Type	Description
`opt_markers`	Array.<Marker>=	Markers to add to the collection.
`opt_options`	Object=

methods

Method	Return value	Description
`getParams()`	Params	Return params used to query the Aeris API.
`setParams(params: Object )`		Set params used to query the Aeris API.
`setFrom(from: Date )`		Set the `from` parameter for querying the Aeris API.
`setTo(to: Date )`		Set the `to` parameter for querying the Aeris API.
`setBounds(bounds: Bounds )`		Set the latLon bounds for querying the Aeris API.
`addFilter(filter: string\|Array.<string> )`		Add a filter to the Aeris API request.
`removeFilter(filter: string\|Array.<string> )`		Remove a filter from the Aeris API request.
`resetFilter(opt_filter: string\|Array.<string>= )`		Reset a filter from the Aeris API request.
`addQuery(query: Query\|Array.<Query> )`		Add a query term to Aeris API request.
`removeQuery(Query: Query\|Array.<Query>\|string\|Array.<string> )`		Remove a query from the Aeris API request
`resetQuery(opt_replacementQuery: Query\|Array.<Query>= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`getClusterStyle(opt_group: String= )`	Object	Returns a copy of the cluster styles for the specified cluster group. Cluster styles object.
`getClusterOptions()`	Object
`startClustering()`		Starts up the strategy defined by this.clusterStrategy_.
`stopClustering()`		Destroys the clustering strategy started up by #startClustering.
`setMap()`		Set the map on all child MapObjects. Any newly created map objects will be instantiated with the map set here.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean
`_onModelEvent()`		From Backbone.Collection#_onModelEvent

events

Event	Parameters	Description
`cluster:click`	`latLon: LatLon`
`cluster:mouseover`	`latLon: LatLon`	When the mouse enters a cluster.
`cluster:mouseout`	`latLon: LatLon`	When the mouse exits a cluster.
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.StormReportMarkers

constructor

new aeris.maps.markercollections.StormReportMarkers(opt_markers, opt_options);

Parameter	Type	Description
`opt_markers`	Array.<Marker>=	Markers to add to the collection.
`opt_options`	Object=

methods

Method	Return value	Description
`getParams()`	Params	Return params used to query the Aeris API.
`setParams(params: Object )`		Set params used to query the Aeris API.
`setFrom(from: Date )`		Set the `from` parameter for querying the Aeris API.
`setTo(to: Date )`		Set the `to` parameter for querying the Aeris API.
`setBounds(bounds: Bounds )`		Set the latLon bounds for querying the Aeris API.
`addFilter(filter: string\|Array.<string> )`		Add a filter to the Aeris API request.
`removeFilter(filter: string\|Array.<string> )`		Remove a filter from the Aeris API request.
`resetFilter(opt_filter: string\|Array.<string>= )`		Reset a filter from the Aeris API request.
`addQuery(query: Query\|Array.<Query> )`		Add a query term to Aeris API request.
`removeQuery(Query: Query\|Array.<Query>\|string\|Array.<string> )`		Remove a query from the Aeris API request
`resetQuery(opt_replacementQuery: Query\|Array.<Query>= )`		Resets the query for the Aeris API request.
`getQuery()`	ChainedQueries	Returns the query for the Aeris API request.
`getClusterStyle(opt_group: String= )`	Object	Returns a copy of the cluster styles for the specified cluster group. Cluster styles object.
`getClusterOptions()`	Object
`startClustering()`		Starts up the strategy defined by this.clusterStrategy_.
`stopClustering()`		Destroys the clustering strategy started up by #startClustering.
`setMap()`		Set the map on all child MapObjects. Any newly created map objects will be instantiated with the map set here.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean
`_onModelEvent()`		From Backbone.Collection#_onModelEvent

events

Event	Parameters	Description
`cluster:click`	`latLon: LatLon`
`cluster:mouseover`	`latLon: LatLon`	When the mouse enters a cluster.
`cluster:mouseout`	`latLon: LatLon`	When the mouse exits a cluster.
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Advisories

aeris.maps.layers.Advisories
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.Advisories(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.AdvisoriesKML

aeris.maps.layers.AdvisoriesKML
extends aeris.maps.layers.KML

Representation of Aeris Advisories.

constructor

new aeris.maps.layers.AdvisoriesKML(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`click`	`latLon: LatLon data: Object`
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Chlorophyll

aeris.maps.layers.Chlorophyll
extends aeris.maps.layers.AerisTile

Representation of Aeris Sea Surface Temperatures layer.

constructor

new aeris.maps.layers.Chlorophyll(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.ConvectiveHazards

Representation of Aeris Convective Hazards layer.

constructor

new aeris.maps.layers.ConvectiveHazards(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`fetch()`	Promise	Fetch polygon data from the Aeris API. Resolves with response from server.
`setOpacity(opacity: Number )`
`validate()`
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.DewPoints

aeris.maps.layers.DewPoints
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.DewPoints(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.GoogleHybrid

Representation of Google's Hybrid.

constructor

new aeris.maps.layers.GoogleHybrid(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.GoogleRoadMap

Representation of Google's RoadMap.

constructor

new aeris.maps.layers.GoogleRoadMap(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.GoogleSatellite

Representation of Google's Satellite.

constructor

new aeris.maps.layers.GoogleSatellite(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.GoogleTerrain

Representation of Google's Terrain.

constructor

new aeris.maps.layers.GoogleTerrain(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.HeatIndex

aeris.maps.layers.HeatIndex
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.HeatIndex(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Humidity

aeris.maps.layers.Humidity
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.Humidity(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.LightningStrikeDensity

Representation of Aeris Lightning Strike Density layer.

constructor

new aeris.maps.layers.LightningStrikeDensity(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.OSM

aeris.maps.layers.OSM
extends aeris.maps.layers.AbstractTile

Representation of OpenStreetMaps layer.

constructor

new aeris.maps.layers.OSM(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`validate()`
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Precip

aeris.maps.layers.Precip
extends aeris.maps.layers.AerisTile

Precipitation layer.

constructor

new aeris.maps.layers.Precip(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.QPF

aeris.maps.layers.QPF
extends aeris.maps.layers.AerisTile

Representation of Aeris QPF (Quantitative Precipitation Forecast) layer.

constructor

new aeris.maps.layers.QPF(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Radar

aeris.maps.layers.Radar
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.Radar(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.RadSat

aeris.maps.layers.RadSat
extends aeris.maps.layers.AerisTile

Representation of Aeris RadSat layer.

constructor

new aeris.maps.layers.RadSat(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Satellite

aeris.maps.layers.Satellite
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.Satellite(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.SatelliteGlobal

constructor

new aeris.maps.layers.SatelliteGlobal(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.SatelliteVisible

constructor

new aeris.maps.layers.SatelliteVisible(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.SeaSurfaceTemps

Representation of Aeris Sea Surface Temperatures layer.

constructor

new aeris.maps.layers.SeaSurfaceTemps(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.SnowDepth

aeris.maps.layers.SnowDepth
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.SnowDepth(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.SnowFallAccum

constructor

new aeris.maps.layers.SnowFallAccum(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Temps

aeris.maps.layers.Temps
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.Temps(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.WindChill

aeris.maps.layers.WindChill
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.WindChill(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

.Winds

aeris.maps.layers.Winds
extends aeris.maps.layers.AerisTile

constructor

new aeris.maps.layers.Winds(opt_attrs, opt_options);

Parameter	Type	Description
`opt_attrs`	Object=
`opt_options`	Object=

methods

Method	Return value	Description
`validate()`
`getUrl()`	String	Returns the url for requesting tiles. The url will be interpolated by replacing special variables with calculated values. Special variables should be wrapped in brackets. * d - a randomly selected subdomain * z - the calculated zoom factor * x - the tile's starting x coordinate * y - the tile's starting y coordinate ex. http://d.tileserver.net/z/x/y.png default url for tile image.
`getTimestamp()`	Number	UNIX Timestamp.
`getAerisTimeString()`	String	Get's the layer's time, formatted for the Aeris API. Format: [year][month][date][hours][minutes][seconds].
`loadTileTimes()`	Promise	Retrieve a list of timestamps for which tile images are available on the AerisAPI server. Resolves with arrary of timestamps.
`getRandomSubdomain()`	String	A random subdomain for the tile server.
`zoomFactor(zoom: Number )`	Number	Implemented map specific zoom factor calculation.
`setOpacity(opacity: Number )`		Sets the opacity of the tile layer.
`getOpacity()`	Number
`setZIndex()`		Sets the zIndex of a tile layer.
`getZIndex()`	Number
`isLoaded()`	Boolean	True, if tile images have finished loading.
`preload(map: Map )`		Preloads the tile layer images.
`fadeTo(targetOpacity: Number , duration: Number )`		Experimental layer fade animation.
`show()`		Show the layer.
`hide()`		Hide the layer.
`setMap(aerisMap: ?Map , opt_options: Object= )`		Associates a map with the map object. Setting the map to null is equivalent to removing the object from the map.
`getMap()`	Map	Gets the map associtaed with the map object.
`hasMap()`	Boolean	Returns true if the layer has a map set.
`getView()`	*	Returns the object view, as rendered by the object's strategy.
`destroy()`

events

Event	Parameters	Description
`autoUpdate`		The tile has automatically updated to the most current time.
`load`		Fires when tile images are loaded.
`load:reset`		Firest when tile images must be re-loaded (eg. if the map bounds change)
`map:set`	`mapObject: MapObjectInterface map: Map options: Object=`	Triggered when a map is set to a MapObjectInterface.
`map:remove`	`mapObject: MapObjectInterface null: Null options: Object=`	Triggered when a map is removed from a MapObjectInterface (ie, map was set to null).

util

aeris.util.config

aeris.util.aeris.config

Global configuration object for Aeris.js library.

constructor

new aeris.util.aeris.config();

methods

Method	Return value	Description
`validate()`
`setApiId(apiId: String )`
`setApiSecret(setApiSecret: String )`

aeris.util.DateHelper

aeris.util.aeris.DateHelper

Manipulates a Date object.

constructor

new aeris.util.aeris.DateHelper(opt_date);

Parameter	Type	Description
`opt_date`	Date=	Defaults to current date.

methods

Method	Return value	Description
`addMilliseconds(ms: Number )`	Date	Modified date object.
`addSeconds(seconds: Number )`	Date	Modified date object.
`addMinutes(minutes: Number )`	Date	Modified date object.
`addHours(hours: Number )`	Date	Modified date object.
`addDays(days: Number )`	Date	Modified date object.
`addWeeks(weeks: Number )`	Date	Modified date object.
`add(hours: Number , opt_minutes: Number= , opt_seconds: Number= , opt_milliseconds: Number= )`
`getDate()`	Date
`getTime()`
`setDate(opt_date: Date )`

aeris.util.Events

aeris.util.aeris.Events

An events manager,
based on Backbone.Events.

constructor

new aeris.util.aeris.Events();

methods

Method	Return value	Description
`on()`		Bind an event handler to the object. See Backbone.Events#on
`off()`		See http://backbonejs.org/#Events-off
`publish()`		Publish a global event Same signature as Events#trigger
`subscribe()`		Subscribe to a global event Same signature as Events#on
`unsubscribe()`		Unsubscribe from a global event Same signature as Events#off

aeris.util.Promise

aeris.util.aeris.Promise

Create a lightweight Promise for async related work.

constructor

new aeris.util.aeris.Promise();

methods

Method	Return value	Description
`done(callback: Function , opt_ctx: Object )`		Ensure a callback is called when the promise is resolved.
`fail(callback: Function , opt_ctx: Object )`		Ensure a callback is called when the promise is rejected.
`always(callback: Function , opt_ctx: Object )`		Ensure a callback is called when the promise is either resolved or rejected.
`resolve(var_args: ...* )`		Mark a promise is resolved, passing in a variable number of arguments.
`reject(var_args: ...* )`		Mark a promise is rejected, passing in a variable number of arguments.
`getState()`	String	The current state of the promise. 'pending', 'resolved', or 'rejected'.
`proxy()`		Resolve/reject the promise when the proxy promise is resolved/rejected.
`when(var_args: ...* )`	Promise	Create a master promise from a combination of promises. Master promise is resolved when all component promises are resolved, or rejected when any single component promise is rejected. Master promise.