The WMSGetFeatureInfo control uses a WMS query to get information about a point on the map. The information may be in a display-friendly format such as HTML, or a machine-friendly format such as GML, depending on the server’s capabilities and the client’s configuration. This control handles click or hover events, attempts to parse the results using an OpenLayers.Format, and fires a ‘getfeatureinfo’ event with the click position, the raw body of the response, and an array of features if it successfully read the response.
OpenLayers.
|
The WMSGetFeatureInfo control uses a WMS query to get information about a point on the map. |
Properties | |
hover | {Boolean} Send GetFeatureInfo requests when mouse stops moving. |
drillDown | {Boolean} Drill down over all WMS layers in the map. |
maxFeatures | {Integer} Maximum number of features to return from a WMS query. |
clickCallback | {String} The click callback to register in the {OpenLayers.Handler.Click} object created when the hover option is set to false. |
output | {String} Either “features” or “object”. |
layers | {Array(OpenLayers.Layer.WMS)} The layers to query for feature info. |
queryVisible | {Boolean} If true, filter out hidden layers when searching the map for layers to query. |
url | {String} The URL of the WMS service to use. |
layerUrls | {Array(String)} Optional list of urls for layers that should be queried. |
infoFormat | {String} The mimetype to request from the server. |
vendorParams | {Object} Additional parameters that will be added to the request, for WMS implementations that support them. |
format | {OpenLayers.Format} A format for parsing GetFeatureInfo responses. |
formatOptions | {Object} Optional properties to set on the format (if one is not provided in the format property. |
handlerOptions | {Object} Additional options for the handlers used by this control, e.g. |
events | {OpenLayers.Events} Events instance for listeners and triggering control specific events. |
Constructor | |
<OpenLayers.
|
{String} The click callback to register in the {OpenLayers.Handler.Click} object created when the hover option is set to false. Default is “click”.
{Array(OpenLayers.Layer.WMS)} The layers to query for feature info. If omitted, all map WMS layers with a url that matches this url or layerUrls will be considered.
{String} The mimetype to request from the server. If you are using drillDown mode and have multiple servers that do not share a common infoFormat, you can override the control’s infoFormat by providing an INFO_FORMAT parameter in your OpenLayers.Layer.WMS instance(s).
{OpenLayers.Format} A format for parsing GetFeatureInfo responses. Default is OpenLayers.Format.WMSGetFeatureInfo.
{Object} Optional properties to set on the format (if one is not provided in the format property.
{OpenLayers.Events} Events instance for listeners and triggering control specific events.
control.events.register(type, obj, listener);
beforegetfeatureinfo | Triggered before the request is sent. The event object has an xy property with the position of the mouse click or hover event that triggers the request. |
nogetfeatureinfo | no queryable layers were found. |
getfeatureinfo | Triggered when a GetFeatureInfo response is received. The event object has a text property with the body of the response (String), a features property with an array of the parsed features, an xy property with the position of the mouse click or hover event that triggered the request, and a request property with the request itself. If drillDown is set to true and multiple requests were issued to collect feature info from all layers, text and request will only contain the response body and request object of the last request. |