plotly / plotly/plotly.py

mixed graph and table subplots break when hline or vline are added

Open
#3,424 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug P3
Dominant language
Python
Stars
18.8k
Forks
2.8k
Avg merge
16h 26m
Merged PRs (30d)
21

Description

Describe your context
Python 3.8
Dash 2.0
Plotly 5.3.1

  • replace the result of pip list | grep dash below
dash                                              2.0.0
dash-core-components                              2.0.0
dash-html-components                              2.0.0
dash-table                                        5.0.0

Take a 5 x 3 subplot layout as follows:

    fig = make_subplots(rows=5, cols=3,
                        specs=[[{'secondary_y': True}, {'secondary_y': False}, {'type': 'table'}],
                               [{'secondary_y': False}, {'secondary_y': False}, {'secondary_y': False}],
                               [{'secondary_y': False}, {'secondary_y': False}, {'secondary_y': False}],
                               [{'secondary_y': False}, {'secondary_y': False}, {'secondary_y': False}],
                               [{'secondary_y': False}, {'secondary_y': False}, {'secondary_y': False}]],
                        shared_xaxes=True, shared_yaxes=True,
                        vertical_spacing=0.01, horizontal_spacing=0,
                        row_heights=[0.775, 0.15, 0.025, 0.025, 0.025], column_widths=[0.8, 0.1, 0.1])

We add subplots as follows:

fig.add_trace(go.Scatter(x= ... row=1, col=1)
fig.add_trace(go.Scatter(x= ... row=1, col=2)
fig.add_trace(go.Scatter(x= ... row=2, col=1)
fig.add_trace(go.Scatter(x= ... row=3, col=1)
fig.add_trace(go.Scatter(x= ... row=4, col=1)
fig.add_trace(go.Scatter(x= ... row=5, col=1)

At position row=1 col=3 we place a table.

fig.add_trace(go.Table(header=dict(line=dict(color='red'),
                              fill=dict(color='red')),
                       cells=dict(values=[df.A, df.B])),
              row=1, col=3)

This all works fine. But when we add an hline or vline to the top left graph...

        fig.add_vline(x=42, line_width=1, line_dash='dot', line_color='rgba(255, 165, 0, 0.3)', row=1, col=1)

Plotly throws an error:

_plotly_utils.exceptions.PlotlyKeyError: Invalid property specified for object of type plotly.graph_objs.Table: 'xaxis'

Did you mean "cells"?

This happens regardless of line orientation (h or v), or if the lines are limited to a single row and col or spanning all cols.

Posting in in case this may be a bug.
Posted also on StackOverflow, where Rob Raymond prepared a working example and also a workaround for this issue.
See here:
https://stackoverflow.com/questions/69498665/why-do-plotly-dash-mixed-graph-and-table-subplots-break-when-hline-or-vline-ar/69507165#69507165

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the 5 x 3 mixed graph-and-table layout from the issue, then add the shown fig.add_vline call and compare it with the working case. Start by tracing make_subplots and the hline/vline handling around table subplots. Done means both hline and vline render for graph subplots without raising a PlotlyKeyError for the Table trace.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.