feat: DH-18165: Add calendar argument to several dx charts by jnumainville · Pull Request #1122 · deephaven/deephaven-plugins

jnumainville · 2025-02-27T21:38:58Z

Adds calendar option to several chart types. Some good examples are in the docs and e2e tests.

I also noticed some of the js tests were not quite correct when making my new ones. Since there was just a few straightforward changes I made them in this ticket.

Copilot

PR Overview

This PR adds support for a calendar argument to several chart types in the dx charts library, along with updates to documentation and tests. Key changes include:

Adding a calendar parameter to chart APIs and propagating the calendar option to underlying plotly figures.
Updating documentation for OHLC, candlestick, scatter, line, and area charts to include calendar usage.
Adjusting tests and internal implementation (e.g. in FigureCalendar, _private_utils, and PartitionManager) for calendar handling.

Reviewed Changes

File	Description
plugins/plotly-express/src/deephaven/plot/express/deephaven_figure/FigureCalendar.py	Introduces the FigureCalendar class and methods to convert calendar data for the frontend.
plugins/plotly-express/docs/*.md	Updates documentation for various chart types to include calendar usage examples.
plugins/plotly-express/src/js/src/PlotlyExpressChartModel.test.ts	Updates tests to accommodate new calendar behavior and related events.
plugins/plotly-express/src/deephaven/plot/express/plots/*.py	Adds calendar parameters to chart plotting functions and updates logic to force svg render mode when a calendar is provided.
Other files	Adjustments in data generators, custom draw functions, and internal utils to support the new calendar functionality, plus minor grammar fixes.

Copilot reviewed 37 out of 37 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

plugins/plotly-express/src/deephaven/plot/express/deephaven_figure/FigureCalendar.py:216

Overriding dict as a method might cause confusion with the built-in dict attribute. Consider renaming this method to to_dict() to clearly indicate its purpose.

def __dict__(self) -> FigureCalendarDict | None:

mofojed · 2025-03-03T19:14:29Z

+      this.calendar = {
+        ...calendar,
+        timeZone,
+      } as unknown as DhType.calendar.BusinessCalendar;


Hmmm this isn't quite right... you need to cast it, because the holiday.date is just a string instead of the LocalDateWrapper type that BusinessCalendar has... And this is currently working because we just call holiday.date.toString() in ChartUtils.
At the very least there needs to be some comments about why that's being done. But I'd rather wrap the string in an object that does match the interface correctly, so converting those holiday.dates to something that conforms to:

export interface LocalDateWrapper { valueOf():string; getYear():number; getMonthValue():number; getDayOfMonth():number; toString():string; }

Otherwise we open ourselves up to issues later.

github-actions · 2025-03-04T19:37:26Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-03-31T19:02:51Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-03-31T20:38:41Z

plotly-express docs preview (Available for 14 days)

jnumainville · 2025-03-31T21:46:47Z

There is a small bug where the loading spinner is not dismissed correctly when creating multiple charts I am investigating but otherwise this is ready for review

update - this is fixed

github-actions · 2025-04-01T18:22:37Z

plotly-express docs preview (Available for 14 days)

mofojed

I think I got hung up on some of the diff by changes brought over by indicator merge... but there's still a couple spots that should be cleaned up here.

mofojed · 2025-04-02T19:49:55Z

@@ -334,6 +335,45 @@ export class PlotlyExpressChartModel extends ChartModel {
    return timeZone !== newTimeZone && newTimeZone != null;
  }

+  /**
+   * Update the calendar object from the data
+   * @param data The new data to update the calendar from
+   */
+  updateCalendar(data: PlotlyChartWidgetData): void {
+    const { calendar } = data.figure.deephaven;


This casting is gross, and then doing a .forEach is pretty nasty when you should just do a .map. Rewritten so you don't need casts (and probably add a name to FigureCalendar so that you don't need to add a name here):

Suggested change

const newCalendar = {

...calendar,

timeZone,

} as unknown as DhType.calendar.BusinessCalendar;

// Holidays should be converted to LocalDate objects so

// they have all the necessary methods to match the BusinessCalendar interface

newCalendar.holidays.forEach((holiday, i) => {

const { date } = holiday;

// date is a really a string at this point, but it should be a LocalDate object

const dateObj = new Date(date as unknown as string);

const year = dateObj.getFullYear();

const month = dateObj.getMonth();

const day = dateObj.getDate();

newCalendar.holidays[i] = {

...newCalendar.holidays[i],

date: {

valueOf: () => date,

getYear: () => year,

getMonthValue: () => month,

getDayOfMonth: () => day,

toString: () => date,

} as unknown as DhType.LocalDateWrapper,

};

});

this.calendar = newCalendar;

this.calendar = {

...calendar,

timeZone,

name: 'PlotlyExpressCalendar',

holidays: calendar.holidays.map((holiday, i) => {

const { date } = holiday;

// date is a really a string at this point, but it should be a LocalDate object

const dateObj = new Date(date as unknown as string);

const year = dateObj.getFullYear();

const month = dateObj.getMonth();

const day = dateObj.getDate();

return {

...holiday,

date: {

valueOf: () => date,

getYear: () => year,

getMonthValue: () => month,

getDayOfMonth: () => day,

toString: () => date,

} as unknown as DhType.LocalDateWrapper,

};

}),

};

mofojed · 2025-04-02T19:51:22Z

+   * @param id The table ID to unsubscribe from
+   */
+  unsubscribeTable(id: number): void {
+    this.tableSubscriptionMap.get(id)?.close();


Optimization: Opt to do the this.isSubscribed check first - no need to do the work in timeZoneChanged if we're not subscribed.

Suggested change

if (this.timeZoneChanged(formatter) && this.isSubscribed) {

if (this.isSubscribed && this.timeZoneChanged(formatter)) {

mofojed · 2025-04-02T20:08:46Z

+
+/**
+ * Check if the data at the selector should be replaced with a single value instead of an array
+ * @param data The data to check


We shouldn't be casting stuff like this. That's an indication we're doing something wrong; casting should be a last resort, not used liberally like this (particularly casting to any). We're essentially rendering the type checking system useless.

Not sure why that was so ugly in the first place, done.

mofojed · 2025-04-02T20:20:19Z

+  if (formatter != null && calendar != null) {
+    const layoutUpdate: Partial<Layout> = {};
+
+    Object.keys(layout).forEach(key => {


Could do a filter here which might be a little clearer, instead of having the if block within, e.g.

Object.keys(layout).filter(key => key.includes('axis')).forEach(key => { const axis = layout[key as keyof Layout];

github-actions · 2025-04-07T14:56:58Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-04-07T15:30:06Z

plotly-express docs preview (Available for 14 days)

github-actions · 2025-04-07T15:47:05Z

plotly-express docs preview (Available for 14 days)

jnumainville added 8 commits February 13, 2025 12:04

wip

2f87022

wip

c5595e8

wip

147e7e1

wip

4106f41

wip

575992d

wip

35b545e

wip

7095e94

wip

2c12c4c

jnumainville requested review from Copilot, mattrunyon and mofojed February 27, 2025 21:38

jnumainville self-assigned this Feb 27, 2025

Copilot AI reviewed Feb 27, 2025

View reviewed changes

jnumainville added 4 commits February 27, 2025 15:42

wip

43f65f6

wip

86aa00a

wip

f697008

wip

150453d

mofojed requested changes Mar 3, 2025

View reviewed changes

wip

e4e1da5

jnumainville added 2 commits March 31, 2025 12:43

Merge remote-tracking branch 'origin/main' into 18165_businesstime

22f45ba

wip

3f46384

wip

c4a9ff0

jnumainville marked this pull request as ready for review March 31, 2025 21:45

github-actions Bot requested a review from margaretkennedy March 31, 2025 21:45

margaretkennedy previously approved these changes Apr 1, 2025

View reviewed changes

wip

ca17955

jnumainville dismissed margaretkennedy’s stale review via ca17955 April 1, 2025 18:19

jnumainville requested a review from mofojed April 1, 2025 19:09

mofojed requested changes Apr 2, 2025

View reviewed changes

wip

8cbbaf7

wip

7f86b1b

wip

3949df6

jnumainville requested a review from mofojed April 7, 2025 16:26

mofojed approved these changes Apr 7, 2025

View reviewed changes

jnumainville merged commit 47a2d71 into deephaven:main Apr 7, 2025
17 checks passed

-      const newCalendar = {
-        ...calendar,
-        timeZone,
-      } as unknown as DhType.calendar.BusinessCalendar;
-      // Holidays should be converted to LocalDate objects so
-      // they have all the necessary methods to match the BusinessCalendar interface
-      newCalendar.holidays.forEach((holiday, i) => {
-        const { date } = holiday;
-        // date is a really a string at this point, but it should be a LocalDate object
-        const dateObj = new Date(date as unknown as string);
-        const year = dateObj.getFullYear();
-        const month = dateObj.getMonth();
-        const day = dateObj.getDate();
-        newCalendar.holidays[i] = {
-          ...newCalendar.holidays[i],
-          date: {
-            valueOf: () => date,
-            getYear: () => year,
-            getMonthValue: () => month,
-            getDayOfMonth: () => day,
-            toString: () => date,
-          } as unknown as DhType.LocalDateWrapper,
-        };
-      });
-      this.calendar = newCalendar;
+      this.calendar = {
+        ...calendar,
+        timeZone,
+        name: 'PlotlyExpressCalendar',
+        holidays: calendar.holidays.map((holiday, i) => {
+          const { date } = holiday;
+          // date is a really a string at this point, but it should be a LocalDate object
+          const dateObj = new Date(date as unknown as string);
+          const year = dateObj.getFullYear();
+          const month = dateObj.getMonth();
+          const day = dateObj.getDate();
+          return {
+            ...holiday,
+            date: {
+              valueOf: () => date,
+              getYear: () => year,
+              getMonthValue: () => month,
+              getDayOfMonth: () => day,
+              toString: () => date,
+            } as unknown as DhType.LocalDateWrapper,
+          };
+        }),
+      };

	if (this.timeZoneChanged(formatter) && this.isSubscribed) {
	if (this.isSubscribed && this.timeZoneChanged(formatter)) {

Conversation

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

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Mar 4, 2025

Uh oh!

github-actions Bot commented Mar 31, 2025

Uh oh!

github-actions Bot commented Mar 31, 2025

Uh oh!

jnumainville commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 1, 2025

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!

github-actions Bot commented Apr 7, 2025

Uh oh!

github-actions Bot commented Apr 7, 2025

Uh oh!

github-actions Bot commented Apr 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jnumainville commented Feb 27, 2025 •

edited by atlassian Bot

Loading

jnumainville commented Mar 31, 2025 •

edited

Loading