plotly / plotly/plotly.py

Inconsistent row and col parameters used to add vline to faceted subplots

Aberta
#4,553 2 comentários 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

bug P3 sev-2
Linguagem predominante
Python
Estrelas
18.8k
Forks
2.8k
Merge médio
16h 26min
PRs com merge (30d)
21

Descrição

I'm trying to have a vertical line added to faceted plots, with the line being at a different position for every subplot. Here's a MRE:

import plotly.express as px
import pandas as pd
import numpy as np
from itertools import product

# Prepare data
combinations = list(product(range(1, 11), repeat=2))
df = pd.DataFrame(combinations, columns=['cat', 'x'])
df['y'] = np.random.randint(1, 100, size=len(df))

# Figure
fig = px.line(df, x='x', y='y', facet_col='cat', facet_col_wrap=3)

# Add vlines in a loop
def generate_lines(n, d):
    tuples_list = []
    a = 1  # Initial value for a
    b = 1  # Initial value for b
    for i in range(1, n+1):
        tuples_list.append((i, a, b))
        if i % d == 0:  # Check if the divider is reached
            a += 1  # Increment a when the divider is reached
            b = 1   # Reset b to 1 when the divider is reached
        else:
            b += 1  # Increment b otherwise
    return tuples_list

lines = generate_lines(10, 3)
for i, a, b in lines:
    fig.add_vline(x=i, row=a, col=b, opacity=1, line_width=2, line_dash='dash', line_color='red')

fig.show()

What this code should produce is a vertical line at the value of the cat parameter but this is obviously not the case:

image

It took me a while to figure out what's actually happening. The issue is that the row argument does not start at the top left in the same way as faceting does, but instead starts at the bottom left. As a result, the (1,2) plot with a value of 2 is not shown because that's an empty space (would correspond to cat=11) and the 2nd subplot does not receive their vertical line.

This leads to inconsistencies and the required code to make the location more complicated because e.g. reducing the number of categories to 9 would mean that (1,1) needs to suddenly get a value of 7.

The behavior would be more intuitive if row 1 was the top one instead of the bottom one. If this is not a bug but a feature, it would be good to have this explicitly stated in the documentation / API reference.

Using plotly 5.13.0

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece reproduzindo o MRE fornecido com plotly 5.13.0, concentrando-se em como facet_col_wrap atribui as linhas dos subplots e em como add_vline interpreta row e col. Inspecione o comportamento dos facets e das linhas/colunas dos subplots exposto por essas APIs. O trabalho estará concluído quando a numeração das linhas corresponder ao layout de faceting ou quando a documentação/referência da API explicar claramente o comportamento existente e seu workaround.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
data-visualization
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.