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

Summary
OpenLayers. Layer. VectorInstances 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 friendly error message when loading of renderer fails.
style{Object} Default style for the layer
rendererOptions{Object} Options for the renderer.
geometryType{String} geometryType allows you to limit the types of geometries this layer supports.
Constructor
OpenLayers. Layer. VectorCreate a new vector layer
Functions
destroyDestroy this layer
displayHide or show the Layer
addFeaturesAdd Features to the layer.
removeFeaturesRemove features from the layer.
destroyFeaturesErase and destroy features on the layer.
drawFeatureDraw (or redraw) a feature on the layer.
getFeatureByIdGiven a feature id, return the feature if it exists in the features array
onFeatureInsertmethod called after a feature is inserted.
preFeatureInsertmethod called before a feature is inserted.
getDataExtentCalculates 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)

beforefeatureaddedTriggered before a feature is added.  Listeners will receive an object with a feature property referencing the feature to be added.  To stop the feature from being added, a listener should return false.
beforefeaturesaddedTriggered before an array of features is added.  Listeners will receive an object with a features property referencing the feature to be added.  To stop the features from being added, a listener should return false.
featureaddedTriggered after a feature is added.  The event object passed to listeners will have a feature property with a reference to the added feature.
featuresaddedTriggered after features are added.  The event object passed to listeners will have a features property with a reference to an array of added features.
beforefeatureremovedTriggered before a feature is removed.  Listeners will receive an object with a feature property referencing the feature to be removed.
featureremovedTriggerd after a feature is removed.  The event object passed to listeners will have a feature property with a reference to the removed feature.
featuresremovedTriggered after features are removed.  The event object passed to listeners will have a features property with a reference to an array of removed features.
featureselectedTriggered after a feature is selected.  Listeners will receive an object with a feature property referencing the selected feature.
featureunselectedTriggered after a feature is unselected.  Listeners will receive an object with a feature property referencing the unselected feature.
beforefeaturemodifiedTriggered when a feature is selected to be modified.  Listeners will receive an object with a feature property referencing the selected feature.
featuremodifiedTriggered when a feature has been modified.  Listeners will receive an object with a feature property referencing the modified feature.
afterfeaturemodifiedTriggered when a feature is finished being modified.  Listeners will receive an object with a feature property referencing the modified feature.
vertexmodifiedTriggered when a vertex within any feature geometry has been modified.  Listeners will receive an object with a feature property referencing the modified feature, a vertex property referencing the vertex modified (always a point geometry), and a pixel property referencing the pixel location of the modification.
sketchstartedTriggered when a feature sketch bound for this layer is started.  Listeners will receive an object with a feature property referencing the new sketch feature and a vertex property referencing the creation point.
sketchmodifiedTriggered when a feature sketch bound for this layer is modified.  Listeners will receive an object with a vertex property referencing the modified vertex and a feature property referencing the sketch feature.
sketchcompleteTriggered when a feature sketch bound for this layer is complete.  Listeners will receive an object with a feature property referencing the sketch feature.  By returning false, a listener can stop the sketch feature from being added to the layer.
refreshTriggered when something wants a strategy to ask the protocol for a new set of features.

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

reportError

{Boolean} report friendly error message when loading of renderer fails.

style

{Object} Default style for the layer

rendererOptions

{Object} Options for the renderer.  See {OpenLayers.Renderer} for supported options.

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

display

display: function(display)

Hide or show the Layer

Parameters

display{Boolean}

addFeatures

addFeatures: function(features,
options)

Add Features to the layer.

Parameters

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

removeFeatures

removeFeatures: function(features,
options)

Remove features from the layer.  This erases any drawn features and removes them from the layer’s control.  The beforefeatureremoved and featureremoved events will be triggered for each feature.  The featuresremoved event will be triggered after all features have been removed.  To supress event triggering, use the silent option.

Parameters

features{Array(OpenLayers.Feature.Vector)} List of features to be removed.
options{Object} Optional properties for changing behavior of the removal.

Valid options

silent{Boolean} Supress event triggering.  Default is false.

destroyFeatures

destroyFeatures: function(features,
options)

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.
options{Object}

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.

This function is not designed to be used when adding features to the layer (use addFeatures instead).  It is meant to be used when the style of a feature has changed, or in some other way needs to visually updated after it has already been added to a layer.  You must add the feature to the layer for most layer-related events to happen.

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}

Vector features use the OpenLayers.Geometry classes as geometry description.
destroy: function()
Destroy this layer
display: function(display)
Hide or show the Layer
addFeatures: function(features,
options)
Add Features to the layer.
removeFeatures: function(features,
options)
Remove features from the layer.
destroyFeatures: function(features,
options)
Erase and destroy features on the layer.
drawFeature: function(feature,
style)
Draw (or redraw) a feature on the layer.
getFeatureById: function(featureId)
Given a feature id, return the feature if it exists in the features array
onFeatureInsert: function(feature)
method called after a feature is inserted.
preFeatureInsert: function(feature)
method called before a feature is inserted.
getDataExtent: function ()
Calculates the max extent which includes all of the features.
Create a new vector layer
This is the base class for all renderers.
Instances of this class represent bounding boxes.
Close