Revamp tls.get_subplots #170

etpinard · 2014-12-22T21:43:40Z

@theengineear @chriddyp

tls.get_subplots is in need of some revamping.

More info in this Asana task.

This NB shows off the new features.

Features wishlist:

Generate more complicated subplot arrangements e.g https://plot.ly/~etpinard/245
Assign shared axes
Set irregular horizontal and vertical spacing in-between subplots
Generate subscenes - subaxes subplot grid.
Generate insets with ease

API issue to resolve:

rowspan > 1 and is_empty Revamp tls.get_subplots #170 (comment)

Solution: Enforce specs to have dimensions (rows, columns). Use None to fill in cells over row / column spans.

Ordering of the specs keyword argument Revamp tls.get_subplots #170 (comment)

etpinard · 2014-12-22T21:46:24Z

plotly/tools.py

-    key (types, default=default):
-        description.
+    fig (arg[0]):
+        Plotly figure object or dictionary.


I'm thinking about supporting fig = tls.get_subplots(fig, **kwargs)

e.g. if someone wants to augment a already-defined figure object.

i maybe it would make sense as as a method of a figure?

etpinard · 2014-12-22T21:53:57Z

@theengineear @chriddyp

I'd love to get some feedback before I get started. Thanks in advance.

theengineear · 2014-12-23T00:08:24Z

@etpinard , my major two concerns are:

misplaced functionality, let's make sure we don't extend the use of the get_subplots function beyond it's intuited limits. (related to adding some functionality to a method of Figure OR making a new function to handle a more abstracted figure design process)
rather than take a complicated structure of subplots and infer locations, it might be better to allow the user to define a grid and then assign subplots to locations on the grid (like matplotlib's gridspec)

etpinard · 2014-12-23T15:32:31Z

@theengineear Thanks for the insight as always.

Something along the lines of mpl's gridspecs is the way to go I think. I'll try to work something out today.
[Re making fig an argument for tls.get_subplots] You're right, it does seem a little weird. I wouldn't be opposed to making get_subplots a method of Figure, but let's leave that for a future PR.

- breaks backwards compatibility - horz = 0.2 / columns (same as old if rows==2) - vert = 0.3 / rows (same as old if columns==2)

- subplot domain computation are made using specs whether or not it is a supplied argument

- use tracers (x and y) to keep track of position from subplot to subplot - cases where colspan > 1 or rowspan > 1 require more attention - use _get_shared() to get the shared axis (if any) - use _add_domain() to paste result into fig object - use _fill_grid() to generate the str repr of the subplot grid

- because of new horizontal_spacing and vertical_spacing defaults

etpinard · 2014-12-30T00:28:25Z

plotly/tests/test_core/test_tools/test_get_subplots.py

@@ -73,7 +74,7 @@ def test_a_lot():
        data=Data(),
        layout=Layout(
            xaxis1=XAxis(
-                domain=[0.0, 0.05714285714285713],
+                domain=[0.0, 0.05714285714285712],


@theengineear I had to modify the computed domains. The algorithm in this branch yield slightly (slightly) different values.

etpinard · 2014-12-30T00:33:15Z

@theengineear @chriddyp

I'll make an NB tomorrow showing tls.get_subplots new muscles.

etpinard · 2014-12-31T16:16:28Z

FYI I found a few bugs yesterday while making the NB.

Modifs are coming.

etpinard · 2015-01-09T20:01:29Z

@theengineear good call. _grid_ref and _grid_str make more sense as attributes.

etpinard · 2015-01-09T20:51:21Z

@theengineear @chriddyp version bump and merge?

theengineear · 2015-01-09T21:21:20Z

🍔 from me, but I think we should @chriddyp a little time to respond as well!

chriddyp · 2015-01-09T21:28:23Z

plotly/graph_objs/graph_objs.py

+    Figure.print_grid = print_grid
+
+    def append_trace(self, trace, row, col):
+        try:


docstring!

Helper function to add a data traces to your figure that is bound to axes at the row, col index.
The row, col index is generated from figures created with plotly.tools.make_subplots and
can be viewed with Figure.print_grid.

chriddyp · 2015-01-09T21:45:46Z

I'm gonna give this a quick spin 🚗

chriddyp · 2015-01-09T21:56:11Z

(ongoing)

Missing trace
TODO in the docstring:
rightmost xaxis should prolly be on the bottom
Should we through an error if user puts {} instead of None? Is there any case where {} would be used in tandem with rowspan or colspan?

chriddyp · 2015-01-09T22:02:32Z

plotly/tools.py

+    # stack two subplots vertically
+    fig = tools.get_subplots(rows=2)
+    fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x1', yaxis='y1')]
+    fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]



Maybe changed to:

stack two subplots vertically

fig = tools.get_subplots(rows=2)
fig.append_trace(Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1)

alternatively: fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x1', yaxis='y1')]

fig.append_trace(Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1)

alternatively: fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]

Not sure about the "alternatively" text - thoughts? @theengineear , @etpinard . I sort of feel like docstring should be as concise and informative and extendable as possible, so we shouldn't have the extra comment and instead do a more thorough job on our hosted docs

yeah, let's give one example and link to documentation, we can use that thing to link to the appropriate domain too: https://github.com/plotly/python-api/blob/80fcc59309d59c227a91075070882904e29fb006/plotly/utils.py#L286-292

with the @utils.template_doc wrapper, like in https://github.com/plotly/python-api/blob/a0dad3cc0b70a60e195d4a6ea7eaca06937d1bf3/plotly/plotly/plotly.py#L391

Conflicts: plotly/version.py

chriddyp · 2015-01-12T15:22:15Z

besides this comment (#170 (comment)), 💃 from me

theengineear · 2015-01-12T18:47:15Z

should we make a note about subtle changes (don't have to list them, but just let the user know) here:

https://github.com/plotly/python-api/blob/revamp-get_subplots/plotly/tools.py#L430-433

Revamp tls.get_subplots

add specs to revamped get_subplots()

9b2f4c0

etpinard reviewed Dec 22, 2014
View reviewed changes

etpinard added 17 commits December 29, 2014 18:59

sync latest graph ref master

637c5de

update get_subplots() docstring

55637e0

remove old get_subplots() code

1b1d23a

add Exception if rows or/and columns are not integers

76c6d4e

make h/v spacing depend on the number of rows/columns:

9f1c240

- breaks backwards compatibility - horz = 0.2 / columns (same as old if rows==2) - vert = 0.3 / rows (same as old if columns==2)

initialize specs list of lists:

5406fb3

- subplot domain computation are made using specs whether or not it is a supplied argument

compute some common distances

26f704e

add _get_shared()

8705058

add _add_domain() and _add_domain_is3D()

842ff88

add _fill_grid()

c55a92f

initialize looping variables

34ee502

(oops) get_shared -> _get_shared

97145a5

add print_grid

5dfcfad

modify computed domain in existing tests (because of rounding errors)

f72a249

modify arguments in existing tests:

857a7d7

- because of new horizontal_spacing and vertical_spacing defaults

test galore git diff --cached !

e64794b

etpinard reviewed Dec 30, 2014
View reviewed changes

etpinard added 2 commits January 9, 2015 14:42

add append_trace method to Figure

9a2767b

make _grid_ref and _grid_str attributes

f13a408

etpinard added 4 commits January 9, 2015 15:23

fix typo in exception msg

857013c

better test name

7e2d3e0

add exception for row/col =< 0

ff0a112

add tests for append_trace

8dc3f80

chriddyp reviewed Jan 9, 2015
View reviewed changes

etpinard added 9 commits January 9, 2015 17:31

force set axis.position when anchor == 'free'

87501d8

update tests

cebfae2

update make_subplot docstring

68aee36

add docstring to append_trace and print_grid

4ee9b59

add Exception if rows / cols <= 0

d2d7a92

add tests about last commit

1f1960d

add example in Figure.append_trace docstring on ref in make_subplots

e0301ad

v 1.5.0

3ac711f

Merge branch 'master' into revamp-get_subplots

5536194

Conflicts: plotly/version.py

etpinard added a commit that referenced this pull request Jan 13, 2015

Merge pull request #170 from plotly/revamp-get_subplots

241f4ca

Revamp tls.get_subplots

etpinard merged commit 241f4ca into master Jan 13, 2015

etpinard deleted the revamp-get_subplots branch January 13, 2015 00:28

chriddyp mentioned this pull request May 25, 2015

Add update functionality to make_subplots #221

Closed

etpinard mentioned this pull request Feb 14, 2019

layout.grid enhancements for plotly.py to replace make_subplots plotly/plotly.js#3507

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revamp tls.get_subplots #170

Revamp tls.get_subplots #170

etpinard commented Dec 22, 2014

etpinard Dec 22, 2014

theengineear Dec 22, 2014

etpinard commented Dec 22, 2014

theengineear commented Dec 23, 2014

etpinard commented Dec 23, 2014

etpinard Dec 30, 2014

etpinard commented Dec 30, 2014

etpinard commented Dec 31, 2014

etpinard commented Jan 9, 2015

etpinard commented Jan 9, 2015

theengineear commented Jan 9, 2015

chriddyp Jan 9, 2015

chriddyp commented Jan 9, 2015

chriddyp commented Jan 9, 2015

chriddyp Jan 9, 2015

theengineear Jan 12, 2015

chriddyp commented Jan 12, 2015

theengineear commented Jan 12, 2015

Revamp tls.get_subplots #170

Revamp tls.get_subplots #170

Conversation

etpinard commented Dec 22, 2014

etpinard Dec 22, 2014

Choose a reason for hiding this comment

theengineear Dec 22, 2014

Choose a reason for hiding this comment

etpinard commented Dec 22, 2014

theengineear commented Dec 23, 2014

etpinard commented Dec 23, 2014

etpinard Dec 30, 2014

Choose a reason for hiding this comment

etpinard commented Dec 30, 2014

etpinard commented Dec 31, 2014

etpinard commented Jan 9, 2015

etpinard commented Jan 9, 2015

theengineear commented Jan 9, 2015

chriddyp Jan 9, 2015

Choose a reason for hiding this comment

chriddyp commented Jan 9, 2015

chriddyp commented Jan 9, 2015

chriddyp Jan 9, 2015

Choose a reason for hiding this comment

stack two subplots vertically

alternatively: fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x1', yaxis='y1')]

alternatively: fig['data'] += [Scatter(x=[1,2,3], y=[2,1,2], xaxis='x2', yaxis='y2')]

theengineear Jan 12, 2015

Choose a reason for hiding this comment

chriddyp commented Jan 12, 2015

theengineear commented Jan 12, 2015