PivotEngine Class

If you set this property to false, the context menus shown by controls such as the PivotGrid and PivotPanel will not include an option for changing the field settings.

The default value for this property is true.

This property is set to true by default, so summaries over large data sets are performed asynchronously to prevent stopping the UI thread.

The default value for this property is true.

If you set this property to true, the engine will generate fields for each property of the items in the itemsSource. The PivotField.binding property of the auto-generated fields is set to the property name, and their PivotField.header property is set to a string obtained by capitalizing the first letter of the binding and adding spaces before each capital letter.

For example, a 'customerName' property will cause the engine create a field with PivotField.binding set to 'customerName' and PivotField.header set to 'Customer Name'.

When adding fields to one of the view lists using strings, you must specify the PivotField.header, not the PivotField.binding (unlike bindings, field headers must be unique).

The default value for this property is true.

The default value for this property is null, which causes the engine to use FilterType.Both on the client or FilterType.Condition on the server.

The default value for this property is true, which matches Excel's behavior.

Set it to false to disable this behavior, so searching only affects which items are displayed on the list and not which items are included in the filter.

This list is created automatically whenever the itemsSource property is set.

Pivot views are defined by copying fields from this list to the lists that define the view: valueFields, rowFields, columnFields, and filterFields.

For example, the code below assigns a data source to the PivotEngine and then defines a view by adding fields to the rowFields, columnFields, and valueFields lists.

import { PivotEngine } from '@grapecity/wijmo.olap';

// create pivot engine
let pe = new PivotEngine();

// set data source (populates fields list)
pe.itemsSource = this.getRawData();

// prevent updates while building Olap view
pe.beginUpdate();

// show countries in rows
pe.rowFields.push('Country');

// show categories and products in columns
pe.columnFields.push('Category');
pe.columnFields.push('Product');

// show total sales in cells
pe.valueFields.push('Sales');

// done defining the view
pe.endUpdate();

Fields on this list do not appear in the output table, but are still used for filtering the input data.

A pivot view is defined if any of the valueFields, rowFields, or columnFields lists are not empty.

The first option (using an array or ICollectionView) is the simplest, but it limits the amount of raw data you can handle. Loading the raw data into an array can take a long time if the data set contains more than about 50,000 items or so.

To use this option, simply set the itemsSource property to any JavaScript array containing the raw data to be analyzed. For example:

import { PivotEngine } from '@grapecity/wijmo.olap';
let ng = PivotEngine({
    itemsSource = getDataArray(1000);
});

The second option (direct connection to OLAP SSAS cubes) allows the PivotEngine to connect directly to OLAP cubes provided by SSAS servers. This option removes the size limitations mentioned above and allows you to analyze data sets with millions or billions of records.

To use this option, set the itemsSource property to an object that specifies how the component should access the service. For example:

import { PivotEngine } from '@grapecity/wijmo.olap';
let ng = PivotEngine({
    itemsSource: {
        url: 'http://ssrs.componentone.com/OLAP/msmdpump.dll',
        cube: 'Adventure Works',
        catalog: 'AdventureWorksDW2012Multidimensional'
    }
});

The catalog property is optional, but url and cube are required.

The preceding example works with SSAS servers that allow anonymous access. For servers that require Basic Authentication, you should also include the appropriate user and password members as part of the itemsSource object.

When connecting directly to OLAP SSAS cubes, users will not be able to filter fields by value. They will still be able to filter by condition.

The third option, ComponentOne data engine services, allows you to analyze large datasets on a server without downloading the raw data to the client. You can use our high-performance FlexPivot services or interface with Microsoft's SQL Server Analysis Services OLAP Cubes.

To use ComponentOne data engine services, set the itemsSource property to a string containing the URL of the data service. For example:

import { PivotEngine } from '@grapecity/wijmo.olap';
let ng = new wijmo.olap.PivotEngine({
    itemsSource: 'http://demos.componentone.com/ASPNET/c1webapi/4.5.20193.222/api/dataengine/cube'
});

The PivotEngine sends view definitions to the server, where summaries are calculated and returned to the client.

When connecting ComponentOne DataEngine data sources, users will not be able to filter fields by value. They will still be able to filter by condition.

For more information about the ComponentOne DataEngine services please refer to the online documentation.

Our OlapServerIntro sample shows all options working with a single PivotEngine.

The default value for this property is 1,000, which is a reasonable amount of detail in many scenarios. If you want to allow more detail records to be retrieved, increase the value of this property.

The default value for this property is 500 milliseconds, which causes the engine to poll the server for a status update every half second.

The default value for this property is 60,000 milliseconds, or one minute. If you expect server operations to take longer than that, set the property to a higher value.

The default value for this property is ShowTotals.GrandTotals.

The default value for this property is ShowTotals.GrandTotals.

The default value for this property is false.

If this property is set to true, the PivotEngine will not sort the data it receives from the server.

This property should be used only in conjunction with custom servers that return the aggregated data properly sorted, typically using custom logic not available in the standard PivotEngine.

The default value for this property is false.

The default value for this property is true.

If this value is set to true, total rows appear above data rows and total columns appear on the left of regular data columns.

The default value for this property is false.

This property is typically used to persist the current view as an application setting.

For example, the code below implements two functions that save and load view definitions using local storage:

// save/load views
function saveView() {
  localStorage.viewDefinition = pivotEngine.viewDefinition;
}
function loadView() {
  pivotEngine.viewDefinition = localStorage.viewDefinition;
}