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

Package | org.openscales.core.layer.ogc
Class | public class WFS
Inheritance | WFS FeatureLayer Layer flash.display.Sprite

Instances of WFS are used to display data from OGC Web Feature Services.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | capabilities : HashMap | WFS
|  | capabilitiesVersion : String | WFS
|  | DEFAULT_MAXEXTENT : Bounds [static] | Layer
|  | DEFAULT_PROJECTION : ProjProjection [static] | Layer
|  | displayed : Boolean | Layer
|  | extent : Bounds A Bounds object which represents the lon/lat bounds of the current viewPort. | Layer
|  | extractAttributes : Boolean | WFS
|  | featureNS : String | WFS
|  | features : Array | FeatureLayer
|  | featuresBbox : Bounds | FeatureLayer
|  | geometryColumn : String | WFS
|  | geometryType : String | FeatureLayer
|  | imageSize : Size For layers with a gutter, the image is larger than the tile by twice the gutter in each dimension. | Layer
|  | inEditionMode : Boolean | FeatureLayer
|  | 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 [write-only] | WFS
|  | maxExtent : Bounds The center of these bounds will not stray outside of the viewport extent during panning. | Layer
|  | maxResolution : Number | Layer
|  | maxZoomLevel : Number | Layer
|  | minResolution : Number | Layer
|  | minZoomLevel : Number | Layer
|  | numZoomLevels : Number Number of zoom levels | Layer
|  | params : WFSParams | WFS
|  | 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
|  | resolutions : Array A list of map resolutions (map units per pixel) in descending order. | Layer
|  | security : ISecurity | Layer
|  | selectedFeatures : Array | FeatureLayer
|  | style : Style | FeatureLayer
|  | typename : String | WFS
|  | url : String | WFS
|  | useCapabilities : Boolean | WFS
|  | visible : Boolean | Layer
|  | writer : Format | WFS
|  | zindex : int | Layer

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined by
--- | --- | ---
|  | _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
--- | --- | ---
|  | WFS(name:String, url:String, typename:String, isBaseLayer:Boolean = false, visible:Boolean = true, projection:String = null, proxy:String = null, useCapabilities:Boolean = false, capabilities:HashMap = null) WFS class constructor | WFS
|  | addFeature(feature:Feature, dispatchFeatureEvent:Boolean = true):void | WFS
|  | addFeatures(features:Array):void Add Features to the layer. | FeatureLayer
|  | capabilitiesGetter(caller:GetCapabilities):void TODO: Refactor this to use events Callback method called by the capabilities retriever. | WFS
|  | clear():void | FeatureLayer
|  | destroy(setNewBaseLayer:Boolean = true):void | FeatureLayer
|  | generateResolutions(numZoomLevels:uint, nominalResolution:Number):void | Layer
|  | getFullRequestString(altUrl:String = null):String Combine the layer's url with its params and these newParams. | WFS
|  | 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
|  | getURL(bounds:Bounds):String | Layer
|  | 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
|  | onMapMove(e:MapEvent):void | Layer
|  | onMapResize(e:MapEvent):void | Layer
|  | onMapZoom(e:MapEvent):void | Layer
|  | onSecurityInitialized(e:SecurityEvent):void | Layer
|  | redraw(fullRedraw:Boolean = true):void | WFS
|  | removeEventListenerFromMap():void | Layer
|  | removeFeature(feature:Feature, dispatchFeatureEvent:Boolean = true):void | FeatureLayer
|  | removeFeatures(features:Array):void | FeatureLayer
|  | reset():void | FeatureLayer

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined by
--- | --- | ---
|  | draw():void | FeatureLayer
|  | loadFeatures(url:String):void Abort any pending requests and issue another request for data. | WFS
|  | onFailure(event:Event):void Called on return from request failure. | WFS
|  | onSuccess(event:Event):void Called on return from request succcess. | WFS

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

capabilities | property

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

capabilitiesVersion | property |

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

extractAttributes | property |

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

featureNS | property |

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

geometryColumn | property |

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

map | property |

`map:Map` [write-only]Implementation
`public function set map(value:Map):void`

params | property |

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

typename | property |

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

url | property |

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

useCapabilities | property |

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

writer | property |

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

WFS | () | constructor

`public function WFS(name:String, url:String, typename:String, isBaseLayer:Boolean = false, visible:Boolean = true, projection:String = null, proxy:String = null, useCapabilities:Boolean = false, capabilities:HashMap = null)`

WFS class constructor

Parameters

| `name:String` — Layer's name
| `url:String` — The WFS server url to request
| `typename:String`
| `isBaseLayer:Boolean` (default = `false`)``
| `visible:Boolean` (default = `true`)``
| `projection:String` (default = `null`)``
| `proxy:String` (default = `null`)``
| `useCapabilities:Boolean` (default = `false`)``
| `capabilities:HashMap` (default = `null`)``

Method detail

addFeature | () | method

`public override function addFeature(feature:Feature, dispatchFeatureEvent:Boolean = true):void` Parameters

| `feature:Feature`
| `dispatchFeatureEvent:Boolean` (default = `true`)``

capabilitiesGetter | () | method |

`public function capabilitiesGetter(caller:GetCapabilities):void`

TODO: Refactor this to use events Callback method called by the capabilities retriever.

Parameters

| `caller:GetCapabilities` — The GetCapabilities instance which call it.

getFullRequestString | () | method |

`public function getFullRequestString(altUrl:String = null):String`

Combine the layer's url with its params and these newParams.

Parameters

| `altUrl:String` (default = `null`)``

Returns

| `String`

loadFeatures | () | method |

`protected function loadFeatures(url:String):void`

Abort any pending requests and issue another request for data. Input are function pointers for what to do on success and failure.

Parameters

| `url:String`

onFailure | () | method |

`protected function onFailure(event:Event):void`

Called on return from request failure.

Parameters

| `event:Event`

onSuccess | () | method |

`protected function onSuccess(event:Event):void`

Called on return from request succcess.

Parameters

| `event:Event`

redraw | () | method |

`public override function redraw(fullRedraw:Boolean = true):void` Parameters

| `fullRedraw:Boolean` (default = `true`)``