documenting the options argument and how to limit the attributes returned by GetFeature

git-svn-id: http://svn.openlayers.org/trunk/openlayers@11692 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
ahocevar
2011-03-10 22:46:42 +00:00
parent 27da366cd0
commit c0ae33e457

View File

@@ -149,6 +149,10 @@ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, {
* format's read method (that is only about reading transaction
* responses).
*
* Parameters:
* options - {Object} Options for the read operation, in addition to the
* options set on the instance (options set here will take precedence).
*
* To use a configured protocol to get e.g. a WFS hit count, applications
* could do the following:
*
@@ -162,6 +166,16 @@ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, {
* }
* });
* (end)
*
* To limit the attributes returned by the GetFeature request, applications
* can use the propertyNames option to specify the properties to include in
* the response:
*
* (code)
* protocol.read({
* propertyNames: ["DURATION", "INTENSITY"]
* });
* (end)
*/
read: function(options) {
OpenLayers.Protocol.prototype.read.apply(this, arguments);