React Startup Animation

Demonstrates how to run Startup Animations using SciChart.js, High Performance JavaScript Charts

src/drawExample.ts
import {
    WaveAnimation,
    SweepAnimation,
    ScaleAnimation,
    FadeAnimation,
    TextAnnotation,
    GenericAnimation,
    SciChartSurface,
    NumericAxis,
    FastBubbleRenderableSeries,
    EllipsePointMarker,
    XyzDataSeries,
    SplineLineRenderableSeries,
    XyDataSeries,
    ECoordinateMode,
    EHorizontalAnchorPoint,
    EVerticalAnchorPoint,
    SeriesAnimation,
    ZoomPanModifier,
    ZoomExtentsModifier,
    MouseWheelZoomModifier,
} from "scichart";
import { appTheme } from "./appTheme";

// Four Series Animations are defined below. We apply these to the chart sequentially
const waveAnimation = new WaveAnimation({ zeroLine: 0, pointDurationFraction: 0.5, duration: 1000, fadeEffect: true });
const sweepAnimation = new SweepAnimation({ duration: 1000 });
const scaleAnimation = new ScaleAnimation({ duration: 1000, zeroLine: 0 });
const fadeAnimation = new FadeAnimation({ duration: 1000 });

// generic animation to create typewritter effect on the watermark
const typeWriterAnimation = (textAnnotation: TextAnnotation, finalText: string) =>
    new GenericAnimation<string>({
        from: "",
        to: finalText,
        onAnimate: (from: string, to: string, progress: number) => {
            const length = Math.floor(to.length * progress);
            textAnnotation.text = to.substring(0, length);
        },
        duration: 1000,
        setInitialValueImmediately: true,
    });

// Setup the example & chart

export const drawExample = async (rootElement: string | HTMLDivElement) => {
    // Create a SciChartSurface with theme
    const { sciChartSurface, wasmContext } = await SciChartSurface.create(rootElement, {
        theme: appTheme.SciChartJsTheme,
    });
    // Create X and Y Axis
    sciChartSurface.xAxes.add(new NumericAxis(wasmContext));
    sciChartSurface.yAxes.add(new NumericAxis(wasmContext));

    // Create some data
    const xValues = [];
    const yValues = [];
    const zValues = [];
    let prevYValue = 0;
    for (let i = 0; i < 20; i++) {
        const curYValue = Math.sin(i) * 10 + 5;
        const size = Math.sin(i) * 60 + 3;

        xValues.push(i);
        yValues.push(prevYValue + curYValue);
        zValues.push(size);

        prevYValue += curYValue;
    }

    // Create a Bubble Series
    const bubbleSeries = new FastBubbleRenderableSeries(wasmContext, {
        pointMarker: new EllipsePointMarker(wasmContext, {
            width: 64,
            height: 64,
            fill: appTheme.VividSkyBlue + "77",
            strokeThickness: 0,
        }),
        dataSeries: new XyzDataSeries(wasmContext, { xValues, yValues, zValues }),
    });
    sciChartSurface.renderableSeries.add(bubbleSeries);

    // Create a Line Series
    const lineSeries = new SplineLineRenderableSeries(wasmContext, {
        stroke: appTheme.VividSkyBlue,
        strokeThickness: 2,
        opacity: 0.7,
        dataSeries: new XyDataSeries(wasmContext, { xValues, yValues }),
    });
    sciChartSurface.renderableSeries.add(lineSeries);

    // Add watermark annotation
    const watermark = new TextAnnotation({
        text: "",
        x1: 0.5,
        y1: 0.5,
        fontSize: 42,
        opacity: 0.5,
        xCoordinateMode: ECoordinateMode.Relative,
        yCoordinateMode: ECoordinateMode.Relative,
        horizontalAnchorPoint: EHorizontalAnchorPoint.Center,
        verticalAnchorPoint: EVerticalAnchorPoint.Center,
        textColor: appTheme.TextColor,
    });
    sciChartSurface.annotations.add(watermark);

    // Add title annotation
    sciChartSurface.annotations.add(
        new TextAnnotation({
            text: "Series Startup Animations in SciChart.js",
            fontSize: 18,
            textColor: appTheme.ForegroundColor,
            x1: 0.5,
            y1: 0,
            opacity: 0.77,
            horizontalAnchorPoint: EHorizontalAnchorPoint.Center,
            xCoordinateMode: ECoordinateMode.Relative,
            yCoordinateMode: ECoordinateMode.Relative,
        })
    );

    // Loop forever and update animations
    let animationState = 0;
    const updateAnimation = () => {
        let currentAnimation: SeriesAnimation;
        switch (animationState) {
            case 0:
                currentAnimation = waveAnimation;
                sciChartSurface.addAnimation(typeWriterAnimation(watermark, "Wave Animation"));
                animationState++;
                break;
            case 1:
                currentAnimation = sweepAnimation;
                sciChartSurface.addAnimation(typeWriterAnimation(watermark, "Sweep Animation"));
                animationState++;
                break;
            case 2:
                currentAnimation = scaleAnimation;
                sciChartSurface.addAnimation(typeWriterAnimation(watermark, "Scale Animation"));
                animationState++;
                break;
            case 3:
                currentAnimation = fadeAnimation;
                sciChartSurface.addAnimation(typeWriterAnimation(watermark, "Fade Animation"));
                animationState = 0;
                break;
        }
        lineSeries.enqueueAnimation(currentAnimation);
        bubbleSeries.enqueueAnimation(currentAnimation);
        // Loop forever while SciChartSurface is not deleted (see React Component unmount)
        if (!sciChartSurface.isDeleted) setTimeout(updateAnimation, 2000);
    };

    updateAnimation();

    sciChartSurface.chartModifiers.add(new ZoomPanModifier({ enableZoom: true }));
    sciChartSurface.chartModifiers.add(new ZoomExtentsModifier());
    sciChartSurface.chartModifiers.add(new MouseWheelZoomModifier());
    return { wasmContext, sciChartSurface };
};

React Startup Animation

Overview

This example demonstrates an interactive Chart Startup Animation built with SciChart.js in a React application. The implementation sequentially animates chart series using Wave, Sweep, Scale, and Fade animations, while a dynamic typewriter effect updates a watermark annotation. The example showcases both bubble and spline line renderable series, along with interactive zoom and pan modifiers.

Technical Implementation

The chart is initialized in a React component using the <SciChartReact/> element from the SciChart.js React integration, as described in the SciChart React integration guide. The primary animation logic is encapsulated in a function that alternates between different animations by enqueuing them on the renderable series. A custom typewriter effect is implemented through a GenericAnimation, following guidelines found in the Generic Animations documentation please also see Series Startup Animations. Furthermore, the example adds chart modifiers such as ZoomPanModifier, ZoomExtentsModifier, and MouseWheelZoomModifier to enhance interactivity; more details can be found in the Zooming and Panning Tutorial.

Features and Capabilities

The example illustrates several advanced features including real-time animation chaining and dynamic data binding. The series startup animations provide a visually appealing entrance effect, while the typewriter-based watermark animation adds a layer of customizability. Additionally, interactive controls are implemented through built-in chart modifiers, demonstrating how to provide an enhanced user experience with minimal performance overhead.

Integration and Best Practices

Integrating SciChart.js with React is streamlined using the <SciChartReact/> component, ensuring that the chart lifecycle is properly managed within a React application. Developers are encouraged to follow the best practices for lifecycle management, such as clean-up on component unmount, as detailed in the Reusable React Component tutorial. The example not only provides performance optimization and interactive features but also serves as a guide for integrating complex animations and custom theming in React-based chart applications.