[OpenLayers-Commits] r11692 - trunk/openlayers/lib/OpenLayers/Protocol/WFS

[commits-20090109 at openlayers.org]

Author: ahocevar
Date: 2011-03-10 14:46:42 -0800 (Thu, 10 Mar 2011)
New Revision: 11692

Modified:
   trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js
Log:
documenting the options argument and how to limit the attributes returned by GetFeature

Modified: trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js	2011-03-10 20:51:03 UTC (rev 11691)
+++ trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js	2011-03-10 22:46:42 UTC (rev 11692)
@@ -149,6 +149,10 @@
      *     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 @@
      *     }
      * });
      * (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);