Changes between Version 7 and Version 8 of BluePrintGISAPI

Timestamp:

04/26/10 08:01:24 (16 years ago)

Author:

Michael Howden

Comment:

API function extended

BluePrintGISAPI

@@ -11 +11 @@
    * A form which get displayed as the pop-up for the markers (along with the location_id as a arg/var, so can customize the display)
   * Be able to define the default size of the map
+ * It would be good to be able to pass additional layers (or turn current layers off) to the map via JS, so that the map can be controlled dynamically using external controls. Although this probably represents a great deal of complexity and may need to be reconsidered.
 
 We can pass information in 3 different ways:
  1. Argument
- 2. Global variable (e.g. request.s3.gis_*)
- 3. Config in Database
+ 2. Global variable (e.g. request.s3.gis_*) <- Not Advised
+ 3. Config in Database <- Not efficient
   * {{{gis.read_config()}}}
 
@@ -23 +24 @@
 This is the current API used by the FRP application:
 {{{
-http://127.0.0.1:8000/frp/gis/map_viewing_client?kml_name=Programmes&kml_feed=http://127.0.0.1:8000/frp/or/programme/report.kml?from=2010-04-23&until=2010-04-23&mode=programme
+http://127.0.0.1:8000/frp/gis/map_viewing_client?
+    kml_name=Programmes&
+    kml_feed=http://127.0.0.1:8000/frp/or/programme/report.kml?
+        from=2010-04-23&
+        until=2010-04-23&
+        mode=programme
 }}}
 
@@ -33 +39 @@
 ==== Embed a map within a Page ====
 {{{
-    gis.show_map(height=default, width=default, overlays=False)
+    gis.show_map(height=<default>, 
+                 width=<default>, 
+                 base_layer=<default>, 
+                 internal_layers=None,
+                 internal_layer_menu = True,
+                 markers=<default>,
+                 popup_url = <default>,
+                 external_layers=None,
+                 external_layer_menu = True,
+                 map_center_lat = <default>,
+                 map_center_long = <default>,
+                 zoom = <default> 
+)
+    """
+    height - int - height of map in pixels
+    width - int - width of map in pixels
+    base_layer - string - base layer used for map: "OSM", "Google", "Bing"
+    internal_layers - list of strings - db.gis_feature_group.name to display on the map
+    internal_layer_menu - bool - whether or not to display the menu to turn on and off the internal_layers
+    markers - list of URLs - to images to display
+    popup_url - list of strings - The URL which will be used to fill the pop-up (potentially different for each internal_layer) (???current term). it will be appended by the Location ID.
+    external_layers - list of strings - List of the WMS(???) to display on the map
+    external_layer_menu - bool - whether or not to display the menu to turn on and off the internal_layers
+    map_center_lat -  ??? - Initial map center point
+    map_center_long - ??? - Initial map center point
+    zoom - int - the initial zoom level of the map
+
+    Will return the HTML to embed a map with the specified options.
+    it would be cool it the layer  menus could be tabs on the side, which slide out when you click on them...
+   
+    Questions: 
+    * I wonder if internal_layers and markers and popup_url should be joined together in a dictionary.
+    * I wonder if we need another array to differentiate between int/ext layers which are a) initially displayed on the map AND b) shown on the menu (but not selected)
+    * I am not entirely sure how the gis_feature_group will work. Perhaps it would be good to be able to pass a query to the function (one of the results of the query will be a location_id field). That would be really nice.
+
+    Given all of these, I wonder if it would be best to pass a list of:
+    internal_layer_options = {gis_feature_group_name,
+                              query, #if query = None, use gis_feature_group_name
+                              marker,
+                              default #if the layer defaults on, or just appears on the menu.
+                              }
+    """
 }}}
 ==== Display Features on the Map ====