API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class WMS

Package | org.openscales.core.layer.ogc
Class | public class WMS
Inheritance | WMS Grid HTTPRequest Layer flash.display.Sprite
Subclasses | WMSC

Instances of WMS are used to display data from OGC Web Mapping Services.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | altUrls : Array | HTTPRequest
|  | buffer : Number Used only when in gridded mode, this specifies the number of extra rows and colums of tiles on each side which will surround the minimum grid tiles to cover the map. | Grid
|  | DEFAULT_MAXEXTENT : Bounds [static] | Layer
|  | DEFAULT_PROJECTION : ProjProjection [static] | Layer
|  | displayed : Boolean | Layer
|  | exception : String | WMS
|  | extent : Bounds A Bounds object which represents the lon/lat bounds of the current viewPort. | Layer
|  | grid : Array | Grid
|  | imageSize : Size | Grid
|  | inRange : Boolean | Layer
|  | isBaseLayer : Boolean Whether or not the layer is a base layer. | Layer
|  | isFixed : Boolean Whether or not the layer is a fixed layer. | Layer
|  | loadComplete : Boolean Whether or not the layer is loading data | Layer
|  | map : Map | Layer
|  | maxExtent : Bounds [read-only] | WMS
|  | maxResolution : Number | Layer
|  | maxZoomLevel : Number | Layer
|  | minResolution : Number | Layer
|  | minZoomLevel : Number | Layer
|  | numLoadingTiles : int | Grid
|  | numZoomLevels : Number Number of zoom levels | Layer
|  | params : IHttpParams | HTTPRequest
|  | projection : ProjProjection Override the default projection. | Layer
|  | proxy : String Proxy (usually a PHP, Python, or Java script) used to request remote servers like WFS servers in order to allow crossdomain requests. | Layer
|  | reproject : Boolean | WMS
|  | resolutions : Array A list of map resolutions (map units per pixel) in descending order. | Layer
|  | security : ISecurity | Layer
|  | singleTile : Boolean | Grid
|  | tileHeight : Number | Grid
|  | tileWidth : Number | Grid
|  | url : String | HTTPRequest
|  | URL_HASH_FACTOR : Number | HTTPRequest
|  | visible : Boolean | Layer
|  | zindex : int | Layer

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined by
--- | --- | ---
|  | CACHE_SIZE : int = 64 | Grid
|  | _imageSize : Size = null | Layer
|  | loading : Boolean Used to set loading status of layer | Layer

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | WMS(name:String = "", url:String = "", layers:String = "", isBaseLayer:Boolean = false, visible:Boolean = true, projection:String = null, proxy:String = null) | WMS
|  | addTile(bounds:Bounds, position:Pixel):Tile | WMS
|  | addTileCache(url:String, loader:Loader):void Methodd to cache a tile | Grid
|  | clear():void Go through and remove all tiles from the grid, calling destroy() on each of them to kill circular references | Grid
|  | destroy(newBaseLayer:Boolean = true):void | Grid
|  | generateResolutions(numZoomLevels:uint, nominalResolution:Number):void | Layer
|  | getLonLatFromMapPx(viewPortPx:Pixel):LonLat Return a LonLat which is the passed-in map Pixel, translated into lon/lat by the layer. | Layer
|  | getMapPxFromLonLat(lonlat:LonLat):Pixel Return a Pixel which is the passed-in LonLat,translated into map pixels. | Layer
|  | getTileBounds(viewPortPx:Pixel):Bounds Returns The tile bounds for a layer given a pixel location. | Grid
|  | getTileCache(url:String):Loader Method to get a cached tile by its url | Grid
|  | getTilesBounds():Bounds Return the bounds of the tile grid. | Grid
|  | getURL(bounds:Bounds):String | WMS
|  | getUrls():Array | HTTPRequest
|  | getZoomForExtent(extent:Bounds):Number | Layer
|  | getZoomForResolution(resolution:Number):Number Return The index of the zoomLevel (entry in the resolutions array) that corresponds to the best fit resolution given the passed in value and the 'closest' specification. | Layer
|  | initGriddedTiles(bounds:Bounds):void | Grid
|  | initSingleTile(bounds:Bounds):void Initialization singleTile | Grid
|  | moveGriddedTiles(bounds:Bounds):void | Grid
|  | onMapMove(e:MapEvent):void | Layer
|  | onMapResize(e:MapEvent):void | Layer
|  | onMapZoom(e:MapEvent):void | Grid
|  | onSecurityInitialized(e:SecurityEvent):void | Layer
|  | redraw(fullRedraw:Boolean = true):void | Grid
|  | removeExcessTiles(rows:int, columns:int):void When the size of the map or the buffer changes, we may need to remove some excess rows and columns. | Grid
|  | removeTileMonitoringHooks(tile:Tile):void | Grid
|  | reset():void Reset layer data | Layer
|  | selectUrl(paramString:String, urls:Array):String selectUrl() implements the standard floating-point multiplicative hash function described by Knuth, and hashes the contents of the given param string into a float between 0 and 1. | HTTPRequest

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined by
--- | --- | ---
|  | draw():void Reset layer data | Layer
|  | spiralTileLoad():void Starts at the top right corner of the grid and proceeds in a spiral towards the center, adding tiles one at a time to the beginning of a queue. | Grid

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined by
--- | --- | ---
|  | DEFAULT_NOMINAL_RESOLUTION : Number = 1.40625 [static] | Layer
|  | DEFAULT_NUM_ZOOM_LEVELS : uint = 16 [static] | Layer
|  | DEFAULT_SRS_CODE : String = "EPSG:4326" [static] | Layer
|  | RESOLUTION_TOLERANCE : Number = 0.000001 [static] | Layer

Property detail

exception | property

`exception:String` [read-write]Implementation
`public function get exception():String`
`public function set exception(value:String):void`

maxExtent | property |

`maxExtent:Bounds` [read-only]Implementation
`public function get maxExtent():Bounds`

reproject | property |

`reproject:Boolean` [read-write]Implementation
`public function get reproject():Boolean`
`public function set reproject(value:Boolean):void`
Constructor detail

WMS | () | constructor

`public function WMS(name:String = "", url:String = "", layers:String = "", isBaseLayer:Boolean = false, visible:Boolean = true, projection:String = null, proxy:String = null)`Parameters

| `name:String` (default = "``")``
| `url:String` (default = "``")``
| `layers:String` (default = "``")``
| `isBaseLayer:Boolean` (default = `false`)``
| `visible:Boolean` (default = `true`)``
| `projection:String` (default = `null`)``
| `proxy:String` (default = `null`)``

Method detail

addTile | () | method

`public override function addTile(bounds:Bounds, position:Pixel):Tile` Parameters

| `bounds:Bounds`
| `position:Pixel`

Returns

| `Tile`

getURL | () | method |

`public override function getURL(bounds:Bounds):String` Parameters

| `bounds:Bounds`

Returns

| `String`