Getting Started with the KendoReact PivotGrid

This guide provides essential information about using the KendoReact PivotGrid. You will learn how to install the package, add a PivotGrid component to your project, style the component, and activate your license.

The PivotGrid is part of KendoReact, a professional grade UI library with 110+ components for building modern and feature-rich applications. To try it out sign up for a free 30-day trial.Start Free Trial

After completing this guide, you will be able to reproduce the following example.

Change Theme

Theme

Loading ...

Setting Up Your React Project

Before you install the KendoReact PivotGrid, make sure that you have a running React project. The easiest way to set up a React project is to use the Create React App approach that is described in the Get Started with KendoReact article.

Installing the Component

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the PivotGrid component, start with the installation of the PivotGrid npm package and its dependencies. Use Node.js v5.0.0 or later.

npm install --save @progress/kendo-react-pivotgrid @progress/kendo-data-query @progress/kendo-react-buttons @progress/kendo-react-treeview @progress/kendo-react-data-tools @progress/kendo-react-form @progress/kendo-react-indicators @progress/kendo-react-intl @progress/kendo-react-labels @progress/kendo-svg-icons

Importing the Component

After installing the package, import the PivotGrid component in the React App.

In the src/App.js file of your React project, import the PivotGrid, PivotGridAxis and PivotGridContainer, components from the PivotGrid package. The PivotGridAxis provides a single column, row, or measure Axis.

jsx

// ES2015 module syntax
import {
  PivotGrid,
  PivotGridContainer,
  PivotGridAxis,
} from "@progress/kendo-react-pivotgrid";

jsx

// CommonJS format
const { PivotGrid, PivotGridContainer, PivotGridAxis } = require('@progress/kendo-react-pivotgrid');

Using the Component

Define the defaultColumnAxes, defaultRowAxes and the defaultMeasureAxes.

jsx

const defaultColumnAxes: PivotGridAxis[] = [
    { name: ['[Date].[Calendar]'], expand: true },
    { name: ['[Product].[Category]'] }
];
const defaultRowAxes: PivotGridAxis[] = [{ name: ['[Geography].[City]'] }];
const defaultMeasureAxes: PivotGridAxis[] = [{ name: ['[Measures].[Reseller Freight Cost]'] }];

Define the catalog, cube, and url.

jsx

const catalog = 'Adventure Works DW 2008R2';
const cube = 'Adventure Works';
const url = 'https://demos.telerik.com/olap/msmdpump.dll';

Add the component's markup to the src/App.js file in your project and set the desired properties.

jsx

return (
    <PivotOLAPService
        catalog={catalog}
        cube={cube}
        url={url}
        defaultRowAxes={defaultRowAxes}
        defaultColumnAxes={defaultColumnAxes}
        defaultMeasureAxes={defaultMeasureAxes}
    >
        {({ pivotProps }) => (
            <PivotGridContainer>
                <PivotGrid {...pivotProps} style={{ height: 700 }} column={WideColumn} />
            </PivotGridContainer>
        )}
    </PivotOLAPService>
);

To style the PivotGrid, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

4.1. Install the Default theme package.
sh
```
npm install --save @progress/kendo-theme-default
```
4.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.
jsx
```
import '@progress/kendo-theme-default/dist/all.css';
```
Build and run the application by typing the following command in the root folder of your project:
sh
```
npm start
```
Navigate to http://localhost:3000 to see the KendoReact PivotGrid component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The PivotGrid package requires you to install the following peer dependencies in your application:

Package Name	Description
react 16.8.2*	Contains the functionality necessary to define React components.
react-dom	Contains the React renderer for the web.
@progress/kendo-data-query	Contains the KendoReact data query helpers.
@progress/kendo-react-intl	Contains the KendoReact Internationalization package that applies the desired cultures by providing services and pipes for the parsing and formatting of dates and numbers.
@progress/kendo-react-buttons	Contains the KendoReact Buttons components.
@progress/kendo-react-treeview	Contains the KendoReact Treeview components.
@progress/kendo-react-form	Contains the KendoReact Form components.
@progress/kendo-react-indicators	Contains the KendoReact Indicator components.
@progress/kendo-react-labels	Contains the KendoReact Labels components.
@progress/kendo-svg-icons	Contains the KendoReact SVG icons.