Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Export plotly-express as a dashboard plugin #329

Merged
merged 3 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions plugins/plotly-express/src/js/src/DashboardPlugin.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import { useCallback, DragEvent, useEffect } from 'react';
import shortid from 'shortid';
import {
DashboardPluginComponentProps,
LayoutUtils,
PanelEvent,
useListener,
} from '@deephaven/dashboard';
import type { VariableDescriptor } from '@deephaven/jsapi-types';
import PlotlyExpressChartPanel from './PlotlyExpressChartPanel.js';
import type { PlotlyChartWidget } from './PlotlyExpressChartUtils.js';

export function DashboardPlugin(
props: DashboardPluginComponentProps
): JSX.Element | null {
const { id, layout, registerComponent } = props;

const handlePanelOpen = useCallback(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Side note, we have a useDashboardPanel hook that should do what we're doing here, but it would require other changes as well (since it doesn't use metadata or fetch at all). No need to worry about it here.

async ({
dragEvent,
fetch,
metadata = {},
panelId = shortid.generate(),
widget,
}: {
dragEvent?: DragEvent;
fetch: () => Promise<PlotlyChartWidget>;
metadata?: Record<string, unknown>;
panelId?: string;
widget: VariableDescriptor;
}) => {
const { type, name } = widget;
if (type !== 'deephaven.plot.express.DeephavenFigure') {
return;
}

const config = {
type: 'react-component' as const,
component: 'PlotlyPanel',
props: {
localDashboardId: id,
id: panelId,
metadata: {
...metadata,
...widget,
figure: name,
},
fetch,
},
title: name,
id: panelId,
};

const { root } = layout;
LayoutUtils.openComponent({ root, config, dragEvent });
},
[id, layout]
);

useEffect(
function registerComponentsAndReturnCleanup() {
const cleanups = [
registerComponent('PlotlyPanel', PlotlyExpressChartPanel),
];
return () => {
cleanups.forEach(cleanup => cleanup());
};
},
[registerComponent]
);

useListener(layout.eventHub, PanelEvent.OPEN, handlePanelOpen);

return null;
}

export default DashboardPlugin;
11 changes: 10 additions & 1 deletion plugins/plotly-express/src/js/src/PlotlyExpressChartUtils.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
import type { Data, PlotlyDataLayoutConfig } from 'plotly.js';
import type { Widget } from '@deephaven/jsapi-types';
import type { Table, Widget } from '@deephaven/jsapi-types';

export interface PlotlyChartWidget {
getDataAsBase64(): string;
exportedObjects: { fetch(): Promise<Table> }[];
addEventListener(
type: string,
fn: (event: CustomEvent<PlotlyChartWidget>) => () => void
): void;
}

export interface PlotlyChartWidgetData {
type: string;
Expand Down
2 changes: 2 additions & 0 deletions plugins/plotly-express/src/js/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { PlotlyExpressPlugin } from './PlotlyExpressPlugin.js';

// Export legacy dashboard plugin as named export for backwards compatibility
export * from './DashboardPlugin.js';
vbabich marked this conversation as resolved.
Show resolved Hide resolved
export * from './PlotlyExpressChartModel.js';
export * from './PlotlyExpressChartUtils.js';

Expand Down
Loading