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.

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();
}

Inherited Members

colorScheme

coloringOptions

DevExpress.Dashboard.Model.DataDashboardItem.componentName

dataItems

dataMember

dataSource

filterString

formatRules

hiddenDimensions

hiddenMeasures

isMasterFilterCrossDataSource

itemType

DevExpress.Dashboard.Model.DataDashboardItem.name

DevExpress.Dashboard.Model.DataDashboardItem.parentContainer

DevExpress.Dashboard.Model.DataDashboardItem.showCaption

DevExpress.Dashboard.Model.DataDashboardItem.getUniqueNamePrefix

Inheritance

DataDashboardItem

PivotItem

constructor

Initializes a new instance of the PivotItem class.

Declaration

constructor(
    dashboardItemJSON?: any,
    serializer?: DxDesigner.Analytics.Utils.ModelSerializer
)

Parameters

Name	Type	Description
dashboardItemJSON	any	A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

autoExpandColumnGroups Property

Declaration

autoExpandColumnGroups: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

autoExpandRowGroups Property

Declaration

autoExpandRowGroups: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

columns Property

Declaration

columns: ko.ObservableArray<Dimension>

Property Value

Type
ObservableArray<Dimension>

columnTotalsLocation Property

Declaration

columnTotalsLocation: ko.Observable<PivotColumnTotalsPosition>

Property Value

Type
Observable<PivotColumnTotalsPosition>

interactivityOptions Property

Declaration

interactivityOptions: FilterableDashboardItemInteractivityOptions

Property Value

Type
FilterableDashboardItemInteractivityOptions

layoutType Property

Declaration

layoutType: ko.Observable<PivotLayoutType>

Property Value

Type
Observable<PivotLayoutType>

rows Property

Declaration

rows: ko.ObservableArray<Dimension>

Property Value

Type
ObservableArray<Dimension>

rowTotalsLocation Property

Declaration

rowTotalsLocation: ko.Observable<PivotRowTotalsPosition>

Property Value

Type
Observable<PivotRowTotalsPosition>

showColumnGrandTotals Property

Declaration

showColumnGrandTotals: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

showColumnTotals Property

Declaration

showColumnTotals: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

showRowGrandTotals Property

Declaration

showRowGrandTotals: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

showRowTotals Property

Declaration

showRowTotals: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

values Property

Declaration

values: ko.ObservableArray<Measure>

Property Value

Type
ObservableArray<Measure>

valuesPosition Property

Declaration

valuesPosition: ko.Observable<PivotValuesPosition>

Property Value

Type
Observable<PivotValuesPosition>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationInfoArray