Getting Started with the Vue Stock Chart Component in Vue 3

28 Jul 202615 minutes to read

This article provides a step-by-step guide for setting up a Vite project with a JavaScript environment and integrating the Syncfusion® Vue Stock Chart component using the Composition API / Options API.

The Composition API is a new feature introduced in Vue.js 3 that provides an alternative way to organize and reuse component logic. It allows developers to write components as functions that use smaller, reusable functions called composition functions to manage their properties and behavior.

The Options API is the traditional way of writing Vue.js components, where the component logic is organized into a series of options that define the component’s properties and behavior. These options include data, methods, computed properties, watchers, life cycle hooks, and more.

Prerequisites

Ensure that the development environment meets the required criteria listed in System requirements for Syncfusion® Vue UI components.

Set Up the Vite Project

Create a Vite project using either npm or Yarn.

npm

npm create vite@latest my-app -- --template vue

yarn

yarn create vite my-app --template vue

If Vite prompts you to install dependencies and start the project immediately, select No. The Syncfusion package is installed in a later step.

Navigate to the project directory:

cd my-app

Install the project dependencies using either npm or Yarn.

npm

npm install

yarn

yarn install

Now that my-project is set up, let’s add Syncfusion® components to the project.

Note: To create a TypeScript project, use npm create vite@latest my-app -- --template vue-ts or yarn create vite my-app --template vue-ts.

Add Syncfusion® Vue Stock Chart Packages

Syncfusion® Vue component packages are available at npmjs.com. To use Syncfusion® Vue components in the project, install the corresponding npm package.

This article uses the Vue Stock Chart component as an example. To use the Vue Stock Chart component in the project, the @syncfusion/ej2-vue-charts package needs to be installed using either npm or Yarn:

npm

npm install @syncfusion/ej2-vue-charts

yarn

yarn add @syncfusion/ej2-vue-charts

Note: npm v5+ saves packages to dependencies by default; --save is not required.

Import Syncfusion® CSS styles

Syncfusion® Vue Stock Chart component themes can be applied using CSS or SASS from npm theme packages, CDN, CRG or Theme Studio.

This example uses the Material 3 theme for the Stock Chart component. To install the Material 3 theme package, use the following command:

npm install @syncfusion/ej2-material3-theme --save
yarn add @syncfusion/@syncfusion/ej2-material3-theme

The necessary CSS styles for the Stock Chart component were imported into the <style> section of src/App.vue file. Vite app generates a default styles.css file which we do not need for this example. Before running the sample, delete the content of src/style.css or remove the file if it’s unused.

<style>
  @import "../node_modules/@syncfusion/ej2-material3-theme/styles/stock-chart/index.css";
</style>

Add Syncfusion® Vue Stock Chart Component

Follow the below steps to add the Vue Stock Chart component using Composition API or Options API:

Step 1: First, import and register the Stock Chart component and its child directives in the script section of the src/App.vue file. If you are using the Composition API, you should add the setup attribute to the script tag to indicate that Vue will be using the Composition API.

<script setup>
import { StockChartComponent as EjsStockchart, StockChartSeriesCollectionDirective as EStockchartSeriesCollection, StockChartSeriesDirective as EStockchartSeries, DateTime, CandleSeries } from "@syncfusion/ej2-vue-charts";
</script>
<script>
import { StockChartComponent, StockChartSeriesCollectionDirective, StockChartSeriesDirective, DateTime, CandleSeries } from "@syncfusion/ej2-vue-charts";
//Component registration
export default {
  name: "App",
  components: {
    "ejs-stockchart": StockChartComponent,
    "e-stockchart-series-collection": StockChartSeriesCollectionDirective,
    "e-stockchart-series": StockChartSeriesDirective
  }
}
</script>

Step 2: Declare the values for the dataSource property in the script section.

<script setup>
const seriesData = [
        {
            date: new Date('2012-04-02'),
            open: 85.9757,
            high: 90.6657,
            low: 85.7685,
            close: 90.5257,
            volume: 660187068
        },
        {
            date: new Date('2012-04-09'),
            open: 89.4471,
            high: 92,
            low: 86.2157,
            close: 86.4614,
            volume: 912634864
        },
        // Additional data points...
];
</script>
<script>
export default {
  data() {
    return {
        seriesData: [
            {
                date: new Date('2012-04-02'),
                open: 85.9757,
                high: 90.6657,
                low: 85.7685,
                close: 90.5257,
                volume: 660187068
            },
            {
                date: new Date('2012-04-09'),
                open: 89.4471,
                high: 92,
                low: 86.2157,
                close: 86.4614,
                volume: 912634864
            },
            // Additional data points...
        ],
    };
  }
};
</script>

Note: Register the feature modules using provide('stockChart', [...]) (Composition API) or the provide option (Options API). This step is essential for the Stock Chart to function properly with the required series types and axes.

Note: If you skip module registration, the chart will not render correctly and you may encounter errors like “Module is not injected” in the browser console.

Step 3: In the template section, define the Stock Chart component with the dataSource property.

<template>
        <ejs-stockchart>
            <e-stockchart-series-collection>
                <e-stockchart-series :dataSource="seriesData" type="Candle" volume="volume" xName="date" low="low" high="high" open="open" close="close">
                </e-stockchart-series>
            </e-stockchart-series-collection>
        <ejs-stockchart>
</template>

Here is the complete summarized code for the src/App.vue file:

<template>
        <ejs-stockchart>
            <e-stockchart-series-collection>
                <e-stockchart-series :dataSource="seriesData" type="Candle" volume="volume" xName="date" low="low" high="high" open="open" close="close">
                </e-stockchart-series>
            </e-stockchart-series-collection>
        <ejs-stockchart>
</template>

<script setup>
import { provide } from 'vue';
import { StockChartComponent as EjsStockchart, StockChartSeriesCollectionDirective as EStockchartSeriesCollection, StockChartSeriesDirective as EStockchartSeries, DateTime, CandleSeries } from "@syncfusion/ej2-vue-charts";

const seriesData = [
        {
            date: new Date('2012-04-02'),
            open: 85.9757,
            high: 90.6657,
            low: 85.7685,
            close: 90.5257,
            volume: 660187068
        },
        {
            date: new Date('2012-04-09'),
            open: 89.4471,
            high: 92,
            low: 86.2157,
            close: 86.4614,
            volume: 912634864
        },
        // Additional data points...
];
const stockChart = [ DateTime, CandleSeries ];
provide('stockChart', stockChart);
</script>
<template>
        <ejs-stockchart>
            <e-stockchart-series-collection>
                <e-stockchart-series :dataSource="seriesData" type="Candle" volume="volume" xName="date" low="low" high="high" open="open" close="close">
                </e-stockchart-series>
            </e-stockchart-series-collection>
        </ejs-stockchart>
</template>

<script>
import { StockChartComponent, StockChartSeriesCollectionDirective, StockChartSeriesDirective, DateTime, CandleSeries } from "@syncfusion/ej2-vue-charts";
//Component registration
export default {
  name: "App",
  components: {
    "ejs-stockchart": StockChartComponent,
    "e-stockchart-series-collection": StockChartSeriesCollectionDirective,
    "e-stockchart-series": StockChartSeriesDirective
  },
  data() {
    return {
        seriesData: [
            {
                date: new Date('2012-04-02'),
                open: 85.9757,
                high: 90.6657,
                low: 85.7685,
                close: 90.5257,
                volume: 660187068
            },
            {
                date: new Date('2012-04-09'),
                open: 89.4471,
                high: 92,
                low: 86.2157,
                close: 86.4614,
                volume: 912634864
            },
            // Additional data points...
        ],
    };
  },
  provide: {
    stockChart: [ DateTime, CandleSeries ]
  }
};
</script>

Run the Project

To run the project, use either npm or Yarn:

npm

npm run dev

yarn

yarn run dev

The development server will start and display a message indicating the port number (typically http://localhost:5173). Open your browser and navigate to http://localhost:5173 to view the Stock Chart.

The output will appear as follows:

Vue 3 Stock Chart demo

Sample: You can explore the complete sample project in the vue-3-stock-chart-getting-started repository.

Troubleshooting

The following are common issues and solutions when integrating the Stock Chart component:

  • Chart not rendering: Ensure that all required modules (DateTime, CandleSeries) are provided using provide('stockChart', [...]) (Composition API) or the provide option (Options API). Verify that the template includes the chart component with proper directives.

  • Module not injected error: This error occurs when feature modules are not registered. Confirm that the provide function or option includes all necessary modules: DateTime for date-time axis and CandleSeries for candle series type.

  • Incorrect data display: Verify that the data object properties match the series configuration attributes (xName="date", open="open", high="high", low="low", close="close"). Ensure date values are created using new Date().

  • OHLC data format issues: Stock Chart expects data with open, high, low, and close properties for candle series. Verify your data structure matches this format and that all required fields are present.

See Also