`add_{hline,vline,hrect,vrect}` and `add_{shape,image,annotation}` to multiple facets, squashed #2840

nicholas-esterer · 2020-10-16T22:11:44Z

Closes #2141 and closes #2140

nicolaskruchten · 2020-10-19T12:59:40Z

doc/python/shapes.md

+See https://plotly.com/python/reference/layout/shapes/ for more information and chart attribute options!
+
+<!-- #region -->


this "what about Dash" section gets added automatically at build time, and so should not be included here please

emmanuelle · 2020-10-20T10:25:51Z

doc/python/horizontal-vertical-shapes.md

+plot can be added via the `add_hline`, `add_vline`, `add_hrect`, and `add_vrect`
+methods of `plotly.graph_objects.Figure`. These shapes are fixed to the
+endpoints of one axis, regardless of the range of the plot, and fixed to data
+coordinates on the other axis. For example


Suggested change

coordinates on the other axis. For example

coordinates on the other axis. Shapes added with these methods are added as [layout shapes](/python/shapes) (as shown when doing `print(fig)`, for example). For example

emmanuelle · 2020-10-20T10:28:52Z

doc/python/horizontal-vertical-shapes.md

+---
+
+### Horizontal and Vertical Lines and Boxes (Autoshapes) in Plotly.py
+


Suggested change

*introduced in plotly 4.12*

maybe also mention that users can pan and zoom, the shapes will adapt

nicolaskruchten · 2020-10-20T13:29:07Z

Needs some changelog entries

nicolaskruchten · 2020-10-20T14:02:16Z

Argh, please ignore last message :)

nicolaskruchten · 2020-10-20T15:16:22Z

OK so this seems to add the shape to all subplots, even if they don't have traces on them:

import plotly.express as px

df = px.data.tips()
fig = px.scatter(df, x="total_bill", y="tip", color="sex", facet_row="time", facet_col="day")
fig.add_shape(x0=0, x1=1, y0=0, y1=1, type="line", row="all", col="all")
fig.show()

but the equivalent .add_hline() call does not... why?

nicolaskruchten · 2020-10-20T18:32:47Z

The behaviour of add_trace() with either or both of row/col = "all" will need to:

implement the "only on subplots with pre-existing traces" logic from .add_hline() and friends
implement the logic we discussed out loud whereby by default all the traces are in the same legendgroup (some UID) unless legendgroup is explicitly set to None and all but the first trace have showlegend=False, unless showlegend is explicitly provided.

nicolaskruchten · 2020-10-20T18:37:08Z

Ah, re point 2 above, we did discuss this and I think I had landed on the idea of documenting the following approach, which is a little verbose, but already works:

fig.add_trace(go.Scatter(x=[1,10], y=[1,5], legendgroup="hi", showlegend=False), row="all", col="all")
fig.data[-1].update(showlegend=True)

nicolaskruchten · 2020-10-20T18:43:16Z

Re point 1 above and the same issue for add_shape ... we had discussed a kwarg exclude_empty_subplots but this doesn't seem to have survived in this PR :) Man, June seems far away now.

emmanuelle · 2020-10-20T20:38:20Z

doc/python/horizontal-vertical-shapes.md

+#### Adding Text Annotations to Autoshapes
+
+Text can be added to an autoshape using the `annotation` keyword. Using the
+above example:


could you please add a link to the annotations tutorial?

Good idea, sure! Is this how you do it? [annotations](/python/text-and-annotations)

emmanuelle

I'm leaving small comments as I'm reading the code... I have not finished yet. The new domain positioning feature is really cool :-).

emmanuelle · 2020-10-20T20:38:59Z

doc/python/images.md

@@ -359,5 +359,8 @@ fig.show(config={'modeBarButtonsToAdd':['drawline',
                                       ]})
 ```

+
+### Images Placed Relative to the Axes
+


placeholder for example here?

Yes, woops ;)

emmanuelle · 2020-10-20T20:40:35Z

doc/python/horizontal-vertical-shapes.md

+---
+
+### Horizontal and Vertical Lines and Boxes (Autoshapes) in Plotly.py
+


maybe also mention that users can pan and zoom, the shapes will adapt

emmanuelle · 2020-10-20T20:56:54Z

doc/python/horizontal-vertical-shapes.md

+df = px.data.tips()
+fig = px.scatter(df, x="total_bill", y="tip", facet_row="smoker", facet_col="sex")
+# Add annotations anchored to the top right corner of the resulting lines
+fig.add_vline(x=30, line_color="purple", annotation=go.layout.Annotation(text="A"))


I think we discourage using go objects like this inside functions, so you could write dict(text="A") instead (@nicolaskruchten can you please confirm?)

yeah let's use a dict here please.

Wait, this was one of the specifications, that it should accept a go.layout.Annotation object, as well as a dict, this is to show that fact.

emmanuelle · 2020-10-21T06:33:37Z

packages/python/plotly/plotly/tests/test_core/test_update_objects/test_select_subplots.py

+    [
+        (
+            ("all", [2, 4, 5], False),
+            _unzip_pairs([(r, c) for r in range(1, NROWS + 1) for c in [2, 4, 5]]),


Suggested change

_unzip_pairs([(r, c) for r in range(1, NROWS + 1) for c in [2, 4, 5]]),

zip(*itertools.product(range(1, NROWS + 1), [2, 4, 5]))

I think the above does the same as your custom _unzip_pairs function (you'd have to import itertools as well, it's part of the standard library), so if it's possible to reduce the amount of home-written code it's better for maintenance and readability.

Nice, I like this trick!

nicolaskruchten · 2020-10-21T12:55:47Z

So just to summarize what I think is missing here: the exclude_empty_subplots kwarg should exist in add_{shape|annotation|layout_image|trace|hline|vline|hrect|vrect} and should default to False for the methods that existed before and to True for the new methods.

In particular, added example for layout images, showing how their position can reference an axis domain.

but this has broken all of the tests.

These will by default add their respective graph object to all subplots but if exclude_empty_subplots is True, they will only add the graph object to those subplots that already have traces on them.

nicolaskruchten · 2020-10-22T13:24:21Z

packages/python/plotly/plotly/basedatatypes.py

+        single plot and so this returns False. """
+        return self._grid_ref is not None
+
+    def _subplot_contains_trace(self, xref, yref):


Right now a subplot with no traces but with a shape does render and "isn't empty" so I'm sort of thinking this should extend to shapes and annotations and images as well...

you mean we should use a function _subplot_contains_shape or something like that? Only add to plots with shapes already on them?

nicolaskruchten · 2020-10-22T14:01:53Z

gotta fix the tests :)

nicolaskruchten · 2020-10-22T14:58:47Z

💃 let's merge this thing!

Squashed version of hline-vline-multifacets

ad54177

nicholas-esterer requested a review from nicolaskruchten October 16, 2020 22:12

Remove mystery file

a7d95be

nicolaskruchten reviewed Oct 19, 2020

View reviewed changes

Removed dash link

6a86381

emmanuelle reviewed Oct 20, 2020

View reviewed changes

This comment has been minimized.

Sign in to view

emmanuelle reviewed Oct 20, 2020

View reviewed changes

emmanuelle reviewed Oct 21, 2020

View reviewed changes

nicholas-esterer added 4 commits October 21, 2020 13:44

Removed _unzip_pairs in favour of zip(*...)

be7eb0f

Improved domain referenced objects docs

0c5126c

In particular, added example for layout images, showing how their position can reference an axis domain.

_add_annotation_like now accepts exclude_empty_subplots argument

00eca47

but this has broken all of the tests.

exclude_empty_subplots for add_{shape,annotation,layout_image,trace}

9cc5777

These will by default add their respective graph object to all subplots but if exclude_empty_subplots is True, they will only add the graph object to those subplots that already have traces on them.

nicolaskruchten reviewed Oct 22, 2020

View reviewed changes

python2 syntax fix

e2f18b1

nicolaskruchten merged commit abd8609 into master Oct 22, 2020

johnml1135 mentioned this pull request Feb 4, 2021

fig.add_vline limited from 0 to 1 when rendered with plotly.offline #2980

Closed

archmoj deleted the hline-vline-multifacets-rebase branch November 23, 2021 23:35

rsubbaraman mentioned this pull request May 8, 2024

Drawing lines / add_shape() is very slow, possible quadratic Schlemiel the Painter algorithm #3620

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`add_{hline,vline,hrect,vrect}` and `add_{shape,image,annotation}` to multiple facets, squashed #2840

`add_{hline,vline,hrect,vrect}` and `add_{shape,image,annotation}` to multiple facets, squashed #2840

nicholas-esterer commented Oct 16, 2020

nicolaskruchten Oct 19, 2020

emmanuelle Oct 20, 2020

emmanuelle Oct 20, 2020

emmanuelle Oct 20, 2020

nicolaskruchten commented Oct 20, 2020

This comment has been minimized.

nicolaskruchten commented Oct 20, 2020

nicolaskruchten commented Oct 20, 2020 •

edited

Loading

nicolaskruchten commented Oct 20, 2020

nicolaskruchten commented Oct 20, 2020

nicolaskruchten commented Oct 20, 2020

emmanuelle Oct 20, 2020

nicholas-esterer Oct 21, 2020

emmanuelle left a comment

emmanuelle Oct 20, 2020

nicholas-esterer Oct 21, 2020

emmanuelle Oct 20, 2020

emmanuelle Oct 20, 2020

nicolaskruchten Oct 21, 2020

nicholas-esterer Oct 21, 2020

emmanuelle Oct 21, 2020

emmanuelle Oct 21, 2020

nicholas-esterer Oct 21, 2020

nicolaskruchten commented Oct 21, 2020 •

edited

Loading

nicolaskruchten Oct 22, 2020

nicholas-esterer Oct 22, 2020

nicolaskruchten commented Oct 22, 2020

nicolaskruchten commented Oct 22, 2020

		See https://plotly.com/python/reference/layout/shapes/ for more information and chart attribute options!

		<!-- #region -->

	coordinates on the other axis. For example
	coordinates on the other axis. Shapes added with these methods are added as [layout shapes](/python/shapes) (as shown when doing `print(fig)`, for example). For example

		---

		### Horizontal and Vertical Lines and Boxes (Autoshapes) in Plotly.py

	_unzip_pairs([(r, c) for r in range(1, NROWS + 1) for c in [2, 4, 5]]),
	zip(*itertools.product(range(1, NROWS + 1), [2, 4, 5]))

add_{hline,vline,hrect,vrect} and add_{shape,image,annotation} to multiple facets, squashed #2840

add_{hline,vline,hrect,vrect} and add_{shape,image,annotation} to multiple facets, squashed #2840

Conversation

nicholas-esterer commented Oct 16, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolaskruchten commented Oct 20, 2020

This comment has been minimized.

nicolaskruchten commented Oct 20, 2020

nicolaskruchten commented Oct 20, 2020 • edited Loading

nicolaskruchten commented Oct 20, 2020

nicolaskruchten commented Oct 20, 2020

nicolaskruchten commented Oct 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmanuelle left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolaskruchten commented Oct 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolaskruchten commented Oct 22, 2020

nicolaskruchten commented Oct 22, 2020

`add_{hline,vline,hrect,vrect}` and `add_{shape,image,annotation}` to multiple facets, squashed #2840

`add_{hline,vline,hrect,vrect}` and `add_{shape,image,annotation}` to multiple facets, squashed #2840

nicolaskruchten commented Oct 20, 2020 •

edited

Loading

nicolaskruchten commented Oct 21, 2020 •

edited

Loading