GUI -- Split MapService into GeoDataService and MapService. WIP.
Change-Id: Ibfe5b35ecdfaaf39b9d48abd29d0a44327dec130
diff --git a/web/gui/src/main/webapp/app/fw/svg/map.js b/web/gui/src/main/webapp/app/fw/svg/map.js
index 7a6b981..d57e65d 100644
--- a/web/gui/src/main/webapp/app/fw/svg/map.js
+++ b/web/gui/src/main/webapp/app/fw/svg/map.js
@@ -21,22 +21,14 @@
*/
/*
- The Map Service caches GeoJSON maps, which can be loaded into the map
- layer of the Topology View.
+ The Map Service provides a simple API for loading geographical maps into
+ an SVG layer. For example, as a background to the Topology View.
- A GeoMap object can be fetched by ID. IDs that start with an asterisk
- identify maps bundled with the GUI. IDs that do not start with an
- asterisk are assumed to be URLs to externally provided data (exact
- format to be decided).
+ e.g. var ok = MapService.loadMapInto(svgLayer, '*continental-us');
- e.g. var geomap = MapService.fetchGeoMap('*continental-us');
-
- The GeoMap object encapsulates topology data (features), and the
- D3 projection object.
-
- Note that, since the GeoMap instance is cached / shared, it should
- contain no state.
- */
+ The Map Service makes use of the GeoDataService to load the required data
+ from the server.
+*/
(function () {
'use strict';