Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Increase options for tile url templates. #715

Merged
merged 2 commits into from
Jun 23, 2017
Merged

Increase options for tile url templates. #715

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b8d7f7
Increase options for tile url templates.
manthey Jun 22, 2017
212b1f8
Refactor so that regexps aren't parsed on every tile.
manthey Jun 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 36 additions & 11 deletions src/tileLayer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,53 @@ module.exports = (function () {
/**
* Pick a subdomain from a list of subdomains based on a the tile location.
*
* @param {number} x: the x tile coordinate.
* @param {number} y: the y tile coordinate.
* @param {list} subdomains: the list of known subdomains.
* @param {number} x The x tile coordinate.
* @param {number} y The y tile coordinate.
* @param {number} z The tile layer.
* @param {string[]} subdomains The list of known subdomains.
* @returns {string} A subdomain based on the location.
*/
function m_getTileSubdomain(x, y, subdomains) {
return subdomains[modulo(x + y, subdomains.length)];
function m_getTileSubdomain(x, y, z, subdomains) {
return subdomains[modulo(x + y + z, subdomains.length)];
}

/**
* Returns an OSM tile server formatting function from a standard format
* string. Replaces {s}, {z}, {x}, and {y}.
* string. Replaces `{s}`, `{z}`, `{x}`, and `{y}`. These may be any case
* and may be prefixed with `$` (e.g., `${X}` is the same as `{x}`). The
* subdomain can be specifed by a string of characters, listed as a range,
* or as a comma separated list (e.g., `{s:abc}`, `{a-c}`, `{a,b,c}` are
* all equivalent.
*
* @param {string} base The tile format string
* @returns: a conversion function.
* @returns {function} A conversion function.
* @private.
*/
function m_tileUrlFromTemplate(base) {
var xPattern = new RegExp(/\$?\{[xX]\}/),
yPattern = new RegExp(/\$?\{[yY]\}/),
zPattern = new RegExp(/\$?\{[zZ]\}/),
sPattern = new RegExp(/\$?\{(s|S|[sS]:.+|[^-{}]-[^-{}]|([^,{}]+,)+[^,{}]+)\}/);
return function (x, y, z, subdomains) {
return base.replace('{s}', m_getTileSubdomain(x, y, subdomains))
.replace('{z}', z)
.replace('{x}', x)
.replace('{y}', y);
var url = base
.replace(xPattern, x)
.replace(yPattern, y)
.replace(zPattern, z);
var sMatch = url.match(sPattern);
if (sMatch) {
if (sMatch[2]) {
subdomains = sMatch[1].split(',');
} else if (sMatch[1][1] === ':') {
subdomains = sMatch[1].substr(2).split('');
} else if (sMatch[1][1] === '-') {
subdomains = [];
for (var i = sMatch[1].charCodeAt(0); i <= sMatch[1].charCodeAt(2); i += 1) {
subdomains.push(String.fromCharCode(i));
}
}
url = url.replace(sPattern, m_getTileSubdomain(x, y, z, subdomains));
}
return url;
};
}

Expand Down
40 changes: 28 additions & 12 deletions tests/cases/tileLayer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -648,8 +648,10 @@ describe('geo.tileLayer', function () {
l._getTiles = function (level, bounds) {
expect(level).toBe(1);
expect(bounds).toEqual({
left: 0, right: 1,
bottom: 0, top: 1
left: 0,
right: 1,
bottom: 0,
top: 1
});
return [
{fetch: function () {
Expand Down Expand Up @@ -1325,21 +1327,35 @@ describe('geo.tileLayer', function () {
});
});
it('url templating', function () {
/* eslint-disable no-template-curly-in-string */
var urls = {
's={s}&x={x}&y={y}&z={z}': ['a', 'b', 'c'],
's=${S}&x=${X}&y=${Y}&z=${Z}': ['a', 'b', 'c'],
's={s:abc}&x={x}&y={y}&z={z}': ['a', 'b', 'c'],
's={a,b,c}&x={x}&y={y}&z={z}': ['a', 'b', 'c'],
's={a-c}&x={x}&y={y}&z={z}': ['a', 'b', 'c'],
's=${s:1234}&x={x}&y={y}&z={z}': ['1', '2', '3', '4'],
's=${1,2,3,4}&x={x}&y={y}&z={z}': ['1', '2', '3', '4'],
's=${1-4}&x={x}&y={y}&z={z}': ['1', '2', '3', '4'],
's={ab,bc,12}&x={x}&y={y}&z={z}': ['ab', 'bc', '12']
};
/* eslint-enable no-template-curly-in-string */
var tiles, l = geo.tileLayer({
map: map({unitsPerPixel: 1}),
wrapX: false,
wrapY: false,
topDown: true,
url: '/testdata/white.jpg?s={s}&x={x}&y={y}&z={z}'
topDown: true
});

tiles = l._getTiles(1, {left: 50, right: 500, bottom: 500, top: 50});
expect(tiles.length).toBe(5);
tiles.forEach(function (tile) {
expect($.inArray(tile._url.split('?s=')[1].split('&')[0],
['a', 'b', 'c'])).toBeGreaterThan(-1);
expect(tile._url.split('&x')[1]).toBe('=' + tile.index.x + '&y=' +
tile.index.y + '&z=' + tile.index.level);
$.each(urls, function (url, subdomains) {
l.url('/testdata/white.jpg?' + url);
tiles = l._getTiles(1, {left: 50, right: 500, bottom: 500, top: 50});
expect(tiles.length).toBe(5);
tiles.forEach(function (tile) {
expect($.inArray(tile._url.split('?s=')[1].split('&')[0],
subdomains)).toBeGreaterThan(-1);
expect(tile._url.split('&x')[1]).toBe('=' + tile.index.x + '&y=' +
tile.index.y + '&z=' + tile.index.level);
});
});
});
it('baseUrl', function () {
Expand Down