OSM.Router also handles updating the hash portion of the URL containing transient
map state such as the position and zoom level. Some route controllers may wish to
temporarily suppress updating the hash (for example, to omit the hash on pages
- such as `/way/1234` unless the map is moved). This can be done by calling
- `OSM.router.moveListenerOff` and `OSM.router.moveListenerOn`.
+ such as `/way/1234` unless the map is moved). This can be done by using
+ `OSM.router.withoutMoveListener` to run a block of code that may update
+ move the map without the hash changing.
*/
-OSM.Router = function(map, rts) {
+OSM.Router = function (map, rts) {
var escapeRegExp = /[\-{}\[\]+?.,\\\^$|#\s]/g;
var optionalParam = /\((.*?)\)/g;
var namedParam = /(\(\?)?:\w+/g;
var splatParam = /\*\w+/g;
function Route(path, controller) {
- var regexp = new RegExp('^' +
- path.replace(escapeRegExp, '\\$&')
- .replace(optionalParam, '(?:$1)?')
- .replace(namedParam, function(match, optional){
- return optional ? match : '([^\/]+)';
+ var regexp = new RegExp("^" +
+ path.replace(escapeRegExp, "\\$&")
+ .replace(optionalParam, "(?:$1)?")
+ .replace(namedParam, function (match, optional) {
+ return optional ? match : "([^\/]+)";
})
- .replace(splatParam, '(.*?)') + '(?:\\?.*)?$');
+ .replace(splatParam, "(.*?)") + "(?:\\?.*)?$");
var route = {};
- route.match = function(path) {
+ route.match = function (path) {
return regexp.test(path);
};
- route.run = function(action, path) {
+ route.run = function (action, path) {
var params = [];
if (path) {
- params = regexp.exec(path).map(function(param, i) {
+ params = regexp.exec(path).map(function (param, i) {
return (i > 0 && param) ? decodeURIComponent(param) : param;
});
}
+ params = params.concat(Array.prototype.slice.call(arguments, 2));
+
return (controller[action] || $.noop).apply(controller, params);
};
}
var routes = [];
- for (var r in rts)
- routes.push(Route(r, rts[r]));
+ for (var r in rts) {
+ routes.push(new Route(r, rts[r]));
+ }
- routes.recognize = function(path) {
+ routes.recognize = function (path) {
for (var i = 0; i < this.length; i++) {
if (this[i].match(path)) return this[i];
}
};
- var currentPath = window.location.pathname.replace(/(.)\/$/, '$1') + window.location.search,
+ var currentPath = window.location.pathname.replace(/(.)\/$/, "$1") + window.location.search,
currentRoute = routes.recognize(currentPath),
currentHash = location.hash || OSM.formatHash(map);
var router = {};
if (window.history && window.history.pushState) {
- $(window).on('popstate', function(e) {
+ $(window).on("popstate", function (e) {
if (!e.originalEvent.state) return; // Is it a real popstate event or just a hash change?
- var path = window.location.pathname + window.location.search;
+ var path = window.location.pathname + window.location.search,
+ route = routes.recognize(path);
if (path === currentPath) return;
- currentRoute.run('unload');
+ currentRoute.run("unload", null, route === currentRoute);
currentPath = path;
- currentRoute = routes.recognize(currentPath);
- currentRoute.run('popstate', currentPath);
- var state = e.originalEvent.state;
- if (state.center) {
- map.setView(state.center, state.zoom, {animate: false});
- map.updateLayers(state.layers);
- }
+ currentRoute = route;
+ currentRoute.run("popstate", currentPath);
+ map.setState(e.originalEvent.state, { animate: false });
});
router.route = function (url) {
- var path = url.replace(/#.*/, ''),
+ var path = url.replace(/#.*/, ""),
route = routes.recognize(path);
if (!route) return false;
- window.history.pushState(OSM.parseHash(url) || {}, document.title, url);
- currentRoute.run('unload');
+ currentRoute.run("unload", null, route === currentRoute);
+ var state = OSM.parseHash(url);
+ map.setState(state);
+ window.history.pushState(state, document.title, url);
currentPath = path;
currentRoute = route;
- currentRoute.run('pushstate', currentPath);
+ currentRoute.run("pushstate", currentPath);
return true;
};
- router.stateChange = function(state) {
+ router.replace = function (url) {
+ window.history.replaceState(OSM.parseHash(url), document.title, url);
+ };
+
+ router.stateChange = function (state) {
if (state.center) {
window.history.replaceState(state, document.title, OSM.formatHash(state));
} else {
}
};
} else {
- router.route = function (url) {
+ router.route = router.replace = function (url) {
window.location.assign(url);
};
- router.stateChange = function(state) {
+ router.stateChange = function (state) {
if (state.center) window.location.replace(OSM.formatHash(state));
};
}
- router.updateHash = function() {
+ router.updateHash = function () {
var hash = OSM.formatHash(map);
if (hash === currentHash) return;
currentHash = hash;
router.stateChange(OSM.parseHash(hash));
};
- router.hashUpdated = function() {
+ router.hashUpdated = function () {
var hash = location.hash;
if (hash === currentHash) return;
currentHash = hash;
var state = OSM.parseHash(hash);
- if (!state) return;
- map.setView(state.center, state.zoom);
- map.updateLayers(state.layers);
+ map.setState(state);
router.stateChange(state, hash);
};
- router.moveListenerOn = function() {
- map.on('moveend', router.updateHash);
+ router.withoutMoveListener = function (callback) {
+ function disableMoveListener() {
+ map.off("moveend", router.updateHash);
+ map.once("moveend", function () {
+ map.on("moveend", router.updateHash);
+ });
+ }
+
+ map.once("movestart", disableMoveListener);
+ callback();
+ map.off("movestart", disableMoveListener);
};
- router.moveListenerOff = function() {
- map.off('moveend', router.updateHash);
+ router.load = function () {
+ var loadState = currentRoute.run("load", currentPath);
+ router.stateChange(loadState || {});
};
- router.load = function() {
- if (currentRoute) {
- var loadState = currentRoute.run('load', currentPath);
- router.stateChange(loadState || {});
- } else {
- console.log("Unable to match route for: " + currentPath);
- }
+ router.setCurrentPath = function (path) {
+ currentPath = path;
+ currentRoute = routes.recognize(currentPath);
};
- map.on('moveend baselayerchange overlaylayerchange', router.updateHash);
- $(window).on('hashchange', router.hashUpdated);
+ map.on("moveend baselayerchange overlaylayerchange", router.updateHash);
+ $(window).on("hashchange", router.hashUpdated);
return router;
};