PivotItem Class
Declaration
export class PivotItem extends DataDashboardItem
The Pivot dashboard item presents data using cross-tabular reports.
The following documentation is available: Web Dashboard - Creating a Pivot.
Example
The following example shows how to create the Pivot dashboard item, bind it to data and add to the existing dashboard.
Create data items (measures and dimensions) and use the DataItem.dataMember property to bind them to the existing data source’s columns. Then use the created measures and dimensions in the dashboard item to bind it to data.
After you add the created dashboard item to the Dashboard.items collection, call the Dashboard.rebuildLayout method to rebuild the dashboard layout and display changes.
// Use the line below for a modular approach:
// import * as Model from 'devexpress-dashboard/model'
// Use the line below for an approach with global namespaces:
// var Model = DevExpress.Dashboard.Model;
// ...
public createPivotItem() {
// Create data items for the Pivot dashboard item.
var pivotCategoryName = new Model.Dimension();
pivotCategoryName.dataMember("CategoryName");
var pivotProductName = new Model.Dimension();
pivotProductName.dataMember("ProductName");
var pivotCountry = new Model.Dimension();
pivotCountry.dataMember("Country");
var pivotFullName = new Model.Dimension();
pivotFullName.dataMember("FullName");
var pivotExtendedPrice = new Model.Measure();
pivotExtendedPrice.dataMember("ExtendedPrice");
// Create the Pivot dashboard item and bind it to data.
var pivotItem = new Model.PivotItem();
pivotItem.name('pivot');
pivotItem.dataSource(sqlDataSource.componentName());
pivotItem.dataMember(sqlDataSource.queries()[0].name());
pivotItem.columns.push(pivotCountry, pivotFullName);
pivotItem.rows.push(pivotCategoryName, pivotProductName);
pivotItem.values.push(pivotExtendedPrice);
control.dashboard().items.push(pivotItem);
// ...
control.dashboard().rebuildLayout();
}
constructor
Initializes a new instance of the PivotItem class.
Declaration
constructor(
dashboardItemJSON?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
Parameters
| Name |
Type |
Description |
| dashboardItemJSON |
any |
A JSON object used for dashboard deserialization. Do not pass this parameter directly.
|
| serializer |
ModelSerializer |
An object used for dashboard deserialization. Do not pass this parameter directly.
|
Properties
autoExpandColumnGroups Property
Declaration
autoExpandColumnGroups: ko.Observable<boolean>
Property Value
autoExpandRowGroups Property
Declaration
autoExpandRowGroups: ko.Observable<boolean>
Property Value
columns Property
Declaration
columns: ko.ObservableArray<DevExpress.Dashboard.Model.Dimension>
Property Value
columnTotalsLocation Property
Declaration
columnTotalsLocation: ko.Observable<DevExpress.Dashboard.Model.PivotColumnTotalsPosition>
Property Value
interactivityOptions Property
Declaration
interactivityOptions: DevExpress.Dashboard.Model.FilterableDashboardItemInteractivityOptions
Property Value
layoutType Property
Declaration
layoutType: ko.Observable<DevExpress.Dashboard.Model.PivotLayoutType>
Property Value
rows Property
Declaration
rows: ko.ObservableArray<DevExpress.Dashboard.Model.Dimension>
Property Value
rowTotalsLocation Property
Declaration
rowTotalsLocation: ko.Observable<DevExpress.Dashboard.Model.PivotRowTotalsPosition>
Property Value
showColumnGrandTotals Property
Declaration
showColumnGrandTotals: ko.Observable<boolean>
Property Value
showColumnTotals Property
Declaration
showColumnTotals: ko.Observable<boolean>
Property Value
showRowGrandTotals Property
Declaration
showRowGrandTotals: ko.Observable<boolean>
Property Value
showRowTotals Property
Declaration
showRowTotals: ko.Observable<boolean>
Property Value
values Property
Declaration
values: ko.ObservableArray<DevExpress.Dashboard.Model.Measure>
Property Value
valuesPosition Property
Declaration
valuesPosition: ko.Observable<DevExpress.Dashboard.Model.PivotValuesPosition>
Property Value