org.openscales.core.layer.VectorLayer

	Property	Defined By
		aggregate : Aggregate The aggregate which contains this layer, null most of the time.	Layer
		alpha : Number [override] [write-only] opacity of the layer (between 0 and 1)	Layer
		attributesId : Vector.<String>	VectorLayer
		available : Boolean [override] [read-only]	VectorLayer
		availableProjections : Vector.<String> Define the layer available projections by its SRS codes.	Layer
		constraints : Vector.<Constraint> A list of constraints for the layer	Layer
		data : XML If the VectorLayer is made from locale source : the XML data	VectorLayer
		DEFAULT_MAXEXTENT : Bounds [static] [read-only]	Layer
		displayed : Boolean [read-only] Is this layer currently displayed ?	Layer
		displayInLayerManager : Boolean Indicates if the layer should be displayed in the LayerManager List or not	Layer
		dpi : Number Indicates the dpi used to calculate resolution and scale upon this layer	Layer
		editable : Boolean	VectorLayer
		extent : Bounds [read-only] A Bounds object which represents the location bounds of the current extent display on the map.	Layer
		features : Vector.<Feature> [read-only] The list of features contained by this layer	VectorLayer
		featuresBbox : Bounds	VectorLayer
		featuresID : Vector.<String> [read-only]	VectorLayer
		geometryType : String	VectorLayer
		idLabel : uint	VectorLayer
		idPath : uint	VectorLayer
		idPoint : uint	VectorLayer
		idPolygon : uint	VectorLayer
		inEditionMode : Boolean	VectorLayer
		initInDrawingToolbar : Boolean	VectorLayer
		initOutDrawingToolbar : Boolean	VectorLayer
		inRange : Boolean [read-only] Is this layer currently in range, based on its min and max resolutions	Layer
		isFixed : Boolean Whether or not the layer is a fixed layer.	Layer
		loadComplete : Boolean [read-only] Whether or not the layer is loading data	Layer
		map : Map [override]	VectorLayer
		maxExtent : Bounds Maximum extent for this layer.	Layer
		maxResolution : Resolution Maximal valid resolution for this layer	Layer
		metaData : Object Allows to add custom metadata about the layer	Layer
		minResolution : Resolution Minimal valid resolution for this layer	Layer
		name : String [override] The layer Name (appears in LayerManager for example)	Layer
		numZoomLevels : Number [read-only] Number of zoom levels (resolutions array length)	Layer
		originators : Vector.<DataOriginator> The list of originators for the layer.	Layer
		projection : ProjProjection The projection of the map.	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 Security manager associated to this layer	Layer
		selected : Boolean	Layer
		selectedFeatures : Vector.<String>	VectorLayer
		style : Style	VectorLayer
		url : String The url use for the layer request if necessary.	Layer
		visible : Boolean [override] [write-only] Define if this layer is visible (displayed) or not	Layer
		zindex : int Current layer position in the display list	Layer

Property

Defined By

aggregate : Aggregate

The aggregate which contains this layer, null most of the time.

Layer

alpha : Number

[override] [write-only] opacity of the layer (between 0 and 1)

Layer

attributesId : Vector.<String>

VectorLayer

available : Boolean

[override] [read-only]

VectorLayer

availableProjections : Vector.<String>

Define the layer available projections by its SRS codes.

Layer

constraints : Vector.<Constraint>

A list of constraints for the layer

Layer

data : XML

If the VectorLayer is made from locale source : the XML data

VectorLayer

DEFAULT_MAXEXTENT : Bounds

[static] [read-only]

Layer

displayed : Boolean

[read-only] Is this layer currently displayed ?

Layer

displayInLayerManager : Boolean

Indicates if the layer should be displayed in the LayerManager List or not

Layer

dpi : Number

Indicates the dpi used to calculate resolution and scale upon this layer

Layer

editable : Boolean

VectorLayer

extent : Bounds

[read-only] A Bounds object which represents the location bounds of the current extent display on the map.

Layer

features : Vector.<Feature>

[read-only] The list of features contained by this layer

VectorLayer

featuresBbox : Bounds

VectorLayer

featuresID : Vector.<String>

[read-only]

VectorLayer

geometryType : String

VectorLayer

idLabel : uint

VectorLayer

idPath : uint

VectorLayer

idPoint : uint

VectorLayer

idPolygon : uint

VectorLayer

inEditionMode : Boolean

VectorLayer

initInDrawingToolbar : Boolean

VectorLayer

initOutDrawingToolbar : Boolean

VectorLayer

inRange : Boolean

[read-only] Is this layer currently in range, based on its min and max resolutions

Layer

isFixed : Boolean

Whether or not the layer is a fixed layer.

Layer

loadComplete : Boolean

[read-only] Whether or not the layer is loading data

Layer

map : Map

[override]

VectorLayer

maxExtent : Bounds

Maximum extent for this layer.

Layer

maxResolution : Resolution

Maximal valid resolution for this layer

Layer

metaData : Object

Allows to add custom metadata about the layer

Layer

minResolution : Resolution

Minimal valid resolution for this layer

Layer

name : String

[override] The layer Name (appears in LayerManager for example)

Layer

numZoomLevels : Number

[read-only] Number of zoom levels (resolutions array length)

Layer

originators : Vector.<DataOriginator>

The list of originators for the layer.

Layer

projection : ProjProjection

The projection of the map.

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

Security manager associated to this layer

Layer

selected : Boolean

Layer

selectedFeatures : Vector.<String>

VectorLayer

style : Style

VectorLayer

url : String

The url use for the layer request if necessary.

Layer

visible : Boolean

[override] [write-only] Define if this layer is visible (displayed) or not

Layer

zindex : int

Current layer position in the display list

Layer

	Property	Defined By
		_autoResolution : Boolean = true	Layer
		_centerChanged : Boolean = false	Layer
		loading : Boolean [write-only] Used to set loading status of layer	Layer
		_mapReload : Boolean = false	Layer
		_projection : ProjProjection = null	Layer
		_projectionChanged : Boolean = false	Layer
		_resolutionChanged : Boolean = false	Layer

Property

Defined By

_autoResolution : Boolean = true

Layer

_centerChanged : Boolean = false

Layer

loading : Boolean

[write-only] Used to set loading status of layer

Layer

_mapReload : Boolean = false

Layer

_projection : ProjProjection = null

Layer

_projectionChanged : Boolean = false

Layer

_resolutionChanged : Boolean = false

Layer

	Method	Defined By
		VectorLayer(name:String)	VectorLayer
		addFeature(feature:Feature, dispatchFeatureEvent:Boolean = true, reproject:Boolean = true):void Add Feature to the layer.	VectorLayer
		addFeatures(features:Vector.<Feature>, reproject:Boolean = true):void Add Features to the layer.	VectorLayer
		addOriginator(originator:DataOriginator):void Add a new originator for the layer	Layer
		clear():void [override]	VectorLayer
		destroy():void [override]	VectorLayer
		generateResolutions(numZoomLevels:uint, nominalResolution:Number):void Generate resolutions array for a nominal resolution (higher one) and a number of zoom levels.	Layer
		getLayerPxFromMapPx(mapPx:Pixel):Pixel	Layer
		getLocationFromMapPx(viewPortPx:Pixel):Location Return a LonLat which is the passed-in map Pixel, translated into lon/lat by the layer.	Layer
		getMapPxFromLayerPx(layerPx:Pixel):Pixel	Layer
		getMapPxFromLocation(lonlat:Location):Pixel Return a Pixel which is the passed-in LonLat,translated into map pixels.	Layer
		getURL(bounds:Bounds):String Return layer URL	Layer
		hasMultiBBoxes():Boolean Tells whether this layer defines multiple bounding boxes	Layer
		isAvailableForBounds(bounds:Bounds, resolution:Resolution):Boolean This method tells if the layer is available for the specified bounds and resolution	Layer
		redraw(fullRedraw:Boolean = false):void [override]	VectorLayer
		removeEventListenerFromMap():void Remove map related event listeners	Layer
		removeFeature(feature:Feature, dispatchFeatureEvent:Boolean = true):void	VectorLayer
		removeFeatures(features:Vector.<Feature>):void	VectorLayer
		reset():void [override]	VectorLayer
		resetFeaturesPosition():void	VectorLayer
		supportsProjection(compareProj:*):Boolean [override]	VectorLayer

Method

Defined By

VectorLayer(name:String)

VectorLayer

addFeature(feature:Feature, dispatchFeatureEvent:Boolean = true, reproject:Boolean = true):void

Add Feature to the layer.

VectorLayer

addFeatures(features:Vector.<Feature>, reproject:Boolean = true):void

Add Features to the layer.

VectorLayer

addOriginator(originator:DataOriginator):void

Add a new originator for the layer

Layer

clear():void

[override]

VectorLayer

destroy():void

[override]

VectorLayer

generateResolutions(numZoomLevels:uint, nominalResolution:Number):void

Generate resolutions array for a nominal resolution (higher one) and a number of zoom levels.

Layer

getLayerPxFromMapPx(mapPx:Pixel):Pixel

Layer

getLocationFromMapPx(viewPortPx:Pixel):Location

Return a LonLat which is the passed-in map Pixel, translated into lon/lat by the layer.

Layer

getMapPxFromLayerPx(layerPx:Pixel):Pixel

Layer

getMapPxFromLocation(lonlat:Location):Pixel

Return a Pixel which is the passed-in LonLat,translated into map pixels.

Layer

getURL(bounds:Bounds):String

Return layer URL

Layer

hasMultiBBoxes():Boolean

Tells whether this layer defines multiple bounding boxes

Layer

isAvailableForBounds(bounds:Bounds, resolution:Resolution):Boolean

This method tells if the layer is available for the specified bounds and resolution

Layer

redraw(fullRedraw:Boolean = false):void

[override]

VectorLayer

removeEventListenerFromMap():void

Remove map related event listeners

Layer

removeFeature(feature:Feature, dispatchFeatureEvent:Boolean = true):void

VectorLayer

removeFeatures(features:Vector.<Feature>):void

VectorLayer

reset():void

[override]

VectorLayer

resetFeaturesPosition():void

VectorLayer

supportsProjection(compareProj:*):Boolean

[override]

VectorLayer

	Method	Defined By
		draw():void [override]	VectorLayer
		onEnterFrame(event:Event):void Bind the redraw of the layers on the flash onEnterFrame	Layer
		onMapCenterChanged(event:MapEvent):void This function is call when the MapEvent.CENTER_CHANGED Call the redraw function to check if the layer can be displayed Override this method if you want a specific behaviour in your layer when the center is changed	Layer
		onMapMove(e:MapEvent):void	Layer
		onMapProjectionChanged(event:MapEvent):void This function is call when the MapEvent.PROJECTION_CHANGED Override this method if you want a specific behaviour in your layer when the projection of the map is changed	Layer
		onMapReload(event:MapEvent):void This function is call when the MapEvent.RELOAD Override this method if you want a specific behaviour in your layer when the map ask for a reload.	Layer
		onMapResize(e:MapEvent):void This function is call when the MapEvent.RESIZE Call the redraw method to fully actualize the layer Override this method if you want a specific behaviour in your layer when the size of the map is changed	Layer
		onMapResolutionChanged(event:MapEvent):void This function is call when the MapEvent.RESOLUTION_CHANGED Override this method if you want a specific behaviour in your layer when the resolution of the map is changed	Layer
		onMaxExtentChanged(e:MapEvent):void This function is call when the MapEvent.MAX_EXTENT_CHANGED Call the redraw method to fully actualize the layer Override this method if you want a specific behaviour in your layer when the MaxExtent of the map is changed	Layer
		onSecurityInitialized(e:SecurityEvent):void	Layer

Method

Defined By

draw():void

[override]

VectorLayer

onEnterFrame(event:Event):void

Bind the redraw of the layers on the flash onEnterFrame

Layer

onMapCenterChanged(event:MapEvent):void

This function is call when the MapEvent.CENTER_CHANGED Call the redraw function to check if the layer can be displayed Override this method if you want a specific behaviour in your layer when the center is changed

Layer

onMapMove(e:MapEvent):void

Layer

onMapProjectionChanged(event:MapEvent):void

This function is call when the MapEvent.PROJECTION_CHANGED Override this method if you want a specific behaviour in your layer when the projection of the map is changed

Layer

onMapReload(event:MapEvent):void

This function is call when the MapEvent.RELOAD Override this method if you want a specific behaviour in your layer when the map ask for a reload.

Layer

onMapResize(e:MapEvent):void

This function is call when the MapEvent.RESIZE Call the redraw method to fully actualize the layer Override this method if you want a specific behaviour in your layer when the size of the map is changed

Layer

onMapResolutionChanged(event:MapEvent):void

This function is call when the MapEvent.RESOLUTION_CHANGED Override this method if you want a specific behaviour in your layer when the resolution of the map is changed

Layer

onMaxExtentChanged(e:MapEvent):void

This function is call when the MapEvent.MAX_EXTENT_CHANGED Call the redraw method to fully actualize the layer Override this method if you want a specific behaviour in your layer when the MaxExtent of the map is changed

Layer

onSecurityInitialized(e:SecurityEvent):void

Layer

	Constant	Defined By
		DEFAULT_DPI : Number = 92 [static]	Layer
		DEFAULT_NOMINAL_RESOLUTION : Resolution [static]	Layer
		DEFAULT_NUM_ZOOM_LEVELS : uint = 18 [static]	Layer
		DEFAULT_PROJECTION : ProjProjection [static]	Layer
		RESOLUTION_TOLERANCE : Number = 0.000001 [static]	Layer

Constant

Defined By

DEFAULT_DPI : Number = 92

[static]

Layer

DEFAULT_NOMINAL_RESOLUTION : Resolution

[static]

Layer

DEFAULT_NUM_ZOOM_LEVELS : uint = 18

[static]

Layer

DEFAULT_PROJECTION : ProjProjection

[static]

Layer

RESOLUTION_TOLERANCE : Number = 0.000001

[static]

Layer

Property Detail

attributesId

property

attributesId:Vector.<String>

Implementation
public function get attributesId():Vector.<String>
public function set attributesId(value:Vector.<String>):void

available

property

available:Boolean [read-only] [override]

Implementation
public function get available():Boolean

data

property

data:XML

If the VectorLayer is made from locale source : the XML data

Implementation
public function get data():XML
public function set data(value:XML):void

editable

property

editable:Boolean

Implementation
public function get editable():Boolean
public function set editable(value:Boolean):void

features

property

features:Vector.<Feature> [read-only]

The list of features contained by this layer

Implementation
public function get features():Vector.<Feature>

featuresBbox

property

featuresBbox:Bounds

Implementation
public function get featuresBbox():Bounds
public function set featuresBbox(value:Bounds):void

featuresID

property

featuresID:Vector.<String> [read-only]

Implementation
public function get featuresID():Vector.<String>

geometryType

property

geometryType:String

Implementation
public function get geometryType():String
public function set geometryType(value:String):void

idLabel

property

idLabel:uint

Implementation
public function get idLabel():uint
public function set idLabel(value:uint):void

idPath

property

idPath:uint

Implementation
public function get idPath():uint
public function set idPath(value:uint):void

idPoint

property

idPoint:uint

Implementation
public function get idPoint():uint
public function set idPoint(value:uint):void

idPolygon

property

idPolygon:uint

Implementation
public function get idPolygon():uint
public function set idPolygon(value:uint):void

inEditionMode

property

inEditionMode:Boolean

Implementation
public function get inEditionMode():Boolean
public function set inEditionMode(value:Boolean):void

initInDrawingToolbar

property

initInDrawingToolbar:Boolean

Implementation
public function get initInDrawingToolbar():Boolean
public function set initInDrawingToolbar(value:Boolean):void

initOutDrawingToolbar

property

initOutDrawingToolbar:Boolean

Implementation
public function get initOutDrawingToolbar():Boolean
public function set initOutDrawingToolbar(value:Boolean):void

map

property

map:Map[override]

Implementation
public function get map():Map
public function set map(value:Map):void

selectedFeatures

property

selectedFeatures:Vector.<String>

Implementation
public function get selectedFeatures():Vector.<String>
public function set selectedFeatures(value:Vector.<String>):void

style

property

style:Style

Implementation
public function get style():Style
public function set style(value:Style):void

Constructor Detail

VectorLayer

()

Constructor

public function VectorLayer(name:String)

Parameters

name:String

Method Detail

addFeature

()

method

public function addFeature(feature:Feature, dispatchFeatureEvent:Boolean = true, reproject:Boolean = true):void

Add Feature to the layer.

Parameters

	`feature:Feature` — The feature to add

	`dispatchFeatureEvent:Boolean` (default = `true`)

	`reproject:Boolean` (default = `true`)

addFeatures

()

method

public function addFeatures(features:Vector.<Feature>, reproject:Boolean = true):void

Add Features to the layer.

Parameters

	`features:Vector.<Feature>` — array

	`reproject:Boolean` (default = `true`)

clear

()

method

override public function clear():void

destroy

()

method

override public function destroy():void

draw

()

method

override protected function draw():void

redraw

()

method

override public function redraw(fullRedraw:Boolean = false):void

Parameters

fullRedraw:Boolean (default = false)

removeFeature

()

method

public function removeFeature(feature:Feature, dispatchFeatureEvent:Boolean = true):void

Parameters

	`feature:Feature`

	`dispatchFeatureEvent:Boolean` (default = `true`)

removeFeatures

()

method

public function removeFeatures(features:Vector.<Feature>):void

Parameters

features:Vector.<Feature>

reset

()

method

override public function reset():void

resetFeaturesPosition

()

method

public function resetFeaturesPosition():void

supportsProjection

()

method

override public function supportsProjection(compareProj:*):Boolean

Parameters

compareProj:*

Returns

Boolean

Fri Dec 23 2011, 11:55 AM +01:00

Core Documentation	All Packages \| All Classes \| Index \| Frames No Frames
VectorLayer	Properties \| Methods \| Constants

Package	org.openscales.core.layer
Class	public class VectorLayer
Inheritance	VectorLayer Layer flash.display.Sprite
Subclasses	GeoRss, GML, GPX, Graticule, KML, WFS