data-grid.d.ts 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228
  1. /*!
  2. * devextreme-angular
  3. * Version: 19.1.16
  4. * Build date: Tue Oct 18 2022
  5. *
  6. * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED
  7. *
  8. * This software may be modified and distributed under the terms
  9. * of the MIT license. See the LICENSE file in the root of the project for details.
  10. *
  11. * https://github.com/DevExpress/devextreme-angular
  12. */
  13. import { TransferState } from '@angular/platform-browser';
  14. import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxDataGrid from 'devextreme/ui/data_grid';
  17. import { DxComponent } from '../core/component';
  18. import { DxTemplateHost } from '../core/template-host';
  19. import { NestedOptionHost } from '../core/nested-option';
  20. import { WatcherHelper } from '../core/watcher-helper';
  21. import { IterableDifferHelper } from '../core/iterable-differ-helper';
  22. import { DxiColumnComponent } from './nested/column-dxi';
  23. import { DxiSortByGroupSummaryInfoComponent } from './nested/sort-by-group-summary-info-dxi';
  24. /**
  25. * 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.
  26. */
  27. export declare class DxDataGridComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  28. private _watcherHelper;
  29. private _idh;
  30. instance: DxDataGrid;
  31. /**
  32. * Specifies the shortcut key that sets focus on the widget.
  33. */
  34. accessKey: string;
  35. /**
  36. * Specifies whether or not the widget changes its state when interacting with a user.
  37. */
  38. activeStateEnabled: boolean;
  39. /**
  40. * Specifies whether a user can reorder columns.
  41. */
  42. allowColumnReordering: boolean;
  43. /**
  44. * Specifies whether a user can resize columns.
  45. */
  46. allowColumnResizing: boolean;
  47. /**
  48. * Specifies whether data should be cached.
  49. */
  50. cacheEnabled: boolean;
  51. /**
  52. * Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content.
  53. */
  54. cellHintEnabled: boolean;
  55. /**
  56. * Specifies whether columns should adjust their widths to the content.
  57. */
  58. columnAutoWidth: boolean;
  59. /**
  60. * Configures the column chooser.
  61. */
  62. columnChooser: {
  63. allowSearch?: boolean;
  64. emptyPanelText?: string;
  65. enabled?: boolean;
  66. height?: number;
  67. mode?: string;
  68. searchTimeout?: number;
  69. title?: string;
  70. width?: number;
  71. };
  72. /**
  73. * Configures column fixing.
  74. */
  75. columnFixing: {
  76. enabled?: boolean;
  77. texts?: {
  78. fix?: string;
  79. leftPosition?: string;
  80. rightPosition?: string;
  81. unfix?: string;
  82. };
  83. };
  84. /**
  85. * Specifies whether the widget should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".
  86. */
  87. columnHidingEnabled: boolean;
  88. /**
  89. * Specifies the minimum width of columns.
  90. */
  91. columnMinWidth: number;
  92. /**
  93. * Specifies how the widget resizes columns. Applies only if allowColumnResizing is true.
  94. */
  95. columnResizingMode: string;
  96. /**
  97. * An array of grid columns.
  98. */
  99. columns: Array<DevExpress.ui.dxDataGridColumn | string>;
  100. /**
  101. * Specifies the width for all data columns. Has a lower priority than the column.width option.
  102. */
  103. columnWidth: number;
  104. /**
  105. * Customizes columns after they are created.
  106. */
  107. customizeColumns: Function;
  108. /**
  109. * Customizes data before export. You can use the export.customizeExcelCell function instead.
  110. */
  111. customizeExportData: Function;
  112. /**
  113. * Binds the widget to data.
  114. */
  115. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<any>;
  116. /**
  117. * Specifies the format in which date-time values should be sent to the server. Use it only if you do not specify the dataSource at design time.
  118. */
  119. dateSerializationFormat: string;
  120. /**
  121. * Specifies whether the widget responds to user interaction.
  122. */
  123. disabled: boolean;
  124. /**
  125. * Configures editing.
  126. */
  127. editing: {
  128. allowAdding?: boolean;
  129. allowDeleting?: boolean | Function;
  130. allowUpdating?: boolean | Function;
  131. form?: DevExpress.ui.dxFormOptions;
  132. mode?: string;
  133. popup?: DevExpress.ui.dxPopupOptions;
  134. refreshMode?: string;
  135. selectTextOnEditStart?: boolean;
  136. startEditAction?: string;
  137. texts?: {
  138. addRow?: string;
  139. cancelAllChanges?: string;
  140. cancelRowChanges?: string;
  141. confirmDeleteMessage?: string;
  142. confirmDeleteTitle?: string;
  143. deleteRow?: string;
  144. editRow?: string;
  145. saveAllChanges?: string;
  146. saveRowChanges?: string;
  147. undeleteRow?: string;
  148. validationCancelChanges?: string;
  149. };
  150. useIcons?: boolean;
  151. };
  152. /**
  153. * Specifies the attributes to be attached to the widget's root element.
  154. */
  155. elementAttr: any;
  156. /**
  157. * Indicates whether to show the error row.
  158. */
  159. errorRowEnabled: boolean;
  160. /**
  161. * Configures client-side exporting.
  162. */
  163. export: {
  164. allowExportSelectedData?: boolean;
  165. customizeExcelCell?: Function;
  166. enabled?: boolean;
  167. excelFilterEnabled?: boolean;
  168. excelWrapTextEnabled?: boolean;
  169. fileName?: string;
  170. ignoreExcelErrors?: boolean;
  171. proxyUrl?: string;
  172. texts?: {
  173. exportAll?: string;
  174. exportSelectedRows?: string;
  175. exportTo?: string;
  176. };
  177. };
  178. /**
  179. * Configures the integrated filter builder.
  180. */
  181. filterBuilder: DevExpress.ui.dxFilterBuilderOptions;
  182. /**
  183. * Configures the popup in which the integrated filter builder is shown.
  184. */
  185. filterBuilderPopup: DevExpress.ui.dxPopupOptions;
  186. /**
  187. * Configures the filter panel.
  188. */
  189. filterPanel: {
  190. customizeText?: Function;
  191. filterEnabled?: boolean;
  192. texts?: {
  193. clearFilter?: string;
  194. createFilter?: string;
  195. filterEnabledHint?: string;
  196. };
  197. visible?: boolean;
  198. };
  199. /**
  200. * Configures the filter row.
  201. */
  202. filterRow: {
  203. applyFilter?: string;
  204. applyFilterText?: string;
  205. betweenEndText?: string;
  206. betweenStartText?: string;
  207. operationDescriptions?: {
  208. between?: string;
  209. contains?: string;
  210. endsWith?: string;
  211. equal?: string;
  212. greaterThan?: string;
  213. greaterThanOrEqual?: string;
  214. lessThan?: string;
  215. lessThanOrEqual?: string;
  216. notContains?: string;
  217. notEqual?: string;
  218. startsWith?: string;
  219. };
  220. resetOperationText?: string;
  221. showAllText?: string;
  222. showOperationChooser?: boolean;
  223. visible?: boolean;
  224. };
  225. /**
  226. * Specifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue option.
  227. */
  228. filterSyncEnabled: boolean;
  229. /**
  230. * Specifies a filter expression.
  231. */
  232. filterValue: any;
  233. /**
  234. * Specifies the index of the column focused initially or currently in the data row area.
  235. */
  236. focusedColumnIndex: number;
  237. /**
  238. * Specifies whether the focused row feature is enabled.
  239. */
  240. focusedRowEnabled: boolean;
  241. /**
  242. * Specifies the initially or currently focused grid row's index. Use it when focusedRowEnabled is true.
  243. */
  244. focusedRowIndex: number;
  245. /**
  246. * Specifies initially or currently focused grid row's key. Use it when focusedRowEnabled is true.
  247. */
  248. focusedRowKey: any;
  249. /**
  250. * Specifies whether the widget can be focused using keyboard navigation.
  251. */
  252. focusStateEnabled: boolean;
  253. /**
  254. * Configures grouping.
  255. */
  256. grouping: {
  257. allowCollapsing?: boolean;
  258. autoExpandAll?: boolean;
  259. contextMenuEnabled?: boolean;
  260. expandMode?: string;
  261. texts?: {
  262. groupByThisColumn?: string;
  263. groupContinuedMessage?: string;
  264. groupContinuesMessage?: string;
  265. ungroup?: string;
  266. ungroupAll?: string;
  267. };
  268. };
  269. /**
  270. * Configures the group panel.
  271. */
  272. groupPanel: {
  273. allowColumnDragging?: boolean;
  274. emptyPanelText?: string;
  275. visible?: boolean | string;
  276. };
  277. /**
  278. * Configures the header filter feature.
  279. */
  280. headerFilter: {
  281. allowSearch?: boolean;
  282. height?: number;
  283. searchTimeout?: number;
  284. texts?: {
  285. cancel?: string;
  286. emptyValue?: string;
  287. ok?: string;
  288. };
  289. visible?: boolean;
  290. width?: number;
  291. };
  292. /**
  293. * Specifies the widget's height.
  294. */
  295. height: number | Function | string;
  296. /**
  297. * Specifies whether to highlight rows and cells with edited data. repaintChangesOnly should be true.
  298. */
  299. highlightChanges: boolean;
  300. /**
  301. * Specifies text for a hint that appears when a user pauses on the widget.
  302. */
  303. hint: string;
  304. /**
  305. * Specifies whether the widget changes its state when a user pauses on it.
  306. */
  307. hoverStateEnabled: boolean;
  308. /**
  309. * Configures keyboard navigation.
  310. */
  311. keyboardNavigation: {
  312. editOnKeyPress?: boolean;
  313. enterKeyAction?: string;
  314. enterKeyDirection?: string;
  315. };
  316. /**
  317. * Specifies which data field provides keys for data items. Applies only if data is a simple array.
  318. */
  319. keyExpr: string | Array<string>;
  320. /**
  321. * Configures the load panel.
  322. */
  323. loadPanel: {
  324. enabled?: boolean;
  325. height?: number;
  326. indicatorSrc?: string;
  327. shading?: boolean;
  328. shadingColor?: string;
  329. showIndicator?: boolean;
  330. showPane?: boolean;
  331. text?: string;
  332. width?: number;
  333. };
  334. /**
  335. * Allows you to build a master-detail interface in the grid.
  336. */
  337. masterDetail: {
  338. autoExpandAll?: boolean;
  339. enabled?: boolean;
  340. template?: any;
  341. };
  342. /**
  343. * Specifies text shown when the widget does not display any data.
  344. */
  345. noDataText: string;
  346. /**
  347. * Configures the pager.
  348. */
  349. pager: {
  350. allowedPageSizes?: Array<number>;
  351. infoText?: string;
  352. showInfo?: boolean;
  353. showNavigationButtons?: boolean;
  354. showPageSizeSelector?: boolean;
  355. visible?: boolean;
  356. };
  357. /**
  358. * Configures paging.
  359. */
  360. paging: {
  361. enabled?: boolean;
  362. pageIndex?: number;
  363. pageSize?: number;
  364. };
  365. /**
  366. * Notifies the DataGrid of the server's data processing operations.
  367. */
  368. remoteOperations: boolean | {
  369. filtering?: boolean;
  370. grouping?: boolean;
  371. groupPaging?: boolean;
  372. paging?: boolean;
  373. sorting?: boolean;
  374. summary?: boolean;
  375. };
  376. /**
  377. * Specifies whether to render the filter row, command columns, and columns with showEditorAlways set to true after other elements.
  378. */
  379. renderAsync: boolean;
  380. /**
  381. * Specifies whether to repaint only those cells whose data changed.
  382. */
  383. repaintChangesOnly: boolean;
  384. /**
  385. * Specifies whether rows should be shaded differently.
  386. */
  387. rowAlternationEnabled: boolean;
  388. /**
  389. * Specifies a custom template for rows.
  390. */
  391. rowTemplate: any;
  392. /**
  393. * Switches the widget to a right-to-left representation.
  394. */
  395. rtlEnabled: boolean;
  396. /**
  397. * Configures scrolling.
  398. */
  399. scrolling: {
  400. columnRenderingMode?: string;
  401. mode?: string;
  402. preloadEnabled?: boolean;
  403. rowRenderingMode?: string;
  404. scrollByContent?: boolean;
  405. scrollByThumb?: boolean;
  406. showScrollbar?: string;
  407. useNative?: boolean;
  408. };
  409. /**
  410. * Configures the search panel.
  411. */
  412. searchPanel: {
  413. highlightCaseSensitive?: boolean;
  414. highlightSearchText?: boolean;
  415. placeholder?: string;
  416. searchVisibleColumnsOnly?: boolean;
  417. text?: string;
  418. visible?: boolean;
  419. width?: number;
  420. };
  421. /**
  422. * Allows you to select rows or determine which rows are selected.
  423. */
  424. selectedRowKeys: Array<any>;
  425. /**
  426. * Configures runtime selection.
  427. */
  428. selection: {
  429. allowSelectAll?: boolean;
  430. deferred?: boolean;
  431. mode?: string;
  432. selectAllMode?: string;
  433. showCheckBoxesMode?: string;
  434. };
  435. /**
  436. * Specifies filters for the rows that must be selected initially. Applies only if selection.deferred is true.
  437. */
  438. selectionFilter: any;
  439. /**
  440. * Specifies whether the outer borders of the widget are visible.
  441. */
  442. showBorders: boolean;
  443. /**
  444. * Specifies whether column headers are visible.
  445. */
  446. showColumnHeaders: boolean;
  447. /**
  448. * Specifies whether vertical lines that separate one column from another are visible.
  449. */
  450. showColumnLines: boolean;
  451. /**
  452. * Specifies whether horizontal lines that separate one row from another are visible.
  453. */
  454. showRowLines: boolean;
  455. /**
  456. * Allows you to sort groups according to the values of group summary items.
  457. */
  458. sortByGroupSummaryInfo: Array<any | {
  459. groupColumn?: string;
  460. sortOrder?: string;
  461. summaryItem?: number | string;
  462. }>;
  463. /**
  464. * Configures runtime sorting.
  465. */
  466. sorting: {
  467. ascendingText?: string;
  468. clearText?: string;
  469. descendingText?: string;
  470. mode?: string;
  471. };
  472. /**
  473. * Configures state storing.
  474. */
  475. stateStoring: {
  476. customLoad?: Function;
  477. customSave?: Function;
  478. enabled?: boolean;
  479. savingTimeout?: number;
  480. storageKey?: string;
  481. type?: string;
  482. };
  483. /**
  484. * Specifies the options of the grid summary.
  485. */
  486. summary: {
  487. calculateCustomSummary?: Function;
  488. groupItems?: Array<any | {
  489. alignByColumn?: boolean;
  490. column?: string;
  491. customizeText?: Function;
  492. displayFormat?: string;
  493. name?: string;
  494. showInColumn?: string;
  495. showInGroupFooter?: boolean;
  496. skipEmptyValues?: boolean;
  497. summaryType?: string;
  498. valueFormat?: DevExpress.ui.format | string;
  499. }>;
  500. recalculateWhileEditing?: boolean;
  501. skipEmptyValues?: boolean;
  502. texts?: {
  503. avg?: string;
  504. avgOtherColumn?: string;
  505. count?: string;
  506. max?: string;
  507. maxOtherColumn?: string;
  508. min?: string;
  509. minOtherColumn?: string;
  510. sum?: string;
  511. sumOtherColumn?: string;
  512. };
  513. totalItems?: Array<any | {
  514. alignment?: string;
  515. column?: string;
  516. cssClass?: string;
  517. customizeText?: Function;
  518. displayFormat?: string;
  519. name?: string;
  520. showInColumn?: string;
  521. skipEmptyValues?: boolean;
  522. summaryType?: string;
  523. valueFormat?: DevExpress.ui.format | string;
  524. }>;
  525. };
  526. /**
  527. * Specifies the number of the element when the Tab key is used for navigating.
  528. */
  529. tabIndex: number;
  530. /**
  531. * Specifies whether to enable two-way data binding.
  532. */
  533. twoWayBindingEnabled: boolean;
  534. /**
  535. * Specifies whether the widget is visible.
  536. */
  537. visible: boolean;
  538. /**
  539. * Specifies the widget's width.
  540. */
  541. width: number | Function | string;
  542. /**
  543. * Specifies whether text that does not fit into a column should be wrapped.
  544. */
  545. wordWrapEnabled: boolean;
  546. /**
  547. * A function that is executed before an adaptive detail row is rendered.
  548. */
  549. onAdaptiveDetailRowPreparing: EventEmitter<any>;
  550. /**
  551. * A function that is executed when a cell is clicked or tapped. Executed before onRowClick.
  552. */
  553. onCellClick: EventEmitter<any>;
  554. /**
  555. * A function that is executed when a cell is double-clicked or double-tapped. Executed before onRowDblClick.
  556. */
  557. onCellDblClick: EventEmitter<any>;
  558. /**
  559. * A function that is executed after the pointer enters or leaves a cell.
  560. */
  561. onCellHoverChanged: EventEmitter<any>;
  562. /**
  563. * A function that is executed after a cell is created.
  564. */
  565. onCellPrepared: EventEmitter<any>;
  566. /**
  567. * A function that is executed when the widget's content is ready and each time the content is changed.
  568. */
  569. onContentReady: EventEmitter<any>;
  570. /**
  571. * A function that is executed before the context menu is rendered.
  572. */
  573. onContextMenuPreparing: EventEmitter<any>;
  574. /**
  575. * A function that is executed when an error occurs in the data source.
  576. */
  577. onDataErrorOccurred: EventEmitter<any>;
  578. /**
  579. * A function that is executed before the widget is disposed of.
  580. */
  581. onDisposing: EventEmitter<any>;
  582. /**
  583. * A function that is executed before a cell or row switches to the editing state.
  584. */
  585. onEditingStart: EventEmitter<any>;
  586. /**
  587. * A function that is executed after an editor is created. Not executed for cells with an editCellTemplate.
  588. */
  589. onEditorPrepared: EventEmitter<any>;
  590. /**
  591. * A function used to customize or replace default editors. Not executed for cells with an editCellTemplate.
  592. */
  593. onEditorPreparing: EventEmitter<any>;
  594. /**
  595. * A function that is executed after data is exported.
  596. */
  597. onExported: EventEmitter<any>;
  598. /**
  599. * A function that is executed before data is exported.
  600. */
  601. onExporting: EventEmitter<any>;
  602. /**
  603. * A function that is executed before a file with exported data is saved to the user's local storage.
  604. */
  605. onFileSaving: EventEmitter<any>;
  606. /**
  607. * A function that is executed after the focused cell changes.
  608. */
  609. onFocusedCellChanged: EventEmitter<any>;
  610. /**
  611. * A function that is executed before the focused cell changes.
  612. */
  613. onFocusedCellChanging: EventEmitter<any>;
  614. /**
  615. * A function that is executed after the focused row changes. Applies only when focusedRowEnabled is true.
  616. */
  617. onFocusedRowChanged: EventEmitter<any>;
  618. /**
  619. * A function that is executed before the focused row changes. Applies only when focusedRowEnabled is true.
  620. */
  621. onFocusedRowChanging: EventEmitter<any>;
  622. /**
  623. * A function used in JavaScript frameworks to save the widget instance.
  624. */
  625. onInitialized: EventEmitter<any>;
  626. /**
  627. * A function that is executed before a new row is added to the widget.
  628. */
  629. onInitNewRow: EventEmitter<any>;
  630. /**
  631. * A function that is executed when the widget is in focus and a key has been pressed down.
  632. */
  633. onKeyDown: EventEmitter<any>;
  634. /**
  635. * A function that is executed after a widget option is changed.
  636. */
  637. onOptionChanged: EventEmitter<any>;
  638. /**
  639. * A function that is executed when a row is clicked or tapped.
  640. */
  641. onRowClick: EventEmitter<any>;
  642. /**
  643. * A function that is executed after a row is collapsed.
  644. */
  645. onRowCollapsed: EventEmitter<any>;
  646. /**
  647. * A function that is executed before a row is collapsed.
  648. */
  649. onRowCollapsing: EventEmitter<any>;
  650. /**
  651. * A function that is executed when a row is double-clicked or double-tapped. Executed after onCellDblClick.
  652. */
  653. onRowDblClick: EventEmitter<any>;
  654. /**
  655. * A function that is executed after a row is expanded.
  656. */
  657. onRowExpanded: EventEmitter<any>;
  658. /**
  659. * A function that is executed before a row is expanded.
  660. */
  661. onRowExpanding: EventEmitter<any>;
  662. /**
  663. * A function that is executed after a new row has been inserted into the data source.
  664. */
  665. onRowInserted: EventEmitter<any>;
  666. /**
  667. * A function that is executed before a new row is inserted into the data source.
  668. */
  669. onRowInserting: EventEmitter<any>;
  670. /**
  671. * A function that is executed after a row is created.
  672. */
  673. onRowPrepared: EventEmitter<any>;
  674. /**
  675. * A function that is executed after a row has been removed from the data source.
  676. */
  677. onRowRemoved: EventEmitter<any>;
  678. /**
  679. * A function that is executed before a row is removed from the data source.
  680. */
  681. onRowRemoving: EventEmitter<any>;
  682. /**
  683. * A function that is executed after a row has been updated in the data source.
  684. */
  685. onRowUpdated: EventEmitter<any>;
  686. /**
  687. * A function that is executed before a row is updated in the data source.
  688. */
  689. onRowUpdating: EventEmitter<any>;
  690. /**
  691. * A function that is executed after cells in a row are validated against validation rules.
  692. */
  693. onRowValidating: EventEmitter<any>;
  694. /**
  695. * A function that is executed after selecting a row or clearing its selection.
  696. */
  697. onSelectionChanged: EventEmitter<any>;
  698. /**
  699. * A function that is executed before the toolbar is created.
  700. */
  701. onToolbarPreparing: EventEmitter<any>;
  702. /**
  703. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  704. */
  705. accessKeyChange: EventEmitter<string>;
  706. /**
  707. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  708. */
  709. activeStateEnabledChange: EventEmitter<boolean>;
  710. /**
  711. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  712. */
  713. allowColumnReorderingChange: EventEmitter<boolean>;
  714. /**
  715. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  716. */
  717. allowColumnResizingChange: EventEmitter<boolean>;
  718. /**
  719. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  720. */
  721. cacheEnabledChange: EventEmitter<boolean>;
  722. /**
  723. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  724. */
  725. cellHintEnabledChange: EventEmitter<boolean>;
  726. /**
  727. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  728. */
  729. columnAutoWidthChange: EventEmitter<boolean>;
  730. /**
  731. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  732. */
  733. columnChooserChange: EventEmitter<{
  734. allowSearch?: boolean;
  735. emptyPanelText?: string;
  736. enabled?: boolean;
  737. height?: number;
  738. mode?: string;
  739. searchTimeout?: number;
  740. title?: string;
  741. width?: number;
  742. }>;
  743. /**
  744. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  745. */
  746. columnFixingChange: EventEmitter<{
  747. enabled?: boolean;
  748. texts?: {
  749. fix?: string;
  750. leftPosition?: string;
  751. rightPosition?: string;
  752. unfix?: string;
  753. };
  754. }>;
  755. /**
  756. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  757. */
  758. columnHidingEnabledChange: EventEmitter<boolean>;
  759. /**
  760. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  761. */
  762. columnMinWidthChange: EventEmitter<number>;
  763. /**
  764. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  765. */
  766. columnResizingModeChange: EventEmitter<string>;
  767. /**
  768. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  769. */
  770. columnsChange: EventEmitter<Array<DevExpress.ui.dxDataGridColumn | string>>;
  771. /**
  772. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  773. */
  774. columnWidthChange: EventEmitter<number>;
  775. /**
  776. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  777. */
  778. customizeColumnsChange: EventEmitter<Function>;
  779. /**
  780. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  781. */
  782. customizeExportDataChange: EventEmitter<Function>;
  783. /**
  784. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  785. */
  786. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<any>>;
  787. /**
  788. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  789. */
  790. dateSerializationFormatChange: EventEmitter<string>;
  791. /**
  792. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  793. */
  794. disabledChange: EventEmitter<boolean>;
  795. /**
  796. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  797. */
  798. editingChange: EventEmitter<{
  799. allowAdding?: boolean;
  800. allowDeleting?: boolean | Function;
  801. allowUpdating?: boolean | Function;
  802. form?: DevExpress.ui.dxFormOptions;
  803. mode?: string;
  804. popup?: DevExpress.ui.dxPopupOptions;
  805. refreshMode?: string;
  806. selectTextOnEditStart?: boolean;
  807. startEditAction?: string;
  808. texts?: {
  809. addRow?: string;
  810. cancelAllChanges?: string;
  811. cancelRowChanges?: string;
  812. confirmDeleteMessage?: string;
  813. confirmDeleteTitle?: string;
  814. deleteRow?: string;
  815. editRow?: string;
  816. saveAllChanges?: string;
  817. saveRowChanges?: string;
  818. undeleteRow?: string;
  819. validationCancelChanges?: string;
  820. };
  821. useIcons?: boolean;
  822. }>;
  823. /**
  824. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  825. */
  826. elementAttrChange: EventEmitter<any>;
  827. /**
  828. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  829. */
  830. errorRowEnabledChange: EventEmitter<boolean>;
  831. /**
  832. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  833. */
  834. exportChange: EventEmitter<{
  835. allowExportSelectedData?: boolean;
  836. customizeExcelCell?: Function;
  837. enabled?: boolean;
  838. excelFilterEnabled?: boolean;
  839. excelWrapTextEnabled?: boolean;
  840. fileName?: string;
  841. ignoreExcelErrors?: boolean;
  842. proxyUrl?: string;
  843. texts?: {
  844. exportAll?: string;
  845. exportSelectedRows?: string;
  846. exportTo?: string;
  847. };
  848. }>;
  849. /**
  850. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  851. */
  852. filterBuilderChange: EventEmitter<DevExpress.ui.dxFilterBuilderOptions>;
  853. /**
  854. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  855. */
  856. filterBuilderPopupChange: EventEmitter<DevExpress.ui.dxPopupOptions>;
  857. /**
  858. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  859. */
  860. filterPanelChange: EventEmitter<{
  861. customizeText?: Function;
  862. filterEnabled?: boolean;
  863. texts?: {
  864. clearFilter?: string;
  865. createFilter?: string;
  866. filterEnabledHint?: string;
  867. };
  868. visible?: boolean;
  869. }>;
  870. /**
  871. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  872. */
  873. filterRowChange: EventEmitter<{
  874. applyFilter?: string;
  875. applyFilterText?: string;
  876. betweenEndText?: string;
  877. betweenStartText?: string;
  878. operationDescriptions?: {
  879. between?: string;
  880. contains?: string;
  881. endsWith?: string;
  882. equal?: string;
  883. greaterThan?: string;
  884. greaterThanOrEqual?: string;
  885. lessThan?: string;
  886. lessThanOrEqual?: string;
  887. notContains?: string;
  888. notEqual?: string;
  889. startsWith?: string;
  890. };
  891. resetOperationText?: string;
  892. showAllText?: string;
  893. showOperationChooser?: boolean;
  894. visible?: boolean;
  895. }>;
  896. /**
  897. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  898. */
  899. filterSyncEnabledChange: EventEmitter<boolean>;
  900. /**
  901. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  902. */
  903. filterValueChange: EventEmitter<any>;
  904. /**
  905. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  906. */
  907. focusedColumnIndexChange: EventEmitter<number>;
  908. /**
  909. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  910. */
  911. focusedRowEnabledChange: EventEmitter<boolean>;
  912. /**
  913. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  914. */
  915. focusedRowIndexChange: EventEmitter<number>;
  916. /**
  917. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  918. */
  919. focusedRowKeyChange: EventEmitter<any>;
  920. /**
  921. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  922. */
  923. focusStateEnabledChange: EventEmitter<boolean>;
  924. /**
  925. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  926. */
  927. groupingChange: EventEmitter<{
  928. allowCollapsing?: boolean;
  929. autoExpandAll?: boolean;
  930. contextMenuEnabled?: boolean;
  931. expandMode?: string;
  932. texts?: {
  933. groupByThisColumn?: string;
  934. groupContinuedMessage?: string;
  935. groupContinuesMessage?: string;
  936. ungroup?: string;
  937. ungroupAll?: string;
  938. };
  939. }>;
  940. /**
  941. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  942. */
  943. groupPanelChange: EventEmitter<{
  944. allowColumnDragging?: boolean;
  945. emptyPanelText?: string;
  946. visible?: boolean | string;
  947. }>;
  948. /**
  949. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  950. */
  951. headerFilterChange: EventEmitter<{
  952. allowSearch?: boolean;
  953. height?: number;
  954. searchTimeout?: number;
  955. texts?: {
  956. cancel?: string;
  957. emptyValue?: string;
  958. ok?: string;
  959. };
  960. visible?: boolean;
  961. width?: number;
  962. }>;
  963. /**
  964. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  965. */
  966. heightChange: EventEmitter<number | Function | string>;
  967. /**
  968. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  969. */
  970. highlightChangesChange: EventEmitter<boolean>;
  971. /**
  972. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  973. */
  974. hintChange: EventEmitter<string>;
  975. /**
  976. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  977. */
  978. hoverStateEnabledChange: EventEmitter<boolean>;
  979. /**
  980. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  981. */
  982. keyboardNavigationChange: EventEmitter<{
  983. editOnKeyPress?: boolean;
  984. enterKeyAction?: string;
  985. enterKeyDirection?: string;
  986. }>;
  987. /**
  988. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  989. */
  990. keyExprChange: EventEmitter<string | Array<string>>;
  991. /**
  992. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  993. */
  994. loadPanelChange: EventEmitter<{
  995. enabled?: boolean;
  996. height?: number;
  997. indicatorSrc?: string;
  998. shading?: boolean;
  999. shadingColor?: string;
  1000. showIndicator?: boolean;
  1001. showPane?: boolean;
  1002. text?: string;
  1003. width?: number;
  1004. }>;
  1005. /**
  1006. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1007. */
  1008. masterDetailChange: EventEmitter<{
  1009. autoExpandAll?: boolean;
  1010. enabled?: boolean;
  1011. template?: any;
  1012. }>;
  1013. /**
  1014. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1015. */
  1016. noDataTextChange: EventEmitter<string>;
  1017. /**
  1018. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1019. */
  1020. pagerChange: EventEmitter<{
  1021. allowedPageSizes?: Array<number>;
  1022. infoText?: string;
  1023. showInfo?: boolean;
  1024. showNavigationButtons?: boolean;
  1025. showPageSizeSelector?: boolean;
  1026. visible?: boolean;
  1027. }>;
  1028. /**
  1029. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1030. */
  1031. pagingChange: EventEmitter<{
  1032. enabled?: boolean;
  1033. pageIndex?: number;
  1034. pageSize?: number;
  1035. }>;
  1036. /**
  1037. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1038. */
  1039. remoteOperationsChange: EventEmitter<boolean | {
  1040. filtering?: boolean;
  1041. grouping?: boolean;
  1042. groupPaging?: boolean;
  1043. paging?: boolean;
  1044. sorting?: boolean;
  1045. summary?: boolean;
  1046. }>;
  1047. /**
  1048. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1049. */
  1050. renderAsyncChange: EventEmitter<boolean>;
  1051. /**
  1052. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1053. */
  1054. repaintChangesOnlyChange: EventEmitter<boolean>;
  1055. /**
  1056. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1057. */
  1058. rowAlternationEnabledChange: EventEmitter<boolean>;
  1059. /**
  1060. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1061. */
  1062. rowTemplateChange: EventEmitter<any>;
  1063. /**
  1064. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1065. */
  1066. rtlEnabledChange: EventEmitter<boolean>;
  1067. /**
  1068. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1069. */
  1070. scrollingChange: EventEmitter<{
  1071. columnRenderingMode?: string;
  1072. mode?: string;
  1073. preloadEnabled?: boolean;
  1074. rowRenderingMode?: string;
  1075. scrollByContent?: boolean;
  1076. scrollByThumb?: boolean;
  1077. showScrollbar?: string;
  1078. useNative?: boolean;
  1079. }>;
  1080. /**
  1081. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1082. */
  1083. searchPanelChange: EventEmitter<{
  1084. highlightCaseSensitive?: boolean;
  1085. highlightSearchText?: boolean;
  1086. placeholder?: string;
  1087. searchVisibleColumnsOnly?: boolean;
  1088. text?: string;
  1089. visible?: boolean;
  1090. width?: number;
  1091. }>;
  1092. /**
  1093. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1094. */
  1095. selectedRowKeysChange: EventEmitter<Array<any>>;
  1096. /**
  1097. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1098. */
  1099. selectionChange: EventEmitter<{
  1100. allowSelectAll?: boolean;
  1101. deferred?: boolean;
  1102. mode?: string;
  1103. selectAllMode?: string;
  1104. showCheckBoxesMode?: string;
  1105. }>;
  1106. /**
  1107. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1108. */
  1109. selectionFilterChange: EventEmitter<any>;
  1110. /**
  1111. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1112. */
  1113. showBordersChange: EventEmitter<boolean>;
  1114. /**
  1115. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1116. */
  1117. showColumnHeadersChange: EventEmitter<boolean>;
  1118. /**
  1119. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1120. */
  1121. showColumnLinesChange: EventEmitter<boolean>;
  1122. /**
  1123. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1124. */
  1125. showRowLinesChange: EventEmitter<boolean>;
  1126. /**
  1127. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1128. */
  1129. sortByGroupSummaryInfoChange: EventEmitter<Array<any | {
  1130. groupColumn?: string;
  1131. sortOrder?: string;
  1132. summaryItem?: number | string;
  1133. }>>;
  1134. /**
  1135. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1136. */
  1137. sortingChange: EventEmitter<{
  1138. ascendingText?: string;
  1139. clearText?: string;
  1140. descendingText?: string;
  1141. mode?: string;
  1142. }>;
  1143. /**
  1144. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1145. */
  1146. stateStoringChange: EventEmitter<{
  1147. customLoad?: Function;
  1148. customSave?: Function;
  1149. enabled?: boolean;
  1150. savingTimeout?: number;
  1151. storageKey?: string;
  1152. type?: string;
  1153. }>;
  1154. /**
  1155. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1156. */
  1157. summaryChange: EventEmitter<{
  1158. calculateCustomSummary?: Function;
  1159. groupItems?: Array<any | {
  1160. alignByColumn?: boolean;
  1161. column?: string;
  1162. customizeText?: Function;
  1163. displayFormat?: string;
  1164. name?: string;
  1165. showInColumn?: string;
  1166. showInGroupFooter?: boolean;
  1167. skipEmptyValues?: boolean;
  1168. summaryType?: string;
  1169. valueFormat?: DevExpress.ui.format | string;
  1170. }>;
  1171. recalculateWhileEditing?: boolean;
  1172. skipEmptyValues?: boolean;
  1173. texts?: {
  1174. avg?: string;
  1175. avgOtherColumn?: string;
  1176. count?: string;
  1177. max?: string;
  1178. maxOtherColumn?: string;
  1179. min?: string;
  1180. minOtherColumn?: string;
  1181. sum?: string;
  1182. sumOtherColumn?: string;
  1183. };
  1184. totalItems?: Array<any | {
  1185. alignment?: string;
  1186. column?: string;
  1187. cssClass?: string;
  1188. customizeText?: Function;
  1189. displayFormat?: string;
  1190. name?: string;
  1191. showInColumn?: string;
  1192. skipEmptyValues?: boolean;
  1193. summaryType?: string;
  1194. valueFormat?: DevExpress.ui.format | string;
  1195. }>;
  1196. }>;
  1197. /**
  1198. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1199. */
  1200. tabIndexChange: EventEmitter<number>;
  1201. /**
  1202. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1203. */
  1204. twoWayBindingEnabledChange: EventEmitter<boolean>;
  1205. /**
  1206. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1207. */
  1208. visibleChange: EventEmitter<boolean>;
  1209. /**
  1210. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1211. */
  1212. widthChange: EventEmitter<number | Function | string>;
  1213. /**
  1214. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  1215. */
  1216. wordWrapEnabledChange: EventEmitter<boolean>;
  1217. columnsChildren: QueryList<DxiColumnComponent>;
  1218. sortByGroupSummaryInfoChildren: QueryList<DxiSortByGroupSummaryInfoComponent>;
  1219. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  1220. protected _createInstance(element: any, options: any): DxDataGrid;
  1221. ngOnDestroy(): void;
  1222. ngOnChanges(changes: SimpleChanges): void;
  1223. setupChanges(prop: string, changes: SimpleChanges): void;
  1224. ngDoCheck(): void;
  1225. _setOption(name: string, value: any): void;
  1226. }
  1227. export declare class DxDataGridModule {
  1228. }