very simple plugin for manipulating url with visualization state

urllib/README.md

@@ -0,0 +1,30 @@
+d3.urllib
+=========
+
+a simple d3 plugin to manage pushing and pulling the visualization state to the brower url
+
+tests
+-----
+no test suite, I've tested in in Chrome v35 for reasonable use cases
+
+example
+-------
+also no simple example, but you can see it in use here:
+http://www.uvm.edu/storylab/share/papers/dodds2014a/books.html
+
+documentation
+-------------
+right now, only works for strings and lists of strings
+
+create an instance of urllib to append some variable to the url: (here we're creating it for a varible lens with the value lensExtent, a list of two numbers
+
+```javascript
+lensencoder = d3.urllib.encoder().varname("lens").varval(lensExtent);
+```
+
+then we update the url (when a slider is dragged, etc) with:
+```javascript
+lensencoder.varval(lensExtent);	
+```
+
+If you don't want the URL to update until you've called the lensencoder again, don't apply the .varval yet.

urllib/urllib.js

@@ -0,0 +1,146 @@
+/*
+d3.urllib
+=========
+
+a simple d3 plugin to manage pushing and pulling the visualization state to the brower url
+
+tests
+-----
+no test suite, I've tested in in Chrome v35 for reasonable use cases
+
+example
+-------
+also no simple example, but you can see it in use here:
+http://www.uvm.edu/storylab/share/papers/dodds2014a/books.html
+
+documentation
+-------------
+slightly more documentation in the README
+
+*/
+(function() {
+    d3.urllib = {
+	encoder: function() {
+	    var varname = "tmp";
+	    var varval = [];
+	    //var that = this;
+
+	    function urllib(d) {
+		// nothing yet
+		//console.log(this);
+		//console.log(that);
+		return {current: varval,};
+	    }
+
+	    function parseurl() {
+		GET = {};
+		query = window.location.search.substring(1).split("&");
+		// break down the url
+		for (var i = 0, max = query.length; i < max; i++)
+		{
+		    if (query[i] === "") // check for trailing & with no param
+			continue;
+		    var param = query[i].split("=");
+		    GET[decodeURIComponent(param[0])] = decodeURIComponent(param[1] || "");
+		}
+
+		baseUrl = window.location.origin+window.location.pathname;
+		var tmpStr = ""
+		if (typeof varval == 'string' || varval instanceof String)
+		{ tmpStr+=varval; }
+		else
+		{
+		    tmpStr += "["+varval[0]
+		    for (var i=1; i<varval.length; i++) { tmpStr += ","+varval[i]; }
+		    tmpStr+="]"
+		}
+		GET[varname] = tmpStr;
+
+		var urlString = ""
+		for (var key in GET) {
+		    if (GET.hasOwnProperty(key)) {
+			urlString += key+"="+GET[key]+"&"
+		    }
+		}
+
+		urlString = urlString.substring(0,urlString.length-1);
+
+		newDataUrl = baseUrl+"?"+urlString
+
+		window.history.replaceState("object or string", "title",newDataUrl);
+
+		return urllib;
+	    }
+
+	    urllib.varname = function(_) {
+		if (!arguments.length) return varname;
+		varname = _;
+		return urllib;
+	    }
+
+	    urllib.varval = function(_) {
+		if (!arguments.length) return varval;
+		varval = _;
+		return parseurl();
+	    }
+
+	    return urllib;
+	},
+	decoder: function() {
+	    var varname = "tmp";
+	    var varresult = [];
+
+	    function urllib(d) {
+		parseurl();
+		return {current: varresult,};
+	    }
+
+	    function parseurl() {
+		GET = {};
+		query = window.location.search.substring(1).split("&");
+		for (var i = 0, max = query.length; i < max; i++) {
+		    if (query[i] === "") // check for trailing & with no param
+			continue;
+		    var param = query[i].split("=");
+		    GET[decodeURIComponent(param[0])] = decodeURIComponent(param[1] || "");
+		}
+
+		if (varname in GET) {
+		    if (GET[varname].length > 0 && GET[varname][0] === "[") {
+			var tmpArray = GET[varname].substring(1, GET[varname].length - 1).split(',');
+			varresult = tmpArray;
+		    }
+		    else {
+			varresult = GET[varname];
+		    }
+		}
+		return urllib;
+	    }
+
+	    urllib.varname = function(_) {
+		if (!arguments.length) return varname;
+		varname = _;
+		return parseurl();
+	    }
+
+	    urllib.varresult = function(_) {
+		if (!arguments.length) return varresult;
+		varresult = _;
+		return urllib;
+	    }
+
+	    return urllib;
+	}
+    }
+})();
+
+
+
+
+
+
+
+
+
+
+