devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
605 lines (478 loc) • 17.5 kB
TypeScript
/*!
* devextreme-angular
* Version: 20.2.5
* Build date: Fri Jan 15 2021
*
* Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-angular
*/
import { TransferState } from '@angular/platform-browser';
import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges } from '@angular/core';
import DevExpress from 'devextreme/bundles/dx.all';
import DxPivotGrid from 'devextreme/ui/pivot_grid';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
/**
* The PivotGrid is a UI component that allows you to display and analyze multi-dimensional data from a local storage or an OLAP cube.
*/
export declare class DxPivotGridComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxPivotGrid;
/**
* Allows an end-user to expand/collapse all header items within a header level.
*/
allowExpandAll: boolean;
/**
* Allows a user to filter fields by selecting or deselecting values in the popup menu.
*/
allowFiltering: boolean;
/**
* Allows an end-user to change sorting properties.
*/
allowSorting: boolean;
/**
* Allows an end-user to sort columns by summary values.
*/
allowSortingBySummary: boolean;
/**
* Specifies the area to which data field headers must belong.
*/
dataFieldArea: string;
/**
* Binds the UI component to data.
*/
dataSource: DevExpress.data.PivotGridDataSource | DevExpress.data.PivotGridDataSourceOptions | Array<any>;
/**
* Specifies whether the UI component responds to user interaction.
*/
disabled: boolean;
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
elementAttr: any;
/**
* Configures client-side exporting.
*/
export: {
enabled?: boolean;
fileName?: string;
ignoreExcelErrors?: boolean;
proxyUrl?: string;
};
/**
* The Field Chooser configuration properties.
*/
fieldChooser: {
allowSearch?: boolean;
applyChangesMode?: string;
enabled?: boolean;
height?: number;
layout?: number | string;
searchTimeout?: number;
texts?: {
allFields?: string;
columnFields?: string;
dataFields?: string;
filterFields?: string;
rowFields?: string;
};
title?: string;
width?: number;
};
/**
* Configures the field panel.
*/
fieldPanel: {
allowFieldDragging?: boolean;
showColumnFields?: boolean;
showDataFields?: boolean;
showFilterFields?: boolean;
showRowFields?: boolean;
texts?: {
columnFieldArea?: string;
dataFieldArea?: string;
filterFieldArea?: string;
rowFieldArea?: string;
};
visible?: boolean;
};
/**
* Configures the header filter feature.
*/
headerFilter: {
allowSearch?: boolean;
height?: number;
searchTimeout?: number;
showRelevantValues?: boolean;
texts?: {
cancel?: string;
emptyValue?: string;
ok?: string;
};
width?: number;
};
/**
* Specifies the UI component's height.
*/
height: number | Function | string;
/**
* Specifies whether or not to hide rows and columns with no data.
*/
hideEmptySummaryCells: boolean;
/**
* Specifies text for a hint that appears when a user pauses on the UI component.
*/
hint: string;
/**
* Specifies properties configuring the load panel.
*/
loadPanel: {
enabled?: boolean;
height?: number;
indicatorSrc?: string;
shading?: boolean;
shadingColor?: string;
showIndicator?: boolean;
showPane?: boolean;
text?: string;
width?: number;
};
/**
* Specifies the layout of items in the row header.
*/
rowHeaderLayout: string;
/**
* Switches the UI component to a right-to-left representation.
*/
rtlEnabled: boolean;
/**
* A configuration object specifying scrolling properties.
*/
scrolling: {
mode?: string;
useNative?: boolean | string;
};
/**
* Specifies whether the outer borders of the grid are visible or not.
*/
showBorders: boolean;
/**
* Specifies whether to display the Grand Total column.
*/
showColumnGrandTotals: boolean;
/**
* Specifies whether to display the Total columns.
*/
showColumnTotals: boolean;
/**
* Specifies whether to display the Grand Total row.
*/
showRowGrandTotals: boolean;
/**
* Specifies whether to display the Total rows. Applies only if rowHeaderLayout is 'standard'.
*/
showRowTotals: boolean;
/**
* Specifies where to show the total rows or columns. Applies only if rowHeaderLayout is 'standard'.
*/
showTotalsPrior: string;
/**
* A configuration object specifying properties related to state storing.
*/
stateStoring: {
customLoad?: Function;
customSave?: Function;
enabled?: boolean;
savingTimeout?: number;
storageKey?: string;
type?: string;
};
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
tabIndex: number;
/**
* Strings that can be changed or localized in the PivotGrid UI component.
*/
texts: {
collapseAll?: string;
dataNotAvailable?: string;
expandAll?: string;
exportToExcel?: string;
grandTotal?: string;
noData?: string;
removeAllSorting?: string;
showFieldChooser?: string;
sortColumnBySummary?: string;
sortRowBySummary?: string;
total?: string;
};
/**
* Specifies whether the UI component is visible.
*/
visible: boolean;
/**
* Specifies the UI component's width.
*/
width: number | Function | string;
/**
* Specifies whether long text in header items should be wrapped.
*/
wordWrapEnabled: boolean;
/**
* A function that is executed when a pivot grid cell is clicked or tapped.
*/
onCellClick: EventEmitter<any>;
/**
* A function that is executed after a pivot grid cell is created.
*/
onCellPrepared: EventEmitter<any>;
/**
* A function that is executed when the UI component's content is ready and each time the content is changed.
*/
onContentReady: EventEmitter<any>;
/**
* A function that is executed before the context menu is rendered.
*/
onContextMenuPreparing: EventEmitter<any>;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: EventEmitter<any>;
/**
* A function that is executed after data is exported.
* @deprecated Since v20.2, we recommend ExcelJS-based export which does not use this property.
*/
onExported: EventEmitter<any>;
/**
* A function that is executed before data is exported.
*/
onExporting: EventEmitter<any>;
/**
* A function that is executed before a file with exported data is saved to the user's local storage.
* @deprecated Since v20.2, we recommend ExcelJS-based export which does not use this property.
*/
onFileSaving: EventEmitter<any>;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized: EventEmitter<any>;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
allowExpandAllChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
allowFilteringChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
allowSortingChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
allowSortingBySummaryChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataFieldAreaChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataSourceChange: EventEmitter<DevExpress.data.PivotGridDataSource | DevExpress.data.PivotGridDataSourceOptions | Array<any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
disabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
elementAttrChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
exportChange: EventEmitter<{
enabled?: boolean;
fileName?: string;
ignoreExcelErrors?: boolean;
proxyUrl?: string;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
fieldChooserChange: EventEmitter<{
allowSearch?: boolean;
applyChangesMode?: string;
enabled?: boolean;
height?: number;
layout?: number | string;
searchTimeout?: number;
texts?: {
allFields?: string;
columnFields?: string;
dataFields?: string;
filterFields?: string;
rowFields?: string;
};
title?: string;
width?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
fieldPanelChange: EventEmitter<{
allowFieldDragging?: boolean;
showColumnFields?: boolean;
showDataFields?: boolean;
showFilterFields?: boolean;
showRowFields?: boolean;
texts?: {
columnFieldArea?: string;
dataFieldArea?: string;
filterFieldArea?: string;
rowFieldArea?: string;
};
visible?: boolean;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
headerFilterChange: EventEmitter<{
allowSearch?: boolean;
height?: number;
searchTimeout?: number;
showRelevantValues?: boolean;
texts?: {
cancel?: string;
emptyValue?: string;
ok?: string;
};
width?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
heightChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hideEmptySummaryCellsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hintChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
loadPanelChange: EventEmitter<{
enabled?: boolean;
height?: number;
indicatorSrc?: string;
shading?: boolean;
shadingColor?: string;
showIndicator?: boolean;
showPane?: boolean;
text?: string;
width?: number;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
rowHeaderLayoutChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
rtlEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
scrollingChange: EventEmitter<{
mode?: string;
useNative?: boolean | string;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showBordersChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showColumnGrandTotalsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showColumnTotalsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showRowGrandTotalsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showRowTotalsChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showTotalsPriorChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
stateStoringChange: EventEmitter<{
customLoad?: Function;
customSave?: Function;
enabled?: boolean;
savingTimeout?: number;
storageKey?: string;
type?: string;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
tabIndexChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
textsChange: EventEmitter<{
collapseAll?: string;
dataNotAvailable?: string;
expandAll?: string;
exportToExcel?: string;
grandTotal?: string;
noData?: string;
removeAllSorting?: string;
showFieldChooser?: string;
sortColumnBySummary?: string;
sortRowBySummary?: string;
total?: string;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
visibleChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
widthChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
wordWrapEnabledChange: EventEmitter<boolean>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxPivotGrid;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
setupChanges(prop: string, changes: SimpleChanges): void;
ngDoCheck(): void;
_setOption(name: string, value: any): void;
}
export declare class DxPivotGridModule {
}