feat: indicator chart by jnumainville · Pull Request #1088 · deephaven/deephaven-plugins

jnumainville · 2025-01-17T19:10:18Z

Adds indicator chart for DH-18091
Note that examples might not work correctly because of deephaven/deephaven-core#6547
Here is some working examples

import deephaven.plot.express as dx
from deephaven import agg as agg
from deephaven import time_table

sym_data = time_table("PT1S").update(["Price = randomDouble(0.0, 5.0)", "StartingPrice = 3", "Sym = (i % 2 == 0) ? `DOG` : `DOG`"]).tail(2).sort(["Sym"])

indicator_plot_basic = dx.indicator(sym_data, value="Price", title="DOG")
indicator_plot_delta = dx.indicator(sym_data, value="Price", reference="StartingPrice")
indicator_plot_text = dx.indicator(sym_data, value="Price", reference="StartingPrice", by="Sym", text="Sym")
indicator_plot_styled = dx.indicator(
    sym_data,
    value="Price",
    reference="StartingPrice",
    text="Sym",
    by="Sym",
    gauge="bullet",
    by_vars=("increasing_color", "decreasing_color", "gauge_color"),
    increasing_color_map={"FISH": "lemonchiffon"},
    decreasing_color_map={"FISH": "salmon"},
    gauge_color_map={"FISH": "chartreuse"},
    increasing_text="Up: ",
    decreasing_text="Down: ",
    prefix="$ ",
    suffix=" (USD)",
    number_format="#,##0.00"
)

mofojed

Can we also add an e2e test in tests/app.d/express.py?

mofojed · 2025-01-23T15:40:30Z

    value="Price",
    reference="StartingPrice",
    by="Sym",
+    by_vars=("increasing_color", "decreasing_color"),


This example is kind of confusing. What is the by_vars argument for? Why are we doing a by here at all when we've already filtered the table to one Sym?

This is so that the symbol can be specified in the increasing_color_map and decreasing_color_map, although it shouldn't have filtered to one symbol so I'll fix that.

mofojed · 2025-01-23T15:41:33Z

            listen_func = partial(self._on_update, node)
            # if a table is not refreshing, it will never update, so no need to listen
-            if table.is_refreshing:
+            if table and table.is_refreshing:


Might want to have this fix as a separate PR just so it's clear this is fixed in the release notes (is there a ticket for it? When do we run into this issue?)

I'm not entirely sure what the issue was here so I have removed the extra check.

mofojed · 2025-01-23T15:48:03Z

    suffix: str | None = None,
    increasing_text: str | None = "▲",
    decreasing_text: str | None = "▼",
+    number_format: str | None = "#,##0.00",


Autodoc isn't loving this:

ValueError: Missing documentation for deephaven.plot.express.indicator parameters {"##0.00'"}. Verify that parameter names have leading asterisks in the description.

However you're parsing the args, probably just need to check that the comma is at the end, as it seems to pick up the comma in the string right now. Fix that issue in autodoc in a PR before this PR goes through.

Since I'm removing this default this won't block here, but I'll open another ticket because that needs to be solved eventually.

https://deephaven.atlassian.net/browse/DH-19066

mofojed · 2025-01-23T15:49:00Z

+# this should be safe as it shouldn't appear naturally in a d3 format string
+# https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+# but isn't a perfect solution
+FORMAT_PREFIX = "DEEPHAVEN_JAVA_FORMAT"


I kind of want an = at the end just to denote the end of the "prefix".

jnumainville · 2025-01-29T15:07:05Z

I have added some new changes, especially with regards to number format and title. I still need to add unit and e2e tests for these new changes.

This PR is blocked on deephaven/web-client-ui#2352 as well.

These are for deephaven/deephaven-plugins#1088 Currently the layout is only set once, but with indicator it may change, although specifically the title, so I added an event for that. Not sure if it's the best approach.

jnumainville · 2025-02-27T16:16:47Z

Blocked on pypi/support#5628

github-actions · 2025-03-04T21:38:46Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-03-26T15:14:18Z

plotly-express docs preview (Available for 14 days)

These are for deephaven/deephaven-plugins#1088 Currently the layout is only set once, but with indicator it may change, although specifically the title, so I added an event for that. Not sure if it's the best approach.

These are for deephaven/deephaven-plugins#1088 Currently the layout is only set once, but with indicator it may change, although specifically the title, so I added an event for that. Not sure if it's the best approach. Co-authored-by: Joe <josephnumainville@deephaven.io>

github-actions · 2025-03-27T15:37:35Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-03-27T15:48:19Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-03-27T18:01:24Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-03-27T18:43:16Z

plotly-express docs preview (Available for 14 days)

jnumainville · 2025-03-27T19:02:20Z

I think we are finally good here barring any other problematic merges beating this one
@margaretkennedy can I get a doc review?

github-actions · 2025-03-27T21:01:39Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-03-28T15:21:01Z

plotly-express docs preview (Available for 14 days)

jnumainville added 10 commits January 7, 2025 15:18

wip

dc60b56

wip

98e9edf

wip

f487c4a

wip

f386079

wip

330c6c8

wip

5cbe713

wip

f9909ef

wip

a38a1a7

wip

dbf372a

wip

31bd571

jnumainville requested review from dsmmcken, mattrunyon and mofojed January 17, 2025 19:10

github-actions Bot requested a review from margaretkennedy January 17, 2025 19:10

wip

636d193

mofojed requested changes Jan 23, 2025

View reviewed changes

jnumainville added 2 commits January 27, 2025 14:45

wip

4d0f147

wip

fd9eaae

jnumainville mentioned this pull request Jan 29, 2025

feat: Add chart event for title change deephaven/web-client-ui#2352

Merged

jnumainville added 3 commits January 29, 2025 09:39

wip

ab6c9b2

wip

c996f3e

wip

c06d9d7

Merge remote-tracking branch 'origin/main' into 18091_indicator

feecf3b

Merge remote-tracking branch 'origin/main' into 18091_indicator

72c69b8

jnumainville mentioned this pull request Mar 21, 2025

docs: snapshots for plotly-express components #1146

Merged

Merge remote-tracking branch 'origin/main' into 18091_indicator

a4a84d7

wip

f54aa50

jnumainville dismissed mofojed’s stale review via f54aa50 March 26, 2025 15:11

mofojed mentioned this pull request Mar 26, 2025

feat: Add chart event for title change (#2352) deephaven/web-client-ui#2394

Merged

Merge remote-tracking branch 'origin' into 18091_indicator

212d9c5

wip

7f1b153

wip

084ac05

jnumainville self-assigned this Mar 27, 2025

jnumainville requested a review from mofojed March 27, 2025 18:29

wip

895d495

wip

ad780f2

mofojed previously approved these changes Mar 28, 2025

View reviewed changes

margaretkennedy reviewed Mar 28, 2025

View reviewed changes

Comment thread plugins/plotly-express/docs/indicator.md Outdated

margaretkennedy reviewed Mar 28, 2025

View reviewed changes

Comment thread plugins/plotly-express/docs/indicator.md Outdated

wip

59430bb

jnumainville dismissed mofojed’s stale review via 59430bb March 28, 2025 15:18

jnumainville requested a review from mofojed March 28, 2025 15:40

jnumainville enabled auto-merge (squash) March 28, 2025 15:40

jnumainville requested a review from margaretkennedy March 28, 2025 16:47

mofojed approved these changes Mar 31, 2025

View reviewed changes

jnumainville merged commit eb835e3 into deephaven:main Mar 31, 2025
17 checks passed

Conversation

jnumainville commented Jan 17, 2025 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mofojed left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jnumainville commented Jan 29, 2025

Uh oh!

jnumainville commented Feb 27, 2025

Uh oh!

github-actions Bot commented Mar 4, 2025

Uh oh!

github-actions Bot commented Mar 26, 2025

Uh oh!

github-actions Bot commented Mar 27, 2025

Uh oh!

github-actions Bot commented Mar 27, 2025

Uh oh!

github-actions Bot commented Mar 27, 2025

Uh oh!

github-actions Bot commented Mar 27, 2025

Uh oh!

jnumainville commented Mar 27, 2025

Uh oh!

github-actions Bot commented Mar 27, 2025

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Mar 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jnumainville commented Jan 17, 2025 •

edited by atlassian Bot

Loading