Winds
Summary
Constructor
aeris.maps.layers.Winds
Syntax
aeris.maps.layers.Winds
()
Summary
Item Index
Methods
- createFutureTileTimesUrl_
- createStrategy_
- createTileTimesUrl_
- createTileTimesUrlForEndpoint_
- destroy
- ensureApiKeys_
- fadeTo
- getAerisTimeString
- getMap
- getOpacity
- getRandomSubdomain
- getTileTypeEndpoint_
- getTimestamp
- getUrl
- getView
- getZIndex
- hasMap
- hide
- initialize
- isLoaded
- loadTileTimes
- loadTileTimesForEndpoint_
- parseTileTimes_
- preload
- rejectAfterTimeout_
- removeStrategy
- resetStrategy
- setMap
- setOpacity
- setStrategy
- setZIndex
- show
- validate
- zoomFactor
Properties
Attributes
Events
Methods
createFutureTileTimesUrl_
Syntax
createFutureTileTimesUrl_
()
private
Summary
createStrategy_
Syntax
Summary
Create a {aeris.maps.AbstractStrategy} instance.
Override to adjust how strategy objects are instantiated.
Parameters:
-
StrategyFunctionAbstractStrategy object ctor.
Returns:
createTileTimesUrlForEndpoint_
Syntax
createTileTimesUrlForEndpoint_
-
endpoint
Summary
Parameters:
-
endpointStringTile type endpoint.
destroy
Syntax
destroy
()
Summary
ensureApiKeys_
Syntax
ensureApiKeys_
()
private
Summary
fadeTo
Syntax
fadeTo
-
targetOpacity -
duration
Summary
Experimental layer fade animation.
getAerisTimeString
Syntax
Summary
Get's the layer's time, formatted for the Aeris API.
Returns:
Format: [year][month][date][hours][minutes][seconds].
getMap
Syntax
getMap
()
Summary
getTileTypeEndpoint_
Syntax
getTileTypeEndpoint_
()
private
Summary
getUrl
Syntax
getUrl
()
Summary
hide
Syntax
hide
()
Summary
Hide the layer.
initialize
Syntax
initialize
()
protected
Summary
loadTileTimes
Syntax
Summary
Retrieve a list of timestamps for which tile images are available on the AerisAPI server.
Returns:
Resolves with arrary of timestamps.
preload
Syntax
preload
-
map
Summary
Preloads the tile layer images.
Parameters:
-
mapMapThe layer will be temporarily set to this map, in order to trigger it's tile images to start loading.
rejectAfterTimeout_
Syntax
rejectAfterTimeout_
-
promise -
timeout -
message
Summary
removeStrategy
Syntax
removeStrategy
()
Summary
Remove and clean up the StrategyObject's strategy.
resetStrategy
Syntax
resetStrategy
()
Summary
Reset the rendering strategy used by the object. Useful for re-enabled a strategy which has previously been removed with StrategyObject#removeStrategy
setMap
Syntax
setMap
()
Summary
setOpacity
Syntax
setOpacity
-
opacity
Summary
Sets the opacity of the tile layer.
Parameters:
-
opacityNumberBetween 0 and 1.
setStrategy
Syntax
setStrategy
-
Strategy
Summary
Set the strategy to use for rendering the StrategyObject.
Parameters:
-
StrategyFunctionConstructor for an {aeris.maps.AbstractStrategy} object.
setZIndex
Syntax
setZIndex
()
Summary
Sets the zIndex of a tile layer.
show
Syntax
show
()
Summary
Show the layer.
validate
Syntax
validate
()
Summary
Properties
autoUpdateIntervalTimer_
Syntax
Summary
A reference to the timer created with window.setInterval, used for autoUpdating.
strategy_
Syntax
strategy_
aeris.maps.Strategy Strategy constructor.
Summary
Default {aeris.Strategy} implementation
StrategyType_
Syntax
StrategyType_
function():aeris.maps.AbstractStrategy
private
Summary
Attributes
futureTileType
The type of Aeris Interactive tile to use when the tile's time is set to a future date.
name
string
The name of the tile layer.
The value of the name can be anything, though some map views will display this name in layer-select controls.
server
string
The server used for requesting tiles. The server will be interpolated by replacing special variables with calculated values. Special variables should be wrapped with '{' and '}'
- {d} - a randomly selected subdomain
time
Date
Tile's timestamp. Defaults to 0. Note that request to the AI Tiles API at time '0' will return the latest available tile.
Events
autoUpdate
Syntax
autoUpdate
Summary
The tile has automatically updated to the most current time.
load
Syntax
load
Summary
Fires when tile images are loaded.
load:reset
Syntax
load:reset
Summary
Firest when tile images must be re-loaded (eg. if the map bounds change)
strategy:set
Syntax
strategy:set
Summary
When a strategy is set on the object.
Event Payload:
-
strategyaeris.maps.AbstractStrategy