ALKMaps.Layer.WeatherRadar

Instances of ALKMaps.Layer.WeatherRadar are used to display weather maps. This layer only supports Spherical Mercator. It can’t be used as a base layer by default.

Inherits from

ALKMaps.Layer.Grid

Summary

ALKMaps.Layer.WeatherRadar	Instances of ALKMaps.Layer.WeatherRadar are used to display weather maps.
Constants
DEFAULT_PARAMS	{Object} Hashtable of default parameter key/value pairs
Properties
reproject	Deprecated.
isBaseLayer	{Boolean} Default is false for this layer
disableCache	{Boolean} Prevents web browser caches content for the same image URL if it is set to true.
Constructor
ALKMaps.Layer.WeatherRadar	Create a new WeatherRadar layer object
Functions
clone	Create a clone of this layer
getURL
getXYZ	Calculates x, y and z for the given bounds.
setMap	When the layer is added to a map, then we can fetch our origin (if we don’t have one.)

Constants

DEFAULT_PARAMS

{Object} Hashtable of default parameter key/value pairs

Properties

reproject

Deprecated. {Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer. Default is false. Set this in the layer options. Should be set to false in most cases.

isBaseLayer

{Boolean} Default is false for this layer

disableCache

{Boolean} Prevents web browser caches content for the same image URL if it is set to true.

Constructor

ALKMaps.Layer.WeatherRadar

Create a new WeatherRadar layer object

Example

The code below creates a transparent WeatherRadar layer.

var radar = new ALKMaps.Layer.WeatherRadar("Radar",
     {
         display: "satellite",
         disableCache: true
     }, {
         opacity: 0.5
     });

Parameters

name	{String} A name for the layer
params	{Object} An object with key/value pairs representing the parameters for the layer.

display - {String} radar, satellite. Values: “radar”, “satellite”. Defaults to “radar”
disableCache - {Boolean} Prevents web browser caches content for the same image URL if it is set to true.

options

{Object} Hashtable of extra options to tag onto the layer. These options include all properties from the WMS parent class.

Functions

clone

clone: function( obj )

Create a clone of this layer

Returns

{ALKMaps.Layer.BaseMap} An exact clone of this layer

getURL

getURL: function ( bounds )

Parameters

bounds

{ALKMaps.Bounds}

Returns

{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters

getXYZ

getXYZ: function( bounds )

Calculates x, y and z for the given bounds.

Parameters

bounds

{ALKMaps.Bounds}

Returns

{Object}

an object with x, y and z properties.

setMap

setMap: function( map )

When the layer is added to a map, then we can fetch our origin (if we don’t have one.)

Parameters

map	{ALKMaps.Map}