Getting Started

Browser Support

SC Charts performs incredibly well in chromium based browsers such as Google Chrome, Microsoft Edge, and even the Ignition Designer. Ensure your browser has WASM support enabled (this should be enabled in modern browsers by default).

There have been noticeable issues in rendering large charts (near full-screen size) in Firefox, and as such Streamline does not recommend its use with this product until a suitable work-around can be found. This is a known Firefox issue with rendering large HTML canvas elements.

Installation

Installation is as easy as any other Ignition module. Simply navigate to the module installation page within your gateway web browser, install the downloaded .modl file,  and accept the certificate! The designer should now have a new section in the perspective component palette called SC Charts. 

See the properties documentation to learn more about developing with the 2D charting component.

Upgrading

It is recommended to uninstall the previous version of the module before upgrading. All views which were previously configured will retain their props but may require additional configuration should there be breaking changes between versions. All designer sessions should also be closed prior to a version upgrade to ensure all caches are cleared.

All version release notes are detailed in Releases.

Minimum Requirements

WASM based charting does utilize additional memory to achieve lightning fast rendering and as such Streamline recommends the following minimum requirements for a seamless development experience. These suggestions are not strict but they do provide additional safety buffering to ensure you can meet your clients needs. Also note that these requirements are based on datasets of 150000 rows (with >3 columns) or larger, basic hardware may be acceptable for more typically sized datasets.

Ignition Server

Host RAM: >= 16 GB

Gateway Memory: >= 8192 MB

Ignition Version: >= 8.1.32

Developers

Host RAM: >= 16 GB

Designer Memory: 2048-4096 MB (4096 MB is ideal)

Perspective Clients

Host RAM: >= 8 GB

Pushing Ignition's Limits

By default, the Perspective websocket has a maximum message size of 2048 KB this value can easily be exceeded when attempting to load large datasets into perspective views. Adding the following line to the Ignition gateway ignition.conf file can increase the maximum websocket message size:

wrapper.java.additional.X=-Dperspective.websocket.max-message-size=Z 

Where X represents the next sequential java parameter in the ignition.conf file and Z is message size in kilobytes.

Example: wrapper.java.additional.7=-Dperspective.websocket.max-message-size=65535 (64 MB)

Increasing the websocket message size to allow for larger datasets will increase data transfer over the network, users should be especially cautious when using this feature with mobile views as carrier data rates may vary and apply. Unexpected behavior is likely as dataset sizes increase as not all client hosts will meet the specifications to handle the memory increase.

Learn More

Development

See the development roadmap documentation to find out more about the project and its intended direction.

Support

Streamline will continue to support this project for our current Ignition integration projects and are dedicated to improving its performance and development experience. The best place to get support for the module if you do not have a support contract with Streamline is the Inductive Automation forum. Our development team will be actively checking the forums for #sc-charts tags.