Skip to content

deephaven-examples/deephaven-react-app-enterprise

Repository files navigation

Example Deephaven Enterprise React Application

This project was bootstrapped with Vite using the react-ts template. It is to provide an example React application connecting to Deephaven and displaying a table of data within a dashboard.

Quick Start

You need to set the ENV variables defined in .env. Change them in .env, or you can override them with a local .env.local file which is ignored by git. After those are set, simply run:

npm install
npm start

Your development server will start up. You can then open up the URL in your browser and you should see a table appear.

Fetching a Table

At the default URL, it will create a table using a Legacy worker and display it using an IrisGrid component. To open this, simply navigate your browser to the development server URL, which is http://localhost:5173 by default.

You can also create a table on a Core+ worker. To do this, navigate to http://localhost:5173/?workerKind=DeephavenCommunity&jvmArgs=-Dhttp.websockets=true, where workerKind=DeephavenCommunity is the Core+ worker kind configured on your system and jvmArgs=-Dhttp.websockets=true is the JVM argument to enable websockets required when connecting from localhost (insecure) to your server.

You can also fetch a table from a PQ as well. To do this, navigate to http://localhost:5173/?queryName=MyQuery&tableName=myTable where MyQuery is the name of the query and myTable is the name of the table. This works with both Legacy and Core+ workers.

View the source for this at src/App.tsx.

IFrame Example

You can also display a widget from a Core+ query in an IFrame. To do this, navigate to http://localhost:5173/iframe/?queryName=MyQuery&widgetName=myWidget where MyQuery is the name of the query and myWidget is the name of the widget. NOTE: This will only work with Core+ workers.

View the source for this at src/IFrameApp.tsx.

About

Example React App for using Deephaven Enterprise

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published