Geo improvements: fitbounds, 'geojson-id' locationmode and 'featureidkey' #4419

etpinard · 2019-12-11T23:31:38Z

Resolves #4267 (the 'geojson-id' AND fitbounds parts) and resolves #4154

Demos:

https://codepen.io/etpinard/pen/YzPWPer - fitbounds on scoped maps with choropleth traces set with custom GeoJSONs via the new geojson attribute and featureidkey
https://codepen.io/etpinard/pen/vYEKEdW -fitbounds around Brazil (locations: ['BRA']) for all projection types

In brief,

6397ab3 adds to ability to set "custom" GeoJSON features to choropleth and scattergeo traces (those that use locations as opposed to lon and lat coordinates) similar to how choroplethmapbox works.
- Like for choroplethmapbox, we use an attribute called geojson to set custom GeoJSONs either as a JSON object or with a URL.
- We also add a new locationmode value 'geojson-id' to allow users to switch between custom GeoJSONs and our "stock" ISO-3 or USA-states GeoJSONs
5709d1b adds featureidkey to choroplethmapbox (as requested in Add new choroplethmapbox locationmode for geojson properties.id #4154) but also to choropleth and scattergeo traces
02d6143 is a big one where we add geo.fitbounds an enum with three possible values:
- false, the default and current behaviour,
- 'locations' which means consider only the visible data in the fitbound computation, that is polygons for choropleth traces and lon/lat/centroid coordinates for scattergeo traces.
- 'geojson' where the bounding box of the entire custom GeoJSON set in the traces' geojson field is considered
- ... more implementation details are in written down in the commit message.
The others commits are fixups of bugs I encountered while working on this.

Potential TODOs:

~~[ ]~~ Add special fitbounds logic for conic projections. Scroll down to the new geo_fitbounds-locations mock to see the less-than-ideal behaviour. This may be as easy as filling projection.parallels to the computed bounds' min and max latitudes, but I wonder if there's a formula out-there that gives the "optimal" parallels given a region of interest. Differed. I can't find a formula that works well for all fitbound polygons
~~[ ]~~ Replace @turf/bbox package added in this PR with our own compute-bounding-box routine. @turf/bbox gives the wrong bounds when a feature collections has polygons on either side of the anti-meridian (e.g. Alaska). Maybe we could leave this for later to not block the release of v1.52.0. Differed to Replace @turf/bbox in geo fitbounds routine #4436
Add some "scope-none" option for @nicolaskruchten, which would hide all the base layers using a single setting. Thinking about this in more details today, I think it would be better to add a geo.visible attribute similar to axis.visible instead. Done in 0909f33

Asking @archmoj to review !

- move extractTraceFeature & fetchTraceGeoData logic from choroplethmapbox/convert.js -> geo_location_utils.js - move feature2polygons from choropleth/plot -> geo_location_utils.js - use lib/loggers instead of Lib in geo_location_utils

... to choroplethmapbox, scattergeo and choropleth traces. - Coerced only when `locationmode: 'geojson-id'`. To determine which key (or nested key) to use to identify eahc geojson feature. - Improve error messages in extractTraceFeature

... with values false (the default and current behaviour), `'locations'` and `'geojson'`. - add `_module.calcGeoJSON` method to the scattergeo and choropleth trace modules, use `@turf/bbox` to compute location bounding boxes (for now), call `calcGeoJSON` before during geo 'plot' before `updateProjection` - add mock axes to geo lonaxis and lataxis, use them reuse doAutorange - adjust projection settings using autorange values - clear attributes that get auto-filled via `fitbounds` during the geo layout defaults - add three mocks TODOs - find improvement for `@turf/bbox` - improve fitbounds behaviour for conic projections

... in choropleth and scattergeo traces

... which makes `%{ct}` available to hovertemplate strings!

archmoj

Brilliant work!
🎖️ 🏅 🥇
@etpinard please find my few comments below.

src/components/modebar/buttons.js

src/lib/geo_location_utils.js

src/traces/scattergeo/attributes.js

archmoj · 2019-12-12T18:00:06Z

test/jasmine/tests/geo_test.js

            .then(done);
        });
+
+        // TODO add test for scope:'none'


Would you be interested to add these tests in this PR?

Yes, when I'll get to this TODO item

Add some "scope-none" option for @nicolaskruchten, which would hide all the base layers using a single setting. Thinking about this in more details today, I think it would be better to add a geo.visible attribute similar to axis.visible instead.

test/jasmine/tests/geo_test.js

test/image/compare_pixels_test.js

- guard against empty subplot list in modebar button handlers - fix 'when' -> 'went' typo in error msg - guard against (potential) infinite fitbounds scales - improve `geojson` attr description - fixup `projection.rotation` fallback in an assertion wrapper

- which when set to false, overrides all the geo.show* defaults - add jasmine default test - add `geo.visible` to geo_featureidkey mock

src/plots/geo/layout_defaults.js

archmoj · 2019-12-20T20:00:36Z

All looks good to me.
@etpinard would you please updating the PR demos using the latest builds?

etpinard · 2019-12-20T20:01:34Z

@archmoj this PR is ready for another round of review.

I decided to differ the "fitbounds + conic projection" item on the TODO list as well as the "replace @turf/bbox" item for later.

etpinard · 2019-12-20T20:03:54Z

ould you please updating the PR demos using the latest builds?

Not that it matters much, but here there are:

archmoj · 2019-12-20T20:09:37Z

Thanks very much.
Please 💃 💃 💃
After the test passed on CI.

mbkupfer · 2020-01-08T20:06:33Z

Thanks for this update. Any chance there will be documentation on how this can be used in practice? All the codepen examples seem a bit contrived with all the coordinates being hardcoded and all.

etpinard added 8 commits December 10, 2019 12:42

add attribute featureidkey

5709d1b

... to choroplethmapbox, scattergeo and choropleth traces. - Coerced only when `locationmode: 'geojson-id'`. To determine which key (or nested key) to use to identify eahc geojson feature. - Improve error messages in extractTraceFeature

fix potential race condition in fetchTraceGeoData

aeaa06d

call resetViews once per-click NOT once per-subplot per-click

98079a1

fix handling of locations[i] 0

5854f6f

... in choropleth and scattergeo traces

add ct key to choropleth* event data

cd1eaef

... which makes `%{ct}` available to hovertemplate strings!

add two mocks to list of flaky test image mocks

ef28e78

etpinard added feature something new status: reviewable labels Dec 11, 2019

etpinard added this to the v1.52.0 milestone Dec 11, 2019

etpinard mentioned this pull request Dec 11, 2019

Auto center/zoom for scattermapbox #3434

Open

archmoj reviewed Dec 12, 2019

View reviewed changes

etpinard added 3 commits December 18, 2019 17:05

address minor PR comments

0e50599

- guard against empty subplot list in modebar button handlers - fix 'when' -> 'went' typo in error msg - guard against (potential) infinite fitbounds scales - improve `geojson` attr description - fixup `projection.rotation` fallback in an assertion wrapper

tweak scroll delta to fix machine-to-machine discrepancies

2b5ddec

add geo.visible

0909f33

- which when set to false, overrides all the geo.show* defaults - add jasmine default test - add `geo.visible` to geo_featureidkey mock

archmoj reviewed Dec 20, 2019

View reviewed changes

src/plots/geo/layout_defaults.js Outdated Show resolved Hide resolved

fix typo

b5b9484

etpinard mentioned this pull request Dec 20, 2019

Replace @turf/bbox in geo fitbounds routine #4436

Closed

etpinard merged commit 1254e73 into master Dec 20, 2019

etpinard deleted the locationmode-geojson-id branch December 20, 2019 20:20

jdamiba mentioned this pull request Jan 9, 2020

1.52 Dash QA #4476

Closed

snyk-bot mentioned this pull request Feb 4, 2020

[Snyk] Upgrade plotly.js from 1.45.3 to 1.52.0 beauremus/ftp-viewer#1

Merged

snyk-bot mentioned this pull request Feb 22, 2020

[Snyk] Upgrade plotly.js from 1.35.2 to 1.52.1 raindigi/eShopOnContainersAI#1

Open

snyk-bot mentioned this pull request Mar 18, 2020

[Snyk] Upgrade plotly.js from 1.52.0 to 1.52.2 beauremus/ftp-viewer#19

Open

snyk-bot mentioned this pull request Apr 17, 2020

[Snyk] Upgrade plotly.js from 1.41.3 to 1.52.3 dunzoit/redash#4

Open

chriddyp added the sponsored label Aug 31, 2020

Uh oh!

Geo improvements: fitbounds, 'geojson-id' locationmode and 'featureidkey' #4419

Geo improvements: fitbounds, 'geojson-id' locationmode and 'featureidkey' #4419

Uh oh!

Conversation

etpinard commented Dec 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

archmoj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

archmoj Dec 12, 2019

Choose a reason for hiding this comment

Uh oh!

etpinard Dec 13, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

archmoj commented Dec 20, 2019

Uh oh!

etpinard commented Dec 20, 2019

Uh oh!

etpinard commented Dec 20, 2019

Uh oh!

archmoj commented Dec 20, 2019

Uh oh!

mbkupfer commented Jan 8, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

etpinard commented Dec 11, 2019 •

edited

Loading