dashboard-js-devexpress-dot-dashboard-dot-model-5dc0aa15.md
A Pivot dashboard item that displays cross-tabular reports.
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.
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();
}
SerializableModel TypedSerializableModel DashboardItem DataDashboardItem PivotItem
Initializes a new instance of the PivotItem class.
constructor(
dashboardItemJSON?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
| 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.
|
autoExpandColumnGroups: ko.Observable<boolean>
| Type |
|---|
| Observable<boolean> |
autoExpandRowGroups: ko.Observable<boolean>
| Type |
|---|
| Observable<boolean> |
columns: ko.ObservableArray<DevExpress.Dashboard.Model.Dimension>
| Type |
|---|
| ObservableArray<Dimension> |
columnTotalsLocation: ko.Observable<DevExpress.Dashboard.Model.PivotColumnTotalsPosition>
| Type |
|---|
| Observable<PivotColumnTotalsPosition> |
interactivityOptions: DevExpress.Dashboard.Model.FilterableDashboardItemInteractivityOptions
| Type |
|---|
| FilterableDashboardItemInteractivityOptions |
layoutType: ko.Observable<DevExpress.Dashboard.Model.PivotLayoutType>
| Type |
|---|
| Observable<PivotLayoutType> |
rows: ko.ObservableArray<DevExpress.Dashboard.Model.Dimension>
| Type |
|---|
| ObservableArray<Dimension> |
rowTotalsLocation: ko.Observable<DevExpress.Dashboard.Model.PivotRowTotalsPosition>
| Type |
|---|
| Observable<PivotRowTotalsPosition> |
showColumnGrandTotals: ko.Observable<boolean>
| Type |
|---|
| Observable<boolean> |
showColumnTotals: ko.Observable<boolean>
| Type |
|---|
| Observable<boolean> |
showRowGrandTotals: ko.Observable<boolean>
| Type |
|---|
| Observable<boolean> |
showRowTotals: ko.Observable<boolean>
| Type |
|---|
| Observable<boolean> |
values: ko.ObservableArray<DevExpress.Dashboard.Model.Measure>
| Type |
|---|
| ObservableArray<Measure> |
valuesPosition: ko.Observable<DevExpress.Dashboard.Model.PivotValuesPosition>
| Type |
|---|
| Observable<PivotValuesPosition> |