Create Custom Visualizations for BI Dashboards

Wyn Enterprise now supports the ability for developers to create their own custom visualizations to use in WynDashboards. Developers can take advantage of our new visualization SDK to define the specifications of any custom visualization your enterprise requires to bring your data to life.

The series of in-house custom visualizations are built by our own team for public availability.

Wave Chart

The first custom visualization available for download is our aptly named “Wave Chart.” This visualization allows you to show the percentage achievement of a target. However, this custom visualization is animated in such a way to show the visual’s shape filled with a “liquid,” which rises and falls based on the percentage achievement.

Waterfall Chart

The second custom visualization available for download is the Waterfall chart. This visualization shows the cumulative result of sequential positive and negative values. Typically, these values are categorical or time-based. This visualization is often used in finance to show how NET values are calculated from a starting value.

Dashboard authors can use these custom visualizations as a fresh new way to bring their data to life. The Wave Chart and Waterfall can be used across any industry vertical, with any data that you would like to visualize. To upload these to your own instance of Wyn Enterprise, simply upload the .viz file through the Resource Portal.
Download the visualizations here:

The steps to run any of the custom visualizations will always be the same for running our publicly available custom visualizations:

1. Install wyn-visual-tools globally. Run’ npm install @grapecity/wyn-visual-tools -g’ from the command prompt.
2. Change the directory to the sample’s location and run ‘npm install’ to install all required modules.
3. Run’ wyn-visual-tools develop’ to start the development server.
4. Open the Wyn Enterprise portal in your browser. Go to the Admin Portal -> Dashboards Settings and enable developer mode.
5. Go back to the Documents Portal and create a new dashboard. Then, add a “Dev Tools” scenario from the Custom Visualization tab on to the dashboard design surface.
6. Develop your custom visualization using visual API. We recommend developing it using TypeScript.
7. Click the Refresh button on the action bar of the Dev Tool visualization to reload the visualization.

To generate the .viz file:

1. Update the version in package.json and visual.json before release.
2. Pack the visual with build tools. Run’ wyn-visual-tools package’. This command will generate a file with “.viz” extension. This is the custom visualization which will be uploaded to Wyn.
3. Upload the .viz file to Wyn Enterprise using the Resource Portal.
4. The visual will now appear under Custom Visualizations in the Dashboard Designer.

Optional Steps:

1. Edit visual.json to include some meta-information about the visual.
2. Edit capabilities.json to add configuration options around data binding, inspector properties, and action bar.
3. Add i18n resource to i18nResources folder.
4. Add image to assets folder.

Manufacturing Dashboard with Wave Chart — Overall Equipment Effectiveness (OEE) Dashboard

Be sure to check in on our GitHub for more custom visualizations coming soon!

Are you interested in implementing an advanced BI system into your business?

by Ethan Conner

Originally published at https://wyn.grapecity.com on September 22, 2020.