2 * Description: display a query result in a Google map
3 * Copyright (c) 2012-2013 UPMC Sorbonne Universite - INRIA
8 * - infowindow is not properly reopened when the maps does not have the focus
11 GOOGLEMAP_BGCOLOR_RESET = 0;
12 GOOGLEMAP_BGCOLOR_ADDED = 1;
13 GOOGLEMAP_BGCOLOR_REMOVED = 2;
17 // events that happen in the once-per-view range
21 // this now should be obsolete, rather use plugin_debug in plugin.js
22 // more on a on-per-record basis
26 var GoogleMap = Plugin.extend({
28 /**************************************************************************
30 **************************************************************************/
32 init: function(options, element)
34 this._super(options, element);
36 /* Member variables */
38 /* we keep a couple of global hashes
39 * lat_lon --> { marker, <ul> }
40 * id --> { <li>, <input> }
43 /* locating checkboxes by DOM selectors might be abstruse, as we cannot safely assume
44 * all the items will belong under the toplevel <div>
49 this.markers = Array();
52 this.elmt().on('show', this, this.on_show);
53 this.elmt().on('shown.bs.tab', this, this.on_show);
54 this.elmt().on('resize', this, this.on_resize);
56 var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
57 this.object = query.object;
59 /* see querytable.js for an explanation */
60 var keys = manifold.metadata.get_key(this.object);
61 this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
62 this.init_key = this.options.init_key;
63 this.init_key = this.init_key || this.canonical_key;
66 if ( ! this.init_key )
67 messages.warning ("QueryTable : cannot find init_key");
68 if ( ! this.canonical_key )
69 messages.warning ("QueryTable : cannot find canonical_key");
71 messages.debug("googlemap: canonical_key="+this.canonical_key+" init_key="+this.init_key);
73 this.listen_query(options.query_uuid);
75 /* GUI setup and event binding */
76 this.initialize_map();
80 /**************************************************************************
82 **************************************************************************/
84 on_show: function(e) {
85 if (debug) messages.debug("googlemap.on_show");
87 var center = new google.maps.LatLng(self.options.latitude, self.options.longitude);
89 google.maps.event.trigger(self.map, 'resize');
90 self.map.setCenter(center);
93 /**************************************************************************
95 **************************************************************************/
97 initialize_map: function()
99 this.markerCluster = null;
100 //create empty LatLngBounds object in order to automatically center the map on the displayed objects
101 this.bounds = new google.maps.LatLngBounds();
102 var center = new google.maps.LatLng(this.options.latitude, this.options.longitude);
105 zoom: this.options.zoom,
108 mapTypeId: google.maps.MapTypeId.ROADMAP,
111 var domid = this.id('googlemap');
112 var elmt = document.getElementById(domid);
113 this.map = new google.maps.Map(elmt, myOptions);
114 this.infowindow = new google.maps.InfoWindow();
118 // return { marker: gmap_marker, ul : <ul DOM> }
119 create_marker_struct: function(object, lat, lon)
121 /* the DOM fragment */
122 var dom = $("<p>").addClass("geo").append(object+"(s)");
123 var ul = $("<ul>").addClass("geo");
125 /* add a gmap marker to the mix */
126 var marker = new google.maps.Marker({
127 position: new google.maps.LatLng(lat, lon),
129 /* gmap can deal with a DOM element but not a jquery object */
133 //extend the bounds to include each marker's position
134 this.bounds.extend(marker.position);
135 return { marker: marker, ul: ul };
138 /* given an input <ul> element, this method inserts a <li> with embedded checkbox
139 * for displaying/selecting the resource corresponding to the input record
140 * returns the created <input> element for further checkbox manipulation
142 create_record_checkbox: function (record, ul, checked)
144 var key, key_value, data;
146 var checkbox = $("<input>", {type:'checkbox', checked:checked, class:'geo'});
147 var id = record[this.canonical_key];
148 var init_id = record[this.init_key];
150 // xxx use init_key to find out label - or should we explicitly accept an incoming label_key ?
153 key = this.canonical_key;
154 key_value = manifold.record_get_value(record, key);
156 ul.append($("<li>").addClass("geo")
157 .append($('<div>') // .addId(this.id_from_key(key, key_value))
159 .append($("<span>").addClass("geo")
165 // XXX STATE / BACKGROUND
167 // hash by id and by init_id
168 this.by_id[id]=checkbox;
169 this.by_init_id[init_id] = checkbox;
171 /* the callback for when a user clicks
172 * NOTE: this will *not* be called for changes done by program
175 checkbox.change( function (e) {
179 op : this.checked ? STATE_SET_ADD : STATE_SET_REMOVE,
182 manifold.raise_event(self.options.query_uuid, FIELD_STATE_CHANGED, data);
187 set_checkbox_from_record_key: function (record_key, checked)
189 if (checked === undefined) checked = true;
191 var checkbox = this.by_init_id [record_key];
193 console.log("googlemap.set_checkbox_from_record - not found " + record_key);
197 checkbox.attr('checked', checked);
201 set_checkbox_from_data: function(id, checked)
203 var checkbox = this.by_id[id];
205 console.log("googlemap.set_checkbox_from_data - id not found " + id);
208 checkbox.attr('checked', checked);
211 set_bgcolor: function(key_value, class_name)
213 var elt = $(document.getElementById(this.id_from_key(this.canonical_key, key_value)))
214 if (class_name == GOOGLEMAP_BGCOLOR_RESET)
215 elt.removeClass('added removed');
217 elt.addClass((class_name == GOOGLEMAP_BGCOLOR_ADDED ? 'added' : 'removed'));
222 * Populates both this.by_lat_lon and this.arm_marker arrays
224 new_record: function(record)
228 if (!(record['latitude']))
231 /* get the coordinates*/
232 var latitude = unfold.get_value(record['latitude']);
233 var longitude = unfold.get_value(record['longitude']);
234 var lat_lon = latitude + longitude;
236 // check if we've seen anything at that place already
237 // xxx might make sense to allow for some fuzziness,
238 // i.e. consider 2 places equal if not further away than 300m or so...
239 var marker_s = this.by_lat_lon[lat_lon];
240 if ( marker_s == null ) {
241 marker_s = this.create_marker_struct(this.object, latitude, longitude);
242 this.by_lat_lon[lat_lon] = marker_s;
243 this.arm_marker(marker_s.marker, this.map);
246 /* Add key to the marker */
247 record_key = manifold.record_get_value(record, this.canonical_key);
248 marker_s.marker.keys.push(record_key);
250 // now add a line for this resource in the marker
251 // xxx should compute checked here ?
252 // this is where the checkbox will be appended
253 var ul = marker_s.ul;
254 var checkbox = this.create_record_checkbox(record, ul, false);
257 arm_marker: function(marker, map)
260 google.maps.event.addListener(marker, 'click', function () {
261 self.infowindow.close();
262 self.infowindow.setContent(marker.content);
263 self.infowindow.open(map, marker);
267 clear_map: function()
272 filter_map: function()
277 /* Loop on every marker and sets it visible */
278 $.each(this.markers, function(i, marker) {
279 /* For a marker to be visible, at least one of its keys has to
282 $.each(marker.keys, function(j, key) {
283 visible = visible || manifold.query_store.get_record_state(self.options.query_uuid, key, STATE_VISIBLE);
285 marker.setVisible(visible);
288 this.do_clustering();
291 do_clustering: function()
293 this.markerCluster = new MarkerClusterer(this.map, this.markers, {zoomOnClick: false});
294 this.markerCluster.setIgnoreHidden(true);
295 google.maps.event.addListener(this.markerCluster, "clusterclick", function (cluster) {
296 var cluster_markers = cluster.getMarkers();
297 var bounds = new google.maps.LatLngBounds();
298 $.each(cluster_markers, function(i, marker){
299 bounds.extend(marker.getPosition());
301 //map.setCenter(bounds.getCenter(), map.getBoundsZoomLevel(bounds));
302 this.map.fitBounds(bounds);
304 //now fit the map to the bounds
305 this.map.fitBounds(this.bounds);
306 // Fix the zoom of fitBounds function, it's too close when there is only 1 marker
307 if (this.markers.length==1) {
308 this.map.setZoom(this.map.getZoom()-4);
312 redraw_map: function()
314 // Let's clear the table and only add lines that are visible
318 /* Add records to internal hash structure */
319 var record_keys = [];
320 manifold.query_store.iter_records(this.options.query_uuid, function (record_key, record) {
321 self.new_record(record);
322 record_keys.push(record_key);
325 /* Add markers to cluster */
326 this.markers = Array();
327 $.each(this.by_lat_lon, function (k, s) {
328 self.markers.push(s.marker);
331 this.do_clustering();
334 /* Set checkbox and background color */
335 $.each(record_keys, function(i, record_key) {
336 var state = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_SET);
337 var warnings = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_WARNINGS);
339 // XXX The row and checkbox still does not exists !!!!
341 case STATE_SET_IN_SUCCESS:
342 case STATE_SET_OUT_FAILURE:
343 self.set_checkbox_from_record_key(record_key, true);
346 case STATE_SET_OUT_SUCCESS:
347 case STATE_SET_IN_FAILURE:
349 case STATE_SET_IN_PENDING:
350 self.set_checkbox_from_record_key(record_key, true);
351 self.set_bgcolor(record_key, GOOGLEMAP_BGCOLOR_ADDED);
353 case STATE_SET_OUT_PENDING:
354 self.set_bgcolor(record_key, GOOGLEMAP_BGCOLOR_REMOVED);
357 //self.change_status(record_key, warnings); // XXX will retrieve status again
361 /**************************************************************************
363 **************************************************************************/
365 on_filter_added: function(filter)
370 on_filter_removed: function(filter)
375 on_filter_clear: function()
380 on_query_in_progress: function()
385 on_query_done: function()
391 on_field_state_changed: function(data)
397 case STATE_SET_IN_SUCCESS:
398 case STATE_SET_OUT_FAILURE:
399 this.set_checkbox_from_data(data.key, true);
400 this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_RESET);
403 case STATE_SET_OUT_SUCCESS:
404 case STATE_SET_IN_FAILURE:
405 this.set_checkbox_from_data(data.key, false);
406 this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_RESET);
408 case STATE_SET_IN_PENDING:
409 this.set_checkbox_from_data(data.key, true);
410 this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_ADDED);
412 case STATE_SET_OUT_PENDING:
413 this.set_checkbox_from_data(data.key, false);
414 this.set_bgcolor(data.key, QUERYTABLE_BGCOLOR_REMOVED);
420 //this.change_status(data.key, data.value);
427 $.plugin('GoogleMap', GoogleMap);