OpenLayers.Control.GetFeature
Gets vector features for locations underneath the mouse cursor. Can be configured to act on click, hover or dragged boxes. Uses an OpenLayers.Protocol that supports spatial filters to retrieve features from a server and fires events that notify applications of the selected features.
Inherits from
multipleKey
{String} An event modifier (‘altKey’ or ‘shiftKey’) that temporarily sets the multiple property to true. Default is null.
toggleKey
{String} An event modifier (‘altKey’ or ‘shiftKey’) that temporarily sets the toggle property to true. Default is null.
modifiers
{Object} The event modifiers to use, according to the current event being handled by this control’s handlers
multiple
{Boolean} Allow selection of multiple geometries. Default is false.
click
{Boolean} Use a click handler for selecting/unselecting features. If both click and box are set to true, the click handler takes precedence over the box handler if a box with zero extent was selected. Default is true.
single
{Boolean} Tells whether select by click should select a single feature. If set to false, all matching features are selected. If set to true, only the best matching feature is selected. This option has an effect only of the click option is set to true. Default is true.
clickout
{Boolean} Unselect features when clicking outside any feature. Applies only if click is true. Default is true.
toggle
{Boolean} Unselect a selected feature on click. Applies only if click is true. Default is false.
clickTolerance
{Integer} Tolerance for the filter query in pixels. This has the same effect as the tolerance parameter on WMS GetFeatureInfo requests. Will be ignored for box selections. Applies only if click or hover is true. Default is 5. Note that this not only affects requests on click, but also on hover.
hover
{Boolean} Send feature requests on mouse moves. Default is false.
box
{Boolean} Allow feature selection by drawing a box. If set to true set click to false to disable the click handler and rely on the box handler only, even for “zero extent” boxes. See the description of the click option for additional information. Default is false.
maxFeatures
{Integer} Maximum number of features to return from a query in single mode if supported by the protocol. This set of features is then used to determine the best match client-side. Default is 10.
handlerOptions
{Object} Additional options for the handlers used by this control. This is a hash with the keys “click”, “box” and “hover”.
filterType
{String} The type of filter to use when sending off a request. Possible values: OpenLayers.Filter.Spatial.<BBOX|INTERSECTS|WITHIN|CONTAINS> Defaults to: OpenLayers.Filter.Spatial.BBOX
events
{OpenLayers.Events} Events instance for listeners and triggering control specific events.
Register a listener for a particular event with the following syntax
control.events.register(type, obj, listener);
| beforefeatureselected | Triggered when click is true before a feature is selected. The event object has a feature property with the feature about to select |
| featureselected | Triggered when click is true and a feature is selected. The event object has a feature property with the selected feature |
| beforefeaturesselected | Triggered when click is true before a set of features is selected. The event object is an array of feature properties with the features about to be selected. Return false after receiving this event to discontinue processing of all featureselected events and the featuresselected event. |
| featuresselected | Triggered when click is true and a set of features is selected. The event object is an array of feature properties of the selected features |
| featureunselected | Triggered when click is true and a feature is unselected. The event object has a feature property with the unselected feature |
| clickout | Triggered when when click is true and no feature was selected. |
| hoverfeature | Triggered when hover is true and the mouse has stopped over a feature |
| outfeature | Triggered when hover is true and the mouse moves moved away from a hover-selected feature |
OpenLayers.Control.GetFeature
Create a new control for fetching remote features.
Parameters
| options | {Object} A configuration object which at least has to contain a protocol property (if not, it has to be set before a request is made) |
activate
Activates the control.
Returns
{Boolean} The control was effectively activated.
deactivate
Deactivates the control.
Returns
{Boolean} The control was effectively deactivated.
selectClick
| selectClick: function( | evt | ) |
|
Called on click
Parameters
selectBox
| selectBox: function( | position | ) |
|
Callback from the handlers.box set up when box selection is on
Parameters
| position | {<OpenLayers.Bounds>|Object} An OpenLayers.Bounds or an object with a ‘left’, ‘bottom’, ‘right’ and ‘top’ properties. |
selectHover
| selectHover: function( | evt | ) |
|
Callback from the handlers.hover set up when hover selection is on
Parameters
| evt | {Object} event object with an xy property |
cancelHover
Callback from the handlers.hover set up when hover selection is on
request
| request: function( | bounds, | | options | ) |
|
Sends a GetFeature request to the WFS
Parameters
| bounds | {OpenLayers.Bounds} bounds for the request’s BBOX filter |
| options | {Object} additional options for this method. |
Supported options include
| single | {Boolean} A single feature should be returned. Note that this will be ignored if the protocol does not return the geometries of the features. |
| hover | {Boolean} Do the request for the hover handler. |
selectBestFeature
| selectBestFeature: function( | features, | | clickPosition, | | options | ) |
|
Selects the feature from an array of features that is the best match for the click position.
Parameters
Supported options include
| hover | {Boolean} Do the selection for the hover handler. |
setModifiers
| setModifiers: function( | evt | ) |
|
Sets the multiple and toggle modifiers according to the current event
Parameters
select
| select: function( | features | ) |
|
Add feature to the hash of selected features and trigger the featureselected and featuresselected events.
Parameters
hoverSelect
| hoverSelect: function( | feature | ) |
|
Sets/unsets the <hoverFeature>
Parameters
| feature | {OpenLayers.Feature.Vector} the feature to hover-select. If none is provided, the current <hoverFeature> will be nulled and the outfeature event will be triggered. |
unselect
| unselect: function( | feature | ) |
|
Remove feature from the hash of selected features and trigger the featureunselected event.
Parameters
unselectAll
Unselect all selected features.
setMap
Set the map property for the control.
Parameters
pixelToBounds
| pixelToBounds: function( | pixel | ) |
|
Takes a pixel as argument and creates bounds after adding the clickTolerance.
Parameters