JavaScript Chart with Secondary Y Axes

Demonstrates how to create a JavaScript Chart with Secondary Y axis using SciChart.js, High Performance JavaScript Charts

src/drawExample.ts
import {
    EAxisAlignment,
    ECoordinateMode,
    EHorizontalAnchorPoint,
    ELabelAlignment,
    EllipsePointMarker,
    EMultiLineAlignment,
    ENumericFormat,
    EVerticalAnchorPoint,
    EWrapTo,
    FastLineRenderableSeries,
    MouseWheelZoomModifier,
    NativeTextAnnotation,
    NumberRange,
    NumericAxis,
    SciChartSurface,
    TextAnnotation,
    XAxisDragModifier,
    XyDataSeries,
    YAxisDragModifier,
    ZoomExtentsModifier,
    ZoomPanModifier,
} from "scichart";
import { RandomWalkGenerator } from "./RandomWalkGenerator";
import { appTheme } from "./appTheme";

const ID_Y_AXIS_2 = "yAxis2";

export const drawExample = async (rootElement: string | HTMLDivElement) => {
    // Create the SciChartSurface with theme
    const { sciChartSurface, wasmContext } = await SciChartSurface.create(rootElement, {
        theme: appTheme.SciChartJsTheme,
    });

    // Add a primary X,Y Axis pair
    sciChartSurface.xAxes.add(
        new NumericAxis(wasmContext, {
            axisAlignment: EAxisAlignment.Bottom,
            axisTitle: "Shared X Axis",
            axisTitleStyle: {
                color: appTheme.VividGreen,
                fontSize: 30,
            },
            labelStyle: {
                color: appTheme.VividGreen,
            },
            backgroundColor: appTheme.VividGreen + "22",
            axisBorder: {
                borderTop: 1,
                color: appTheme.VividGreen,
            },
        })
    );

    sciChartSurface.yAxes.add(
        new NumericAxis(wasmContext, {
            axisAlignment: EAxisAlignment.Left,
            axisTitle: "Y Axis Left",
            axisTitleStyle: {
                color: appTheme.VividSkyBlue,
                fontSize: 30,
            },
            labelStyle: {
                color: appTheme.VividSkyBlue,
            },
            growBy: new NumberRange(0.1, 0.2),
            backgroundColor: appTheme.VividSkyBlue + "22",
            axisBorder: {
                borderRight: 1,
                color: appTheme.VividSkyBlue,
            },
        })
    );

    // generate some data
    let data = new RandomWalkGenerator().Seed(7331).getRandomWalkSeries(100);

    // Add the first line series on the primary X,Y axis
    // This occurs be default as FastLineRenderableSeries XAxisId and YAxisId are set to a default value
    sciChartSurface.renderableSeries.add(
        new FastLineRenderableSeries(wasmContext, {
            stroke: appTheme.VividSkyBlue,
            strokeThickness: 3,
            dataSeries: new XyDataSeries(wasmContext, { xValues: data.xValues, yValues: data.yValues }),
            pointMarker: new EllipsePointMarker(wasmContext, {
                width: 5,
                height: 5,
                fill: appTheme.VividGreen,
                stroke: appTheme.VividGreen,
            }),
        })
    );

    // Add a secondary Y Axis
    sciChartSurface.yAxes.add(
        new NumericAxis(wasmContext, {
            id: ID_Y_AXIS_2,
            axisTitleStyle: {
                color: appTheme.VividOrange,
                fontSize: 30,
            },
            labelStyle: {
                color: appTheme.VividOrange,
                alignment: ELabelAlignment.Right,
            },
            axisAlignment: EAxisAlignment.Right,
            axisTitle: "Y Axis Right",
            labelFormat: ENumericFormat.Decimal,
            labelPrecision: 2,
            growBy: new NumberRange(0.1, 0.2),
            backgroundColor: appTheme.VividOrange + "22",
            axisBorder: {
                borderLeft: 1,
                color: appTheme.VividOrange,
            },
        })
    );

    // Create some data & series for that axis
    data = new RandomWalkGenerator().Seed(1209).getRandomWalkSeries(100);

    // The second line series we specify X/Y axis ids to bind this to the correct axis
    sciChartSurface.renderableSeries.add(
        new FastLineRenderableSeries(wasmContext, {
            stroke: appTheme.VividOrange,
            strokeThickness: 3,
            dataSeries: new XyDataSeries(wasmContext, { xValues: data.xValues, yValues: data.yValues }),
            yAxisId: ID_Y_AXIS_2,
            pointMarker: new EllipsePointMarker(wasmContext, {
                width: 5,
                height: 5,
                fill: appTheme.VividOrange,
                stroke: appTheme.VividOrange,
            }),
        })
    );

    // Optional: Add some interactivity modifiers to enable zooming and panning
    sciChartSurface.chartModifiers.add(
        new YAxisDragModifier(),
        new XAxisDragModifier(),
        new ZoomPanModifier({ enableZoom: true }),
        new MouseWheelZoomModifier(),
        new ZoomExtentsModifier()
    );

    // Add a title over the chart with information
    sciChartSurface.annotations.add(
        new NativeTextAnnotation({
            x1: 0.01,
            y1: 0.01,
            xCoordinateMode: ECoordinateMode.Relative,
            yCoordinateMode: ECoordinateMode.Relative,
            horizontalAnchorPoint: EHorizontalAnchorPoint.Left,
            verticalAnchorPoint: EVerticalAnchorPoint.Top,
            fontSize: 18,
            opacity: 0.55,
            textColor: appTheme.ForegroundColor,
            text: "SciChart.js supports unlimited X,Y axis. Drag an axis to see the series scale",
            wrapTo: EWrapTo.ViewRect,
            multiLineAlignment: EMultiLineAlignment.Left,
        })
    );

    sciChartSurface.annotations.add(
        new TextAnnotation({
            x1: 10,
            y1: 1.1,
            fontSize: 18,
            textColor: appTheme.VividSkyBlue,
            horizontalAnchorPoint: EHorizontalAnchorPoint.Left,
            verticalAnchorPoint: EVerticalAnchorPoint.Bottom,
            text: "Blue series is bound to the Shared X-Axis, and Left Y-Axis",
        })
    );

    // Note annotations need X,Y Axis ID as well in multi-axis scenarios
    sciChartSurface.annotations.add(
        new TextAnnotation({
            x1: 5,
            y1: -1.2,
            fontSize: 18,
            textColor: appTheme.VividOrange,
            yAxisId: ID_Y_AXIS_2,
            text: "Orange series is bound to the Shared X-Axis, and Right Y-Axis",
        })
    );

    return { sciChartSurface, wasmContext };
};

Secondary Y Axes (JavaScript)

Overview

This example demonstrates how to create a high-performance sciChart using JavaScript with two vertically aligned Y axes, one on the left and a secondary on the right. The chart is built using SciChart.js and showcases binding different data series to distinct axes, each with its own custom styling and interactive capabilities.

Technical Implementation

The implementation begins by initializing a SciChartSurface with a WebAssembly (WASM) context to ensure optimal rendering performance. Developers can refer to the Creating a new SciChartSurface and loading Wasm documentation for further details on WASM context initialization. The primary X axis and left Y axis are set up first using NumericAxis, after which a secondary right Y axis is added using axis.axisAlignment = EAxisAlignment.Right. Styling properties like axisTitleStyle, axisTitle, labelStyle and axisBorder, backgroundColor define axis appearance. Data series are bound to their corresponding axes via axis.id using the FastLineRenderableSeries.xAxisId and yAxisId properties, following the guidelines in the Tutorial 08 - Adding Multiple Axis guide. Interactive modifiers, including YAxisDragModifier, XAxisDragModifier, ZoomPanModifier, MouseWheelZoomModifier, and ZoomExtentsModifier, are added to enable dynamic chart interactions.

Features and Capabilities

This example features real-time data visualization with dynamic updates and drag-to-scale capabilities. Both series use custom point markers rendered with the EllipsePointMarker, ensuring that each data point is visually distinctive. The chart also integrates both native and text annotations, providing contextual information directly on the chart. For more on configuring custom point markers, check the PointMarkers API documentation.

Integration and Best Practices

Leveraging JavaScript, this example provides a straightforward integration approach by directly calling the drawExample function and handling resource cleanup with a destructor on the SciChartSurface. The cleanup process follows best practices for memory management, as outlined in resources such as the Proper Disposal of SciChartSurface guide. Additionally, the use of interactive chart modifiers enhances user experience by allowing intuitive dragging, zooming, and panning. Developers are encouraged to follow these patterns to maintain performance and ensure efficient resource management.

For further technical context and advanced customization options, please explore the additional links provided, which cover various aspects from numeric axis configuration to performance optimization in SciChart.js.