The requested page is not available for the requested platform. You are viewing the content for Default platform.

PivotItem Class

A Pivot dashboard item that displays cross-tabular reports.

Declaration

export class PivotItem extends DataDashboardItem

Remarks

The Pivot dashboard item presents data using cross-tabular reports.

wdd-dashboard-items-pivot

The following documentation is available: Web Dashboard - Creating a Pivot.

Examples

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?: DxDesigner.Analytics.Utils.ModelSerializer)

Optional Parameters

Name Type Default Description
dashboardItemJSON any null

A JSON object used for a dashboard deserialization. Do not pass this parameter directly.

serializer DxDesigner.Analytics.Utils.ModelSerializer null

An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

autoExpandColumnGroups Property

Declaration

autoExpandColumnGroups: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

autoExpandRowGroups Property

Declaration

autoExpandRowGroups: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

columnTotalsLocation Property

Declaration

columnTotalsLocation: ko.Observable<PivotColumnTotalsPosition>

Property Value

Type Description
ko.Observable<PivotColumnTotalsPosition>

columns Property

Declaration

columns: ko.ObservableArray<Dimension>

Property Value

Type Description
ko.ObservableArray<Dimension>

interactivityOptions Property

Declaration

interactivityOptions: FilterableDashboardItemInteractivityOptions

Property Value

Type Description
FilterableDashboardItemInteractivityOptions

layoutType Property

Declaration

layoutType: ko.Observable<PivotLayoutType>

Property Value

Type Description
ko.Observable<PivotLayoutType>

rowTotalsLocation Property

Declaration

rowTotalsLocation: ko.Observable<PivotRowTotalsPosition>

Property Value

Type Description
ko.Observable<PivotRowTotalsPosition>

rows Property

Declaration

rows: ko.ObservableArray<Dimension>

Property Value

Type Description
ko.ObservableArray<Dimension>

showColumnGrandTotals Property

Declaration

showColumnGrandTotals: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

showColumnTotals Property

Declaration

showColumnTotals: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

showRowGrandTotals Property

Declaration

showRowGrandTotals: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

showRowTotals Property

Declaration

showRowTotals: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

values Property

Declaration

values: ko.ObservableArray<Measure>

Property Value

Type Description
ko.ObservableArray<Measure>

valuesPosition Property

Declaration

valuesPosition: ko.Observable<PivotValuesPosition>

Property Value

Type Description
ko.Observable<PivotValuesPosition>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfoArray