Skip to content

Scattermapbox line trailing gaps #1421

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

Merged
merged 4 commits into from
Feb 27, 2017
Merged

Scattermapbox line trailing gaps #1421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63b33c3
don't add empty line strings to line coordinates
etpinard Feb 24, 2017
8215169
add scattermapbox test for lines with trailing gaps
etpinard Feb 24, 2017
1a22beb
add additional trailing null to scattermapbox line w/ gap case
etpinard Feb 27, 2017
24d7c47
improve test case description string
etpinard Feb 27, 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
4 changes: 3 additions & 1 deletion src/lib/geojson_utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ exports.calcTraceToLineCoords = function(calcTrace) {
}
}

coords.push(lineString);
if(lineString.length > 0) {
coords.push(lineString);
}

return coords;
};
Expand Down
55 changes: 35 additions & 20 deletions test/jasmine/tests/scattermapbox_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ describe('scattermapbox convert', function() {
lat: [20, 20, '10', null, 10, 10, 20]
};

it('for markers + circle bubbles traces, should', function() {
it('should generate correct output for markers + circle bubbles traces', function() {
var opts = _convert(Lib.extendFlat({}, base, {
mode: 'markers',
marker: {
Expand All @@ -276,12 +276,12 @@ describe('scattermapbox convert', function() {
stops: [
[0, 'rgb(220, 220, 220)'], [1, '#444'], [2, 'rgb(178, 10, 28)']
]
}, 'have correct circle-color stops');
}, 'circle-color stops');

expect(opts.circle.paint['circle-radius']).toEqual({
property: 'circle-radius',
stops: [ [0, 5], [1, 10], [2, 0] ]
}, 'have correct circle-radius stops');
}, 'circle-radius stops');

var circleProps = opts.circle.geojson.features.map(function(f) {
return f.properties;
Expand All @@ -294,10 +294,10 @@ describe('scattermapbox convert', function() {
{ 'circle-color': 2, 'circle-radius': 2 },
{ 'circle-color': 1, 'circle-radius': 2 },
{ 'circle-color': 1, 'circle-radius': 2 }
], 'have correct geojson feature properties');
], 'geojson feature properties');
});

it('fill + markers + lines traces, should', function() {
it('should generate correct output for fill + markers + lines traces', function() {
var opts = _convert(Lib.extendFlat({}, base, {
mode: 'markers+lines',
marker: { symbol: 'circle' },
Expand All @@ -312,19 +312,19 @@ describe('scattermapbox convert', function() {
var lineCoords = [segment1, segment2],
fillCoords = [[segment1], [segment2]];

expect(opts.line.geojson.coordinates).toEqual(lineCoords, 'have correct line coords');
expect(opts.fill.geojson.coordinates).toEqual(fillCoords, 'have correct fill coords');
expect(opts.line.geojson.coordinates).toEqual(lineCoords, 'line coords');
expect(opts.fill.geojson.coordinates).toEqual(fillCoords, 'fill coords');

var circleCoords = opts.circle.geojson.features.map(function(f) {
return f.geometry.coordinates;
});

expect(circleCoords).toEqual([
[10, 20], [20, 20], [30, 10], [20, 10], [10, 20]
], 'have correct circle coords');
], 'circle coords');
});

it('for markers + non-circle traces, should', function() {
it('should generate correct output for markers + non-circle traces', function() {
var opts = _convert(Lib.extendFlat({}, base, {
mode: 'markers',
marker: { symbol: 'monument' }
Expand All @@ -340,10 +340,10 @@ describe('scattermapbox convert', function() {
return ['monument', ''];
});

expect(symbolProps).toEqual(expected, 'have correct geojson properties');
expect(symbolProps).toEqual(expected, 'geojson properties');
});

it('for text + lines traces, should', function() {
it('should generate correct output for text + lines traces', function() {
var opts = _convert(Lib.extendFlat({}, base, {
mode: 'lines+text',
connectgaps: true,
Expand All @@ -356,7 +356,7 @@ describe('scattermapbox convert', function() {
[10, 20], [20, 20], [30, 10], [20, 10], [10, 20]
];

expect(opts.line.geojson.coordinates).toEqual(lineCoords, 'have correct line coords');
expect(opts.line.geojson.coordinates).toEqual(lineCoords, 'line coords');

var actualText = opts.symbol.geojson.features.map(function(f) {
return f.properties.text;
Expand All @@ -365,6 +365,23 @@ describe('scattermapbox convert', function() {
expect(actualText).toEqual(['A', 'B', 'C', 'F', '']);
});

it('should generate correct output for lines traces with trailing gaps', function() {
var opts = _convert(Lib.extendFlat({}, base, {
mode: 'lines',
lon: [10, '20', 30, 20, null, 20, 10, null, null],
lat: [20, 20, '10', null, 10, 10, 20, null]
}));

assertVisibility(opts, ['none', 'visible', 'none', 'none']);

var lineCoords = [
[[10, 20], [20, 20], [30, 10]],
[[20, 10], [10, 20]]
];
Copy link
Contributor Author

@etpinard etpinard Feb 24, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previously, this was:

var lineCoords = [
  [[10, 20], [20, 20], [30, 10]],
  [[20, 10], [10, 20]].
  []
];

which lead to an invalid GeoJSON and made mapbox-gl fail.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. I thought this would be a pretty easy fix. Just to confirm, I assume it will also handle [10, '20', 30, 20, null, 20, 10, null, null] without problems?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume it will also handle [10, '20', 30, 20, null, 20, 10, null, null] without problems?

Yes it does: 1a22beb


expect(opts.line.geojson.coordinates).toEqual(lineCoords, 'have correct line coords');
});

it('should correctly convert \'textposition\' to \'text-anchor\' and \'text-offset\'', function() {
var specs = {
'top left': ['top-right', [-0.65, -1.65]],
Expand Down Expand Up @@ -395,15 +412,15 @@ describe('scattermapbox convert', function() {
});
});

it('for markers + circle bubbles traces with repeated values, should', function() {
it('should generate correct output for markers + circle bubbles traces with repeated values', function() {
var opts = _convert(Lib.extendFlat({}, base, {
lon: ['-96.796988', '-81.379236', '-85.311819', ''],
lat: ['32.776664', '28.538335', '35.047157', '' ],
marker: { size: ['5', '49', '5', ''] }
}));

expect(opts.circle.paint['circle-radius'].stops)
.toBeCloseTo2DArray([[0, 2.5], [1, 24.5]], 'not replicate stops');
.toBeCloseTo2DArray([[0, 2.5], [1, 24.5]], 'no replicate stops');

var radii = opts.circle.geojson.features.map(function(f) {
return f.properties['circle-radius'];
Expand All @@ -412,7 +429,7 @@ describe('scattermapbox convert', function() {
expect(radii).toBeCloseToArray([0, 1, 0], 'link features to correct stops');
});

it('for input only blank pts', function() {
it('should generate correct output for traces with only blank points', function() {
var opts = _convert(Lib.extendFlat({}, base, {
mode: 'lines',
lon: ['', null],
Expand All @@ -422,18 +439,16 @@ describe('scattermapbox convert', function() {

assertVisibility(opts, ['none', 'none', 'none', 'none']);

expect(opts.line.geojson.coordinates).toEqual([], 'have correct line coords');
expect(opts.fill.geojson.coordinates).toEqual([], 'have correct fill coords');
expect(opts.line.geojson.coordinates).toEqual([], 'line coords');
expect(opts.fill.geojson.coordinates).toEqual([], 'fill coords');
});

function assertVisibility(opts, expectations) {
var actual = ['fill', 'line', 'circle', 'symbol'].map(function(l) {
return opts[l].layout.visibility;
});

var msg = 'set layer visibility properly';

expect(actual).toEqual(expectations, msg);
expect(actual).toEqual(expectations, 'layer visibility');
}
});

Expand Down