OpenLayers. Layer. Vector

Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. Create a new vector layer with the OpenLayers.Layer.Vector constructor.

Inherits from

OpenLayers.Layer

Summary

OpenLayers. Layer. Vector	Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources.
Constants
EVENT_TYPES	{Array(String)} Supported application event types.
Properties
isBaseLayer	{Boolean} The layer is a base layer.
isFixed	{Boolean} Whether the layer remains in one place while dragging the map.
isVector	{Boolean} Whether the layer is a vector layer.
features	{Array(OpenLayers.Feature.Vector)}
reportError	{Boolean} report error message via alert() when loading of renderers fails.
style	{Object} Default style for the layer
geometryType	{String} geometryType allows you to limit the types of geometries this layer supports.
Constructor
OpenLayers. Layer. Vector	Create a new vector layer
Functions
destroy	Destroy this layer
addFeatures	Add Features to the layer.
removeFeatures
destroyFeatures	Erase and destroy features on the layer.
drawFeature	Draw (or redraw) a feature on the layer.
getFeatureById	Given a feature id, return the feature if it exists in the features array
onFeatureInsert	method called after a feature is inserted.
preFeatureInsert	method called before a feature is inserted.
getDataExtent	Calculates the max extent which includes all of the features.

Constants

EVENT_TYPES

{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax:

layer.events.register(type, obj, listener);

Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.

All event objects have at least the following properties

object {Object} A reference to layer.events.object.
element {DOMElement} A reference to layer.events.element.

Supported map event types (in addition to those from OpenLayers.Layer)

beforefeatureadded Triggered before a feature is added. Listeners will receive an object with a feature property referencing the feature to be added.
featureadded Triggered after a feature is added. The event object passed to listeners will have a feature property with a reference to the added feature.
featuresadded Triggered after features are added. The event object passed to listeners will have a features property with a reference to an array of added features.
featureselected Triggered after a feature is selected. Listeners will receive an object with a feature property referencing the selected feature.
featureunselected Triggered after a feature is unselected. Listeners will receive an object with a feature property referencing the unselected feature.
beforefeaturemodified Triggered when a feature is selected to be modified. Listeners will receive an object with a feature property referencing the selected feature.
featuremodified Triggered when a feature has been modified. Listeners will receive an object with a feature property referencing the modified feature.
afterfeaturemodified Triggered when a feature is finished being modified. Listeners will receive an object with a feature property referencing the modified feature.

Properties

isBaseLayer

{Boolean} The layer is a base layer. Default is true. Set this property in the layer options

isFixed

{Boolean} Whether the layer remains in one place while dragging the map.

isVector

{Boolean} Whether the layer is a vector layer.

features

{Array(OpenLayers.Feature.Vector)}

reportError

{Boolean} report error message via alert() when loading of renderers fails.

style

{Object} Default style for the layer

geometryType

{String} geometryType allows you to limit the types of geometries this layer supports. This should be set to something like “OpenLayers.Geometry.Point” to limit types.

Constructor

OpenLayers. Layer. Vector

Create a new vector layer

Parameters

name	{String} A name for the layer
options	{Object} Optional object with non-default properties to set on the layer.

Returns

{OpenLayers.Layer.Vector} A new vector layer

Functions

destroy

destroy: function()

Destroy this layer

addFeatures

addFeatures: function( features,
options )

Add Features to the layer.

Parameters

features	{Array(OpenLayers.Feature.Vector)}
options	{Object}

removeFeatures

removeFeatures: function( features )

Parameters

features

{Array(OpenLayers.Feature.Vector)}

destroyFeatures

destroyFeatures: function( features )

Erase and destroy features on the layer.

Parameters

features

{Array(OpenLayers.Feature.Vector)} An optional array of features to destroy. If not supplied, all features on the layer will be destroyed.

drawFeature

drawFeature: function( feature,
style )

Draw (or redraw) a feature on the layer. If the optional style argument is included, this style will be used. If no style is included, the feature’s style will be used. If the feature doesn’t have a style, the layer’s style will be used.

Parameters

feature	{OpenLayers.Feature.Vector}
style	{Object} Symbolizer hash or {String} renderIntent

getFeatureById

getFeatureById: function( featureId )

Given a feature id, return the feature if it exists in the features array

Parameters

featureId

{String}

Returns

{OpenLayers.Feature.Vector} A feature corresponding to the given featureId

onFeatureInsert

onFeatureInsert: function( feature )

method called after a feature is inserted. Does nothing by default. Override this if you need to do something on feature updates.

Paarameters

feature

{OpenLayers.Feature.Vector}

preFeatureInsert

preFeatureInsert: function( feature )

method called before a feature is inserted. Does nothing by default. Override this if you need to do something when features are first added to the layer, but before they are drawn, such as adjust the style.

Parameters

feature

{OpenLayers.Feature.Vector}

getDataExtent

getDataExtent: function ()

Calculates the max extent which includes all of the features.

Returns

{OpenLayers.Bounds}