@syncfusion/ej2-treegrid 25.2.5 → 26.1.35-469198
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.json +243 -259
- package/README.md +83 -83
- package/dist/ej2-treegrid.min.js +1 -10
- package/dist/ej2-treegrid.umd.min.js +1 -10
- package/dist/ej2-treegrid.umd.min.js.map +1 -1
- package/dist/es6/ej2-treegrid.es2015.js +706 -532
- package/dist/es6/ej2-treegrid.es2015.js.map +1 -1
- package/dist/es6/ej2-treegrid.es5.js +1222 -1047
- package/dist/es6/ej2-treegrid.es5.js.map +1 -1
- package/dist/global/ej2-treegrid.min.js +1 -10
- package/dist/global/ej2-treegrid.min.js.map +1 -1
- package/dist/global/index.d.ts +0 -9
- package/dist/ts/undefined +602 -0
- package/license +9 -9
- package/package.json +70 -70
- package/src/treegrid/actions/clipboard.js +13 -13
- package/src/treegrid/actions/edit.js +8 -7
- package/src/treegrid/actions/excel-export.js +4 -3
- package/src/treegrid/actions/logger.js +13 -13
- package/src/treegrid/actions/page.js +4 -0
- package/src/treegrid/actions/rowdragdrop.js +29 -14
- package/src/treegrid/actions/selection.js +4 -1
- package/src/treegrid/actions/virtual-scroll.js +13 -13
- package/src/treegrid/base/constant.js +2 -0
- package/src/treegrid/base/data.js +2 -1
- package/src/treegrid/base/interface.js +0 -1
- package/src/treegrid/base/treegrid-model.d.ts +875 -875
- package/src/treegrid/base/treegrid.js +260 -92
- package/src/treegrid/models/column-model.d.ts +6 -6
- package/src/treegrid/models/column.js +19 -19
- package/src/treegrid/models/edit-settings-model.d.ts +72 -72
- package/src/treegrid/models/edit-settings.js +19 -19
- package/src/treegrid/models/filter-settings-model.d.ts +206 -206
- package/src/treegrid/models/filter-settings.js +19 -19
- package/src/treegrid/models/infinite-scroll-settings-model.d.ts +16 -16
- package/src/treegrid/models/infinite-scroll-settings.js +19 -19
- package/src/treegrid/models/loading-indicator.js +19 -19
- package/src/treegrid/models/page-settings-model.d.ts +46 -46
- package/src/treegrid/models/page-settings.js +19 -19
- package/src/treegrid/models/rowdrop-settings-model.d.ts +6 -6
- package/src/treegrid/models/rowdrop-settings.js +19 -19
- package/src/treegrid/models/search-settings-model.d.ts +60 -60
- package/src/treegrid/models/search-settings.js +19 -19
- package/src/treegrid/models/selection-settings-model.d.ts +66 -66
- package/src/treegrid/models/selection-settings.js +19 -19
- package/src/treegrid/models/sort-settings-model.d.ts +24 -24
- package/src/treegrid/models/sort-settings.js +19 -19
- package/src/treegrid/models/summary-model.d.ts +64 -64
- package/src/treegrid/models/summary.js +19 -19
- package/src/treegrid/models/textwrap-settings-model.d.ts +9 -9
- package/src/treegrid/models/textwrap-settings.js +19 -19
- package/src/treegrid/renderer/render.js +3 -1
- package/src/treegrid/renderer/virtual-row-model-generator.js +15 -15
- package/src/treegrid/renderer/virtual-tree-content-render.js +15 -14
- package/styles/bds-lite.css +745 -0
- package/styles/bds-lite.scss +18 -0
- package/styles/bds.css +765 -0
- package/styles/bds.scss +19 -0
- package/styles/bootstrap-dark-lite.css +506 -0
- package/styles/bootstrap-dark-lite.scss +18 -0
- package/styles/bootstrap-dark.css +187 -117
- package/styles/bootstrap-dark.scss +19 -1
- package/styles/bootstrap-lite.css +509 -0
- package/styles/bootstrap-lite.scss +18 -0
- package/styles/bootstrap.css +190 -121
- package/styles/bootstrap.scss +19 -1
- package/styles/bootstrap4-lite.css +550 -0
- package/styles/bootstrap4-lite.scss +18 -0
- package/styles/bootstrap4.css +194 -133
- package/styles/bootstrap4.scss +19 -1
- package/styles/bootstrap5-dark-lite.css +545 -0
- package/styles/bootstrap5-dark-lite.scss +18 -0
- package/styles/bootstrap5-dark.css +189 -123
- package/styles/bootstrap5-dark.scss +19 -1
- package/styles/bootstrap5-lite.css +545 -0
- package/styles/bootstrap5-lite.scss +18 -0
- package/styles/bootstrap5.3-lite.css +1637 -0
- package/styles/bootstrap5.3-lite.scss +18 -0
- package/styles/bootstrap5.3.css +1657 -0
- package/styles/bootstrap5.3.scss +19 -0
- package/styles/bootstrap5.css +188 -122
- package/styles/bootstrap5.scss +19 -1
- package/styles/fabric-dark-lite.css +485 -0
- package/styles/fabric-dark-lite.scss +18 -0
- package/styles/fabric-dark.css +188 -118
- package/styles/fabric-dark.scss +19 -1
- package/styles/fabric-lite.css +485 -0
- package/styles/fabric-lite.scss +18 -0
- package/styles/fabric.css +188 -111
- package/styles/fabric.scss +19 -1
- package/styles/fluent-dark-lite.css +548 -0
- package/styles/fluent-dark-lite.scss +18 -0
- package/styles/fluent-dark.css +195 -116
- package/styles/fluent-dark.scss +19 -1
- package/styles/fluent-lite.css +548 -0
- package/styles/fluent-lite.scss +18 -0
- package/styles/fluent.css +195 -116
- package/styles/fluent.scss +19 -1
- package/styles/fluent2-lite.css +1856 -0
- package/styles/fluent2-lite.scss +18 -0
- package/styles/fluent2.css +1879 -0
- package/styles/fluent2.scss +19 -0
- package/styles/highcontrast-light-lite.css +491 -0
- package/styles/highcontrast-light-lite.scss +18 -0
- package/styles/highcontrast-light.css +185 -103
- package/styles/highcontrast-light.scss +19 -1
- package/styles/highcontrast-lite.css +498 -0
- package/styles/highcontrast-lite.scss +18 -0
- package/styles/highcontrast.css +196 -107
- package/styles/highcontrast.scss +19 -1
- package/styles/material-dark-lite.css +567 -0
- package/styles/material-dark-lite.scss +18 -0
- package/styles/material-dark.css +220 -105
- package/styles/material-dark.scss +19 -1
- package/styles/material-lite.css +591 -0
- package/styles/material-lite.scss +18 -0
- package/styles/material.css +234 -129
- package/styles/material.scss +19 -1
- package/styles/material3-dark-lite.css +1666 -0
- package/styles/material3-dark-lite.scss +18 -0
- package/styles/material3-dark.css +1310 -187
- package/styles/material3-dark.scss +19 -1
- package/styles/material3-lite.css +1668 -0
- package/styles/material3-lite.scss +18 -0
- package/styles/material3.css +1311 -242
- package/styles/material3.scss +19 -1
- package/styles/tailwind-dark-lite.css +518 -0
- package/styles/tailwind-dark-lite.scss +18 -0
- package/styles/tailwind-dark.css +196 -103
- package/styles/tailwind-dark.scss +19 -1
- package/styles/tailwind-lite.css +518 -0
- package/styles/tailwind-lite.scss +18 -0
- package/styles/tailwind.css +196 -103
- package/styles/tailwind.scss +19 -1
- package/styles/tailwind3-lite.css +1697 -0
- package/styles/tailwind3-lite.scss +18 -0
- package/styles/tailwind3.css +1717 -0
- package/styles/tailwind3.scss +19 -0
- package/styles/treegrid/_all.scss +2 -2
- package/styles/treegrid/_bds-definition.scss +49 -28
- package/styles/treegrid/_bigger.scss +66 -0
- package/styles/treegrid/_bootstrap-dark-definition.scss +54 -30
- package/styles/treegrid/_bootstrap-definition.scss +54 -30
- package/styles/treegrid/_bootstrap4-definition.scss +54 -30
- package/styles/treegrid/_bootstrap5-definition.scss +49 -28
- package/styles/treegrid/_bootstrap5.3-definition.scss +49 -0
- package/styles/treegrid/_fabric-dark-definition.scss +54 -30
- package/styles/treegrid/_fabric-definition.scss +54 -30
- package/styles/treegrid/_fluent-definition.scss +50 -29
- package/styles/treegrid/_fluent2-definition.scss +49 -0
- package/styles/treegrid/_fusionnew-definition.scss +49 -28
- package/styles/treegrid/_highcontrast-definition.scss +54 -30
- package/styles/treegrid/_highcontrast-light-definition.scss +54 -30
- package/styles/treegrid/_icons.scss +47 -37
- package/styles/treegrid/_layout.scss +530 -455
- package/styles/treegrid/_material-dark-definition.scss +54 -30
- package/styles/treegrid/_material-definition.scss +54 -30
- package/styles/treegrid/_material3-definition.scss +49 -28
- package/styles/treegrid/_tailwind-definition.scss +49 -28
- package/styles/treegrid/_tailwind3-definition.scss +49 -0
- package/styles/treegrid/_theme.scss +1 -1
- package/styles/treegrid/bds.css +765 -0
- package/styles/treegrid/bds.scss +19 -0
- package/styles/treegrid/bootstrap-dark.css +187 -117
- package/styles/treegrid/bootstrap-dark.scss +1 -0
- package/styles/treegrid/bootstrap.css +190 -121
- package/styles/treegrid/bootstrap.scss +1 -0
- package/styles/treegrid/bootstrap4.css +194 -133
- package/styles/treegrid/bootstrap4.scss +1 -0
- package/styles/treegrid/bootstrap5-dark.css +189 -123
- package/styles/treegrid/bootstrap5-dark.scss +1 -0
- package/styles/treegrid/bootstrap5.3.css +1657 -0
- package/styles/treegrid/bootstrap5.3.scss +19 -0
- package/styles/treegrid/bootstrap5.css +188 -122
- package/styles/treegrid/bootstrap5.scss +1 -0
- package/styles/treegrid/fabric-dark.css +188 -118
- package/styles/treegrid/fabric-dark.scss +1 -0
- package/styles/treegrid/fabric.css +188 -111
- package/styles/treegrid/fabric.scss +1 -0
- package/styles/treegrid/fluent-dark.css +195 -116
- package/styles/treegrid/fluent-dark.scss +1 -0
- package/styles/treegrid/fluent.css +195 -116
- package/styles/treegrid/fluent.scss +1 -0
- package/styles/treegrid/fluent2.css +1879 -0
- package/styles/treegrid/fluent2.scss +19 -0
- package/styles/treegrid/highcontrast-light.css +185 -103
- package/styles/treegrid/highcontrast-light.scss +1 -0
- package/styles/treegrid/highcontrast.css +196 -107
- package/styles/treegrid/highcontrast.scss +1 -0
- package/styles/treegrid/icons/_bds.scss +37 -37
- package/styles/treegrid/icons/_bootstrap-dark.scss +47 -37
- package/styles/treegrid/icons/_bootstrap.scss +47 -37
- package/styles/treegrid/icons/_bootstrap4.scss +47 -37
- package/styles/treegrid/icons/_bootstrap5.3.scss +47 -0
- package/styles/treegrid/icons/_bootstrap5.scss +47 -37
- package/styles/treegrid/icons/_fabric-dark.scss +47 -37
- package/styles/treegrid/icons/_fabric.scss +47 -37
- package/styles/treegrid/icons/_fluent.scss +47 -37
- package/styles/treegrid/icons/_fluent2.scss +47 -0
- package/styles/treegrid/icons/_fusionnew.scss +30 -26
- package/styles/treegrid/icons/_highcontrast-light.scss +47 -37
- package/styles/treegrid/icons/_highcontrast.scss +47 -37
- package/styles/treegrid/icons/_material-dark.scss +47 -37
- package/styles/treegrid/icons/_material.scss +47 -37
- package/styles/treegrid/icons/_material3.scss +47 -37
- package/styles/treegrid/icons/_tailwind-dark.scss +47 -37
- package/styles/treegrid/icons/_tailwind.scss +47 -37
- package/styles/treegrid/icons/_tailwind3.scss +47 -0
- package/styles/treegrid/material-dark.css +220 -105
- package/styles/treegrid/material-dark.scss +1 -0
- package/styles/treegrid/material.css +234 -129
- package/styles/treegrid/material.scss +1 -0
- package/styles/treegrid/material3-dark.css +1310 -187
- package/styles/treegrid/material3-dark.scss +2 -1
- package/styles/treegrid/material3.css +1311 -242
- package/styles/treegrid/material3.scss +2 -1
- package/styles/treegrid/tailwind-dark.css +196 -103
- package/styles/treegrid/tailwind-dark.scss +1 -0
- package/styles/treegrid/tailwind.css +196 -103
- package/styles/treegrid/tailwind.scss +1 -0
- package/styles/treegrid/tailwind3.css +1717 -0
- package/styles/treegrid/tailwind3.scss +19 -0
- package/CHANGELOG.md +0 -250
- package/helpers/e2e/index.d.ts +0 -1
- package/helpers/e2e/index.js +0 -8
- package/helpers/e2e/treegridhelper.d.ts +0 -21
- package/helpers/e2e/treegridhelper.js +0 -83
- package/index.d.ts +0 -4
- package/index.js +0 -4
- package/src/index.d.ts +0 -4
- package/src/treegrid/actions/batch-edit.d.ts +0 -73
- package/src/treegrid/actions/clipboard.d.ts +0 -36
- package/src/treegrid/actions/column-chooser.d.ts +0 -37
- package/src/treegrid/actions/column-menu.d.ts +0 -24
- package/src/treegrid/actions/command-column.d.ts +0 -24
- package/src/treegrid/actions/context-menu.d.ts +0 -42
- package/src/treegrid/actions/crud-actions.d.ts +0 -66
- package/src/treegrid/actions/detail-row.d.ts +0 -39
- package/src/treegrid/actions/edit.d.ts +0 -112
- package/src/treegrid/actions/excel-export.d.ts +0 -59
- package/src/treegrid/actions/filter.d.ts +0 -57
- package/src/treegrid/actions/freeze-column.d.ts +0 -28
- package/src/treegrid/actions/index.d.ts +0 -24
- package/src/treegrid/actions/infinite-scroll.d.ts +0 -96
- package/src/treegrid/actions/logger.d.ts +0 -25
- package/src/treegrid/actions/page.d.ts +0 -67
- package/src/treegrid/actions/pdf-export.d.ts +0 -55
- package/src/treegrid/actions/print.d.ts +0 -37
- package/src/treegrid/actions/reorder.d.ts +0 -36
- package/src/treegrid/actions/resize.d.ts +0 -36
- package/src/treegrid/actions/rowdragdrop.d.ts +0 -113
- package/src/treegrid/actions/selection.d.ts +0 -51
- package/src/treegrid/actions/sort.d.ts +0 -63
- package/src/treegrid/actions/summary.d.ts +0 -47
- package/src/treegrid/actions/toolbar.d.ts +0 -52
- package/src/treegrid/actions/virtual-scroll.d.ts +0 -53
- package/src/treegrid/base/constant.d.ts +0 -160
- package/src/treegrid/base/data.d.ts +0 -90
- package/src/treegrid/base/index.d.ts +0 -11
- package/src/treegrid/base/interface.d.ts +0 -182
- package/src/treegrid/base/treegrid.d.ts +0 -2186
- package/src/treegrid/enum.d.ts +0 -155
- package/src/treegrid/index.d.ts +0 -9
- package/src/treegrid/models/column.d.ts +0 -752
- package/src/treegrid/models/edit-settings.d.ts +0 -90
- package/src/treegrid/models/filter-settings.d.ts +0 -203
- package/src/treegrid/models/index.d.ts +0 -24
- package/src/treegrid/models/infinite-scroll-settings.d.ts +0 -25
- package/src/treegrid/models/loading-indicator.d.ts +0 -19
- package/src/treegrid/models/page-settings.d.ts +0 -60
- package/src/treegrid/models/rowdrop-settings.d.ts +0 -27
- package/src/treegrid/models/search-settings.d.ts +0 -71
- package/src/treegrid/models/selection-settings.d.ts +0 -79
- package/src/treegrid/models/sort-settings.d.ts +0 -40
- package/src/treegrid/models/summary.d.ts +0 -124
- package/src/treegrid/models/textwrap-settings.d.ts +0 -16
- package/src/treegrid/renderer/index.d.ts +0 -5
- package/src/treegrid/renderer/render.d.ts +0 -41
- package/src/treegrid/renderer/virtual-row-model-generator.d.ts +0 -16
- package/src/treegrid/renderer/virtual-tree-content-render.d.ts +0 -75
- package/src/treegrid/utils.d.ts +0 -70
- package/treegrid.d.ts +0 -4
- package/treegrid.js +0 -4
- package/tslint.json +0 -111
|
@@ -1,2186 +0,0 @@
|
|
|
1
|
-
import { Component, ModuleDeclaration } from '@syncfusion/ej2-base';
|
|
2
|
-
import { EmitType } from '@syncfusion/ej2-base';
|
|
3
|
-
import { INotifyPropertyChanged, KeyboardEvents } from '@syncfusion/ej2-base';
|
|
4
|
-
import { Column, ColumnModel } from '../models/column';
|
|
5
|
-
import { BeforeBatchSaveArgs, BeforeBatchAddArgs, BatchDeleteArgs, BeforeBatchDeleteArgs } from '@syncfusion/ej2-grids';
|
|
6
|
-
import { ColumnQueryModeType, HeaderCellInfoEventArgs } from '@syncfusion/ej2-grids';
|
|
7
|
-
import { RowDragEventArgs, RowDropSettingsModel } from '@syncfusion/ej2-grids';
|
|
8
|
-
import { LoadingIndicatorModel } from '../models/loading-indicator-model';
|
|
9
|
-
import { DetailDataBoundEventArgs, ClipMode, ColumnChooser } from '@syncfusion/ej2-grids';
|
|
10
|
-
import { SearchEventArgs, AddEventArgs, EditEventArgs, DeleteEventArgs } from '@syncfusion/ej2-grids';
|
|
11
|
-
import { SaveEventArgs, CellSaveArgs, BatchAddArgs, BatchCancelArgs, BeginEditArgs, CellEditArgs } from '@syncfusion/ej2-grids';
|
|
12
|
-
import { TextWrapSettingsModel } from '../models/textwrap-settings-model';
|
|
13
|
-
import { Filter } from '../actions/filter';
|
|
14
|
-
import { BeforeCopyEventArgs, BeforePasteEventArgs } from '@syncfusion/ej2-grids';
|
|
15
|
-
import { TreeClipboard } from '../actions/clipboard';
|
|
16
|
-
import { Aggregate } from '../actions/summary';
|
|
17
|
-
import { Reorder } from '../actions/reorder';
|
|
18
|
-
import { Resize } from '../actions/resize';
|
|
19
|
-
import { Selection as TreeGridSelection } from '../actions/selection';
|
|
20
|
-
import { ColumnMenu } from '../actions/column-menu';
|
|
21
|
-
import { DetailRow } from '../actions/detail-row';
|
|
22
|
-
import { Freeze } from '../actions/freeze-column';
|
|
23
|
-
import { Print } from '../actions/print';
|
|
24
|
-
import { TreeGridModel } from './treegrid-model';
|
|
25
|
-
import { FilterSettingsModel } from '../models/filter-settings-model';
|
|
26
|
-
import { SearchSettingsModel } from '../models/search-settings-model';
|
|
27
|
-
import { RowInfo, RowDataBoundEventArgs, PageEventArgs, FilterEventArgs, FailureEventArgs, SortEventArgs } from '@syncfusion/ej2-grids';
|
|
28
|
-
import { RowSelectingEventArgs, RowSelectEventArgs, RowDeselectEventArgs, IIndex, ISelectedCell } from '@syncfusion/ej2-grids';
|
|
29
|
-
import { CellSelectEventArgs, CellDeselectEventArgs } from '@syncfusion/ej2-grids';
|
|
30
|
-
import { SelectionSettingsModel } from '../models/selection-settings-model';
|
|
31
|
-
import { SortDirection, ColumnDragEventArgs } from '@syncfusion/ej2-grids';
|
|
32
|
-
import { PrintMode, Data, ContextMenuItemModel } from '@syncfusion/ej2-grids';
|
|
33
|
-
import { ColumnMenuItem, ColumnMenuItemModel, CheckBoxChangeEventArgs } from '@syncfusion/ej2-grids';
|
|
34
|
-
import { ExcelExportCompleteArgs, ExcelHeaderQueryCellInfoEventArgs, ExcelQueryCellInfoEventArgs } from '@syncfusion/ej2-grids';
|
|
35
|
-
import { PdfExportCompleteArgs, PdfHeaderQueryCellInfoEventArgs, PdfQueryCellInfoEventArgs } from '@syncfusion/ej2-grids';
|
|
36
|
-
import { ExcelExportProperties, PdfExportProperties, CellSelectingEventArgs, PrintEventArgs } from '@syncfusion/ej2-grids';
|
|
37
|
-
import { ColumnMenuOpenEventArgs } from '@syncfusion/ej2-grids';
|
|
38
|
-
import { BeforeDataBoundArgs } from '@syncfusion/ej2-grids';
|
|
39
|
-
import { DataManager, Query } from '@syncfusion/ej2-data';
|
|
40
|
-
import { Grid, QueryCellInfoEventArgs } from '@syncfusion/ej2-grids';
|
|
41
|
-
import { Render } from '../renderer/render';
|
|
42
|
-
import { DataManipulation } from './data';
|
|
43
|
-
import { RowDD } from '../actions/rowdragdrop';
|
|
44
|
-
import { Sort } from '../actions/sort';
|
|
45
|
-
import { ITreeData, RowExpandedEventArgs, RowCollapsedEventArgs, RowCollapsingEventArgs, TreeGridExcelExportProperties } from './interface';
|
|
46
|
-
import { DataStateChangeEventArgs, RowExpandingEventArgs, TreeGridPdfExportProperties } from './interface';
|
|
47
|
-
import { GridLine } from '@syncfusion/ej2-grids';
|
|
48
|
-
import { DataSourceChangedEventArgs, RecordDoubleClickEventArgs, ResizeArgs } from '@syncfusion/ej2-grids';
|
|
49
|
-
import { ToolbarItems, ToolbarItem, ContextMenuItem, RowPosition, CopyHierarchyType } from '../enum';
|
|
50
|
-
import { ItemModel, ClickEventArgs, BeforeOpenCloseMenuEventArgs, MenuEventArgs } from '@syncfusion/ej2-navigations';
|
|
51
|
-
import { PageSettingsModel } from '../models/page-settings-model';
|
|
52
|
-
import { AggregateRowModel } from '../models/summary-model';
|
|
53
|
-
import { ExcelExport } from '../actions/excel-export';
|
|
54
|
-
import { PdfExport } from '../actions/pdf-export';
|
|
55
|
-
import { Toolbar } from '../actions/toolbar';
|
|
56
|
-
import { Page } from '../actions/page';
|
|
57
|
-
import { ContextMenu } from '../actions/context-menu';
|
|
58
|
-
import { EditSettingsModel } from '../models/edit-settings-model';
|
|
59
|
-
import { Edit } from '../actions/edit';
|
|
60
|
-
import { SortSettingsModel } from '../models/sort-settings-model';
|
|
61
|
-
import { InfiniteScrollSettingsModel } from '../models/infinite-scroll-settings-model';
|
|
62
|
-
/**
|
|
63
|
-
* Represents the TreeGrid component.
|
|
64
|
-
* ```html
|
|
65
|
-
* <div id='treegrid'></div>
|
|
66
|
-
* <script>
|
|
67
|
-
* var treegridObj = new TreeGrid({ allowPaging: true });
|
|
68
|
-
* treegridObj.appendTo('#treegrid');
|
|
69
|
-
* </script>
|
|
70
|
-
* ```
|
|
71
|
-
*/
|
|
72
|
-
export declare class TreeGrid extends Component<HTMLElement> implements INotifyPropertyChanged {
|
|
73
|
-
constructor(options?: TreeGridModel, element?: Element);
|
|
74
|
-
private defaultLocale;
|
|
75
|
-
private dataResults;
|
|
76
|
-
private l10n;
|
|
77
|
-
dataModule: DataManipulation;
|
|
78
|
-
private registeredTemplate;
|
|
79
|
-
private uniqueIDCollection;
|
|
80
|
-
private uniqueIDFilterCollection;
|
|
81
|
-
private changedRecords;
|
|
82
|
-
private deletedRecords;
|
|
83
|
-
private addedRecords;
|
|
84
|
-
private targetElement;
|
|
85
|
-
private isGantt;
|
|
86
|
-
private isAddedFromGantt;
|
|
87
|
-
private isIndentEnabled;
|
|
88
|
-
private indentOutdentAction;
|
|
89
|
-
private isCollapsedEventTriggered;
|
|
90
|
-
private isCollapsingEventTriggered;
|
|
91
|
-
private isExpandedEventTriggered;
|
|
92
|
-
private isExpandingEventTriggered;
|
|
93
|
-
private collapseAllPrevent;
|
|
94
|
-
private expandAllPrevent;
|
|
95
|
-
/**
|
|
96
|
-
* The `sortModule` is used to manipulate sorting in TreeGrid.
|
|
97
|
-
*/
|
|
98
|
-
sortModule: Sort;
|
|
99
|
-
private action;
|
|
100
|
-
private dropIndex;
|
|
101
|
-
private dropPosition;
|
|
102
|
-
private modifiedRecords;
|
|
103
|
-
private selectedRecords;
|
|
104
|
-
private selectedRows;
|
|
105
|
-
private loggerModule;
|
|
106
|
-
private isSelfReference;
|
|
107
|
-
private columnModel;
|
|
108
|
-
private isExpandAll;
|
|
109
|
-
private isCollapseAll;
|
|
110
|
-
private isExpandRefresh;
|
|
111
|
-
private gridSettings;
|
|
112
|
-
private isEditCollapse;
|
|
113
|
-
private treeColumnTextAlign;
|
|
114
|
-
private treeColumnField;
|
|
115
|
-
private stackedHeader;
|
|
116
|
-
private isExcel;
|
|
117
|
-
/** @hidden */
|
|
118
|
-
initialRender: boolean;
|
|
119
|
-
/** @hidden */
|
|
120
|
-
flatData: Object[];
|
|
121
|
-
/** @hidden */
|
|
122
|
-
private infiniteScrollData;
|
|
123
|
-
/** @hidden */
|
|
124
|
-
private remoteCollapsedData;
|
|
125
|
-
/** @hidden */
|
|
126
|
-
private remoteExpandedData;
|
|
127
|
-
/** @hidden */
|
|
128
|
-
isLocalData: boolean;
|
|
129
|
-
/** @hidden */
|
|
130
|
-
parentData: Object[];
|
|
131
|
-
/**
|
|
132
|
-
* @hidden
|
|
133
|
-
*/
|
|
134
|
-
renderModule: Render;
|
|
135
|
-
/** @hidden */
|
|
136
|
-
summaryModule: Aggregate;
|
|
137
|
-
/**
|
|
138
|
-
* The `reorderModule` is used to manipulate reordering in TreeGrid.
|
|
139
|
-
*/
|
|
140
|
-
reorderModule: Reorder;
|
|
141
|
-
/**
|
|
142
|
-
* The `columnMenuModule` is used to manipulate column menu items and its action in TreeGrid.
|
|
143
|
-
*/
|
|
144
|
-
columnMenuModule: ColumnMenu;
|
|
145
|
-
/**
|
|
146
|
-
* The `rowDragandDrop` is used to manipulate Row Reordering in TreeGrid.
|
|
147
|
-
*/
|
|
148
|
-
rowDragAndDropModule: RowDD;
|
|
149
|
-
/**
|
|
150
|
-
* The `contextMenuModule` is used to handle context menu items and its action in the TreeGrid.
|
|
151
|
-
*/
|
|
152
|
-
contextMenuModule: ContextMenu;
|
|
153
|
-
/**
|
|
154
|
-
* `detailRowModule` is used to handle detail rows rendering in the TreeGrid.
|
|
155
|
-
*
|
|
156
|
-
* @hidden
|
|
157
|
-
*/
|
|
158
|
-
detailRowModule: DetailRow;
|
|
159
|
-
/**
|
|
160
|
-
* `freezeModule` is used to freeze the rows and columns in the TreeGrid.
|
|
161
|
-
*
|
|
162
|
-
* @hidden
|
|
163
|
-
*/
|
|
164
|
-
freezeModule: Freeze;
|
|
165
|
-
/**
|
|
166
|
-
* Gets or sets the number of frozen rows.
|
|
167
|
-
*
|
|
168
|
-
* @default 0
|
|
169
|
-
*/
|
|
170
|
-
frozenRows: number;
|
|
171
|
-
/**
|
|
172
|
-
* Gets or sets the number of frozen columns.
|
|
173
|
-
*
|
|
174
|
-
* @default 0
|
|
175
|
-
*/
|
|
176
|
-
frozenColumns: number;
|
|
177
|
-
/**
|
|
178
|
-
* Defines the mode of clip. The available modes are,
|
|
179
|
-
* ```props
|
|
180
|
-
* * Clip :- Truncates the cell content when it overflows its area.
|
|
181
|
-
* * Ellipsis :- Displays ellipsis when the cell content overflows its area.
|
|
182
|
-
* * EllipsisWithTooltip :- Displays ellipsis when the cell content overflows its area,
|
|
183
|
-
* ```
|
|
184
|
-
* also it will display the tooltip while hover on ellipsis is applied.
|
|
185
|
-
*
|
|
186
|
-
* @default Syncfusion.EJ2.Grids.ClipMode.Ellipsis
|
|
187
|
-
* @aspType Syncfusion.EJ2.Grids.ClipMode
|
|
188
|
-
* @isEnumeration true
|
|
189
|
-
*/
|
|
190
|
-
clipMode: ClipMode;
|
|
191
|
-
/**
|
|
192
|
-
* `resizeModule` is used to manipulate resizing in the TreeGrid.
|
|
193
|
-
*
|
|
194
|
-
* @hidden
|
|
195
|
-
*/
|
|
196
|
-
resizeModule: Resize;
|
|
197
|
-
/**
|
|
198
|
-
* The `keyboardModule` is used to manipulate keyboard interactions in TreeGrid.
|
|
199
|
-
*/
|
|
200
|
-
keyboardModule: KeyboardEvents;
|
|
201
|
-
/**
|
|
202
|
-
* The `printModule` is used to handle the printing feature of the TreeGrid.
|
|
203
|
-
*/
|
|
204
|
-
printModule: Print;
|
|
205
|
-
/**
|
|
206
|
-
* `clipboardModule` is used to handle TreeGrid copy action.
|
|
207
|
-
*/
|
|
208
|
-
clipboardModule: TreeClipboard;
|
|
209
|
-
private keyConfigs;
|
|
210
|
-
/** @hidden */
|
|
211
|
-
filterModule: Filter;
|
|
212
|
-
excelExportModule: ExcelExport;
|
|
213
|
-
pdfExportModule: PdfExport;
|
|
214
|
-
selectionModule: TreeGridSelection;
|
|
215
|
-
/** @hidden */
|
|
216
|
-
/** @hidden */
|
|
217
|
-
grid: Grid;
|
|
218
|
-
/**
|
|
219
|
-
* Defines the schema of dataSource.
|
|
220
|
-
* If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.
|
|
221
|
-
* {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}
|
|
222
|
-
*
|
|
223
|
-
* @default []
|
|
224
|
-
*/
|
|
225
|
-
columns: ColumnModel[] | string[] | Column[];
|
|
226
|
-
/**
|
|
227
|
-
* Specifies the mapping property path for child records in data source
|
|
228
|
-
* {% codeBlock src='treegrid/childMapping/index.md' %}{% endcodeBlock %}
|
|
229
|
-
*
|
|
230
|
-
* @default null
|
|
231
|
-
*/
|
|
232
|
-
childMapping: string;
|
|
233
|
-
/**
|
|
234
|
-
* Specifies whether record is parent or not for the remote data binding
|
|
235
|
-
*
|
|
236
|
-
* @default null
|
|
237
|
-
*/
|
|
238
|
-
hasChildMapping: string;
|
|
239
|
-
/**
|
|
240
|
-
* Specifies the index of the column that needs to have the expander button.
|
|
241
|
-
*
|
|
242
|
-
* @default 0
|
|
243
|
-
*/
|
|
244
|
-
treeColumnIndex: number;
|
|
245
|
-
/**
|
|
246
|
-
* Specifies the name of the field in the dataSource, which contains the id of that row.
|
|
247
|
-
* {% codeBlock src='treegrid/idMapping/index.md' %}{% endcodeBlock %}
|
|
248
|
-
*
|
|
249
|
-
* @default null
|
|
250
|
-
*/
|
|
251
|
-
idMapping: string;
|
|
252
|
-
/**
|
|
253
|
-
* Specifies the name of the field in the dataSource, which contains the parent’s id
|
|
254
|
-
* {% codeBlock src='treegrid/parentIdMapping/index.md' %}{% endcodeBlock %}
|
|
255
|
-
*
|
|
256
|
-
* @default null
|
|
257
|
-
*/
|
|
258
|
-
parentIdMapping: string;
|
|
259
|
-
/**
|
|
260
|
-
* Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.
|
|
261
|
-
*
|
|
262
|
-
* @default false
|
|
263
|
-
*/
|
|
264
|
-
enableCollapseAll: boolean;
|
|
265
|
-
/**
|
|
266
|
-
* Specifies the mapping property path for the expand status of a record in data source.
|
|
267
|
-
*
|
|
268
|
-
* @default null
|
|
269
|
-
*/
|
|
270
|
-
expandStateMapping: string;
|
|
271
|
-
/**
|
|
272
|
-
* If `allowRowDragAndDrop` is set to true, you can drag and drop treegrid rows at another treegrid.
|
|
273
|
-
*
|
|
274
|
-
* @default false
|
|
275
|
-
*/
|
|
276
|
-
allowRowDragAndDrop: boolean;
|
|
277
|
-
/**
|
|
278
|
-
* It is used to render TreeGrid table rows.
|
|
279
|
-
* {% codeBlock src='treegrid/dataSource/index.md' %}{% endcodeBlock %}
|
|
280
|
-
*
|
|
281
|
-
* @default []
|
|
282
|
-
* @isGenericType true
|
|
283
|
-
* @isDataSource true
|
|
284
|
-
*/
|
|
285
|
-
dataSource: Object | DataManager;
|
|
286
|
-
/**
|
|
287
|
-
* Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
|
|
288
|
-
* that will be executed along with data processing.
|
|
289
|
-
*
|
|
290
|
-
* @default null
|
|
291
|
-
*/
|
|
292
|
-
query: Query;
|
|
293
|
-
/**
|
|
294
|
-
* @hidden
|
|
295
|
-
*/
|
|
296
|
-
cloneQuery: Query;
|
|
297
|
-
/**
|
|
298
|
-
* Defines the print modes. The available print modes are
|
|
299
|
-
* ```props
|
|
300
|
-
* * AllPages :- Prints all pages of the TreeGrid.
|
|
301
|
-
* * CurrentPage :- Prints the current page of the TreeGrid.
|
|
302
|
-
* ```
|
|
303
|
-
*
|
|
304
|
-
* @default Syncfusion.EJ2.Grids.PrintMode.AllPages
|
|
305
|
-
* @isEnumeration true
|
|
306
|
-
* @aspType Syncfusion.EJ2.Grids.PrintMode
|
|
307
|
-
*/
|
|
308
|
-
printMode: PrintMode;
|
|
309
|
-
/**
|
|
310
|
-
* If `allowPaging` is set to true, pager renders.
|
|
311
|
-
*
|
|
312
|
-
* @default false
|
|
313
|
-
*/
|
|
314
|
-
allowPaging: boolean;
|
|
315
|
-
/**
|
|
316
|
-
* If `loadChildOnDemand` is enabled, parent records are render in expanded state.
|
|
317
|
-
*
|
|
318
|
-
* @default false
|
|
319
|
-
*/
|
|
320
|
-
loadChildOnDemand: boolean;
|
|
321
|
-
/**
|
|
322
|
-
* If `allowTextWrap` set to true,
|
|
323
|
-
* then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
|
|
324
|
-
*
|
|
325
|
-
* @default false
|
|
326
|
-
*/
|
|
327
|
-
allowTextWrap: boolean;
|
|
328
|
-
/**
|
|
329
|
-
* Configures the text wrap in the TreeGrid.
|
|
330
|
-
*
|
|
331
|
-
* @default {wrapMode:"Both"}
|
|
332
|
-
*/
|
|
333
|
-
textWrapSettings: TextWrapSettingsModel;
|
|
334
|
-
/**
|
|
335
|
-
* If `allowReordering` is set to true, TreeGrid columns can be reordered.
|
|
336
|
-
* Reordering can be done by drag and drop of a particular column from one index to another index.
|
|
337
|
-
* > If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
|
|
338
|
-
*
|
|
339
|
-
* @default false
|
|
340
|
-
*/
|
|
341
|
-
allowReordering: boolean;
|
|
342
|
-
/**
|
|
343
|
-
* If `allowResizing` is set to true, TreeGrid columns can be resized.
|
|
344
|
-
*
|
|
345
|
-
* @default false
|
|
346
|
-
*/
|
|
347
|
-
allowResizing: boolean;
|
|
348
|
-
/**
|
|
349
|
-
* If `autoCheckHierarchy` is set to true, hierarchy checkbox selection is enabled in TreeGrid.
|
|
350
|
-
*
|
|
351
|
-
* @default false
|
|
352
|
-
*/
|
|
353
|
-
autoCheckHierarchy: boolean;
|
|
354
|
-
/**
|
|
355
|
-
* Configures the pager in the TreeGrid.
|
|
356
|
-
*
|
|
357
|
-
* @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
|
|
358
|
-
*/
|
|
359
|
-
pageSettings: PageSettingsModel;
|
|
360
|
-
/**
|
|
361
|
-
* Configures the row drop settings of the TreeGrid.
|
|
362
|
-
*/
|
|
363
|
-
rowDropSettings: RowDropSettingsModel;
|
|
364
|
-
/**
|
|
365
|
-
* Defines the currencyCode format of the Tree Grid columns
|
|
366
|
-
*
|
|
367
|
-
* @private
|
|
368
|
-
*/
|
|
369
|
-
private currencyCode;
|
|
370
|
-
/**
|
|
371
|
-
* @hidden
|
|
372
|
-
* It used to render pager template
|
|
373
|
-
* @default null
|
|
374
|
-
* @aspType string
|
|
375
|
-
*/
|
|
376
|
-
pagerTemplate: string | Function;
|
|
377
|
-
/**
|
|
378
|
-
* If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
|
|
379
|
-
*
|
|
380
|
-
* > Check the [`Column menu`](../../treegrid/columns/#column-menu/) for its configuration.
|
|
381
|
-
*
|
|
382
|
-
* @default false
|
|
383
|
-
*/
|
|
384
|
-
showColumnMenu: boolean;
|
|
385
|
-
/**
|
|
386
|
-
* If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
|
|
387
|
-
*
|
|
388
|
-
* @default false
|
|
389
|
-
*/
|
|
390
|
-
showColumnChooser: boolean;
|
|
391
|
-
/**
|
|
392
|
-
* If `allowSorting` is set to true, it allows sorting of treegrid records when column header is clicked.
|
|
393
|
-
*
|
|
394
|
-
* @default false
|
|
395
|
-
*/
|
|
396
|
-
allowSorting: boolean;
|
|
397
|
-
/**
|
|
398
|
-
* If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the treegrid.
|
|
399
|
-
* > `allowSorting` should be true.
|
|
400
|
-
*
|
|
401
|
-
* @default true
|
|
402
|
-
*/
|
|
403
|
-
allowMultiSorting: boolean;
|
|
404
|
-
/**
|
|
405
|
-
* Configures the sort settings of the TreeGrid.
|
|
406
|
-
*
|
|
407
|
-
* @default {columns:[]}
|
|
408
|
-
*/
|
|
409
|
-
sortSettings: SortSettingsModel;
|
|
410
|
-
/**
|
|
411
|
-
* Configures the TreeGrid aggregate rows.
|
|
412
|
-
* > Check the [`Aggregates`](../../treegrid/aggregates/aggregates) for its configuration.
|
|
413
|
-
*
|
|
414
|
-
* @default []
|
|
415
|
-
*/
|
|
416
|
-
aggregates: AggregateRowModel[];
|
|
417
|
-
/**
|
|
418
|
-
* Configures the edit settings.
|
|
419
|
-
*
|
|
420
|
-
* @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
|
|
421
|
-
* allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
|
|
422
|
-
*/
|
|
423
|
-
editSettings: EditSettingsModel;
|
|
424
|
-
/**
|
|
425
|
-
* If `allowFiltering` is set to true the filter bar will be displayed.
|
|
426
|
-
* If set to false the filter bar will not be displayed.
|
|
427
|
-
* Filter bar allows the user to filter tree grid records with required criteria.
|
|
428
|
-
*
|
|
429
|
-
* @default false
|
|
430
|
-
*/
|
|
431
|
-
allowFiltering: boolean;
|
|
432
|
-
/**
|
|
433
|
-
* The detail template allows you to show or hide additional information about a particular row.
|
|
434
|
-
*
|
|
435
|
-
* > It accepts either the [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
|
|
436
|
-
* or the HTML element ID.
|
|
437
|
-
*
|
|
438
|
-
* @aspType string
|
|
439
|
-
*/
|
|
440
|
-
detailTemplate: string | Function;
|
|
441
|
-
/**
|
|
442
|
-
* Configures the filter settings of the TreeGrid.
|
|
443
|
-
*
|
|
444
|
-
* @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
|
|
445
|
-
*/
|
|
446
|
-
filterSettings: FilterSettingsModel;
|
|
447
|
-
/**
|
|
448
|
-
* Configures the search settings of the TreeGrid.
|
|
449
|
-
*
|
|
450
|
-
* @default {search: [] , operators: {}}
|
|
451
|
-
*/
|
|
452
|
-
searchSettings: SearchSettingsModel;
|
|
453
|
-
/**
|
|
454
|
-
* `toolbar` defines the ToolBar items of the TreeGrid.
|
|
455
|
-
* It contains built-in and custom toolbar items.
|
|
456
|
-
* If a string value is assigned to the `toolbar` option, it is considered as the template for the whole TreeGrid ToolBar.
|
|
457
|
-
* If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar.
|
|
458
|
-
* <br><br>
|
|
459
|
-
* The available built-in ToolBar items are:
|
|
460
|
-
* * Search: Searches records by the given key.
|
|
461
|
-
* * ExpandAll: Expands all the rows in TreeGrid
|
|
462
|
-
* * CollapseAll: Collapses all the rows in TreeGrid
|
|
463
|
-
* * ExcelExport - Export the TreeGrid to Excel(excelExport() method manually to make export.)
|
|
464
|
-
* * PdfExport - Export the TreeGrid to PDF(pdfExport() method manually to make export.)
|
|
465
|
-
* * CsvExport - Export the TreeGrid to CSV(csvExport() method manually to make export.)<br><br>
|
|
466
|
-
* The following code example implements the custom toolbar items.
|
|
467
|
-
*
|
|
468
|
-
* @default null
|
|
469
|
-
*/
|
|
470
|
-
toolbar: (ToolbarItems | string | ItemModel | ToolbarItem)[];
|
|
471
|
-
/**
|
|
472
|
-
* @hidden
|
|
473
|
-
* It used to render toolbar template
|
|
474
|
-
* @default null
|
|
475
|
-
* @aspType string
|
|
476
|
-
*/
|
|
477
|
-
toolbarTemplate: string | Function;
|
|
478
|
-
/**
|
|
479
|
-
* Defines the mode of TreeGrid lines. The available modes are,
|
|
480
|
-
* ```props
|
|
481
|
-
* * Both :- Displays both horizontal and vertical TreeGrid lines.
|
|
482
|
-
* * None :- No TreeGrid lines are displayed.
|
|
483
|
-
* * Horizontal :- Displays the horizontal TreeGrid lines only.
|
|
484
|
-
* * Vertical :- Displays the vertical TreeGrid lines only.
|
|
485
|
-
* * Default :- Displays TreeGrid lines based on the theme.
|
|
486
|
-
* ```
|
|
487
|
-
*
|
|
488
|
-
* @default Syncfusion.EJ2.Grids.GridLine.Default
|
|
489
|
-
* @isEnumeration true
|
|
490
|
-
* @aspType Syncfusion.EJ2.Grids.GridLine
|
|
491
|
-
*/
|
|
492
|
-
gridLines: GridLine;
|
|
493
|
-
/**
|
|
494
|
-
* `contextMenuItems` defines both built-in and custom context menu items.
|
|
495
|
-
* <br><br>
|
|
496
|
-
* The available built-in items are,
|
|
497
|
-
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
498
|
-
* * `AutoFit` - Auto fit the current column.
|
|
499
|
-
* * `Edit` - Edit the current record.
|
|
500
|
-
* * `Delete` - Delete the current record.
|
|
501
|
-
* * `Save` - Save the edited record.
|
|
502
|
-
* * `Cancel` - Cancel the edited state.
|
|
503
|
-
* * `PdfExport` - Export the grid as Pdf format.
|
|
504
|
-
* * `ExcelExport` - Export the grid as Excel format.
|
|
505
|
-
* * `CsvExport` - Export the grid as CSV format.
|
|
506
|
-
* * `SortAscending` - Sort the current column in ascending order.
|
|
507
|
-
* * `SortDescending` - Sort the current column in descending order.
|
|
508
|
-
* * `FirstPage` - Go to the first page.
|
|
509
|
-
* * `PrevPage` - Go to the previous page.
|
|
510
|
-
* * `LastPage` - Go to the last page.
|
|
511
|
-
* * `NextPage` - Go to the next page.
|
|
512
|
-
*
|
|
513
|
-
* @default null
|
|
514
|
-
*/
|
|
515
|
-
contextMenuItems: ContextMenuItem[] | ContextMenuItemModel[];
|
|
516
|
-
/**
|
|
517
|
-
* `columnMenuItems` defines both built-in and custom column menu items.
|
|
518
|
-
* <br><br>
|
|
519
|
-
* The available built-in items are,
|
|
520
|
-
* * `AutoFitAll` - Auto fit the size of all columns.
|
|
521
|
-
* * `AutoFit` - Auto fit the current column.
|
|
522
|
-
* * `SortAscending` - Sort the current column in ascending order.
|
|
523
|
-
* * `SortDescending` - Sort the current column in descending order.
|
|
524
|
-
* * `Filter` - Filter options will show based on filterSettings property like filterbar, menu filter.
|
|
525
|
-
*
|
|
526
|
-
* @default null
|
|
527
|
-
*/
|
|
528
|
-
columnMenuItems: ColumnMenuItem[] | ColumnMenuItemModel[];
|
|
529
|
-
/**
|
|
530
|
-
* The row template that renders customized rows from the given template.
|
|
531
|
-
* By default, TreeGrid renders a table row for every data source item.
|
|
532
|
-
* > * It accepts either [template string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals)
|
|
533
|
-
* or HTML element ID.
|
|
534
|
-
* > * The row template must be a table row.
|
|
535
|
-
*
|
|
536
|
-
* > Check the [`Row Template`](../../treegrid/row) customization.
|
|
537
|
-
*
|
|
538
|
-
* @aspType string
|
|
539
|
-
*/
|
|
540
|
-
rowTemplate: string | Function;
|
|
541
|
-
/**
|
|
542
|
-
* `copyHierarchyMode` Defines the copy clipboard types.
|
|
543
|
-
* <br><br>
|
|
544
|
-
* The available built-in items are,
|
|
545
|
-
* * `Parent` - Copy the selected data with parent record.
|
|
546
|
-
* * `Child` - Copy the selected data with child record.
|
|
547
|
-
* * `Both` - Copy the selected data with both parent and child record.
|
|
548
|
-
* * `None` - Copy only the selected record.
|
|
549
|
-
*
|
|
550
|
-
* @default Parent
|
|
551
|
-
*/
|
|
552
|
-
copyHierarchyMode: CopyHierarchyType;
|
|
553
|
-
/**
|
|
554
|
-
* Defines the height of TreeGrid rows.
|
|
555
|
-
*
|
|
556
|
-
* @default null
|
|
557
|
-
*/
|
|
558
|
-
rowHeight: number;
|
|
559
|
-
/**
|
|
560
|
-
* If `enableAltRow` is set to true, the TreeGrid will render with `e-altrow` CSS class to the alternative tr elements.
|
|
561
|
-
* > Check the [`AltRow`](../../treegrid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
|
|
562
|
-
*
|
|
563
|
-
* @default true
|
|
564
|
-
*/
|
|
565
|
-
enableAltRow: boolean;
|
|
566
|
-
/**
|
|
567
|
-
* Enables or disables the key board interaction of TreeGrid.
|
|
568
|
-
*
|
|
569
|
-
* @hidden
|
|
570
|
-
* @default true
|
|
571
|
-
*/
|
|
572
|
-
allowKeyboard: boolean;
|
|
573
|
-
/**
|
|
574
|
-
* If `enableHover` is set to true, the row hover is enabled in the TreeGrid.
|
|
575
|
-
*
|
|
576
|
-
* @default false
|
|
577
|
-
*/
|
|
578
|
-
enableHover: boolean;
|
|
579
|
-
/**
|
|
580
|
-
* If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
|
|
581
|
-
* It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
|
|
582
|
-
*
|
|
583
|
-
* @default false
|
|
584
|
-
*/
|
|
585
|
-
enableAutoFill: boolean;
|
|
586
|
-
/**
|
|
587
|
-
* If `enableAdaptiveUI` is set to true, the pop-up UI will become adaptive to small screens,
|
|
588
|
-
* and be used for filtering and other features.
|
|
589
|
-
* ```html
|
|
590
|
-
* <div id='treegrid'></div>
|
|
591
|
-
* <script>
|
|
592
|
-
* var treegridObj = new TreeGrid({ enableAdaptiveUI: true });
|
|
593
|
-
* treegridObj.appendTo('#treegrid');
|
|
594
|
-
* </script>
|
|
595
|
-
* ```
|
|
596
|
-
*
|
|
597
|
-
* @default false
|
|
598
|
-
*/
|
|
599
|
-
enableAdaptiveUI: boolean;
|
|
600
|
-
/**
|
|
601
|
-
* If `enableImmutableMode` is set to true, the TreeGrid will reuse old rows if it exists in the new result instead of
|
|
602
|
-
* full refresh while performing the TreeGrid actions.
|
|
603
|
-
*
|
|
604
|
-
* @default false
|
|
605
|
-
*/
|
|
606
|
-
enableImmutableMode: boolean;
|
|
607
|
-
/**
|
|
608
|
-
* Defines the scrollable height of the TreeGrid content.
|
|
609
|
-
*
|
|
610
|
-
* @default 'auto'
|
|
611
|
-
*/
|
|
612
|
-
height: string | number;
|
|
613
|
-
/**
|
|
614
|
-
* Defines the TreeGrid width.
|
|
615
|
-
*
|
|
616
|
-
* @default 'auto'
|
|
617
|
-
*/
|
|
618
|
-
width: string | number;
|
|
619
|
-
/**
|
|
620
|
-
* Configures the loading indicator of the Tree Grid. Specifies whether to display spinner or shimmer effect
|
|
621
|
-
* during the waiting time on any actions (paging, sorting, filtering, CRUD operations) performed in Tree Grid.
|
|
622
|
-
*
|
|
623
|
-
* @default {indicatorType: 'Spinner'}
|
|
624
|
-
*/
|
|
625
|
-
loadingIndicator: LoadingIndicatorModel;
|
|
626
|
-
/**
|
|
627
|
-
* Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature.
|
|
628
|
-
* If disabled, spinner is shown instead of shimmer effect.
|
|
629
|
-
*
|
|
630
|
-
* @default true
|
|
631
|
-
*/
|
|
632
|
-
enableVirtualMaskRow: boolean;
|
|
633
|
-
/**
|
|
634
|
-
* If `enableVirtualization` set to true, then the TreeGrid will render only the rows visible within the view-port
|
|
635
|
-
* and load subsequent rows on vertical scrolling. This helps to load large dataset in TreeGrid.
|
|
636
|
-
*
|
|
637
|
-
* @default false
|
|
638
|
-
*/
|
|
639
|
-
enableVirtualization: boolean;
|
|
640
|
-
/**
|
|
641
|
-
* If `enableColumnVirtualization` set to true, then the Tree Grid will render only the columns visible within the view-port
|
|
642
|
-
* and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Tree Grid.
|
|
643
|
-
*
|
|
644
|
-
* @default false
|
|
645
|
-
*/
|
|
646
|
-
enableColumnVirtualization: boolean;
|
|
647
|
-
/**
|
|
648
|
-
* Specifies whether to display or remove the untrusted HTML values in the TreeGrid component.
|
|
649
|
-
* If `enableHtmlSanitizer` is set to true, then it will sanitize any suspected untrusted strings and scripts before rendering them.
|
|
650
|
-
*
|
|
651
|
-
* @default false
|
|
652
|
-
*/
|
|
653
|
-
enableHtmlSanitizer: boolean;
|
|
654
|
-
/**
|
|
655
|
-
* If `enableInfiniteScrolling` set to true, then the data will be loaded in TreeGrid when the scrollbar reaches the end.
|
|
656
|
-
* This helps to load large dataset in TreeGrid.
|
|
657
|
-
*
|
|
658
|
-
* @default false
|
|
659
|
-
|
|
660
|
-
*/
|
|
661
|
-
enableInfiniteScrolling: boolean;
|
|
662
|
-
/**
|
|
663
|
-
* Configures the infinite scroll settings.
|
|
664
|
-
*
|
|
665
|
-
* @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
|
|
666
|
-
|
|
667
|
-
*/
|
|
668
|
-
infiniteScrollSettings: InfiniteScrollSettingsModel;
|
|
669
|
-
/**
|
|
670
|
-
* `columnQueryMode`provides options to retrieves data from the data source.Their types are
|
|
671
|
-
* * `All`: It retrieves whole data source.
|
|
672
|
-
* * `Schema`: retrieves data for all the defined columns in TreeGrid from the data source.
|
|
673
|
-
* * `ExcludeHidden`: retrieves data only for visible columns of TreeGrid from the data Source.
|
|
674
|
-
*
|
|
675
|
-
* @default All
|
|
676
|
-
*/
|
|
677
|
-
columnQueryMode: ColumnQueryModeType;
|
|
678
|
-
/**
|
|
679
|
-
* Triggers when the component is created.
|
|
680
|
-
*
|
|
681
|
-
* @event created
|
|
682
|
-
*/
|
|
683
|
-
created: EmitType<Object>;
|
|
684
|
-
/**
|
|
685
|
-
* This event allows customization of TreeGrid properties before rendering.
|
|
686
|
-
*
|
|
687
|
-
* @event load
|
|
688
|
-
*/
|
|
689
|
-
load: EmitType<Object>;
|
|
690
|
-
/**
|
|
691
|
-
* Triggers while expanding the TreeGrid record
|
|
692
|
-
*
|
|
693
|
-
* @event expanding
|
|
694
|
-
*/
|
|
695
|
-
expanding: EmitType<RowExpandingEventArgs>;
|
|
696
|
-
/**
|
|
697
|
-
* Triggers after the record is expanded
|
|
698
|
-
*
|
|
699
|
-
* @event expanded
|
|
700
|
-
*/
|
|
701
|
-
expanded: EmitType<RowExpandedEventArgs>;
|
|
702
|
-
/**
|
|
703
|
-
* Triggers while collapsing the TreeGrid record
|
|
704
|
-
*
|
|
705
|
-
* @event collapsing
|
|
706
|
-
*/
|
|
707
|
-
collapsing: EmitType<RowCollapsingEventArgs>;
|
|
708
|
-
/**
|
|
709
|
-
* Triggers after the record is collapsed.
|
|
710
|
-
*
|
|
711
|
-
* @event collapsed
|
|
712
|
-
*/
|
|
713
|
-
collapsed: EmitType<RowCollapsedEventArgs>;
|
|
714
|
-
/**
|
|
715
|
-
* Triggers when cell is saved.
|
|
716
|
-
*
|
|
717
|
-
* @event cellSave
|
|
718
|
-
*/
|
|
719
|
-
cellSave: EmitType<CellSaveArgs>;
|
|
720
|
-
/**
|
|
721
|
-
* Triggers when cell is saved.
|
|
722
|
-
*
|
|
723
|
-
* @event cellSaved
|
|
724
|
-
*/
|
|
725
|
-
cellSaved: EmitType<CellSaveArgs>;
|
|
726
|
-
/**
|
|
727
|
-
* Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.
|
|
728
|
-
* @event actionBegin
|
|
729
|
-
*/
|
|
730
|
-
actionBegin: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
731
|
-
/**
|
|
732
|
-
* Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.
|
|
733
|
-
* @event actionComplete
|
|
734
|
-
*/
|
|
735
|
-
actionComplete: EmitType<PageEventArgs | FilterEventArgs | SortEventArgs | SearchEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs>;
|
|
736
|
-
/**
|
|
737
|
-
* Triggers before the record is to be edit.
|
|
738
|
-
* @event beginEdit
|
|
739
|
-
*/
|
|
740
|
-
beginEdit: EmitType<BeginEditArgs>;
|
|
741
|
-
/**
|
|
742
|
-
* Triggers when records are added in batch mode.
|
|
743
|
-
* @event batchAdd
|
|
744
|
-
*/
|
|
745
|
-
batchAdd: EmitType<BatchAddArgs>;
|
|
746
|
-
/**
|
|
747
|
-
* Triggers when records are deleted in batch mode.
|
|
748
|
-
* @event batchDelete
|
|
749
|
-
*/
|
|
750
|
-
batchDelete: EmitType<BatchDeleteArgs>;
|
|
751
|
-
/**
|
|
752
|
-
* Triggers before records are added in batch mode.
|
|
753
|
-
* @event batchCancel
|
|
754
|
-
*/
|
|
755
|
-
batchCancel: EmitType<BatchCancelArgs>;
|
|
756
|
-
/**
|
|
757
|
-
* Triggers before records are added in batch mode.
|
|
758
|
-
* @event beforeBatchAdd
|
|
759
|
-
*/
|
|
760
|
-
beforeBatchAdd: EmitType<BeforeBatchAddArgs>;
|
|
761
|
-
/**
|
|
762
|
-
* Triggers before records are deleted in batch mode.
|
|
763
|
-
* @event beforeBatchDelete
|
|
764
|
-
*/
|
|
765
|
-
beforeBatchDelete: EmitType<BeforeBatchDeleteArgs>;
|
|
766
|
-
/**
|
|
767
|
-
* Triggers before records are saved in batch mode.
|
|
768
|
-
* @event beforeBatchSave
|
|
769
|
-
*/
|
|
770
|
-
beforeBatchSave: EmitType<BeforeBatchSaveArgs>;
|
|
771
|
-
/**
|
|
772
|
-
* Triggers when the cell is being edited.
|
|
773
|
-
* @event cellEdit
|
|
774
|
-
*/
|
|
775
|
-
cellEdit: EmitType<CellEditArgs>;
|
|
776
|
-
/**
|
|
777
|
-
* Triggers when any TreeGrid action failed to achieve the desired results.
|
|
778
|
-
*
|
|
779
|
-
* @event actionFailure
|
|
780
|
-
*/
|
|
781
|
-
actionFailure: EmitType<FailureEventArgs>;
|
|
782
|
-
/**
|
|
783
|
-
* Triggers when data source is populated in the TreeGrid.
|
|
784
|
-
*
|
|
785
|
-
* @event dataBound
|
|
786
|
-
*/
|
|
787
|
-
dataBound: EmitType<Object>;
|
|
788
|
-
/**
|
|
789
|
-
* Triggers when the TreeGrid data is added, deleted and updated.
|
|
790
|
-
* Invoke the done method from the argument to start render after edit operation.
|
|
791
|
-
*
|
|
792
|
-
* @event dataSourceChanged
|
|
793
|
-
|
|
794
|
-
*/
|
|
795
|
-
dataSourceChanged: EmitType<DataSourceChangedEventArgs>;
|
|
796
|
-
/**
|
|
797
|
-
* Triggers when the TreeGrid actions such as Sorting, Paging etc., are done.
|
|
798
|
-
* In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
|
|
799
|
-
*
|
|
800
|
-
* @event dataStateChange
|
|
801
|
-
|
|
802
|
-
*/
|
|
803
|
-
dataStateChange: EmitType<DataStateChangeEventArgs>;
|
|
804
|
-
/**
|
|
805
|
-
* Triggers when record is double clicked.
|
|
806
|
-
*
|
|
807
|
-
* @event recordDoubleClick
|
|
808
|
-
*/
|
|
809
|
-
recordDoubleClick: EmitType<RecordDoubleClickEventArgs>;
|
|
810
|
-
/**
|
|
811
|
-
* Triggered every time a request is made to access row information, element, or data.
|
|
812
|
-
* This will be triggered before the row element is appended to the TreeGrid element.
|
|
813
|
-
*
|
|
814
|
-
* @event rowDataBound
|
|
815
|
-
*/
|
|
816
|
-
rowDataBound: EmitType<RowDataBoundEventArgs>;
|
|
817
|
-
/**
|
|
818
|
-
* Triggers after detail row expands.
|
|
819
|
-
* > This event triggers at initial expand.
|
|
820
|
-
*
|
|
821
|
-
* @event detailDataBound
|
|
822
|
-
*/
|
|
823
|
-
detailDataBound: EmitType<DetailDataBoundEventArgs>;
|
|
824
|
-
/**
|
|
825
|
-
* Triggered every time a request is made to access cell information, element, or data.
|
|
826
|
-
* This will be triggered before the cell element is appended to the TreeGrid element.
|
|
827
|
-
*
|
|
828
|
-
* @event queryCellInfo
|
|
829
|
-
*/
|
|
830
|
-
queryCellInfo: EmitType<QueryCellInfoEventArgs>;
|
|
831
|
-
/**
|
|
832
|
-
* If `allowSelection` is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.
|
|
833
|
-
*
|
|
834
|
-
* @default true
|
|
835
|
-
*/
|
|
836
|
-
allowSelection: boolean;
|
|
837
|
-
/**
|
|
838
|
-
* Triggers before row selection occurs.
|
|
839
|
-
*
|
|
840
|
-
* @event rowSelecting
|
|
841
|
-
*/
|
|
842
|
-
rowSelecting: EmitType<RowSelectingEventArgs>;
|
|
843
|
-
/**
|
|
844
|
-
* Triggers after a row is selected.
|
|
845
|
-
*
|
|
846
|
-
* @event rowSelected
|
|
847
|
-
*/
|
|
848
|
-
rowSelected: EmitType<RowSelectEventArgs>;
|
|
849
|
-
/**
|
|
850
|
-
* Triggers before deselecting the selected row.
|
|
851
|
-
*
|
|
852
|
-
* @event rowSelected
|
|
853
|
-
|
|
854
|
-
*/
|
|
855
|
-
rowDeselecting: EmitType<RowDeselectEventArgs>;
|
|
856
|
-
/**
|
|
857
|
-
* Triggers when a selected row is deselected.
|
|
858
|
-
*
|
|
859
|
-
* @event rowDeselected
|
|
860
|
-
*/
|
|
861
|
-
rowDeselected: EmitType<RowDeselectEventArgs>;
|
|
862
|
-
/**
|
|
863
|
-
* Triggered for stacked header.
|
|
864
|
-
*
|
|
865
|
-
* @event headerCellInfo
|
|
866
|
-
*/
|
|
867
|
-
headerCellInfo: EmitType<HeaderCellInfoEventArgs>;
|
|
868
|
-
/**
|
|
869
|
-
* Triggers before any cell selection occurs.
|
|
870
|
-
*
|
|
871
|
-
* @event cellSelecting
|
|
872
|
-
*/
|
|
873
|
-
cellSelecting: EmitType<CellSelectingEventArgs>;
|
|
874
|
-
/**
|
|
875
|
-
* Triggers before column menu opens.
|
|
876
|
-
*
|
|
877
|
-
* @event columnMenuOpen
|
|
878
|
-
|
|
879
|
-
*/
|
|
880
|
-
columnMenuOpen: EmitType<ColumnMenuOpenEventArgs>;
|
|
881
|
-
/**
|
|
882
|
-
* Triggers when click on column menu.
|
|
883
|
-
*
|
|
884
|
-
* @event columnMenuClick
|
|
885
|
-
*/
|
|
886
|
-
columnMenuClick: EmitType<MenuEventArgs>;
|
|
887
|
-
/**
|
|
888
|
-
* Triggers after a cell is selected.
|
|
889
|
-
*
|
|
890
|
-
* @event cellSelected
|
|
891
|
-
*/
|
|
892
|
-
cellSelected: EmitType<CellSelectEventArgs>;
|
|
893
|
-
/**
|
|
894
|
-
* Triggers before the selected cell is deselecting.
|
|
895
|
-
*
|
|
896
|
-
* @event cellDeselecting
|
|
897
|
-
|
|
898
|
-
*/
|
|
899
|
-
cellDeselecting: EmitType<CellDeselectEventArgs>;
|
|
900
|
-
/**
|
|
901
|
-
* Triggers when a particular selected cell is deselected.
|
|
902
|
-
*
|
|
903
|
-
* @event cellDeselected
|
|
904
|
-
|
|
905
|
-
*/
|
|
906
|
-
cellDeselected: EmitType<CellDeselectEventArgs>;
|
|
907
|
-
/**
|
|
908
|
-
* Triggers when column resize starts.
|
|
909
|
-
*
|
|
910
|
-
* @event resizeStart
|
|
911
|
-
|
|
912
|
-
*/
|
|
913
|
-
resizeStart: EmitType<ResizeArgs>;
|
|
914
|
-
/**
|
|
915
|
-
* Triggers on column resizing.
|
|
916
|
-
*
|
|
917
|
-
* @event resizing
|
|
918
|
-
|
|
919
|
-
*/
|
|
920
|
-
resizing: EmitType<ResizeArgs>;
|
|
921
|
-
/**
|
|
922
|
-
* Triggers when column resize ends.
|
|
923
|
-
*
|
|
924
|
-
* @event resizeStop
|
|
925
|
-
|
|
926
|
-
*/
|
|
927
|
-
resizeStop: EmitType<ResizeArgs>;
|
|
928
|
-
/**
|
|
929
|
-
* Triggers when column header element drag (move) starts.
|
|
930
|
-
*
|
|
931
|
-
* @event columnDragStart
|
|
932
|
-
|
|
933
|
-
*/
|
|
934
|
-
columnDragStart: EmitType<ColumnDragEventArgs>;
|
|
935
|
-
/**
|
|
936
|
-
* Triggers when column header element is dragged (moved) continuously.
|
|
937
|
-
*
|
|
938
|
-
* @event columnDrag
|
|
939
|
-
|
|
940
|
-
*/
|
|
941
|
-
columnDrag: EmitType<ColumnDragEventArgs>;
|
|
942
|
-
/**
|
|
943
|
-
* Triggers when a column header element is dropped on the target column.
|
|
944
|
-
*
|
|
945
|
-
* @event columnDrop
|
|
946
|
-
|
|
947
|
-
*/
|
|
948
|
-
columnDrop: EmitType<ColumnDragEventArgs>;
|
|
949
|
-
/**
|
|
950
|
-
* Triggers when the check box state change in checkbox column.
|
|
951
|
-
*
|
|
952
|
-
* @event checkboxChange
|
|
953
|
-
|
|
954
|
-
*/
|
|
955
|
-
checkboxChange: EmitType<CheckBoxChangeEventArgs>;
|
|
956
|
-
/**
|
|
957
|
-
* Triggers after print action is completed.
|
|
958
|
-
*
|
|
959
|
-
* @event printComplete
|
|
960
|
-
|
|
961
|
-
*/
|
|
962
|
-
printComplete: EmitType<PrintEventArgs>;
|
|
963
|
-
/**
|
|
964
|
-
* Triggers before the print action starts.
|
|
965
|
-
*
|
|
966
|
-
* @event beforePrint
|
|
967
|
-
|
|
968
|
-
*/
|
|
969
|
-
beforePrint: EmitType<PrintEventArgs>;
|
|
970
|
-
/**
|
|
971
|
-
* Triggers when toolbar item is clicked.
|
|
972
|
-
*
|
|
973
|
-
* @event toolbarClick
|
|
974
|
-
*/
|
|
975
|
-
toolbarClick: EmitType<ClickEventArgs>;
|
|
976
|
-
/**
|
|
977
|
-
* Triggers before data is bound to Tree Grid.
|
|
978
|
-
*
|
|
979
|
-
* @event beforeDataBound
|
|
980
|
-
*/
|
|
981
|
-
beforeDataBound: EmitType<BeforeDataBoundArgs>;
|
|
982
|
-
/**
|
|
983
|
-
* Triggers before context menu opens.
|
|
984
|
-
*
|
|
985
|
-
* @event contextMenuOpen
|
|
986
|
-
|
|
987
|
-
*/
|
|
988
|
-
contextMenuOpen: EmitType<BeforeOpenCloseMenuEventArgs>;
|
|
989
|
-
/**
|
|
990
|
-
* Triggers when click on context menu.
|
|
991
|
-
*
|
|
992
|
-
* @event contextMenuClick
|
|
993
|
-
*/
|
|
994
|
-
contextMenuClick: EmitType<MenuEventArgs>;
|
|
995
|
-
/**
|
|
996
|
-
* Triggers before TreeGrid copy action.
|
|
997
|
-
*
|
|
998
|
-
* @event beforeCopy
|
|
999
|
-
|
|
1000
|
-
*/
|
|
1001
|
-
beforeCopy: EmitType<BeforeCopyEventArgs>;
|
|
1002
|
-
/**
|
|
1003
|
-
* Triggers before TreeGrid paste action.
|
|
1004
|
-
*
|
|
1005
|
-
* @event beforePaste
|
|
1006
|
-
|
|
1007
|
-
*/
|
|
1008
|
-
beforePaste: EmitType<BeforePasteEventArgs>;
|
|
1009
|
-
/**
|
|
1010
|
-
* Triggers when row elements are dragged (moved) continuously.
|
|
1011
|
-
*
|
|
1012
|
-
* @event rowDrag
|
|
1013
|
-
|
|
1014
|
-
*/
|
|
1015
|
-
rowDrag: EmitType<RowDragEventArgs>;
|
|
1016
|
-
/**
|
|
1017
|
-
* Triggers when row element’s drag(move) starts.
|
|
1018
|
-
*
|
|
1019
|
-
* @event rowDragStart
|
|
1020
|
-
|
|
1021
|
-
*/
|
|
1022
|
-
rowDragStart: EmitType<RowDragEventArgs>;
|
|
1023
|
-
/**
|
|
1024
|
-
* Triggers when row element’s before drag(move).
|
|
1025
|
-
*
|
|
1026
|
-
* @event rowDragStartHelper
|
|
1027
|
-
|
|
1028
|
-
*/
|
|
1029
|
-
rowDragStartHelper: EmitType<RowDragEventArgs>;
|
|
1030
|
-
/**
|
|
1031
|
-
* Triggers when row elements are dropped on the target row.
|
|
1032
|
-
*
|
|
1033
|
-
* @event rowDrop
|
|
1034
|
-
|
|
1035
|
-
*/
|
|
1036
|
-
rowDrop: EmitType<RowDragEventArgs>;
|
|
1037
|
-
/**
|
|
1038
|
-
* The `selectedRowIndex` allows you to select a row at initial rendering.
|
|
1039
|
-
* You can also get the currently selected row index.
|
|
1040
|
-
*
|
|
1041
|
-
* @default -1
|
|
1042
|
-
*/
|
|
1043
|
-
selectedRowIndex: number;
|
|
1044
|
-
/**
|
|
1045
|
-
* Configures the selection settings.
|
|
1046
|
-
*
|
|
1047
|
-
* @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
|
|
1048
|
-
*/
|
|
1049
|
-
selectionSettings: SelectionSettingsModel;
|
|
1050
|
-
/**
|
|
1051
|
-
* If `allowExcelExport` set to true, then it will allow the user to export treegrid to Excel file.
|
|
1052
|
-
*
|
|
1053
|
-
* > Check the [`ExcelExport`](../../treegrid/excel-export/) to configure exporting document.
|
|
1054
|
-
*
|
|
1055
|
-
* @default false
|
|
1056
|
-
*/
|
|
1057
|
-
allowExcelExport: boolean;
|
|
1058
|
-
/**
|
|
1059
|
-
* If `allowPdfExport` set to true, then it will allow the user to export treegrid to Pdf file.
|
|
1060
|
-
*
|
|
1061
|
-
* > Check the [`Pdfexport`](../../treegrid/pdf-export/) to configure the exporting document.
|
|
1062
|
-
*
|
|
1063
|
-
* @default false
|
|
1064
|
-
*/
|
|
1065
|
-
allowPdfExport: boolean;
|
|
1066
|
-
/**
|
|
1067
|
-
* Triggers before exporting each cell to PDF document.
|
|
1068
|
-
* You can also customize the PDF cells.
|
|
1069
|
-
*
|
|
1070
|
-
* @event pdfQueryCellInfo
|
|
1071
|
-
|
|
1072
|
-
*/
|
|
1073
|
-
pdfQueryCellInfo: EmitType<PdfQueryCellInfoEventArgs>;
|
|
1074
|
-
/**
|
|
1075
|
-
* Triggers before exporting each header cell to PDF document.
|
|
1076
|
-
* You can also customize the PDF cells.
|
|
1077
|
-
*
|
|
1078
|
-
* @event pdfHeaderQueryCellInfo
|
|
1079
|
-
|
|
1080
|
-
*/
|
|
1081
|
-
pdfHeaderQueryCellInfo: EmitType<PdfHeaderQueryCellInfoEventArgs>;
|
|
1082
|
-
/**
|
|
1083
|
-
* Triggers before exporting each cell to Excel file.
|
|
1084
|
-
* You can also customize the Excel cells.
|
|
1085
|
-
*
|
|
1086
|
-
* @event excelQueryCellInfo
|
|
1087
|
-
|
|
1088
|
-
*/
|
|
1089
|
-
excelQueryCellInfo: EmitType<ExcelQueryCellInfoEventArgs>;
|
|
1090
|
-
/**
|
|
1091
|
-
* Triggers before exporting each header cell to Excel file.
|
|
1092
|
-
* You can also customize the Excel cells.
|
|
1093
|
-
*
|
|
1094
|
-
* @event excelHeaderQueryCellInfo
|
|
1095
|
-
|
|
1096
|
-
*/
|
|
1097
|
-
excelHeaderQueryCellInfo: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
|
|
1098
|
-
/**
|
|
1099
|
-
* Triggers before TreeGrid data is exported to Excel file.
|
|
1100
|
-
*
|
|
1101
|
-
* @event beforeExcelExport
|
|
1102
|
-
*/
|
|
1103
|
-
beforeExcelExport: EmitType<Object>;
|
|
1104
|
-
/**
|
|
1105
|
-
* Triggers after TreeGrid data is exported to Excel file.
|
|
1106
|
-
*
|
|
1107
|
-
* @event excelExportComplete
|
|
1108
|
-
|
|
1109
|
-
*/
|
|
1110
|
-
excelExportComplete: EmitType<ExcelExportCompleteArgs>;
|
|
1111
|
-
/**
|
|
1112
|
-
* Triggers before TreeGrid data is exported to PDF document.
|
|
1113
|
-
*
|
|
1114
|
-
* @event beforePdfExport
|
|
1115
|
-
*/
|
|
1116
|
-
beforePdfExport: EmitType<Object>;
|
|
1117
|
-
/**
|
|
1118
|
-
* Triggers after TreeGrid data is exported to PDF document.
|
|
1119
|
-
*
|
|
1120
|
-
* @event pdfExportComplete
|
|
1121
|
-
|
|
1122
|
-
*/
|
|
1123
|
-
pdfExportComplete: EmitType<PdfExportCompleteArgs>;
|
|
1124
|
-
/**
|
|
1125
|
-
* Export TreeGrid data to Excel file(.xlsx).
|
|
1126
|
-
*
|
|
1127
|
-
* @param {ExcelExportProperties | TreeGridExcelExportProperties} excelExportProperties - Defines the export properties of the Tree Grid.
|
|
1128
|
-
* @param {boolean} isMultipleExport - Define to enable multiple export.
|
|
1129
|
-
* @param {workbook} workbook - Defines the Workbook if multiple export is enabled.
|
|
1130
|
-
* @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
|
|
1131
|
-
* @returns {Promise<any>} - Returns promise object of export action
|
|
1132
|
-
*/
|
|
1133
|
-
excelExport(excelExportProperties?: ExcelExportProperties | TreeGridExcelExportProperties, isMultipleExport?: boolean, workbook?: any, isBlob?: boolean): Promise<any>;
|
|
1134
|
-
/**
|
|
1135
|
-
* Export TreeGrid data to CSV file.
|
|
1136
|
-
*
|
|
1137
|
-
* @param {ExcelExportProperties} excelExportProperties - Defines the export properties of the TreeGrid.
|
|
1138
|
-
* @param {boolean} isMultipleExport - Define to enable multiple export.
|
|
1139
|
-
* @param {workbook} workbook - Defines the Workbook if multiple export is enabled.
|
|
1140
|
-
* @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
|
|
1141
|
-
* @returns {Promise<any>} - Returns promise object of export action
|
|
1142
|
-
*/
|
|
1143
|
-
csvExport(excelExportProperties?: ExcelExportProperties, isMultipleExport?: boolean, workbook?: any, isBlob?: boolean): Promise<any>;
|
|
1144
|
-
/**
|
|
1145
|
-
* Export TreeGrid data to PDF document.
|
|
1146
|
-
*
|
|
1147
|
-
* @param {PdfExportProperties | TreeGridPdfExportProperties} pdfExportProperties - Defines the export properties of the Tree Grid.
|
|
1148
|
-
* @param {boolean} isMultipleExport - Define to enable multiple export.
|
|
1149
|
-
* @param {Object} pdfDoc - Defined the Pdf Document if multiple export is enabled.
|
|
1150
|
-
* @param {boolean} isBlob - If 'isBlob' set to true, then it will be returned as blob data.
|
|
1151
|
-
* @returns {Promise<any>} - Returns promise object of export action
|
|
1152
|
-
*/
|
|
1153
|
-
pdfExport(pdfExportProperties?: PdfExportProperties | TreeGridPdfExportProperties, isMultipleExport?: boolean, pdfDoc?: Object, isBlob?: boolean): Promise<Object>;
|
|
1154
|
-
/**
|
|
1155
|
-
* Sends a post request to export tree grid to excel file in server side.
|
|
1156
|
-
*
|
|
1157
|
-
* @param {string} url - Pass URL for server side excel export action.
|
|
1158
|
-
* @returns {void}
|
|
1159
|
-
*/
|
|
1160
|
-
serverExcelExport(url: string): void;
|
|
1161
|
-
/**
|
|
1162
|
-
* Sends a post request to export tree grid to pdf file in server side.
|
|
1163
|
-
*
|
|
1164
|
-
* @param {string} url - Pass URL for server-side pdf export action.
|
|
1165
|
-
* @returns {void}
|
|
1166
|
-
*/
|
|
1167
|
-
serverPdfExport(url: string): void;
|
|
1168
|
-
/**
|
|
1169
|
-
* Sends a Post request to export Tree Grid to CSV file in server side.
|
|
1170
|
-
*
|
|
1171
|
-
* @param {string} url - Pass URL for server-side csv export action.
|
|
1172
|
-
* @returns {void}
|
|
1173
|
-
*/
|
|
1174
|
-
serverCsvExport(url: string): void;
|
|
1175
|
-
/**
|
|
1176
|
-
* Exports the TreeGrid data to the specified URL using a POST request.
|
|
1177
|
-
* @param {string} url - Defines exporting url
|
|
1178
|
-
* @returns {void}
|
|
1179
|
-
*/
|
|
1180
|
-
private exportTreeGrid;
|
|
1181
|
-
/**
|
|
1182
|
-
* Sets the header text and other properties for an array of columns based on specified criteria.
|
|
1183
|
-
* @param {Column[]} columns - Defines array of columns
|
|
1184
|
-
* @param {string[]} include - Defines array of sting
|
|
1185
|
-
* @returns {Column[]} returns array of columns
|
|
1186
|
-
*/
|
|
1187
|
-
private setHeaderText;
|
|
1188
|
-
/**
|
|
1189
|
-
* Retrieves the appropriate format string from the given format options.
|
|
1190
|
-
*
|
|
1191
|
-
* @param {string | NumberFormatOptions | DateFormatOptions} format - The format options to retrieve the format string from.
|
|
1192
|
-
* @returns {string} The format string extracted from the provided format options.
|
|
1193
|
-
*/
|
|
1194
|
-
private getFormat;
|
|
1195
|
-
/**
|
|
1196
|
-
* For internal use only - Get the module name.
|
|
1197
|
-
*
|
|
1198
|
-
* @private
|
|
1199
|
-
* @returns {string} Returns TreeGrid module name
|
|
1200
|
-
*/
|
|
1201
|
-
protected getModuleName(): string;
|
|
1202
|
-
/**
|
|
1203
|
-
* For internal use only - Initialize the event handler;
|
|
1204
|
-
*
|
|
1205
|
-
* @private
|
|
1206
|
-
* @returns {void}
|
|
1207
|
-
*/
|
|
1208
|
-
protected preRender(): void;
|
|
1209
|
-
/**
|
|
1210
|
-
* Sorts a column with the given options.
|
|
1211
|
-
*
|
|
1212
|
-
* @param {string} columnName - Defines the column name to be sorted.
|
|
1213
|
-
* @param {SortDirection} direction - Defines the direction of sorting field.
|
|
1214
|
-
* @param {boolean} isMultiSort - Specifies whether the previous sorted columns are to be maintained.
|
|
1215
|
-
* @returns {void}
|
|
1216
|
-
*/
|
|
1217
|
-
sortByColumn(columnName: string, direction: SortDirection, isMultiSort?: boolean): void;
|
|
1218
|
-
/**
|
|
1219
|
-
* Clears all the sorted columns of the TreeGrid.
|
|
1220
|
-
*
|
|
1221
|
-
* @returns {void}
|
|
1222
|
-
*/
|
|
1223
|
-
clearSorting(): void;
|
|
1224
|
-
/**
|
|
1225
|
-
* Remove sorted column by field name.
|
|
1226
|
-
*
|
|
1227
|
-
* @param {string} field - Defines the column field name to remove sort.
|
|
1228
|
-
* @returns {void}
|
|
1229
|
-
* @hidden
|
|
1230
|
-
*/
|
|
1231
|
-
removeSortColumn(field: string): void;
|
|
1232
|
-
/**
|
|
1233
|
-
* Searches TreeGrid records using the given key.
|
|
1234
|
-
* You can customize the default search option by using the
|
|
1235
|
-
* [`searchSettings`](./#searchsettings/).
|
|
1236
|
-
*
|
|
1237
|
-
* @param {string} searchString - Defines the key.
|
|
1238
|
-
* @returns {void}
|
|
1239
|
-
*/
|
|
1240
|
-
search(searchString: string): void;
|
|
1241
|
-
/**
|
|
1242
|
-
* Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.
|
|
1243
|
-
* > * This method ignores the hidden columns.
|
|
1244
|
-
* > * Uses the `autoFitColumns` method in the `dataBound` event to resize at initial rendering.
|
|
1245
|
-
*
|
|
1246
|
-
* @param {string |string[]} fieldNames - Defines the column names.
|
|
1247
|
-
* @returns {void}
|
|
1248
|
-
*
|
|
1249
|
-
*
|
|
1250
|
-
*
|
|
1251
|
-
*/
|
|
1252
|
-
autoFitColumns(fieldNames?: string | string[]): void;
|
|
1253
|
-
/**
|
|
1254
|
-
* Changes the TreeGrid column positions by field names.
|
|
1255
|
-
*
|
|
1256
|
-
* @param {string} fromFName - Defines the origin field name.
|
|
1257
|
-
* @param {string} toFName - Defines the destination field name.
|
|
1258
|
-
* @returns {void}
|
|
1259
|
-
*/
|
|
1260
|
-
reorderColumns(fromFName: string | string[], toFName: string): void;
|
|
1261
|
-
private TreeGridLocale;
|
|
1262
|
-
/**
|
|
1263
|
-
* By default, prints all the pages of the TreeGrid and hides the pager.
|
|
1264
|
-
* > You can customize print options using the
|
|
1265
|
-
* [`printMode`](./#printmode).
|
|
1266
|
-
*
|
|
1267
|
-
* @returns {void}
|
|
1268
|
-
*/
|
|
1269
|
-
print(): void;
|
|
1270
|
-
private treeGridkeyActionHandler;
|
|
1271
|
-
private findnextRowElement;
|
|
1272
|
-
private findPreviousRowElement;
|
|
1273
|
-
private initProperties;
|
|
1274
|
-
/**
|
|
1275
|
-
* Binding events to the element while component creation.
|
|
1276
|
-
*
|
|
1277
|
-
* @hidden
|
|
1278
|
-
* @returns {void}
|
|
1279
|
-
*/
|
|
1280
|
-
wireEvents(): void;
|
|
1281
|
-
/**
|
|
1282
|
-
* To provide the array of modules needed for component rendering
|
|
1283
|
-
*
|
|
1284
|
-
* @returns {ModuleDeclaration[]} - Returns TreeGrid modules collection
|
|
1285
|
-
* @hidden
|
|
1286
|
-
*/
|
|
1287
|
-
requiredModules(): ModuleDeclaration[];
|
|
1288
|
-
extendRequiredModules(modules: ModuleDeclaration[]): void;
|
|
1289
|
-
private isCommandColumn;
|
|
1290
|
-
/**
|
|
1291
|
-
* Unbinding events from the element while component destroy.
|
|
1292
|
-
*
|
|
1293
|
-
* @hidden
|
|
1294
|
-
* @returns {void}
|
|
1295
|
-
*/
|
|
1296
|
-
unwireEvents(): void;
|
|
1297
|
-
/**
|
|
1298
|
-
* Logs tree grid error message on console
|
|
1299
|
-
*
|
|
1300
|
-
* @param {string | string[]} types - Tree Grid error type
|
|
1301
|
-
* @param {object} args - Error details
|
|
1302
|
-
* @hidden
|
|
1303
|
-
* @private
|
|
1304
|
-
* @returns {void}
|
|
1305
|
-
*/
|
|
1306
|
-
log(types: string | string[], args?: Object): void;
|
|
1307
|
-
/**
|
|
1308
|
-
* For internal use only - To Initialize the component rendering.
|
|
1309
|
-
*
|
|
1310
|
-
* @private
|
|
1311
|
-
* @returns {void}
|
|
1312
|
-
*/
|
|
1313
|
-
protected render(): void;
|
|
1314
|
-
private refreshToolbarItems;
|
|
1315
|
-
private afterGridRender;
|
|
1316
|
-
private convertTreeData;
|
|
1317
|
-
private bindGridProperties;
|
|
1318
|
-
private triggerEvents;
|
|
1319
|
-
private IsExpandCollapseClicked;
|
|
1320
|
-
private bindGridEvents;
|
|
1321
|
-
private lastRowBorder;
|
|
1322
|
-
private isPixelHeight;
|
|
1323
|
-
private extendedGridDataBoundEvent;
|
|
1324
|
-
private objectEqualityChecker;
|
|
1325
|
-
private bindCallBackEvents;
|
|
1326
|
-
private extendedGridEditEvents;
|
|
1327
|
-
private updateRowTemplate;
|
|
1328
|
-
private bindedDataSource;
|
|
1329
|
-
private extendedGridActionEvents;
|
|
1330
|
-
private extendedGridEvents;
|
|
1331
|
-
private bindGridDragEvents;
|
|
1332
|
-
/**
|
|
1333
|
-
* Renders TreeGrid component
|
|
1334
|
-
*
|
|
1335
|
-
* @private
|
|
1336
|
-
* @returns {void}
|
|
1337
|
-
*/
|
|
1338
|
-
protected loadGrid(): void;
|
|
1339
|
-
/**
|
|
1340
|
-
* AutoGenerate TreeGrid columns from first record
|
|
1341
|
-
*
|
|
1342
|
-
* @hidden
|
|
1343
|
-
* @returns {void}
|
|
1344
|
-
*/
|
|
1345
|
-
private autoGenerateColumns;
|
|
1346
|
-
private getGridEditSettings;
|
|
1347
|
-
/**
|
|
1348
|
-
* Defines grid toolbar from treegrid toolbar model
|
|
1349
|
-
*
|
|
1350
|
-
* @hidden
|
|
1351
|
-
* @returns {Object[]} - returns context menu items
|
|
1352
|
-
*/
|
|
1353
|
-
private getContextMenu;
|
|
1354
|
-
/**
|
|
1355
|
-
* Defines grid toolbar from treegrid toolbar model
|
|
1356
|
-
*
|
|
1357
|
-
* @hidden
|
|
1358
|
-
* @returns {Object[]} - Returns toolbar items
|
|
1359
|
-
*/
|
|
1360
|
-
private getGridToolbar;
|
|
1361
|
-
private getGridColumns;
|
|
1362
|
-
/**
|
|
1363
|
-
* Called internally if any of the property value changed.
|
|
1364
|
-
*
|
|
1365
|
-
* @param {TreeGridModel} newProp - properties details which has to be modified
|
|
1366
|
-
* @hidden
|
|
1367
|
-
* @returns {void}
|
|
1368
|
-
*/
|
|
1369
|
-
onPropertyChanged(newProp: TreeGridModel): void;
|
|
1370
|
-
private updateTreeColumnTextAlign;
|
|
1371
|
-
/**
|
|
1372
|
-
* Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).
|
|
1373
|
-
*
|
|
1374
|
-
* @method destroy
|
|
1375
|
-
* @returns {void}
|
|
1376
|
-
*/
|
|
1377
|
-
destroy(): void;
|
|
1378
|
-
/**
|
|
1379
|
-
* Update the TreeGrid model
|
|
1380
|
-
*
|
|
1381
|
-
* @method dataBind
|
|
1382
|
-
* @returns {void}
|
|
1383
|
-
* @private
|
|
1384
|
-
*/
|
|
1385
|
-
dataBind(): void;
|
|
1386
|
-
/**
|
|
1387
|
-
* Get the properties to be maintained in the persisted state.
|
|
1388
|
-
*
|
|
1389
|
-
* @returns {string} - Returns persist properties details
|
|
1390
|
-
* @hidden
|
|
1391
|
-
*/
|
|
1392
|
-
getPersistData(): string;
|
|
1393
|
-
private ignoreInArrays;
|
|
1394
|
-
private ignoreInColumn;
|
|
1395
|
-
private mouseClickHandler;
|
|
1396
|
-
/**
|
|
1397
|
-
* Returns TreeGrid rows
|
|
1398
|
-
*
|
|
1399
|
-
* @returns {HTMLTableRowElement[]} - Returns row elements collection
|
|
1400
|
-
*/
|
|
1401
|
-
getRows(): HTMLTableRowElement[];
|
|
1402
|
-
/**
|
|
1403
|
-
* Gets the pager of the TreeGrid.
|
|
1404
|
-
*
|
|
1405
|
-
* @returns {Element} - Returns pager element
|
|
1406
|
-
*/
|
|
1407
|
-
getPager(): Element;
|
|
1408
|
-
/**
|
|
1409
|
-
* Adds a new record to the TreeGrid. Without passing parameters, it adds empty rows.
|
|
1410
|
-
* > `editSettings.allowEditing` should be true.
|
|
1411
|
-
*
|
|
1412
|
-
* @param {Object} data - Defines the new add record data.
|
|
1413
|
-
* @param {number} index - Defines the row index to be added.
|
|
1414
|
-
* @param {RowPosition} position - Defines the new row position to be added.
|
|
1415
|
-
* @returns {void}
|
|
1416
|
-
*/
|
|
1417
|
-
addRecord(data?: Object, index?: number, position?: RowPosition): void;
|
|
1418
|
-
/**
|
|
1419
|
-
* Cancels edited state.
|
|
1420
|
-
*
|
|
1421
|
-
* @returns {void}
|
|
1422
|
-
*/
|
|
1423
|
-
closeEdit(): void;
|
|
1424
|
-
/**
|
|
1425
|
-
* Saves the cell that is currently edited. It does not save the value to the DataSource.
|
|
1426
|
-
*
|
|
1427
|
-
* @returns {void}
|
|
1428
|
-
*/
|
|
1429
|
-
saveCell(): void;
|
|
1430
|
-
/**
|
|
1431
|
-
* To update the specified cell by given value without changing into edited state.
|
|
1432
|
-
*
|
|
1433
|
-
* @param {number} rowIndex Defines the row index.
|
|
1434
|
-
* @param {string} field Defines the column field.
|
|
1435
|
-
* @param {string | number | boolean | Date} value - Defines the value to be changed.
|
|
1436
|
-
* @returns {void}
|
|
1437
|
-
*/
|
|
1438
|
-
updateCell(rowIndex: number, field: string, value: string | number | boolean | Date): void;
|
|
1439
|
-
/**
|
|
1440
|
-
* To update the specified row by given values without changing into edited state.
|
|
1441
|
-
*
|
|
1442
|
-
* @param {number} index Defines the row index.
|
|
1443
|
-
* @param {Object} data Defines the data object to be updated.
|
|
1444
|
-
* @returns {void}
|
|
1445
|
-
*/
|
|
1446
|
-
updateRow(index: number, data: Object): void;
|
|
1447
|
-
/**
|
|
1448
|
-
* Delete a record with Given options. If fieldName and data is not given then TreeGrid will delete the selected record.
|
|
1449
|
-
* > `editSettings.allowDeleting` should be true.
|
|
1450
|
-
*
|
|
1451
|
-
* @param {string} fieldName - Defines the primary key field, 'Name of the column'.
|
|
1452
|
-
* @param {Object} data - Defines the JSON data of the record to be deleted.
|
|
1453
|
-
* @returns {void}
|
|
1454
|
-
*/
|
|
1455
|
-
deleteRecord(fieldName?: string, data?: Object): void;
|
|
1456
|
-
/**
|
|
1457
|
-
* To edit any particular row by TR element.
|
|
1458
|
-
*
|
|
1459
|
-
* @param {HTMLTableRowElement} row - Defines the table row to be edited.
|
|
1460
|
-
* @returns {void}
|
|
1461
|
-
*/
|
|
1462
|
-
startEdit(row?: HTMLTableRowElement): void;
|
|
1463
|
-
/**
|
|
1464
|
-
* To edit any particular cell using row index and cell index.
|
|
1465
|
-
*
|
|
1466
|
-
* @param {number} rowIndex - Defines row index to edit a particular cell.
|
|
1467
|
-
* @param {string} field - Defines the field name of the column to perform cell edit.
|
|
1468
|
-
* @returns {void}
|
|
1469
|
-
*/
|
|
1470
|
-
editCell(rowIndex?: number, field?: string): void;
|
|
1471
|
-
/**
|
|
1472
|
-
* Enables or disables ToolBar items.
|
|
1473
|
-
*
|
|
1474
|
-
* @param {string[]} items - Defines the collection of itemID of ToolBar items.
|
|
1475
|
-
* @param {boolean} isEnable - Defines the items to be enabled or disabled.
|
|
1476
|
-
* @returns {void}
|
|
1477
|
-
*/
|
|
1478
|
-
enableToolbarItems(items: string[], isEnable: boolean): void;
|
|
1479
|
-
/**
|
|
1480
|
-
* If TreeGrid is in editable state, you can save a record by invoking endEdit.
|
|
1481
|
-
*
|
|
1482
|
-
* @returns {void}
|
|
1483
|
-
*/
|
|
1484
|
-
endEdit(): void;
|
|
1485
|
-
/**
|
|
1486
|
-
* Column chooser can be displayed on screen by given position(X and Y axis).
|
|
1487
|
-
*
|
|
1488
|
-
* @param {number} x - Defines the X axis.
|
|
1489
|
-
* @param {number} y - Defines the Y axis.
|
|
1490
|
-
* @returns {void}
|
|
1491
|
-
*/
|
|
1492
|
-
openColumnChooser(x?: number, y?: number): void;
|
|
1493
|
-
/**
|
|
1494
|
-
* Delete any visible row by TR element.
|
|
1495
|
-
*
|
|
1496
|
-
* @param {HTMLTableRowElement} tr - Defines the table row element.
|
|
1497
|
-
* @returns {void}
|
|
1498
|
-
*/
|
|
1499
|
-
deleteRow(tr: HTMLTableRowElement): void;
|
|
1500
|
-
/**
|
|
1501
|
-
* Get the names of the primary key columns of the TreeGrid.
|
|
1502
|
-
*
|
|
1503
|
-
* @returns {string[]} - Returns primary key collection
|
|
1504
|
-
*/
|
|
1505
|
-
getPrimaryKeyFieldNames(): string[];
|
|
1506
|
-
/**
|
|
1507
|
-
* Updates particular cell value based on the given primary key value.
|
|
1508
|
-
* > Primary key column must be specified using `columns.isPrimaryKey` property.
|
|
1509
|
-
*
|
|
1510
|
-
* @param {string| number} key - Specifies the PrimaryKey value of dataSource.
|
|
1511
|
-
* @param {string } field - Specifies the field name which you want to update.
|
|
1512
|
-
* @param {string | number | boolean | Date} value - To update new value for the particular cell.
|
|
1513
|
-
* @returns {void}
|
|
1514
|
-
*/
|
|
1515
|
-
setCellValue(key: string | number, field: string, value: string | number | boolean | Date): void;
|
|
1516
|
-
/**
|
|
1517
|
-
* Updates and refresh the particular row values based on the given primary key value.
|
|
1518
|
-
* > Primary key column must be specified using `columns.isPrimaryKey` property.
|
|
1519
|
-
*
|
|
1520
|
-
* @param {string| number} key - Specifies the PrimaryKey value of dataSource.
|
|
1521
|
-
* @param {Object} rowData - To update new data for the particular row.
|
|
1522
|
-
* @returns {void}
|
|
1523
|
-
*/
|
|
1524
|
-
setRowData(key: string | number, rowData?: ITreeData): void;
|
|
1525
|
-
/**
|
|
1526
|
-
* Navigates to the specified target page.
|
|
1527
|
-
*
|
|
1528
|
-
* @param {number} pageNo - Defines the page number to navigate.
|
|
1529
|
-
* @returns {void}
|
|
1530
|
-
*/
|
|
1531
|
-
goToPage(pageNo: number): void;
|
|
1532
|
-
/**
|
|
1533
|
-
* Defines the text of external message.
|
|
1534
|
-
*
|
|
1535
|
-
* @param {string} message - Defines the message to update.
|
|
1536
|
-
* @returns {void}
|
|
1537
|
-
*/
|
|
1538
|
-
updateExternalMessage(message: string): void;
|
|
1539
|
-
/**
|
|
1540
|
-
* Gets a cell by row and column index.
|
|
1541
|
-
*
|
|
1542
|
-
* @param {number} rowIndex - Specifies the row index.
|
|
1543
|
-
* @param {number} columnIndex - Specifies the column index.
|
|
1544
|
-
* @returns {Element} - Returns cell element in grid content
|
|
1545
|
-
*/
|
|
1546
|
-
getCellFromIndex(rowIndex: number, columnIndex: number): Element;
|
|
1547
|
-
/**
|
|
1548
|
-
* Gets a Column by column name.
|
|
1549
|
-
*
|
|
1550
|
-
* @param {string} field - Specifies the column name.
|
|
1551
|
-
* @returns {Column} - Returns tree grid column
|
|
1552
|
-
*/
|
|
1553
|
-
getColumnByField(field: string): Column;
|
|
1554
|
-
/**
|
|
1555
|
-
* Gets a column by UID.
|
|
1556
|
-
*
|
|
1557
|
-
* @param {string} uid - Specifies the column UID.
|
|
1558
|
-
* @returns {Column} - Returns tree grid column
|
|
1559
|
-
*/
|
|
1560
|
-
getColumnByUid(uid: string): Column;
|
|
1561
|
-
/**
|
|
1562
|
-
* Gets the collection of column fields.
|
|
1563
|
-
*
|
|
1564
|
-
* @returns {string[]} - Returns column field name as collection
|
|
1565
|
-
*/
|
|
1566
|
-
getColumnFieldNames(): string[];
|
|
1567
|
-
/**
|
|
1568
|
-
* Gets the footer div of the TreeGrid.
|
|
1569
|
-
*
|
|
1570
|
-
* @returns {Element} - Returns footer content div element
|
|
1571
|
-
*/
|
|
1572
|
-
getFooterContent(): Element;
|
|
1573
|
-
/**
|
|
1574
|
-
* Gets the footer table element of the TreeGrid.
|
|
1575
|
-
*
|
|
1576
|
-
* @returns {Element} - Returns footer content table element
|
|
1577
|
-
*/
|
|
1578
|
-
getFooterContentTable(): Element;
|
|
1579
|
-
/**
|
|
1580
|
-
* Shows a column by its column name.
|
|
1581
|
-
*
|
|
1582
|
-
* @param {string|string[]} keys - Defines a single or collection of column names.
|
|
1583
|
-
* @param {string} showBy - Defines the column key either as field name or header text.
|
|
1584
|
-
* @returns {void}
|
|
1585
|
-
*/
|
|
1586
|
-
showColumns(keys: string | string[], showBy?: string): void;
|
|
1587
|
-
/**
|
|
1588
|
-
* Hides a column by column name.
|
|
1589
|
-
*
|
|
1590
|
-
* @param {string|string[]} keys - Defines a single or collection of column names.
|
|
1591
|
-
* @param {string} hideBy - Defines the column key either as field name or header text.
|
|
1592
|
-
* @returns {void}
|
|
1593
|
-
*/
|
|
1594
|
-
hideColumns(keys: string | string[], hideBy?: string): void;
|
|
1595
|
-
/**
|
|
1596
|
-
* Gets a column header by column name.
|
|
1597
|
-
*
|
|
1598
|
-
* @param {string} field - Specifies the column name.
|
|
1599
|
-
* @returns {Element} - Returns column header element
|
|
1600
|
-
*/
|
|
1601
|
-
getColumnHeaderByField(field: string): Element;
|
|
1602
|
-
/**
|
|
1603
|
-
* Gets a column header by column index.
|
|
1604
|
-
*
|
|
1605
|
-
* @param {number} index - Specifies the column index.
|
|
1606
|
-
* @returns {Element} - Returns column header element
|
|
1607
|
-
*/
|
|
1608
|
-
getColumnHeaderByIndex(index: number): Element;
|
|
1609
|
-
/**
|
|
1610
|
-
* Gets a column header by UID.
|
|
1611
|
-
*
|
|
1612
|
-
* @param {string} uid - Specifies the column uid.
|
|
1613
|
-
* @returns {Element} - Returns column header element
|
|
1614
|
-
*/
|
|
1615
|
-
getColumnHeaderByUid(uid: string): Element;
|
|
1616
|
-
/**
|
|
1617
|
-
* Gets a column index by column name.
|
|
1618
|
-
*
|
|
1619
|
-
* @param {string} field - Specifies the column name.
|
|
1620
|
-
* @returns {number} - Returns column index
|
|
1621
|
-
*/
|
|
1622
|
-
getColumnIndexByField(field: string): number;
|
|
1623
|
-
private getVirtualColIndexByUid;
|
|
1624
|
-
/**
|
|
1625
|
-
* Gets a column index by UID.
|
|
1626
|
-
*
|
|
1627
|
-
* @param {string} uid - Specifies the column UID.
|
|
1628
|
-
* @returns {number} - Returns column index
|
|
1629
|
-
*/
|
|
1630
|
-
getColumnIndexByUid(uid: string): number;
|
|
1631
|
-
/**
|
|
1632
|
-
* Gets the columns from the TreeGrid.
|
|
1633
|
-
*
|
|
1634
|
-
* @param {boolean} isRefresh - Defined whether to update DOM
|
|
1635
|
-
* @returns {Column[]} - Returns treegrid columns collection
|
|
1636
|
-
*/
|
|
1637
|
-
getColumns(isRefresh?: boolean): Column[];
|
|
1638
|
-
private updateColumnModel;
|
|
1639
|
-
private updateColumnsWidth;
|
|
1640
|
-
/**
|
|
1641
|
-
* Gets the content div of the TreeGrid.
|
|
1642
|
-
*
|
|
1643
|
-
* @returns {Element} - Return tree grid content element
|
|
1644
|
-
*/
|
|
1645
|
-
getContent(): Element;
|
|
1646
|
-
private mergePersistTreeGridData;
|
|
1647
|
-
private mergeColumns;
|
|
1648
|
-
private setFrozenCount;
|
|
1649
|
-
private splitFrozenCount;
|
|
1650
|
-
private isFrozenGrid;
|
|
1651
|
-
private updateTreeGridModel;
|
|
1652
|
-
/**
|
|
1653
|
-
* Gets the content table of the TreeGrid.
|
|
1654
|
-
*
|
|
1655
|
-
* @returns {Element} - Returns content table element
|
|
1656
|
-
*/
|
|
1657
|
-
getContentTable(): Element;
|
|
1658
|
-
/**
|
|
1659
|
-
* Gets all the TreeGrid's data rows.
|
|
1660
|
-
*
|
|
1661
|
-
* @returns {Element[]} - Returns row elements
|
|
1662
|
-
*/
|
|
1663
|
-
getDataRows(): Element[];
|
|
1664
|
-
/**
|
|
1665
|
-
* Get current visible data of TreeGrid.
|
|
1666
|
-
*
|
|
1667
|
-
* @returns {Object[]} - Returns current view records
|
|
1668
|
-
* @isGenericType true
|
|
1669
|
-
*/
|
|
1670
|
-
getCurrentViewRecords(): Object[];
|
|
1671
|
-
/**
|
|
1672
|
-
* Gets the added, edited,and deleted data before bulk save to the DataSource in batch mode.
|
|
1673
|
-
*
|
|
1674
|
-
* @returns {Object} - Returns batch changes
|
|
1675
|
-
*/
|
|
1676
|
-
getBatchChanges(): Object;
|
|
1677
|
-
/**
|
|
1678
|
-
* Gets the header div of the TreeGrid.
|
|
1679
|
-
*
|
|
1680
|
-
* @returns {Element} - Returns Header content element
|
|
1681
|
-
*/
|
|
1682
|
-
getHeaderContent(): Element;
|
|
1683
|
-
/**
|
|
1684
|
-
* Gets the header table element of the TreeGrid.
|
|
1685
|
-
*
|
|
1686
|
-
* @returns {Element} - Return header table element
|
|
1687
|
-
*/
|
|
1688
|
-
getHeaderTable(): Element;
|
|
1689
|
-
/**
|
|
1690
|
-
* Gets a row by index.
|
|
1691
|
-
*
|
|
1692
|
-
* @param {number} index - Specifies the row index.
|
|
1693
|
-
* @returns {Element} - Returns row element
|
|
1694
|
-
*/
|
|
1695
|
-
getRowByIndex(index: number): Element;
|
|
1696
|
-
/**
|
|
1697
|
-
* Get a row information based on cell
|
|
1698
|
-
*
|
|
1699
|
-
* @param {Element | EventTarget} target - Target row element
|
|
1700
|
-
* @returns {RowInfo} - Returns row information in a JSON object
|
|
1701
|
-
*/
|
|
1702
|
-
getRowInfo(target: Element | EventTarget): RowInfo;
|
|
1703
|
-
/**
|
|
1704
|
-
* Gets UID by column name.
|
|
1705
|
-
*
|
|
1706
|
-
* @param {string} field - Specifies the column name.
|
|
1707
|
-
* @returns {string} - Returns unique id based on column field name given
|
|
1708
|
-
*/
|
|
1709
|
-
getUidByColumnField(field: string): string;
|
|
1710
|
-
/**
|
|
1711
|
-
* Gets the visible columns from the TreeGrid.
|
|
1712
|
-
*
|
|
1713
|
-
* @returns {Column[]} - Returns visible columns collection
|
|
1714
|
-
*/
|
|
1715
|
-
getVisibleColumns(): Column[];
|
|
1716
|
-
/**
|
|
1717
|
-
* By default, TreeGrid shows the spinner for all its actions. You can use this method to show spinner at your needed time.
|
|
1718
|
-
*
|
|
1719
|
-
* @returns {void}
|
|
1720
|
-
*/
|
|
1721
|
-
showSpinner(): void;
|
|
1722
|
-
/**
|
|
1723
|
-
* Manually shown spinner needs to hide by `hideSpinnner`.
|
|
1724
|
-
*
|
|
1725
|
-
* @returns {void}
|
|
1726
|
-
*/
|
|
1727
|
-
hideSpinner(): void;
|
|
1728
|
-
/**
|
|
1729
|
-
* Refreshes the TreeGrid header and content.
|
|
1730
|
-
*
|
|
1731
|
-
* @returns {void}
|
|
1732
|
-
*/
|
|
1733
|
-
refresh(): void;
|
|
1734
|
-
/**
|
|
1735
|
-
* Get the records of checked rows.
|
|
1736
|
-
*
|
|
1737
|
-
* @returns {Object[]} - Returns records that has been checked
|
|
1738
|
-
* @isGenericType true
|
|
1739
|
-
*/
|
|
1740
|
-
getCheckedRecords(): Object[];
|
|
1741
|
-
/**
|
|
1742
|
-
* Get the visible records corresponding to rows visually displayed.
|
|
1743
|
-
*
|
|
1744
|
-
* @returns {Object[]} - Returns visible records based on collapse state of rows
|
|
1745
|
-
* @isGenericType true
|
|
1746
|
-
*/
|
|
1747
|
-
getVisibleRecords(): Object[];
|
|
1748
|
-
/**
|
|
1749
|
-
* Get the indexes of checked rows.
|
|
1750
|
-
*
|
|
1751
|
-
* @returns {number[]} - Returns checked row indexes
|
|
1752
|
-
*/
|
|
1753
|
-
getCheckedRowIndexes(): number[];
|
|
1754
|
-
/**
|
|
1755
|
-
* Checked the checkboxes using rowIndexes.
|
|
1756
|
-
*
|
|
1757
|
-
* @param {number[]} indexes - row indexes
|
|
1758
|
-
* @returns {void}
|
|
1759
|
-
*/
|
|
1760
|
-
selectCheckboxes(indexes: number[]): void;
|
|
1761
|
-
/**
|
|
1762
|
-
* Refreshes the TreeGrid column changes.
|
|
1763
|
-
*
|
|
1764
|
-
* @param {boolean} refreshUI - Defined whether to refresh the DOM
|
|
1765
|
-
* @returns {void}
|
|
1766
|
-
*/
|
|
1767
|
-
refreshColumns(refreshUI?: boolean): void;
|
|
1768
|
-
/**
|
|
1769
|
-
* Refreshes the TreeGrid header.
|
|
1770
|
-
*
|
|
1771
|
-
* @returns {void}
|
|
1772
|
-
*/
|
|
1773
|
-
refreshHeader(): void;
|
|
1774
|
-
/**
|
|
1775
|
-
* Expands or collapse child records
|
|
1776
|
-
*
|
|
1777
|
-
* @param {HTMLElement} target - Expand collapse icon cell as target element
|
|
1778
|
-
* @returns {void}
|
|
1779
|
-
* @hidden
|
|
1780
|
-
*/
|
|
1781
|
-
private expandCollapseRequest;
|
|
1782
|
-
/**
|
|
1783
|
-
* Expands child rows
|
|
1784
|
-
*
|
|
1785
|
-
* @param {HTMLTableRowElement} row - Expands the given row
|
|
1786
|
-
* @param {Object} record - Expands the given record
|
|
1787
|
-
* @param {Object} key - Primary key value
|
|
1788
|
-
* @param {number} level - Specifies the hierarchical level of the record
|
|
1789
|
-
* @returns {void}
|
|
1790
|
-
*/
|
|
1791
|
-
expandRow(row: HTMLTableRowElement, record?: Object, key?: Object, level?: number): void;
|
|
1792
|
-
private expandRows;
|
|
1793
|
-
private expandCollapseAllChildren;
|
|
1794
|
-
private getCollapseExpandRecords;
|
|
1795
|
-
/**
|
|
1796
|
-
* Collapses child rows
|
|
1797
|
-
*
|
|
1798
|
-
* @param {HTMLTableRowElement} row - Collapse the given row
|
|
1799
|
-
* @param {Object} record - Collapse the given record
|
|
1800
|
-
* @param {Object} key - Primary key value
|
|
1801
|
-
* @returns {void}
|
|
1802
|
-
*/
|
|
1803
|
-
collapseRow(row: HTMLTableRowElement, record?: Object, key?: Object): void;
|
|
1804
|
-
private collapseRows;
|
|
1805
|
-
private updateExpandStateMapping;
|
|
1806
|
-
/**
|
|
1807
|
-
* Expands the records at specific hierarchical level
|
|
1808
|
-
*
|
|
1809
|
-
* @param {number} level - Expands the parent rows at given level
|
|
1810
|
-
* @returns {void}
|
|
1811
|
-
*/
|
|
1812
|
-
expandAtLevel(level: number): void;
|
|
1813
|
-
/**
|
|
1814
|
-
* Expands the records by given primary key value
|
|
1815
|
-
*
|
|
1816
|
-
* @param {Object} key - Expands the parent rows with given primary key value
|
|
1817
|
-
* @returns {void}
|
|
1818
|
-
*/
|
|
1819
|
-
expandByKey(key: Object): void;
|
|
1820
|
-
private expandAction;
|
|
1821
|
-
private getRecordDetails;
|
|
1822
|
-
/**
|
|
1823
|
-
* Collapses the records at specific hierarchical level
|
|
1824
|
-
*
|
|
1825
|
-
* @param {number} level - Define the parent row level which needs to be collapsed
|
|
1826
|
-
* @returns {void}
|
|
1827
|
-
*/
|
|
1828
|
-
collapseAtLevel(level: number): void;
|
|
1829
|
-
/**
|
|
1830
|
-
* Collapses the records by given primary key value
|
|
1831
|
-
*
|
|
1832
|
-
* @param {Object} key - Collapses the parent rows with given primary key value
|
|
1833
|
-
* @returns {void}
|
|
1834
|
-
*/
|
|
1835
|
-
collapseByKey(key: Object): void;
|
|
1836
|
-
private expandCollapseActionByKey;
|
|
1837
|
-
private collapseAction;
|
|
1838
|
-
/**
|
|
1839
|
-
* Expands All the rows
|
|
1840
|
-
*
|
|
1841
|
-
* @returns {void}
|
|
1842
|
-
*/
|
|
1843
|
-
expandAll(): void;
|
|
1844
|
-
/**
|
|
1845
|
-
* Collapses All the rows
|
|
1846
|
-
*
|
|
1847
|
-
* @returns {void}
|
|
1848
|
-
*/
|
|
1849
|
-
collapseAll(): void;
|
|
1850
|
-
private expandCollapseAll;
|
|
1851
|
-
private expandCollapse;
|
|
1852
|
-
private updateChildOnDemand;
|
|
1853
|
-
private remoteExpand;
|
|
1854
|
-
private localExpand;
|
|
1855
|
-
private updateAltRow;
|
|
1856
|
-
private treeColumnRowTemplate;
|
|
1857
|
-
private collapseRemoteChild;
|
|
1858
|
-
/**
|
|
1859
|
-
* Method to sanitize html element
|
|
1860
|
-
*
|
|
1861
|
-
* @param {any} value - Specifies the html value to sanitize
|
|
1862
|
-
* @returns {any} Returns the sanitized html value
|
|
1863
|
-
* @hidden
|
|
1864
|
-
*/
|
|
1865
|
-
private sanitize;
|
|
1866
|
-
/**
|
|
1867
|
-
* Updates the rows and cells
|
|
1868
|
-
*
|
|
1869
|
-
* @param {Object[]} records - Updates the given records
|
|
1870
|
-
* @param {HTMLTableRowElement[]} rows - Updates the given rows
|
|
1871
|
-
* @param {number} index - Updates the given cell index
|
|
1872
|
-
* @returns {void}
|
|
1873
|
-
*/
|
|
1874
|
-
private updateRowAndCellElements;
|
|
1875
|
-
/**
|
|
1876
|
-
* @hidden
|
|
1877
|
-
* @returns {void}
|
|
1878
|
-
*/
|
|
1879
|
-
addListener(): void;
|
|
1880
|
-
private updateResultModel;
|
|
1881
|
-
/**
|
|
1882
|
-
* @hidden
|
|
1883
|
-
* @returns {void}
|
|
1884
|
-
*/
|
|
1885
|
-
private removeListener;
|
|
1886
|
-
/**
|
|
1887
|
-
* Filters TreeGrid row by column name with the given options.
|
|
1888
|
-
*
|
|
1889
|
-
* @param {string} fieldName - Defines the field name of the column.
|
|
1890
|
-
* @param {string} filterOperator - Defines the operator to filter records.
|
|
1891
|
-
* @param {string | number | Date | boolean} filterValue - Defines the value used to filter records.
|
|
1892
|
-
* @param {string} predicate - Defines the relationship between one filter query and another by using AND or OR predicate.
|
|
1893
|
-
* @param {boolean} matchCase - If match case is set to true, the TreeGrid filters the records with exact match. if false, it filters
|
|
1894
|
-
* case insensitive records (uppercase and lowercase letters are treated the same).
|
|
1895
|
-
* @param {boolean} ignoreAccent - If ignoreAccent is set to true,
|
|
1896
|
-
* then filter ignores diacritic characters or accents while filtering.
|
|
1897
|
-
* @param {string} actualFilterValue - Defines the actual filter value for filter column.
|
|
1898
|
-
* @param {string} actualOperator - Defines the actual filter operator for filter column.
|
|
1899
|
-
* @returns {void}
|
|
1900
|
-
*/
|
|
1901
|
-
filterByColumn(fieldName: string, filterOperator: string, filterValue: string | number | Date | boolean | number[] | string[] | Date[] | boolean[], predicate?: string, matchCase?: boolean, ignoreAccent?: boolean, actualFilterValue?: string, actualOperator?: string): void;
|
|
1902
|
-
/**
|
|
1903
|
-
* Clears all the filtered rows of the TreeGrid.
|
|
1904
|
-
*
|
|
1905
|
-
* @returns {void}
|
|
1906
|
-
*/
|
|
1907
|
-
clearFiltering(): void;
|
|
1908
|
-
/**
|
|
1909
|
-
* Removes filtered column by field name.
|
|
1910
|
-
*
|
|
1911
|
-
* @param {string} field - Defines column field name to remove filter.
|
|
1912
|
-
* @param {boolean} isClearFilterBar - Specifies whether the filter bar value needs to be cleared.
|
|
1913
|
-
* @returns {void}
|
|
1914
|
-
* @hidden
|
|
1915
|
-
*/
|
|
1916
|
-
removeFilteredColsByField(field: string, isClearFilterBar?: boolean): void;
|
|
1917
|
-
/**
|
|
1918
|
-
* Selects a row by given index.
|
|
1919
|
-
*
|
|
1920
|
-
* @param {number} index - Defines the row index.
|
|
1921
|
-
* @param {boolean} isToggle - If set to true, then it toggles the selection.
|
|
1922
|
-
* @returns {void}
|
|
1923
|
-
*/
|
|
1924
|
-
selectRow(index: number, isToggle?: boolean): void;
|
|
1925
|
-
/**
|
|
1926
|
-
* Selects a collection of rows by indexes.
|
|
1927
|
-
*
|
|
1928
|
-
* @param {number[]} rowIndexes - Specifies the row indexes.
|
|
1929
|
-
* @returns {void}
|
|
1930
|
-
*/
|
|
1931
|
-
selectRows(rowIndexes: number[]): void;
|
|
1932
|
-
/**
|
|
1933
|
-
* Deselects the current selected rows and cells.
|
|
1934
|
-
*
|
|
1935
|
-
* @returns {void}
|
|
1936
|
-
*/
|
|
1937
|
-
clearSelection(): void;
|
|
1938
|
-
/**
|
|
1939
|
-
* Copy the selected rows or cells data into clipboard.
|
|
1940
|
-
*
|
|
1941
|
-
* @param {boolean} withHeader - Specifies whether the column header text needs to be copied along with rows or cells.
|
|
1942
|
-
* @returns {void}
|
|
1943
|
-
*/
|
|
1944
|
-
copy(withHeader?: boolean): void;
|
|
1945
|
-
/**
|
|
1946
|
-
* Paste data from clipboard to selected cells.
|
|
1947
|
-
*
|
|
1948
|
-
* @param {boolean} data - Specifies the date for paste.
|
|
1949
|
-
* @param {boolean} rowIndex - Specifies the row index.
|
|
1950
|
-
* @param {boolean} colIndex - Specifies the column index.
|
|
1951
|
-
* @returns {void}
|
|
1952
|
-
*/
|
|
1953
|
-
paste(data: string, rowIndex: number, colIndex: number): void;
|
|
1954
|
-
/**
|
|
1955
|
-
* Selects a cell by the given index.
|
|
1956
|
-
*
|
|
1957
|
-
* @param {IIndex} cellIndex - Defines the row and column indexes.
|
|
1958
|
-
* @param {boolean} isToggle - If set to true, then it toggles the selection.
|
|
1959
|
-
* @returns {void}
|
|
1960
|
-
*/
|
|
1961
|
-
selectCell(cellIndex: IIndex, isToggle?: boolean): void;
|
|
1962
|
-
/**
|
|
1963
|
-
* Gets the collection of selected rows.
|
|
1964
|
-
*
|
|
1965
|
-
* @returns {Element[]} - Returns selected row elements collection
|
|
1966
|
-
*/
|
|
1967
|
-
getSelectedRows(): Element[];
|
|
1968
|
-
/**
|
|
1969
|
-
* Gets a movable table cell by row and column index.
|
|
1970
|
-
*
|
|
1971
|
-
* @param {number} rowIndex - Specifies the row index.
|
|
1972
|
-
* @param {number} columnIndex - Specifies the column index.
|
|
1973
|
-
* @returns {Element} - Returns movable cell element from the indexes passed
|
|
1974
|
-
*
|
|
1975
|
-
|
|
1976
|
-
*/
|
|
1977
|
-
getMovableCellFromIndex(rowIndex: number, columnIndex: number): Element;
|
|
1978
|
-
/**
|
|
1979
|
-
* Gets all the TreeGrid's movable table data rows.
|
|
1980
|
-
*
|
|
1981
|
-
* @returns {Element[]} - Returns element collection of movable rows
|
|
1982
|
-
*
|
|
1983
|
-
|
|
1984
|
-
*/
|
|
1985
|
-
getMovableDataRows(): Element[];
|
|
1986
|
-
/**
|
|
1987
|
-
* Gets a movable tables row by index.
|
|
1988
|
-
*
|
|
1989
|
-
* @param {number} index - Specifies the row index.
|
|
1990
|
-
* @returns {Element} - Returns movable row based on index passed
|
|
1991
|
-
*
|
|
1992
|
-
|
|
1993
|
-
*/
|
|
1994
|
-
getMovableRowByIndex(index: number): Element;
|
|
1995
|
-
/**
|
|
1996
|
-
* Gets the TreeGrid's movable content rows from frozen treegrid.
|
|
1997
|
-
*
|
|
1998
|
-
* @returns {Element[]}: Returns movable row element
|
|
1999
|
-
|
|
2000
|
-
*/
|
|
2001
|
-
getMovableRows(): Element[];
|
|
2002
|
-
/**
|
|
2003
|
-
* Gets a frozen right tables row element by index.
|
|
2004
|
-
*
|
|
2005
|
-
* @param {number} index - Specifies the row index.
|
|
2006
|
-
* @returns {Element} returns the element
|
|
2007
|
-
*
|
|
2008
|
-
|
|
2009
|
-
*/
|
|
2010
|
-
getFrozenRightRowByIndex(index: number): Element;
|
|
2011
|
-
/**
|
|
2012
|
-
* Gets the Tree Grid's frozen right content rows from frozen Tree Grid.
|
|
2013
|
-
*
|
|
2014
|
-
* @returns {Element[]} returns the element
|
|
2015
|
-
*
|
|
2016
|
-
|
|
2017
|
-
*/
|
|
2018
|
-
getFrozenRightRows(): Element[];
|
|
2019
|
-
/**
|
|
2020
|
-
* Gets all the Tree Grid's frozen right table data rows.
|
|
2021
|
-
*
|
|
2022
|
-
* @returns {Element[]} Returns the Element
|
|
2023
|
-
*
|
|
2024
|
-
|
|
2025
|
-
*/
|
|
2026
|
-
getFrozenRightDataRows(): Element[];
|
|
2027
|
-
/**
|
|
2028
|
-
* Gets a frozen right table cell by row and column index.
|
|
2029
|
-
*
|
|
2030
|
-
* @param {number} rowIndex - Specifies the row index.
|
|
2031
|
-
* @param {number} columnIndex - Specifies the column index.
|
|
2032
|
-
* @returns {Element} Returns the Element
|
|
2033
|
-
*
|
|
2034
|
-
|
|
2035
|
-
*/
|
|
2036
|
-
getFrozenRightCellFromIndex(rowIndex: number, columnIndex: number): Element;
|
|
2037
|
-
/**
|
|
2038
|
-
* Gets a frozen left column header by column index.
|
|
2039
|
-
*
|
|
2040
|
-
* @param {number} index - Specifies the column index.
|
|
2041
|
-
* @returns {Element} Returns the Element
|
|
2042
|
-
*
|
|
2043
|
-
|
|
2044
|
-
*/
|
|
2045
|
-
getFrozenLeftColumnHeaderByIndex(index: number): Element;
|
|
2046
|
-
/**
|
|
2047
|
-
* Gets a frozen right column header by column index.
|
|
2048
|
-
*
|
|
2049
|
-
* @param {number} index - Specifies the column index.
|
|
2050
|
-
* @returns {Element} Returns the Element
|
|
2051
|
-
*
|
|
2052
|
-
|
|
2053
|
-
*/
|
|
2054
|
-
getFrozenRightColumnHeaderByIndex(index: number): Element;
|
|
2055
|
-
/**
|
|
2056
|
-
* Gets a movable column header by column index.
|
|
2057
|
-
*
|
|
2058
|
-
* @param {number} index - Specifies the column index.
|
|
2059
|
-
* @returns {Element} Returns the Element
|
|
2060
|
-
*
|
|
2061
|
-
|
|
2062
|
-
*/
|
|
2063
|
-
getMovableColumnHeaderByIndex(index: number): Element;
|
|
2064
|
-
/**
|
|
2065
|
-
* @hidden
|
|
2066
|
-
* @returns {number} Returns the movable column count
|
|
2067
|
-
*/
|
|
2068
|
-
getMovableColumnsCount(): number;
|
|
2069
|
-
/**
|
|
2070
|
-
* @hidden
|
|
2071
|
-
* @returns {number} Returns the Frozen Left column
|
|
2072
|
-
*/
|
|
2073
|
-
getFrozenLeftColumnsCount(): number;
|
|
2074
|
-
/**
|
|
2075
|
-
* @hidden
|
|
2076
|
-
* @returns {number} Returns the Frozen Right column count
|
|
2077
|
-
*/
|
|
2078
|
-
getFrozenRightColumnsCount(): number;
|
|
2079
|
-
/**
|
|
2080
|
-
* @hidden
|
|
2081
|
-
* @returns {Column[]} Returns the column
|
|
2082
|
-
*/
|
|
2083
|
-
getFrozenLeftColumns(): Column[];
|
|
2084
|
-
/**
|
|
2085
|
-
* @hidden
|
|
2086
|
-
* @returns {Column[]} Returns the column
|
|
2087
|
-
*/
|
|
2088
|
-
getFrozenRightColumns(): Column[];
|
|
2089
|
-
/**
|
|
2090
|
-
* @hidden
|
|
2091
|
-
* @returns {number} Returns the visible movable count
|
|
2092
|
-
*/
|
|
2093
|
-
getVisibleMovableCount(): number;
|
|
2094
|
-
/**
|
|
2095
|
-
* @hidden
|
|
2096
|
-
* @returns {number} Returns the visible Frozen Right count
|
|
2097
|
-
*/
|
|
2098
|
-
getVisibleFrozenRightCount(): number;
|
|
2099
|
-
/**
|
|
2100
|
-
* @hidden
|
|
2101
|
-
* @returns {number} Returns the visible Frozen left count
|
|
2102
|
-
*/
|
|
2103
|
-
getVisibleFrozenLeftCount(): number;
|
|
2104
|
-
/**
|
|
2105
|
-
* @hidden
|
|
2106
|
-
* @returns {Column[]} Returns the column
|
|
2107
|
-
*/
|
|
2108
|
-
getMovableColumns(): Column[];
|
|
2109
|
-
/**
|
|
2110
|
-
* Gets the number of frozen column in tree grid
|
|
2111
|
-
*
|
|
2112
|
-
* @hidden
|
|
2113
|
-
* @returns {number} - Returns frozen column count
|
|
2114
|
-
*/
|
|
2115
|
-
getFrozenColumns(): number;
|
|
2116
|
-
private getFrozenCount;
|
|
2117
|
-
/**
|
|
2118
|
-
* Gets the collection of selected row indexes.
|
|
2119
|
-
*
|
|
2120
|
-
* @returns {number[]} - Returns selected rows index collection
|
|
2121
|
-
*/
|
|
2122
|
-
getSelectedRowIndexes(): number[];
|
|
2123
|
-
/**
|
|
2124
|
-
* Gets the collection of selected row and cell indexes.
|
|
2125
|
-
*
|
|
2126
|
-
* @returns {ISelectedCell[]} - Returns selected cell's index details
|
|
2127
|
-
*/
|
|
2128
|
-
getSelectedRowCellIndexes(): ISelectedCell[];
|
|
2129
|
-
/**
|
|
2130
|
-
* Gets the collection of selected records.
|
|
2131
|
-
*
|
|
2132
|
-
* @isGenericType true
|
|
2133
|
-
* @returns {Object[]} - Returns selected records collection
|
|
2134
|
-
*/
|
|
2135
|
-
getSelectedRecords(): Object[];
|
|
2136
|
-
/**
|
|
2137
|
-
* Gets the data module.
|
|
2138
|
-
*
|
|
2139
|
-
* @returns {{baseModule: Data, treeModule: DataManipulation}}: Returns grid and treegrid data module
|
|
2140
|
-
*/
|
|
2141
|
-
getDataModule(): {
|
|
2142
|
-
baseModule: Data;
|
|
2143
|
-
treeModule: DataManipulation;
|
|
2144
|
-
};
|
|
2145
|
-
/**
|
|
2146
|
-
* Reorder the rows based on given indexes and position
|
|
2147
|
-
*
|
|
2148
|
-
* @param {number[]} fromIndexes - Source indexes of rows
|
|
2149
|
-
* @param {number} toIndex - Destination index of row
|
|
2150
|
-
* @param {string} position - Defines drop position as above or below or child
|
|
2151
|
-
* @returns {void}
|
|
2152
|
-
*/
|
|
2153
|
-
reorderRows(fromIndexes: number[], toIndex: number, position: string): void;
|
|
2154
|
-
/**
|
|
2155
|
-
* Indents the record to one level of hierarchy. Moves the selected row as the last child of its previous row.
|
|
2156
|
-
*
|
|
2157
|
-
* @param {Object} record – specifies the record to do indented
|
|
2158
|
-
* @returns {void}
|
|
2159
|
-
*/
|
|
2160
|
-
indent(record?: Object): void;
|
|
2161
|
-
/**
|
|
2162
|
-
* Outdent the record to one level of hierarchy. Moves the selected row as sibling to its parent row.
|
|
2163
|
-
*
|
|
2164
|
-
* @param {Object} record – specifies the record to do outdented
|
|
2165
|
-
* @returns {void}
|
|
2166
|
-
*/
|
|
2167
|
-
outdent(record?: Object): void;
|
|
2168
|
-
/**
|
|
2169
|
-
* `columnchooserModule` is used to dynamically show or hide the TreeGrid columns.
|
|
2170
|
-
*
|
|
2171
|
-
* @hidden
|
|
2172
|
-
*/
|
|
2173
|
-
columnChooserModule: ColumnChooser;
|
|
2174
|
-
/**
|
|
2175
|
-
* The `toolbarModule` is used to manipulate ToolBar items and its action in the TreeGrid.
|
|
2176
|
-
*/
|
|
2177
|
-
toolbarModule: Toolbar;
|
|
2178
|
-
/**
|
|
2179
|
-
* The `editModule` is used to handle TreeGrid content manipulation.
|
|
2180
|
-
*/
|
|
2181
|
-
editModule: Edit;
|
|
2182
|
-
/**
|
|
2183
|
-
* The `pagerModule` is used to manipulate paging in the TreeGrid.
|
|
2184
|
-
*/
|
|
2185
|
-
pagerModule: Page;
|
|
2186
|
-
}
|