plotly / plotly/dash

customdata is missing in clickData for Scattergl objects

Open
#3,196 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug P2
Dominant language
Python
Stars
24.4k
Forks
2.3k
Avg merge
2d 7h
Merged PRs (30d)
13

Description

Describe your context
I've made a dash application that presents some data from an SQLite database both in a graph and an AG Grid table. I'm using scattergl to create a figure with scattergl traces. Clicking a point on the scattergl traces fires a dash callback that should highlight the relevant data in the table. The mapping of the data between the figure and the table relies on the customdata variable of the scattergl class, and that the clickData passed by the click event carries with it the customdata data. This has been working until I recently upgraded my environment.

  • replace the result of pip list | grep dash below
  - Installing dash-core-components (2.0.0)
  - Installing dash-html-components (2.0.0)
  - Installing dash-table (5.0.0)
  - Installing dash (2.18.2)
  - Installing dash-bootstrap-components (1.7.1)
  - Installing dash-ag-grid (31.3.0)
  - Installing dash-bootstrap-templates (2.1.0)
  • if frontend related, tell us your Browser, Version and OS

    • Windows 10
    • Edge
    • 133.0.3065.69

Describe the bug

The bug is the same as that described in https://github.com/plotly/dash/issues/2493, except that I'm experiencing this with Scattergl objects (added to a plotly.graph_objs._figure object with add_traces). Note that this worked just fine before I recreated my environment (and updated many of my packages). Unfortunately I don't have the package list of the old environment.

Expected behavior

I expected the data in the customdata variable of the Scattergl trace to be present in the clickData object I receive in my figure callback, just like before I upgraded my environment.

Screenshots of actual behaviour
Firstly showing created Scattergl objects containing data in its customdata variable.
Image
Secondly showing the click_data dict received in my dash callback after clicking a point on the scatter graph, which does not contain 'customdata'.
Image

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

Start with the Dash figure callback and a Scattergl trace using customdata, reproducing the missing field under the reported Dash 2.18.2 environment. Compare the received clickData with the expected trace data; the issue is done when customdata is present for clicked Scattergl points.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.