Repository navigation
ENH: provide mapbox viewport coordinates in relayout data #4399
Description
Activity
Could
coordinatesbe something that is added only torelayoutdata, or would it need to be a new figure property as well?It could, but it would be a first. At the moment, we only include key-values of the attributes that changed during an interaction.
I think I would prefer emitting
coordinatesin a differentplotly_event.coordinatesis derivable fromcenter/zoom/bearing/pitchbut it's much, much easier for that derivation to happen in plotly.js via the mapbox code itself. It makes sense to me to add this in the same event, as a favour to non-JS users of this data :)For now though
plotly_relayoutevent data maps exactly toPlotly.relayoutarguments, so in principle folks may be using this to accumulate changes that get fed back to the same or another plot later. If we add in other things that look like attributes, this would lead to invalid figures - mostly silently so, but confusing and potentially painful in case there's any chance we'd add attributes with these names later.But perhaps we could add something that is clearly NOT an attribute? Like:
_derived: {coordinates: ...}Reacted by Mojtaba SamimiBut perhaps we could add something that is clearly NOT an attribute? Like:
_derived: {coordinates: ...}Yes, this is the kind of thing I was thinking
I'd be ok with adding something like
_derived: {coordinates: ...}Works for me! I'll open a PR shortly...
I would like the mapbox subplot relayout data to include the
lon/latof the viewport corners. This would make it possible to use a mapbox subplot to display an image layer that is dynamically generated for the current viewport.The relayout data currently includes
mapbox.center,mapbox.zoom,mapbox.bearing, andmapbox.pitch. I would like to propose that we include amapbox.coordinatesproperty that contains an array of the lon/lat coordinates of the four corners of the viewport.This would match the
coordinatesproperty that is expected inimagelayers. See https://docs.mapbox.com/mapbox-gl-js/example/image-on-a-map/.These points can be generated from the mapbox API by following the example in
mapbox/mapbox-gl-js#2375 (comment).
Question:
Could
coordinatesbe something that is added only torelayoutdata, or would it need to be a new figure property as well? The reason it's not clear to me that it should be a property is that it would be read-only. I don't think we could really support settingcoordinatesas a way to set where to place the viewport (at least in the case of non-zerobearingandpitch).