/*! * devextreme-angular-test * Version: 17.2.8 * Build date: Mon Feb 05 2018 * * Copyright (c) 2012 - 2018 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 { ElementRef, NgZone, OnDestroy, Injector, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core'; import DevExpress from 'devextreme/bundles/dx.all'; import DxDataGrid from 'devextreme/ui/data_grid'; import { DxComponent } from '../core/component'; import { DxTemplateHost } from '../core/template-host'; import { NestedOptionHost } from '../core/nested-option'; import { WatcherHelper } from '../core/watcher-helper'; import { IterableDifferHelper } from '../core/iterable-differ-helper'; import { DxiColumnComponent } from './nested/column-dxi'; import { DxiSortByGroupSummaryInfoComponent } from './nested/sort-by-group-summary-info-dxi'; /** * The DataGrid is a widget that represents data from a local or remote source in the form of a grid. This widget offers such basic features as sorting, grouping, filtering, as well as more advanced capabilities, like state storing, export to Excel, master-detail interface, and many others. */ export declare class DxDataGridComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxDataGrid; /** * Specifies the shortcut key that sets focus on the widget. */ accessKey: string; /** * Specifies whether or not the widget changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Specifies whether a user can reorder columns. */ allowColumnReordering: boolean; /** * Specifies whether a user can resize columns. */ allowColumnResizing: boolean; /** * Specifies whether data should be cached. */ cacheEnabled: boolean; /** * Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content. */ cellHintEnabled: boolean; /** * Specifies whether columns should adjust their widths to the content. */ columnAutoWidth: boolean; /** * Configures the column chooser. */ columnChooser: any; /** * Configures column fixing. */ columnFixing: any; /** * Specifies whether the widget should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget". */ columnHidingEnabled: boolean; /** * Specifies the minimum width of columns. */ columnMinWidth: number; /** * Specifies how the widget resizes columns. Applies only if allowColumnResizing is true. */ columnResizingMode: string; /** * An array of grid columns. */ columns: any | Array; /** * Specifies a function that customizes grid columns after they are created. */ customizeColumns: Function; /** * Customizes grid columns and data before exporting. */ customizeExportData: Function; /** * Specifies the origin of data for the widget. */ dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array; /** * Specifies date-time values' serialization format. Use it only if you do not specify the dataSource at design time. */ dateSerializationFormat: string; /** * Specifies whether the widget responds to user interaction. */ disabled: boolean; /** * Configures editing. */ editing: any; /** * Specifies the attributes to be attached to the widget's root element. */ elementAttr: any; /** * Indicates whether to show the error row. */ errorRowEnabled: boolean; /** * Configures client-side exporting. */ export: any; /** * Configures the filter row. */ filterRow: any; /** * Specifies whether the widget can be focused using keyboard navigation. */ focusStateEnabled: boolean; /** * Specifies grouping settings and the behavior of grouped grid records. */ grouping: any; /** * Configures the group panel. */ groupPanel: any; /** * Configures the header filter feature. */ headerFilter: any; /** * Specifies the widget's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the widget. */ hint: string; /** * Specifies whether the widget changes its state when a user pauses on it. */ hoverStateEnabled: boolean; /** * Specifies which data field provides keys for data items. Applies only if data is a simple array. */ keyExpr: string | Array; /** * Configures the load panel. */ loadPanel: any; /** * Allows you to build a master-detail interface in the grid. */ masterDetail: any; /** * Specifies text shown when the widget does not display any data. */ noDataText: string; /** * Specifies the options of a grid pager. */ pager: any; /** * Specifies paging options. */ paging: any; /** * Specifies the operations that must be performed on the server side. */ remoteOperations: boolean | string | { filtering?: boolean; grouping?: boolean; groupPaging?: boolean; paging?: boolean; sorting?: boolean; summary?: boolean; }; /** * Specifies whether rows should be shaded differently. */ rowAlternationEnabled: boolean; /** * Specifies a custom template for grid rows. */ rowTemplate: any; /** * Switches the widget to a right-to-left representation. */ rtlEnabled: boolean; /** * Configures scrolling. */ scrolling: any; /** * Configures the search panel. */ searchPanel: any; /** * Specifies the keys of rows that must be selected initially. */ selectedRowKeys: Array; /** * Configures runtime selection. */ selection: any; /** * Specifies filters for the rows that must be selected initially. Applies only if selection.deferred is true. */ selectionFilter: any; /** * Specifies whether the outer borders of the widget are visible. */ showBorders: boolean; /** * Specifies whether column headers are visible. */ showColumnHeaders: boolean; /** * Specifies whether vertical lines that separate one column from another are visible. */ showColumnLines: boolean; /** * Specifies whether horizontal lines that separate one row from another are visible. */ showRowLines: boolean; /** * Allows you to sort groups according to the values of group summary items. */ sortByGroupSummaryInfo: Array; /** * Configures runtime sorting. */ sorting: any; /** * Specifies options of state storing. */ stateStoring: any; /** * Specifies the options of the grid summary. */ summary: any; /** * Specifies the number of the element when the Tab key is used for navigating. */ tabIndex: number; /** * Specifies whether to enable two-way data binding. */ twoWayBindingEnabled: boolean; /** * Specifies whether the widget is visible. */ visible: boolean; /** * Specifies the widget's width. */ width: number | Function | string; /** * Specifies whether text that does not fit into a column should be wrapped. */ wordWrapEnabled: boolean; /** * A handler for the adaptiveDetailRowPreparing event. Executed before an adaptive detail row is rendered. */ onAdaptiveDetailRowPreparing: EventEmitter; /** * A handler for the cellClick event. */ onCellClick: EventEmitter; /** * A handler for the cellHoverChanged event. */ onCellHoverChanged: EventEmitter; /** * A handler for the cellPrepared event. */ onCellPrepared: EventEmitter; /** * A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes. */ onContentReady: EventEmitter; /** * A handler for the contextMenuPreparing event. */ onContextMenuPreparing: EventEmitter; /** * A handler for the dataErrorOccurred event. Executed when an error occurs in the data source. */ onDataErrorOccurred: EventEmitter; /** * A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. */ onDisposing: EventEmitter; /** * A handler for the editingStart event. */ onEditingStart: EventEmitter; /** * A handler for the editorPrepared event. */ onEditorPrepared: EventEmitter; /** * A handler for the editorPreparing event. */ onEditorPreparing: EventEmitter; /** * A handler for the exported event. */ onExported: EventEmitter; /** * A handler for the exporting event. */ onExporting: EventEmitter; /** * A handler for the fileSaving event. */ onFileSaving: EventEmitter; /** * A handler for the initialized event. Executed only once, after the widget is initialized. */ onInitialized: EventEmitter; /** * A handler for the initNewRow event. Executed before a new row is added to the widget. */ onInitNewRow: EventEmitter; /** * A handler for the keyDown event. Executed when the widget is in focus and a key has been pressed down. */ onKeyDown: EventEmitter; /** * A handler for the optionChanged event. Executed after an option of the widget is changed. */ onOptionChanged: EventEmitter; /** * A handler for the rowClick event. */ onRowClick: EventEmitter; /** * A handler for the rowCollapsed event. Executed after a row is collapsed. */ onRowCollapsed: EventEmitter; /** * A handler for the rowCollapsing event. Executed before a row is collapsed. */ onRowCollapsing: EventEmitter; /** * A handler for the rowExpanded event. Executed after a row is expanded. */ onRowExpanded: EventEmitter; /** * A handler for the rowExpanding event. Executed before a row is expanded. */ onRowExpanding: EventEmitter; /** * A handler for the rowInserted event. Executed after a new row has been inserted into the data source. */ onRowInserted: EventEmitter; /** * A handler for the rowInserting event. Executed before a new row is inserted into the data source. */ onRowInserting: EventEmitter; /** * A handler for the rowPrepared event. */ onRowPrepared: EventEmitter; /** * A handler for the rowRemoved event. Executed after a row has been removed from the data source. */ onRowRemoved: EventEmitter; /** * A handler for the rowRemoving event. Executed before a row is removed from the data source. */ onRowRemoving: EventEmitter; /** * A handler for the rowUpdated event. Executed after a row has been updated in the data source. */ onRowUpdated: EventEmitter; /** * A handler for the rowUpdating event. Executed before a row is updated in the data source. */ onRowUpdating: EventEmitter; /** * A handler for the rowValidating event. Executed after cells in a row are validated against validation rules. */ onRowValidating: EventEmitter; /** * A handler for the selectionChanged event. Executed after selecting a row or clearing its selection. */ onSelectionChanged: EventEmitter; /** * A handler for the toolbarPreparing event. Executed before the toolbar is created. */ onToolbarPreparing: EventEmitter; /** * A handler for the accessKeyChange event. */ accessKeyChange: EventEmitter; /** * A handler for the activeStateEnabledChange event. */ activeStateEnabledChange: EventEmitter; /** * A handler for the allowColumnReorderingChange event. */ allowColumnReorderingChange: EventEmitter; /** * A handler for the allowColumnResizingChange event. */ allowColumnResizingChange: EventEmitter; /** * A handler for the cacheEnabledChange event. */ cacheEnabledChange: EventEmitter; /** * A handler for the cellHintEnabledChange event. */ cellHintEnabledChange: EventEmitter; /** * A handler for the columnAutoWidthChange event. */ columnAutoWidthChange: EventEmitter; /** * A handler for the columnChooserChange event. */ columnChooserChange: EventEmitter; /** * A handler for the columnFixingChange event. */ columnFixingChange: EventEmitter; /** * A handler for the columnHidingEnabledChange event. */ columnHidingEnabledChange: EventEmitter; /** * A handler for the columnMinWidthChange event. */ columnMinWidthChange: EventEmitter; /** * A handler for the columnResizingModeChange event. */ columnResizingModeChange: EventEmitter; /** * A handler for the columnsChange event. */ columnsChange: EventEmitter>; /** * A handler for the customizeColumnsChange event. */ customizeColumnsChange: EventEmitter; /** * A handler for the customizeExportDataChange event. */ customizeExportDataChange: EventEmitter; /** * A handler for the dataSourceChange event. */ dataSourceChange: EventEmitter>; /** * A handler for the dateSerializationFormatChange event. */ dateSerializationFormatChange: EventEmitter; /** * A handler for the disabledChange event. */ disabledChange: EventEmitter; /** * A handler for the editingChange event. */ editingChange: EventEmitter; /** * A handler for the elementAttrChange event. */ elementAttrChange: EventEmitter; /** * A handler for the errorRowEnabledChange event. */ errorRowEnabledChange: EventEmitter; /** * A handler for the exportChange event. */ exportChange: EventEmitter; /** * A handler for the filterRowChange event. */ filterRowChange: EventEmitter; /** * A handler for the focusStateEnabledChange event. */ focusStateEnabledChange: EventEmitter; /** * A handler for the groupingChange event. */ groupingChange: EventEmitter; /** * A handler for the groupPanelChange event. */ groupPanelChange: EventEmitter; /** * A handler for the headerFilterChange event. */ headerFilterChange: EventEmitter; /** * A handler for the heightChange event. */ heightChange: EventEmitter; /** * A handler for the hintChange event. */ hintChange: EventEmitter; /** * A handler for the hoverStateEnabledChange event. */ hoverStateEnabledChange: EventEmitter; /** * A handler for the keyExprChange event. */ keyExprChange: EventEmitter>; /** * A handler for the loadPanelChange event. */ loadPanelChange: EventEmitter; /** * A handler for the masterDetailChange event. */ masterDetailChange: EventEmitter; /** * A handler for the noDataTextChange event. */ noDataTextChange: EventEmitter; /** * A handler for the pagerChange event. */ pagerChange: EventEmitter; /** * A handler for the pagingChange event. */ pagingChange: EventEmitter; /** * A handler for the remoteOperationsChange event. */ remoteOperationsChange: EventEmitter; /** * A handler for the rowAlternationEnabledChange event. */ rowAlternationEnabledChange: EventEmitter; /** * A handler for the rowTemplateChange event. */ rowTemplateChange: EventEmitter; /** * A handler for the rtlEnabledChange event. */ rtlEnabledChange: EventEmitter; /** * A handler for the scrollingChange event. */ scrollingChange: EventEmitter; /** * A handler for the searchPanelChange event. */ searchPanelChange: EventEmitter; /** * A handler for the selectedRowKeysChange event. */ selectedRowKeysChange: EventEmitter>; /** * A handler for the selectionChange event. */ selectionChange: EventEmitter; /** * A handler for the selectionFilterChange event. */ selectionFilterChange: EventEmitter; /** * A handler for the showBordersChange event. */ showBordersChange: EventEmitter; /** * A handler for the showColumnHeadersChange event. */ showColumnHeadersChange: EventEmitter; /** * A handler for the showColumnLinesChange event. */ showColumnLinesChange: EventEmitter; /** * A handler for the showRowLinesChange event. */ showRowLinesChange: EventEmitter; /** * A handler for the sortByGroupSummaryInfoChange event. */ sortByGroupSummaryInfoChange: EventEmitter>; /** * A handler for the sortingChange event. */ sortingChange: EventEmitter; /** * A handler for the stateStoringChange event. */ stateStoringChange: EventEmitter; /** * A handler for the summaryChange event. */ summaryChange: EventEmitter; /** * A handler for the tabIndexChange event. */ tabIndexChange: EventEmitter; /** * A handler for the twoWayBindingEnabledChange event. */ twoWayBindingEnabledChange: EventEmitter; /** * A handler for the visibleChange event. */ visibleChange: EventEmitter; /** * A handler for the widthChange event. */ widthChange: EventEmitter; /** * A handler for the wordWrapEnabledChange event. */ wordWrapEnabledChange: EventEmitter; columnsChildren: QueryList; sortByGroupSummaryInfoChildren: QueryList; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, injector: Injector, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost); protected _createInstance(element: any, options: any): DxDataGrid; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; } export declare class DxDataGridModule { }