Integrate Chart in EJ2 EJ2 JavaScript Grid

30 Jun 202524 minutes to read

The Grid and Chart Integration feature in Syncfusion allows users to visualize tabular data in a graphical format by linking the Grid with the Chart.This feature allows seamless integration with Charts to visualize selected data interactively. You can generate various Chart types such as bar, line, or pie directly from Grid data using the ContextMenu feature. This feature is particularly useful in scenarios where tabular data can be better understood through graphical representation.

This feature is particularly useful in dashboards, reporting tools, and data-driven applications where both tabular and visual representations of data are required.

Steps for Chart integration

To integrate Charts into your EJ2 EJ2 JavaScript Grid, follow these steps:

Dependencies

Below is the list of minimum dependencies required to integrate Chart functionality into the EJ2 EJ2 JavaScript Grid:

|-- dependencies
  |-- @syncfusion/ej2-grids
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-buttons
    |-- @syncfusion/ej2-dropdowns
    |-- @syncfusion/ej2-inputs
    |-- @syncfusion/ej2-navigations
    |-- @syncfusion/ej2-popups
  |-- @syncfusion/ej2-charts
  |-- @syncfusion/ej2-grid-chart

Setup for local development

Refer to the following steps to set up your local environment.

Step 1: Create a root folder named my-app for your application.

Step 2: Create a my-app/resources folder to store local scripts and styles files.

Step 3: Open Visual Studio Code and create my-app/index.js and my-app/index.html files for initializing the Essential JS 2 Syncfusion control.

Adding Syncfusion resources

The Essential JS 2 Grid and GridChart can be initialized by using either of the following ways.

Chart integration via Context Menu in Grid

This section explains how to dynamically render Charts based on user interactions within the Syncfusion EJ2 JavaScript Grid using the context menu. Users can right-click on selected rows and choose from various Chart types such as bar, pie, line Charts etc to visualize the data instantly. This feature enhances interactivity and provides a seamless analytical experience.

For example, in a sales dashboard, you can select sales records for specific products and instantly view a comparative bar or pie Chart illustrating online sales versus retail sales or revenue trends over several month. This functionality helps improve decision-making by providing immediate visual feedback.

Steps to be followed to integrate Chart into Grid via contextmenu:

Step 1: Define Chart options to Grid Context Menu:

Add Chart visualization options as context menu items within the Grid configuration using contextMenuItems property. These items allow you to right-click on selected rows and choose a Chart type to visualize the data.

contextMenuItems: [
  'Bar', 'StackingBar', 'StackingBar100',
  'Pie','Column', 'StackingColumn', 'StackingColumn100',
  'Line', 'StackingLine', 'StackingLine100',
  'Area', 'StackingArea', 'StackingArea100','Scatter'
]

Step 2: Initialize GridChart instance on Grid creation:

Inside the Grid’s created event, instantiate a GridChart object. This instance will be used to render Charts dynamically based on the selected Grid data.

created: () => {
  gridChart = new GridChart({
    enableRtl: grid.enableRtl,
    locale: grid.locale
  });
}

This ensures that the Chart instance is ready as soon as the Grid is initialized, allowing seamless interaction through the context menu.

Step 3: Handle context menu click to render Chart:

Use the contextMenuClick event to detect which Chart type was selected and render the Chart accordingly using the GridChart.render() method.

ContextMenuClick event passes the below arguments:

  • args.chartType: The selected Chart type.

  • args.gridInstance: The current Grid instance.

  • args.records: The selected data records to be visualized in the Chart.

  • Use the gridChart.render to render the Chart. It accepts three arguments discussed below:

    • chartArgs: Contains Grid instance, Chart type, and selected records.

    • chartModel: This specifies various Chart configurations related to the appearance and behavior of the Chart. The model allows you to configure axes, labels, legends, tooltips, and other Chart attributes. Refer to Syncfusion’s Chart Model for detailed configurations, options, and customization possibilities.

    • categorySeries: This specifies the fields in your data used for categories and series in the Chart.

      • Category fields: Define the grouping axis.
      • Series fields: Define the actual values plotted on the Chart.
  contextMenuClick: (args) => {
    // Check if the Chart type is defined in the clicked context menu item.
    if (args.chartType) {
      
      // Prepare the Chart arguments including the Grid instance, Chart type, and records to plot.
      const chartArgs = {
        gridInstance: args.gridInstance,
        chartType: args.chartType,
        records: args.records 
      };

      // Set up the Chart model configurations.
      const chartModel = {
        primaryXAxis: {
          valueType: 'Category',
          labelRotation: 315
        },
      };

      // Combine both Chart models into a single model for rendering.
      const model = { chart: chartModel, accumulationChart: {} };

      // Determine fields for category and series data in the Chart.
      const categorySeries = {
        category: ['Product', 'Month'], 
        series: ['Online', 'Retail'] 
      };

      // Render the Chart using the configured arguments and models.
      // The render function uses the defined chartArgs, model, and categorySeries to display the Chart.
      gridChart.render(chartArgs, model, categorySeries);
    }
}

The following complete example demonstrates how to integrate Charts into a Grid context menu using the contextMenuClick event with gridChart.render method:

ej.grids.Grid.Inject(ej.grids.ContextMenu);

let gridChart;
let grid = new ej.grids.Grid({
  dataSource: salesDatas,
  height: 416,
  allowSelection: true,
  selectionSettings: { type: 'Multiple' },
  contextMenuItems: [
    'Bar', 'StackingBar', 'StackingBar100',
    'Pie','Column', 'StackingColumn', 'StackingColumn100',
    'Line', 'StackingLine', 'StackingLine100',
    'Area', 'StackingArea', 'StackingArea100','Scatter'
  ],
  columns: [
    { type: 'checkbox', width: 50 },
    { field: 'Product', headerText: 'Products', width: 200 },
    { field: 'Month', headerText: 'Month', width: 160 },
    { field: 'Online', headerText: 'Online', format: 'C2', textAlign: 'Right', width: 160 },
    { field: 'Retail', headerText: 'Retail', format: 'C2', textAlign: 'Right', width: 160 },
    { field: 'Total', headerText: 'Total', format: 'C2', textAlign: 'Right', width: 160 },
  ],
  created: () => {
    gridChart = new ej.gridchart.GridChart({
      enableRtl: grid.enableRtl,
      locale: grid.locale,
    });
  },
  contextMenuClick: (args) => {
    if (args.chartType) {
      const chartArgs = {
        gridInstance: args.gridInstance,
        chartType: args.chartType,
        records: args.records
      };
      const chartModel  = {
        primaryXAxis: {
          valueType: 'Category',
          labelRotation: 315
        }
      };
      const model = {
        chart: chartModel,
        accumulationChart: { }
      };
      const categorySeries = {
        category: ['Product', 'Month'],
        series: ['Online', 'Retail']
      };
      gridChart.render(chartArgs, model, categorySeries);
    }
  }
});
grid.appendTo('#GridChart');
<!DOCTYPE html>
<html lang="en">

<head>
  <title>EJ2 Grid</title>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta name="description" content="Typescript Grid Control">
  <meta name="author" content="Syncfusion">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-base/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-grids/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-buttons/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-popups/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-navigations/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-dropdowns/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-lists/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-inputs/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-calendars/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-splitbuttons/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-grid-chart/styles/bootstrap5.css" rel="stylesheet" />
  <script src="https://cdn.syncfusion.com/ej2/31.1.17/dist/ej2.min.js" type="text/javascript"></script>
  <script src="es5-datasource.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>

<body>

  <div id='container'>
    <div id="GridChart"></div>
  </div>

  <script>
    var ele = document.getElementById('container');
    if (ele) {
      ele.style.visibility = "visible";
    }
  </script>
  <script src="index.js" type="text/javascript"></script>
</body>

</html>

Enable export functionality in GridChart

The export functionality in GridChart allows Charts to be saved or shared externally in various formats. This is particularly useful for preserving visualized data or including Charts in reports and presentations.

To enable this feature, set the allowExport property to true when creating the GridChart instance. Once enabled, an export option appears in the Chart popup toolbar, allowing the Chart to be exported in various formats such as PDF, CSV, Print, JPEG, XLSX, SVG, and PNG.

The following code snippet demonstrates how to enable export functionality in GridChart:

gridChart = new GridChart({
  allowExport: true
});

Enable property panel in GridChart

The property panel in GridChart provides a built-in interface to modify Chart settings dynamically at runtime. By default, the property panel is disabled. To enable it, set the enablePropertyPanel option to true during the instantiation of the GridChart object. Here’s how to do it:

gridChart = new GridChart({
  enablePropertyPanel: true
});

When enabled, the property panel appears alongside the Chart popup and offers three main configuration sections:

  • Chart Types: Choose from a variety of Chart types, including Column, Line, Pie, and others.

  • Chart Data: Configure the category axis and series fields for data visualization.

  • Formatting Options: Adjust styling properties such as Chart style, title style, legend appearance, series settings, and axes formatting.

    • Chart Style:

      • Margin : Adjust the margins around the Chart (top, bottom, left, right) for better layout spacing.
      • Color: Set distinct colors for different Chart elements to improve visual clarity.

    • Title Style

      • Legend - Toggle the visibility of the legend and customize its font, size, color, and position.
      • Series - Enable/disable tooltips and customize Series color and data labels based on categories such as online, retail, or revenue.

    • Axes: - Select axes as either category or value type, and customize:

      • Reverse Order to change the data sequence.
      • Title: Adjust text, font, size, color, and rotation.
      • Label: Modify text, font, size, color, and rotation for better label presentation.

customize the Chart model:

You can customize the Chart by defining a chartModel object in the chart property of the model object within the contextMenuClick event .This allows you to configure various Chart properties such as axes, margins, tooltips, titles, and more. Additionally, you can use the events of the Chart within the chartModel configuration to apply further customizations when the Chart is rendered.

To customize Accumulation Charts (such as Pie), use the accumulationChart property of the model object. This property allows you to configure Chart options like titles, legends, data labels, and visual styles tailored for accumulation-type visualizations. You can also use Accumulation Chart events to apply additional customizations when the Chart is rendered.

The following code snippets demonstrate how to achieve this:

contextMenuClick: (args) => {
  if (args.chartType) {
    const chartModel = {
      primaryXAxis: {
      valueType: 'Category',
      labelRotation: 315,
    },
    margin: {
      top: 20,
      bottom: 20,
      right: 20,
      left: 20
    },
    tooltip: {
      enable: true,
      textStyle: {
        size: '16px',
        fontFamily: 'Arial, Helvetica, sans-serif'
      }
    },
    title: 'Sales Data',
    titleStyle: {
      size: '24px',
      fontFamily: 'Arial, Helvetica, sans-serif',
      fontWeight: 'Bold'
    },
    subTitle: 'Sales data for various products over the months',
    load: (args) => {
      if (args.chart.titleStyle) {
        args.chart.titleStyle.color = '#1976d2';
      }
    }
  };
  const accumulationChartModel = {
    title :'Sales Distribution'
  };
  const model = {
    chart: chartModel,
      accumulationChart: accumulationChartModel
    };
  }
}

You can also programmatically update the Chart’s appearance using the updateChartSettings(args: UpdateChartArgs) event provided by the GridChart integration. This event is triggered when you modify Chart properties through the Chart popup’s property panel. This is useful for applying custom themes, adjusting axis settings, or modifying series styles.

The following code snippet demonstrates how to dynamically customize chart margins and restrict their values to a minimum of 20 using the updateChartSettings event.

created: () => {
  gridChart = new GridChart({
    enablePropertyPanel: true,
    updateChartSettings: updateChartSettings
  });
});

function updateChartSettings(args) {
  const chart = args.changes?.chart;
  if (!chart) return;

  // Restrict margin values to minimum 20.
  const margin = chart.margin;
  if (margin) {
    if ( margin.top < 20) margin.top = 20;
    if (margin.bottom < 20) margin.bottom = 20;
    if (margin.left < 20) margin.left = 20;
    if (margin.right < 20) margin.right = 20;
  }
}

The following complete example demonstrates how to enable the property panel by setting enablePropertyPanel to true, customize the chart using the chartModel within contextMenuClick event, and dynamically control or customize the behavior of the updateChartSettings event.

ej.grids.Grid.Inject(ej.grids.ContextMenu);
let gridChart;
let grid = new ej.grids.Grid(
  {
    dataSource: salesDatas,
    height: 416,
    allowSelection: true,
    selectionSettings: { type: 'Multiple' },
    contextMenuItems: [
      'Bar', 'StackingBar', 'StackingBar100',
      'Pie', 'Column', 'StackingColumn', 'StackingColumn100',
      'Line', 'StackingLine', 'StackingLine100',
      'Area', 'StackingArea', 'StackingArea100', 'Scatter'
    ],
    columns: [
      { type: 'checkbox', width: 50 },
      { field: 'Product', headerText: 'Products', width: 200 },
      { field: 'Month', headerText: 'Month', width: 160 },
      { field: 'Online', headerText: 'Online', format: 'C2', textAlign: 'Right', width: 160 },
      { field: 'Retail', headerText: 'Retail', format: 'C2', textAlign: 'Right', width: 160 },
      { field: 'Total', headerText: 'Total', format: 'C2', textAlign: 'Right', width: 160 },
    ],
    created: () => {
      gridChart = new ej.gridchart.GridChart({
        enablePropertyPanel: true,
        allowExport: true,
        enableRtl: grid.enableRtl,
        locale: grid.locale,
        updateChartSettings: updateChartSettings
      });
    },
    contextMenuClick: (args) => {
      if (args.chartType) {
        const chartArgs= {
          gridInstance: (args.gridInstance),
          chartType: args.chartType,
          records: (args.records),
        };
        const chartModel = {
          primaryXAxis: {
            valueType: 'Category',
            labelRotation: 315,
          },
          margin: {
            top: 20,
            bottom: 20,
            right: 20,
            left: 20
          },
          tooltip: {
            enable: true,
            textStyle: {
              size: '16px',
              fontFamily: 'Arial, Helvetica, sans-serif'
            }
          },
          title: 'Sales Data',
          titleStyle
            : {
            size: '24px',
            fontFamily: 'Arial, Helvetica, sans-serif',
            fontWeight: 'Bold'
          },

          subTitle: 'Sales data for various products over the months',
          load: (args) => {
            if (args.chart.titleStyle) {
              args.chart.titleStyle.color = '#1976d2';
            }
          }
        };
        const accumulationChartModel= {
          title :'Sales Distribution'
        };
        const model = {
          chart: chartModel,
          accumulationChart: accumulationChartModel
        };
        const categorySeries = {
          category: ['Product', 'Month'],
          series: ['Online', 'Retail']
        };
        gridChart.render(chartArgs, model, categorySeries);
      }
    }
  });
grid.appendTo('#GridChart');

function updateChartSettings(args) {
  const chart = args.changes?.chart;
  if (!chart) return;

  // Restrict margin values to minimum 20.
  const margin = chart.margin;
  if (margin) {
    if ( margin.top < 20) margin.top = 20;
    if (margin.bottom < 20) margin.bottom = 20;
    if (margin.left < 20) margin.left = 20;
    if (margin.right < 20) margin.right = 20;
  }
}
<!DOCTYPE html>
<html lang="en">

<head>
  <title>EJ2 Grid</title>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta name="description" content="Typescript Grid Control">
  <meta name="author" content="Syncfusion">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-base/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-grids/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-buttons/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-popups/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-navigations/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-dropdowns/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-lists/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-inputs/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-calendars/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-splitbuttons/styles/bootstrap5.css" rel="stylesheet">
  <link href="https://cdn.syncfusion.com/ej2/31.1.17/ej2-grid-chart/styles/bootstrap5.css" rel="stylesheet" />
  <script src="https://cdn.syncfusion.com/ej2/31.1.17/dist/ej2.min.js" type="text/javascript"></script>
  <script src="es5-datasource.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>

<body>

  <div id='container'>
    <div id="GridChart"></div>
  </div>

  <script>
    var ele = document.getElementById('container');
    if (ele) {
      ele.style.visibility = "visible";
    }
  </script>
  <script src="index.js" type="text/javascript"></script>
</body>

</html>