[Mapbender-commits] r3895 - trunk/mapbender/conf

[svn_mapbender at osgeo.org]

Author: christoph
Date: 2009-04-17 09:12:23 -0400 (Fri, 17 Apr 2009)
New Revision: 3895

Modified:
   trunk/mapbender/conf/wfs_default.conf
Log:
http://trac.osgeo.org/mapbender/ticket/446

Modified: trunk/mapbender/conf/wfs_default.conf
===================================================================
--- trunk/mapbender/conf/wfs_default.conf	2009-04-17 10:37:13 UTC (rev 3894)
+++ trunk/mapbender/conf/wfs_default.conf	2009-04-17 13:12:23 UTC (rev 3895)
@@ -1,3 +1,9 @@
+// --------------------------------------------------------
+//
+// Settings of spatial request buttons
+//
+// --------------------------------------------------------
+
 /**
  * definition of buttons for spatialRequest
  *
@@ -7,46 +13,143 @@
  * [@param {string} img image for the button
  * [@param {string} filteroption type of filter for search (values: "intersects" or "within"), used for buttons buttonRectangle and buttonPolygon 
  */
- 
 var buttonRectangle = {"status":1, "x":750, "y":10, "img":"select_rectangle_off.png","filteroption":"intersects"};
 var buttonPolygon = {"status":1, "x":780, "y":10, "img":"select_polygon_off.png","filteroption":"intersects"};
 var buttonPoint = {"status":1, "x":810, "y":10, "img":"select_point_off.png"};
 var buttonExtent = {"status":1, "x":840, "y":10, "img":"select_extent_off.png"};
 var buttonDialogue = {"status":1, "x":870, "y":10, "img":"select_choose_off.png"};
 
-var mb_wfs_tolerance = 8;
+/**
+ * directory that contains the buttons mentioned above
+ */
+var buttonWfs_imgdir = "../img/button_gray/";
 
-var buttonWfs_imgdir = "../img/button_gray/";
+/**
+ * z-Index of the buttons mentioned above
+ */
 var buttonWfs_zIndex = 10;
 
-// if wfsResultToPopupDiv is 0, this is automatically 1
-var buttonWfs_toDigitize_on = 1; 
-var buttonWfs_toDigitize_target = "digitize";
-var buttonWfs_toDigitize_src = "../img/pencil.png";
 
+// --------------------------------------------------------
+//
+// General WFS request settings
+//
+// --------------------------------------------------------
+
+/**
+ * This is the buffer around query points for spatial requests (in pixel)
+ */
+var mb_wfs_tolerance = 8;
+
+/**
+ * if features found via WFS request do not match 
+ * the current client SRS, a warning with a 
+ * confirmation prompt is displayed. Useful
+ * in applications with switchEPSG
+ */
+var displaySrsWarning = false;
+
+/**
+ * Path to the server-side module that performs the WFS request
+ */
+var wfsResultModulePath = "php/";
+
+/**
+ * File name of the server-side module that performs the WFS request
+ */
+var wfsResultModuleFilename = "mod_wfs_result.php";
+
+
+// --------------------------------------------------------
+//
+// Result geometry highlight settings
+//
+// --------------------------------------------------------
+
+/**
+ * z-Index of the highlighted geometries
+ */
 var generalHighlightZIndex = 90;
+
+/**
+ * Line width of the highlighted geometries in pixel
+ */
 var generalHighlightLineWidth = 2;
 
+/**
+ * Colour of the highlighted geometries in RGB, 
+ * f.e. "#FF0000" for red.
+ */
 var resultHighlightColour = "#FF0000";
 
-var wfsResultModulePath = "php/";
-var wfsResultModuleFilename = "mod_wfs_result.php";
 
-var wfsResultToPopupDiv = 0;
+
+// --------------------------------------------------------
+//
+// Setting for an optional popup div that contains the
+// result geometries from the request
+//
+// --------------------------------------------------------
+
+/**
+ * Displays a popup div that contains the result geometries.
+ * If you want to add a button that exports these geometries
+ * to the digitizing tool, also set the variable "buttonWfs_toDigitize_on"
+ */
+var wfsResultToPopupDiv = 1;
+
+/**
+ * This setting depends on wfsResultToPopupDiv:
+ * if wfsResultToPopupDiv is 1, this setting determines whether
+ * a button appears within the div, that allows to export the
+ * geometries to the digitizing tool.
+ * if wfsResultToPopupDiv is 0, this is setting is ignored,
+ * and geometries will be automatically exported to
+ * the digitizing tool
+ */
+var buttonWfs_toDigitize_on = 1; 
+
+/**
+ * Element ID of the digitizing tool
+ */
+var buttonWfs_toDigitize_target = "digitize";
+
+/**
+ * Path and file name of the button, that exports the
+ * geometries to the digitizing tool
+ */
+var buttonWfs_toDigitize_src = "../img/pencil.png";
+
+/**
+ * Title of the result popup
+ */
 var searchPopupTitle = "Search results";
+
+/**
+ * Width and height of the result popup (in pixel)
+ */
 var searchPopupWidth = 300;
-var searchPopupHeight =250;
+var searchPopupHeight = 250;
+
+/**
+ * Absolute position of the result popup (in pixel)
+ */
 var searchPopupX = 800; 
 var searchPopupY = 100; 
 
-// if feature found via wfs request do not match 
-// the current client SRS, a warning with a 
-// confirmation prompt is displayed. Useful
-// in applications with switchEPSG
-var displaySrsWarning = false;
+/**
+ * Title of the result details popup
+ */
+var detailPopupTitle = "Details";
 
-var detailPopupTitle = "Details";
+/**
+ * Width and height of the result details popup (in pixel)
+ */
 var detailPopupWidth = 300;
 var detailPopupHeight = 250;
+
+/**
+ * Absolute position of the result details popup (in pixel)
+ */
 var detailPopupX = 800; 
 var detailPopupY = 400;
\ No newline at end of file