[Mapbender-commits] r5725 - trunk/mapbender/http/plugins

[svn_mapbender at osgeo.org]

Author: astrid_emde
Date: 2010-03-04 12:40:21 -0500 (Thu, 04 Mar 2010)
New Revision: 5725

Modified:
   trunk/mapbender/http/plugins/mb_zoomBar.js
Log:
added documentation and wiki page

Modified: trunk/mapbender/http/plugins/mb_zoomBar.js
===================================================================
--- trunk/mapbender/http/plugins/mb_zoomBar.js	2010-03-04 16:18:55 UTC (rev 5724)
+++ trunk/mapbender/http/plugins/mb_zoomBar.js	2010-03-04 17:40:21 UTC (rev 5725)
@@ -1,3 +1,44 @@
+/**
+ * Package: zoomBar
+ *
+ * Description:
+ * This module adds a slider to your application which can be used for navigation. The slider provides defined zoom level which can be individually 
+ * configured by the element variable level. A second element variable defaultLevel defines the level which shall be takken when the applicatio-n starts.
+ * 
+ * Files:
+ *  - /http/plugins/mb_zoomBar.js
+ *
+ * SQL:
+ * > INSERT INTO gui_element(fkey_gui_id, e_id, e_pos, e_public, e_comment, e_title, e_element, e_src, e_attributes, e_left, 
+ * > e_top, e_width, e_height, e_z_index, e_more_styles, e_content, e_closetag, e_js_file, e_mb_mod, e_target, e_requires, e_url) VALUES
+ * > ('template_basic_zoomBar','mapframe1_zoomBar',1,1,'Finally, a stupid zoom bar','Zoom to scale','div','','',65,80,NULL ,NULL ,100,'','','div',
+ * > '../plugins/mb_zoomBar.js','','mapframe1','mapframe1, jq_ui_slider','');
+ * > 
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, var_value, context, var_type) VALUES
+ * > ('template_basic_zoomBar', 'mapframe1_zoomBar', 'level', '[2500,5000,10000,50000,100000,500000,1000000,10000000,50000000]', 
+ * > 'define an array of levels for the slider (element_var has to be defined)' ,'var');
+ * 
+ * > INSERT INTO gui_element_vars(fkey_gui_id, fkey_e_id, var_name, var_value, context, var_type) VALUES
+ * > ('template_basic_zoomBar', 'mapframe1_zoomBar', 'defaultLevel', '4', 'define the default level for application start' ,'var');
+ * >
+ * >
+ * Help:
+ * http://www.mapbender.org/zoomBar
+ *
+ * Maintainer:
+ * http://www.mapbender.org/User:Christoph_Baudson
+ * 
+ * Parameters:
+ * level    	     - define an array of levels for the slider (parameter has to be defined)
+ * defaultLevel      -  define the default level for application start, optional, if not defined the last level is taken
+ *
+ * License:
+ * Copyright (c) 2009, Open Source Geospatial Foundation
+ * This program is dual licensed under the GNU General Public License 
+ * and Simplified BSD license.  
+ * http://svn.osgeo.org/mapbender/trunk/mapbender/license/license.txt
+ */
+
 // Must define levels as array, like [250, 1000, 5000, 10000, 100000]
 if (typeof options.level !== "object" || !options.level.length) {
 	new Mapbender.Exception("No levels defined for zoomBar.");