@1771technologies/lytenyte-pro 1.0.0-beta.34 → 1.0.0-beta.37
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/dist/+types.d.ts
CHANGED
|
@@ -2,6 +2,8 @@ import type { ReactNode } from "react";
|
|
|
2
2
|
/**
|
|
3
3
|
* The initial props that may be passed to the `useLyteNyte` hook. The hook
|
|
4
4
|
* returns the state representation of LyteNyte Grid.
|
|
5
|
+
*
|
|
6
|
+
* @group Grid State
|
|
5
7
|
*/
|
|
6
8
|
export interface UseLyteNyteProps<T> {
|
|
7
9
|
/**
|
|
@@ -256,6 +258,8 @@ export interface UseLyteNyteProps<T> {
|
|
|
256
258
|
* grid properties that affect layout, data, selection, and rendering. Updating any of these atoms will trigger
|
|
257
259
|
* corresponding changes in the grid UI. These state values can also be used to create and synchronize external
|
|
258
260
|
* components such as toolbars, panels, or widgets.
|
|
261
|
+
*
|
|
262
|
+
* @group Grid State
|
|
259
263
|
*/
|
|
260
264
|
export interface GridState<T> {
|
|
261
265
|
/**
|
|
@@ -641,6 +645,8 @@ export interface GridState<T> {
|
|
|
641
645
|
/**
|
|
642
646
|
* Defines the viewport boundaries for rendering rows and columns in LyteNyte Grid.
|
|
643
647
|
* These bounds are calculated based on the scroll position and the visible area of the grid.
|
|
648
|
+
*
|
|
649
|
+
* @group Grid View
|
|
644
650
|
*/
|
|
645
651
|
export interface ViewBounds {
|
|
646
652
|
/**
|
|
@@ -703,6 +709,8 @@ export interface ViewBounds {
|
|
|
703
709
|
/**
|
|
704
710
|
* The grid object encapsulates the full LyteNyte Grid instance, including its state, view, and imperative API.
|
|
705
711
|
* It is returned by the `useLyteNyte` hook and serves as the primary interface for interacting with the grid programmatically.
|
|
712
|
+
*
|
|
713
|
+
* @group Grid State
|
|
706
714
|
*/
|
|
707
715
|
export interface Grid<T> {
|
|
708
716
|
/**
|
|
@@ -725,6 +733,8 @@ export interface Grid<T> {
|
|
|
725
733
|
* Represents the current visual layout of the grid including headers and rows.
|
|
726
734
|
* This structure is used by LyteNyte Grid headless components
|
|
727
735
|
* or for building custom visualizations.
|
|
736
|
+
*
|
|
737
|
+
* @group Grid View
|
|
728
738
|
*/
|
|
729
739
|
export interface GridView<T> {
|
|
730
740
|
/**
|
|
@@ -738,6 +748,8 @@ export interface GridView<T> {
|
|
|
738
748
|
}
|
|
739
749
|
/**
|
|
740
750
|
* Describes a standard header cell layout in the grid, used to position and render individual column headers.
|
|
751
|
+
*
|
|
752
|
+
* @group Grid View
|
|
741
753
|
*/
|
|
742
754
|
export interface HeaderCellLayout<T> {
|
|
743
755
|
/**
|
|
@@ -791,6 +803,8 @@ export interface HeaderCellLayout<T> {
|
|
|
791
803
|
}
|
|
792
804
|
/**
|
|
793
805
|
* Describes a floating header cell layout, which remains fixed during scroll operations.
|
|
806
|
+
*
|
|
807
|
+
* @group Grid View
|
|
794
808
|
*/
|
|
795
809
|
export interface HeaderCellFloating<T> {
|
|
796
810
|
/**
|
|
@@ -845,6 +859,8 @@ export interface HeaderCellFloating<T> {
|
|
|
845
859
|
/**
|
|
846
860
|
* Describes a group of columns within the header. Used by LyteNyte
|
|
847
861
|
* Grid to render grouped column headers with optional collapsibility and structural metadata.
|
|
862
|
+
*
|
|
863
|
+
* @group Grid View
|
|
848
864
|
*/
|
|
849
865
|
export interface HeaderGroupCellLayout {
|
|
850
866
|
/**
|
|
@@ -925,6 +941,8 @@ export interface HeaderGroupCellLayout {
|
|
|
925
941
|
/**
|
|
926
942
|
* Defines the overall structure of header rows in the grid.
|
|
927
943
|
* This layout is recalculated based on viewport changes and virtualized rendering.
|
|
944
|
+
*
|
|
945
|
+
* @group Grid View
|
|
928
946
|
*/
|
|
929
947
|
export interface HeaderLayout<T> {
|
|
930
948
|
/**
|
|
@@ -943,10 +961,14 @@ export interface HeaderLayout<T> {
|
|
|
943
961
|
/**
|
|
944
962
|
* Represents a union of all possible header layout cell types:
|
|
945
963
|
* normal header, floating header, or header group.
|
|
964
|
+
*
|
|
965
|
+
* @group Grid View
|
|
946
966
|
*/
|
|
947
967
|
export type HeaderLayoutCell<T> = HeaderCellLayout<T> | HeaderCellFloating<T> | HeaderGroupCellLayout;
|
|
948
968
|
/**
|
|
949
969
|
* Represents the layout metadata for a single cell within a row, including span and contextual info.
|
|
970
|
+
*
|
|
971
|
+
* @group Grid View
|
|
950
972
|
*/
|
|
951
973
|
export interface RowCellLayout<T> {
|
|
952
974
|
/**
|
|
@@ -1013,6 +1035,8 @@ export interface RowCellLayout<T> {
|
|
|
1013
1035
|
/**
|
|
1014
1036
|
* Describes the layout of a full-width row which spans all columns.
|
|
1015
1037
|
* These are typically used for summary or group rows.
|
|
1038
|
+
*
|
|
1039
|
+
* @group Grid View
|
|
1016
1040
|
*/
|
|
1017
1041
|
export interface RowFullWidthRowLayout<T> {
|
|
1018
1042
|
/**
|
|
@@ -1050,11 +1074,15 @@ export interface RowFullWidthRowLayout<T> {
|
|
|
1050
1074
|
}
|
|
1051
1075
|
/**
|
|
1052
1076
|
* A row layout is either a standard row or a full-width row, depending on its content and configuration.
|
|
1077
|
+
*
|
|
1078
|
+
* @group Grid View
|
|
1053
1079
|
*/
|
|
1054
1080
|
export type RowLayout<T> = RowNormalRowLayout<T> | RowFullWidthRowLayout<T>;
|
|
1055
1081
|
/**
|
|
1056
1082
|
* Describes the layout of a standard row in LyteNyte Grid,
|
|
1057
1083
|
* including cell arrangement and row-level metadata.
|
|
1084
|
+
*
|
|
1085
|
+
* @group Grid View
|
|
1058
1086
|
*/
|
|
1059
1087
|
export interface RowNormalRowLayout<T> {
|
|
1060
1088
|
/**
|
|
@@ -1097,6 +1125,8 @@ export interface RowNormalRowLayout<T> {
|
|
|
1097
1125
|
/**
|
|
1098
1126
|
* Organizes the rows into three separate sections: top (pinned), center (scrollable),
|
|
1099
1127
|
* and bottom (pinned). Used to optimize row virtualization and rendering.
|
|
1128
|
+
*
|
|
1129
|
+
* @group Grid View
|
|
1100
1130
|
*/
|
|
1101
1131
|
export interface RowSectionLayouts<T> {
|
|
1102
1132
|
/**
|
|
@@ -1139,6 +1169,8 @@ export interface RowSectionLayouts<T> {
|
|
|
1139
1169
|
*
|
|
1140
1170
|
* This is called when autosize is triggered via the grid's API. Returning `null`
|
|
1141
1171
|
* disables sizing behavior.
|
|
1172
|
+
*
|
|
1173
|
+
* @group Column
|
|
1142
1174
|
*/
|
|
1143
1175
|
export type AutosizeCellFn<T> = (
|
|
1144
1176
|
/**
|
|
@@ -1151,6 +1183,8 @@ params: AutosizeCellParams<T>) => number | null;
|
|
|
1151
1183
|
*
|
|
1152
1184
|
* These provide context about the cell and grid configuration so that the function
|
|
1153
1185
|
* can determine the optimal column width based on cell content.
|
|
1186
|
+
*
|
|
1187
|
+
* @group Column
|
|
1154
1188
|
*/
|
|
1155
1189
|
export interface AutosizeCellParams<T> {
|
|
1156
1190
|
/**
|
|
@@ -1171,6 +1205,8 @@ export interface AutosizeCellParams<T> {
|
|
|
1171
1205
|
* based on the header's rendered content.
|
|
1172
1206
|
*
|
|
1173
1207
|
* This is called as part of the grid's autosize process.
|
|
1208
|
+
*
|
|
1209
|
+
* @group Column
|
|
1174
1210
|
*/
|
|
1175
1211
|
export type AutosizeHeaderFn<T> = (
|
|
1176
1212
|
/**
|
|
@@ -1182,6 +1218,8 @@ params: AutosizeHeaderParams<T>) => number | null;
|
|
|
1182
1218
|
*
|
|
1183
1219
|
* These are used by LyteNyte Grid to calculate the ideal column width based on the
|
|
1184
1220
|
* header content.
|
|
1221
|
+
*
|
|
1222
|
+
* @group Column
|
|
1185
1223
|
*/
|
|
1186
1224
|
export interface AutosizeHeaderParams<T> {
|
|
1187
1225
|
/**
|
|
@@ -1202,6 +1240,8 @@ export interface AutosizeHeaderParams<T> {
|
|
|
1202
1240
|
*
|
|
1203
1241
|
* This allows you to set column-wide defaults that apply retroactively to all applicable columns
|
|
1204
1242
|
* without rewriting each one.
|
|
1243
|
+
*
|
|
1244
|
+
* @group Column
|
|
1205
1245
|
*/
|
|
1206
1246
|
export interface ColumnBase<T> {
|
|
1207
1247
|
/**
|
|
@@ -1275,6 +1315,8 @@ export interface ColumnBase<T> {
|
|
|
1275
1315
|
* Defines the structure of a marker column.
|
|
1276
1316
|
*
|
|
1277
1317
|
* The marker column is a grid managed column used to support features like selection checkboxes or row drag handles.
|
|
1318
|
+
*
|
|
1319
|
+
* @group Column
|
|
1278
1320
|
*/
|
|
1279
1321
|
export interface ColumnMarker<T> {
|
|
1280
1322
|
/**
|
|
@@ -1305,6 +1347,8 @@ export interface ColumnMarker<T> {
|
|
|
1305
1347
|
* are derived from the grid's internal column state and may change depending on modes
|
|
1306
1348
|
* like pivoting. For example, when pivot mode is enabled, `columnsVisible` refers to
|
|
1307
1349
|
* visible pivot columns instead of the regular ones.
|
|
1350
|
+
*
|
|
1351
|
+
* @group Column
|
|
1308
1352
|
*/
|
|
1309
1353
|
export interface ColumnMeta<T> {
|
|
1310
1354
|
/**
|
|
@@ -1338,6 +1382,8 @@ export interface ColumnMeta<T> {
|
|
|
1338
1382
|
* - In right-to-left (RTL) mode, this behavior is reversed.
|
|
1339
1383
|
*
|
|
1340
1384
|
* This approach aligns with CSS logical properties for layout direction.
|
|
1385
|
+
*
|
|
1386
|
+
* @group Column
|
|
1341
1387
|
*/
|
|
1342
1388
|
export type ColumnPin = "start" | "end" | null;
|
|
1343
1389
|
/**
|
|
@@ -1346,6 +1392,8 @@ export type ColumnPin = "start" | "end" | null;
|
|
|
1346
1392
|
* These hints indicate whether a column is eligible to act as a value, row group, or
|
|
1347
1393
|
* column pivot in a pivot table configuration. External components can use these values
|
|
1348
1394
|
* to determine pivot-related capabilities.
|
|
1395
|
+
*
|
|
1396
|
+
* @group Column
|
|
1349
1397
|
*/
|
|
1350
1398
|
export interface ColumnPivotUIHints {
|
|
1351
1399
|
/**
|
|
@@ -1373,6 +1421,8 @@ export interface ColumnPivotUIHints {
|
|
|
1373
1421
|
* - What each cell renders
|
|
1374
1422
|
* - How rows are grouped and sorted
|
|
1375
1423
|
* - How filters are evaluated
|
|
1424
|
+
*
|
|
1425
|
+
* @group Column
|
|
1376
1426
|
*/
|
|
1377
1427
|
export interface Column<T> {
|
|
1378
1428
|
/**
|
|
@@ -1486,6 +1536,8 @@ export interface Column<T> {
|
|
|
1486
1536
|
*
|
|
1487
1537
|
* These columns are created behind the scenes to represent group headers and aggregations
|
|
1488
1538
|
* and can be configured via this interface.
|
|
1539
|
+
*
|
|
1540
|
+
* @group Column
|
|
1489
1541
|
*/
|
|
1490
1542
|
export interface RowGroupColumn<T> {
|
|
1491
1543
|
/**
|
|
@@ -1547,46 +1599,6 @@ export interface RowGroupColumn<T> {
|
|
|
1547
1599
|
*/
|
|
1548
1600
|
readonly autosizeHeaderFn?: AutosizeHeaderFn<T>;
|
|
1549
1601
|
}
|
|
1550
|
-
/**
|
|
1551
|
-
* A set of optional UI hints that external consumers and LyteNyte Grid itself can use
|
|
1552
|
-
* to determine a column's capabilities.
|
|
1553
|
-
*
|
|
1554
|
-
* These hints inform the rendering of column headers (e.g. showing resize handles,
|
|
1555
|
-
* drag handles, sort indicators), but are not enforced. Developers can still override
|
|
1556
|
-
* behaviors via the grid state API directly.
|
|
1557
|
-
*/
|
|
1558
|
-
export interface ColumnUIHints {
|
|
1559
|
-
/**
|
|
1560
|
-
* UI hint indicating whether this column supports sorting. LyteNyte Grid may
|
|
1561
|
-
* hide sort controls if this is set to `false`.
|
|
1562
|
-
*/
|
|
1563
|
-
readonly sortable?: boolean;
|
|
1564
|
-
/**
|
|
1565
|
-
* UI hint indicating whether this column can be used for row grouping.
|
|
1566
|
-
*/
|
|
1567
|
-
readonly rowGroupable?: boolean;
|
|
1568
|
-
/**
|
|
1569
|
-
* UI hint indicating whether the column can be resized by the user.
|
|
1570
|
-
* When set to `false`, resize handles will be hidden.
|
|
1571
|
-
*/
|
|
1572
|
-
readonly resizable?: boolean;
|
|
1573
|
-
/**
|
|
1574
|
-
* UI hint indicating whether the column can be repositioned by dragging.
|
|
1575
|
-
* This only affects drag-and-drop behaviors; programmatic moves are still possible.
|
|
1576
|
-
*/
|
|
1577
|
-
readonly movable?: boolean;
|
|
1578
|
-
/**
|
|
1579
|
-
* UI hint specifying the default aggregation function to apply to this column.
|
|
1580
|
-
*
|
|
1581
|
-
* This is especially relevant in pivot mode or when row grouping is active.
|
|
1582
|
-
*/
|
|
1583
|
-
readonly aggDefault?: string;
|
|
1584
|
-
/**
|
|
1585
|
-
* UI hint specifying the list of valid aggregation functions that can be applied to this column.
|
|
1586
|
-
* If unset, the column may not support aggregation.
|
|
1587
|
-
*/
|
|
1588
|
-
readonly aggsAllowed?: string[];
|
|
1589
|
-
}
|
|
1590
1602
|
/**
|
|
1591
1603
|
* UI hints describing column capabilities in LyteNyte Grid.
|
|
1592
1604
|
*
|
|
@@ -1595,6 +1607,8 @@ export interface ColumnUIHints {
|
|
|
1595
1607
|
* and can be bypassed by modifying grid state directly.
|
|
1596
1608
|
*
|
|
1597
1609
|
* Includes support for pivot-specific behaviors via {@link ColumnPivotUIHints}.
|
|
1610
|
+
*
|
|
1611
|
+
* @group Column
|
|
1598
1612
|
*/
|
|
1599
1613
|
export interface ColumnUIHints {
|
|
1600
1614
|
/**
|
|
@@ -1639,6 +1653,8 @@ export interface ColumnUIHints {
|
|
|
1639
1653
|
* This metadata is auto-generated by the grid based on the configured column definitions.
|
|
1640
1654
|
* It is used internally to manage layout and grouping behavior, but is also exposed for
|
|
1641
1655
|
* advanced use cases where programmatic interaction with group structures is needed.
|
|
1656
|
+
*
|
|
1657
|
+
* @group Column Groups
|
|
1642
1658
|
*/
|
|
1643
1659
|
export interface ColumnGroupMeta {
|
|
1644
1660
|
/**
|
|
@@ -1674,10 +1690,14 @@ export interface ColumnGroupMeta {
|
|
|
1674
1690
|
* - `"open"`: The column is visible only when the group is **expanded**.
|
|
1675
1691
|
*
|
|
1676
1692
|
* Used to build dynamic, collapsible column group layouts in LyteNyte Grid.
|
|
1693
|
+
*
|
|
1694
|
+
* @group Column Groups
|
|
1677
1695
|
*/
|
|
1678
1696
|
export type ColumnGroupVisibility = "always" | "close" | "open";
|
|
1679
1697
|
/**
|
|
1680
1698
|
* Parameters required to initialize a client-side row data source.
|
|
1699
|
+
*
|
|
1700
|
+
* @group Row Data Source
|
|
1681
1701
|
*/
|
|
1682
1702
|
export interface ClientRowDataSourcePaginatedParams<T> {
|
|
1683
1703
|
/**
|
|
@@ -1718,6 +1738,8 @@ export interface ClientRowDataSourcePaginatedParams<T> {
|
|
|
1718
1738
|
}
|
|
1719
1739
|
/**
|
|
1720
1740
|
* Enhanced parameters for a client-side row data source with additional filtering support.
|
|
1741
|
+
*
|
|
1742
|
+
* @group Row Data Source
|
|
1721
1743
|
*/
|
|
1722
1744
|
export interface ClientRowDataSourceParams<T> {
|
|
1723
1745
|
/**
|
|
@@ -1754,6 +1776,8 @@ export interface ClientRowDataSourceParams<T> {
|
|
|
1754
1776
|
}
|
|
1755
1777
|
/**
|
|
1756
1778
|
* Parameters for initializing a tree-structured data source in LyteNyte Grid.
|
|
1779
|
+
*
|
|
1780
|
+
* @group Row Data Source
|
|
1757
1781
|
*/
|
|
1758
1782
|
export interface ClientTreeDataSourceParams<T> {
|
|
1759
1783
|
/**
|
|
@@ -1797,6 +1821,8 @@ export interface ClientTreeDataSourceParams<T> {
|
|
|
1797
1821
|
* It divides the full dataset into pages based on the configured page
|
|
1798
1822
|
* size, reducing the number of rows rendered at any one time to
|
|
1799
1823
|
* improve UI responsiveness and performance.
|
|
1824
|
+
*
|
|
1825
|
+
* @group Row Data Source
|
|
1800
1826
|
*/
|
|
1801
1827
|
export interface RowDataSourceClientPaginated<T> {
|
|
1802
1828
|
/**
|
|
@@ -1866,6 +1892,8 @@ export interface RowDataSourceClientPaginated<T> {
|
|
|
1866
1892
|
/**
|
|
1867
1893
|
* Returns the available in-filter items for the specified column.
|
|
1868
1894
|
* May return items synchronously or as a Promise.
|
|
1895
|
+
*
|
|
1896
|
+
* @group Row Data Source
|
|
1869
1897
|
*/
|
|
1870
1898
|
readonly inFilterItems: (column: Column<T>) => Promise<FilterInFilterItem[]> | FilterInFilterItem[];
|
|
1871
1899
|
/**
|
|
@@ -1876,6 +1904,8 @@ export interface RowDataSourceClientPaginated<T> {
|
|
|
1876
1904
|
/**
|
|
1877
1905
|
* Represents pagination-related state for the client row data source in
|
|
1878
1906
|
* LyteNyte Grid. These values enable pagination logic within the grid's UI and interactions.
|
|
1907
|
+
*
|
|
1908
|
+
* @group Row Data Source
|
|
1879
1909
|
*/
|
|
1880
1910
|
export interface RowDataSourceClientPageState {
|
|
1881
1911
|
/**
|
|
@@ -1898,6 +1928,8 @@ export interface RowDataSourceClientPageState {
|
|
|
1898
1928
|
* This implementation is suitable for small to moderately sized datasets. For large-scale datasets, such as those
|
|
1899
1929
|
* exceeding hundreds of thousands of rows, a server-based data source
|
|
1900
1930
|
* is recommended for performance and memory efficiency.
|
|
1931
|
+
*
|
|
1932
|
+
* @group Row Data Source
|
|
1901
1933
|
*/
|
|
1902
1934
|
export interface RowDataSourceClient<T> {
|
|
1903
1935
|
/**
|
|
@@ -1963,6 +1995,8 @@ export interface RowDataSourceClient<T> {
|
|
|
1963
1995
|
/**
|
|
1964
1996
|
* Returns the available in-filter items for the specified column.
|
|
1965
1997
|
* May return items synchronously or as a Promise.
|
|
1998
|
+
*
|
|
1999
|
+
* @group Row Data Source
|
|
1966
2000
|
*/
|
|
1967
2001
|
readonly inFilterItems: (column: Column<T>) => Promise<FilterInFilterItem[]> | FilterInFilterItem[];
|
|
1968
2002
|
/**
|
|
@@ -1973,6 +2007,8 @@ export interface RowDataSourceClient<T> {
|
|
|
1973
2007
|
/**
|
|
1974
2008
|
* The row data source interface used by LyteNyte Grid to retrieve and manage row data.
|
|
1975
2009
|
* This includes functionality for row expansion, selection, and CRUD operations.
|
|
2010
|
+
*
|
|
2011
|
+
* @group Row Data Source
|
|
1976
2012
|
*/
|
|
1977
2013
|
export interface RowDataSource<T> {
|
|
1978
2014
|
/**
|
|
@@ -2038,6 +2074,8 @@ export interface RowDataSource<T> {
|
|
|
2038
2074
|
/**
|
|
2039
2075
|
* Returns the available in-filter items for the specified column.
|
|
2040
2076
|
* May return items synchronously or as a Promise.
|
|
2077
|
+
*
|
|
2078
|
+
* @group Row Data Source
|
|
2041
2079
|
*/
|
|
2042
2080
|
readonly inFilterItems: (column: Column<T>) => Promise<FilterInFilterItem[]> | FilterInFilterItem[];
|
|
2043
2081
|
}
|
|
@@ -2050,6 +2088,8 @@ export interface RowDataSource<T> {
|
|
|
2050
2088
|
* grouping, and pagination—must be handled on the server. This design provides
|
|
2051
2089
|
* maximum flexibility and scalability, including support for server-driven trees
|
|
2052
2090
|
* and pagination, but requires a more complex implementation on the backend.
|
|
2091
|
+
*
|
|
2092
|
+
* @group Row Data Source
|
|
2053
2093
|
*/
|
|
2054
2094
|
export interface RowDataSourceServer<T> {
|
|
2055
2095
|
/**
|
|
@@ -2115,6 +2155,8 @@ export interface RowDataSourceServer<T> {
|
|
|
2115
2155
|
/**
|
|
2116
2156
|
* Returns the available in-filter items for the specified column.
|
|
2117
2157
|
* May return items synchronously or as a Promise.
|
|
2158
|
+
*
|
|
2159
|
+
* @group Row Data Source
|
|
2118
2160
|
*/
|
|
2119
2161
|
readonly inFilterItems: (column: Column<T>) => Promise<FilterInFilterItem[]> | FilterInFilterItem[];
|
|
2120
2162
|
/**
|
|
@@ -2148,6 +2190,8 @@ export interface RowDataSourceServer<T> {
|
|
|
2148
2190
|
}
|
|
2149
2191
|
/**
|
|
2150
2192
|
* The internal row data store used by LyteNyte Grid to manage row metadata, counts, and access functions.
|
|
2193
|
+
*
|
|
2194
|
+
* @group Row Data Source
|
|
2151
2195
|
*/
|
|
2152
2196
|
export interface RowDataStore<T> {
|
|
2153
2197
|
/**
|
|
@@ -2181,6 +2225,8 @@ export interface RowDataStore<T> {
|
|
|
2181
2225
|
}
|
|
2182
2226
|
/**
|
|
2183
2227
|
* Parameters passed to the row selection handler within the row data source.
|
|
2228
|
+
*
|
|
2229
|
+
* @group Row Data Source
|
|
2184
2230
|
*/
|
|
2185
2231
|
export interface RdsRowSelectParams {
|
|
2186
2232
|
/**
|
|
@@ -2207,69 +2253,95 @@ export interface RdsRowSelectParams {
|
|
|
2207
2253
|
/**
|
|
2208
2254
|
* Represents a mutable piece of reactive grid state. This atom allows reading,
|
|
2209
2255
|
* updating, watching, and consuming its value reactively within React components.
|
|
2256
|
+
*
|
|
2257
|
+
* @group Grid Atom
|
|
2210
2258
|
*/
|
|
2211
2259
|
export interface GridAtom<T> {
|
|
2212
2260
|
/**
|
|
2213
2261
|
* Retrieves the current value stored in the atom. This method provides read access
|
|
2214
2262
|
* to the state managed by the atom.
|
|
2263
|
+
*
|
|
2264
|
+
* @group Grid Atom
|
|
2215
2265
|
*/
|
|
2216
2266
|
readonly get: () => T;
|
|
2217
2267
|
/**
|
|
2218
2268
|
* Updates the atom's value. Accepts either a new value or a function that receives
|
|
2219
2269
|
* the current value and returns the updated value.
|
|
2270
|
+
*
|
|
2271
|
+
* @group Grid Atom
|
|
2220
2272
|
*/
|
|
2221
2273
|
readonly set: (v: T | ((p: T) => T)) => void;
|
|
2222
2274
|
/**
|
|
2223
2275
|
* Registers a listener function to be invoked whenever the atom's value changes.
|
|
2224
2276
|
* Returns a cleanup function to remove the listener.
|
|
2277
|
+
*
|
|
2278
|
+
* @group Grid Atom
|
|
2225
2279
|
*/
|
|
2226
2280
|
readonly watch: (fn: () => void) => () => void;
|
|
2227
2281
|
/**
|
|
2228
2282
|
* A React hook that subscribes to the atom's value and causes the component to re-render
|
|
2229
2283
|
* whenever the atom changes.
|
|
2284
|
+
*
|
|
2285
|
+
* @group Grid Atom
|
|
2230
2286
|
*/
|
|
2231
2287
|
readonly useValue: () => T;
|
|
2232
2288
|
}
|
|
2233
2289
|
/**
|
|
2234
2290
|
* Represents an immutable version of a grid atom that supports read, watch, and reactive
|
|
2235
2291
|
* usage but does not allow updates.
|
|
2292
|
+
*
|
|
2293
|
+
* @group Grid Atom
|
|
2236
2294
|
*/
|
|
2237
2295
|
export interface GridAtomReadonly<T> {
|
|
2238
2296
|
/**
|
|
2239
2297
|
* Retrieves the current value stored in the atom. This method provides read access
|
|
2240
2298
|
* to the state managed by the atom.
|
|
2299
|
+
*
|
|
2300
|
+
* @group Grid Atom
|
|
2241
2301
|
*/
|
|
2242
2302
|
readonly get: () => T;
|
|
2243
2303
|
/**
|
|
2244
2304
|
* Registers a listener function to be invoked whenever the atom's value changes.
|
|
2245
2305
|
* Returns a cleanup function to remove the listener.
|
|
2306
|
+
*
|
|
2307
|
+
* @group Grid Atom
|
|
2246
2308
|
*/
|
|
2247
2309
|
readonly watch: (fn: () => void) => () => void;
|
|
2248
2310
|
/**
|
|
2249
2311
|
* A React hook that subscribes to the atom's value and causes the component to re-render
|
|
2250
2312
|
* whenever the atom changes.
|
|
2313
|
+
*
|
|
2314
|
+
* @group Grid Atom
|
|
2251
2315
|
*/
|
|
2252
2316
|
readonly useValue: () => T;
|
|
2253
2317
|
}
|
|
2254
2318
|
/**
|
|
2255
2319
|
* Represents the most minimal read-only version of a grid atom. It supports value
|
|
2256
2320
|
* retrieval and reactive consumption, but not watching or updates.
|
|
2321
|
+
*
|
|
2322
|
+
* @group Grid Atom
|
|
2257
2323
|
*/
|
|
2258
2324
|
export interface GridAtomReadonlyUnwatchable<T> {
|
|
2259
2325
|
/**
|
|
2260
2326
|
* Retrieves the current value stored in the atom. This method provides read access
|
|
2261
2327
|
* to the state managed by the atom.
|
|
2328
|
+
*
|
|
2329
|
+
* @group Grid Atom
|
|
2262
2330
|
*/
|
|
2263
2331
|
readonly get: () => T;
|
|
2264
2332
|
/**
|
|
2265
2333
|
* A React hook that subscribes to the atom's value and causes the component to re-render
|
|
2266
2334
|
* whenever the atom changes.
|
|
2335
|
+
*
|
|
2336
|
+
* @group Grid Atom
|
|
2267
2337
|
*/
|
|
2268
2338
|
readonly useValue: () => T;
|
|
2269
2339
|
}
|
|
2270
2340
|
/**
|
|
2271
2341
|
* Predicate function to determine if a row should render in full-width mode.
|
|
2272
2342
|
* Commonly used for custom summary or grouped views.
|
|
2343
|
+
*
|
|
2344
|
+
* @group Row
|
|
2273
2345
|
*/
|
|
2274
2346
|
export type RowFullWidthPredicate<T> = (
|
|
2275
2347
|
/**
|
|
@@ -2279,6 +2351,8 @@ params: RowFullWidthPredicateParams<T>) => boolean;
|
|
|
2279
2351
|
/**
|
|
2280
2352
|
* Parameters provided to the {@link RowFullWidthPredicate} function to determine
|
|
2281
2353
|
* if a row should span full width of the grid.
|
|
2354
|
+
*
|
|
2355
|
+
* @group Row
|
|
2282
2356
|
*/
|
|
2283
2357
|
export interface RowFullWidthPredicateParams<T> {
|
|
2284
2358
|
/**
|
|
@@ -2296,6 +2370,8 @@ export interface RowFullWidthPredicateParams<T> {
|
|
|
2296
2370
|
}
|
|
2297
2371
|
/**
|
|
2298
2372
|
* Function to render the full-width row content. Returns a ReactNode to be rendered as the row.
|
|
2373
|
+
*
|
|
2374
|
+
* @group Row
|
|
2299
2375
|
*/
|
|
2300
2376
|
export type RowFullWidthRendererFn<T> = (
|
|
2301
2377
|
/**
|
|
@@ -2305,6 +2381,8 @@ params: RowFullWidthRendererParams<T>) => ReactNode;
|
|
|
2305
2381
|
/**
|
|
2306
2382
|
* Parameters provided to the full-width row renderer.
|
|
2307
2383
|
* Includes row metadata and selection state.
|
|
2384
|
+
*
|
|
2385
|
+
* @group Row
|
|
2308
2386
|
*/
|
|
2309
2387
|
export interface RowFullWidthRendererParams<T> {
|
|
2310
2388
|
/**
|
|
@@ -2331,6 +2409,8 @@ export interface RowFullWidthRendererParams<T> {
|
|
|
2331
2409
|
/**
|
|
2332
2410
|
* Represents a group (branch) row which may contain children rows (leaf or other groups).
|
|
2333
2411
|
* Group rows are used in hierarchical views and support expansion/collapse behavior.
|
|
2412
|
+
*
|
|
2413
|
+
* @group Row
|
|
2334
2414
|
*/
|
|
2335
2415
|
export interface RowGroup {
|
|
2336
2416
|
/**
|
|
@@ -2371,11 +2451,15 @@ export interface RowGroup {
|
|
|
2371
2451
|
* - A fixed number (e.g. 30),
|
|
2372
2452
|
* - A fill value (e.g. `fill:1`),
|
|
2373
2453
|
* - A function that returns dynamic row height based on index.
|
|
2454
|
+
*
|
|
2455
|
+
* @group Row
|
|
2374
2456
|
*/
|
|
2375
2457
|
export type RowHeight = number | `fill:${number}` | ((i: number) => number);
|
|
2376
2458
|
/**
|
|
2377
2459
|
* Represents a leaf row in the grid. A leaf row is a terminal node that has no children.
|
|
2378
2460
|
* These rows typically represent the raw dataset and are used for aggregations and visual representation.
|
|
2461
|
+
*
|
|
2462
|
+
* @group Row
|
|
2379
2463
|
*/
|
|
2380
2464
|
export interface RowLeaf<T = any> {
|
|
2381
2465
|
/**
|
|
@@ -2406,6 +2490,8 @@ export interface RowLeaf<T = any> {
|
|
|
2406
2490
|
/**
|
|
2407
2491
|
* A union of {@link RowLeaf} and {@link RowGroup}. Represents any row that may appear in the grid view.
|
|
2408
2492
|
* Used generically when the row type is not known ahead of time.
|
|
2493
|
+
*
|
|
2494
|
+
* @group Row
|
|
2409
2495
|
*/
|
|
2410
2496
|
export type RowNode<T> = RowLeaf<T> | RowGroup;
|
|
2411
2497
|
/**
|
|
@@ -2414,6 +2500,8 @@ export type RowNode<T> = RowLeaf<T> | RowGroup;
|
|
|
2414
2500
|
* - "bottom": pinned to bottom,
|
|
2415
2501
|
* - null: not pinned.
|
|
2416
2502
|
* Pinned rows remain visible during scrolling.
|
|
2503
|
+
*
|
|
2504
|
+
* @group Row
|
|
2417
2505
|
*/
|
|
2418
2506
|
export type RowPin = "top" | "bottom" | null;
|
|
2419
2507
|
/**
|
|
@@ -2422,6 +2510,8 @@ export type RowPin = "top" | "bottom" | null;
|
|
|
2422
2510
|
* - "bottom": pinned to the bottom area,
|
|
2423
2511
|
* - "center": scrollable middle area,
|
|
2424
2512
|
* - "flat": single flattened section.
|
|
2513
|
+
*
|
|
2514
|
+
* @group Row
|
|
2425
2515
|
*/
|
|
2426
2516
|
export type RowSection = "top" | "bottom" | "center" | "flat";
|
|
2427
2517
|
/**
|
|
@@ -2453,6 +2543,8 @@ export type RowSection = "top" | "bottom" | "center" | "flat";
|
|
|
2453
2543
|
*
|
|
2454
2544
|
* Cells that are spanned over (i.e. covered by another cell's span) will not be rendered and
|
|
2455
2545
|
* are excluded from the layout and DOM. Ensure your span logic accounts for this behavior.
|
|
2546
|
+
*
|
|
2547
|
+
* @group Row And Column Spanning
|
|
2456
2548
|
*/
|
|
2457
2549
|
export type CellSpanFn<T> = (
|
|
2458
2550
|
/**
|
|
@@ -2470,6 +2562,8 @@ params: CellSpanFnParams<T>) => number;
|
|
|
2470
2562
|
* - The row node representing the full row data
|
|
2471
2563
|
*
|
|
2472
2564
|
* Used to compute dynamic row or column spans for advanced layout use cases.
|
|
2565
|
+
*
|
|
2566
|
+
* @group Row And Column Spanning
|
|
2473
2567
|
*/
|
|
2474
2568
|
export interface CellSpanFnParams<T> {
|
|
2475
2569
|
/**
|
|
@@ -2497,6 +2591,8 @@ export interface CellSpanFnParams<T> {
|
|
|
2497
2591
|
* - A `branch` form, representing nested row structures with a key lookup
|
|
2498
2592
|
*
|
|
2499
2593
|
* Note: These do not include attributes like `rowId` or `rowIndex` as those may not be available yet.
|
|
2594
|
+
*
|
|
2595
|
+
* @group Field
|
|
2500
2596
|
*/
|
|
2501
2597
|
export type FieldDataParam<T> = {
|
|
2502
2598
|
kind: "leaf";
|
|
@@ -2510,6 +2606,8 @@ export type FieldDataParam<T> = {
|
|
|
2510
2606
|
* A dynamic field function used to derive values for a column.
|
|
2511
2607
|
*
|
|
2512
2608
|
* This function may be invoked repeatedly, once per cell per column, so it must be optimized for efficiency.
|
|
2609
|
+
*
|
|
2610
|
+
* @group Field
|
|
2513
2611
|
*/
|
|
2514
2612
|
export type FieldFn<T> = (
|
|
2515
2613
|
/**
|
|
@@ -2521,6 +2619,8 @@ params: FieldFnParams<T>) => unknown;
|
|
|
2521
2619
|
*
|
|
2522
2620
|
* LyteNyte Grid calls these functions dynamically during rendering or computation.
|
|
2523
2621
|
* These calls can occur frequently (e.g., for every cell in a column), so implementations should prioritize performance.
|
|
2622
|
+
*
|
|
2623
|
+
* @group Field
|
|
2524
2624
|
*/
|
|
2525
2625
|
export interface FieldFnParams<T> {
|
|
2526
2626
|
/**
|
|
@@ -2533,6 +2633,8 @@ export interface FieldFnParams<T> {
|
|
|
2533
2633
|
readonly column: Column<T>;
|
|
2534
2634
|
/**
|
|
2535
2635
|
* A representation of the row data, used in computing custom fields or sorting logic.
|
|
2636
|
+
*
|
|
2637
|
+
* @group Field
|
|
2536
2638
|
*/
|
|
2537
2639
|
readonly data: FieldDataParam<T>;
|
|
2538
2640
|
}
|
|
@@ -2540,6 +2642,8 @@ export interface FieldFnParams<T> {
|
|
|
2540
2642
|
* Specifies a string-based path used to extract values from a nested data structure, similar to `lodash.get`.
|
|
2541
2643
|
*
|
|
2542
2644
|
* Example: `"point.x"` will return `data.point.x`. Useful for deeply nested row data.
|
|
2645
|
+
*
|
|
2646
|
+
* @group field
|
|
2543
2647
|
*/
|
|
2544
2648
|
export interface FieldPath {
|
|
2545
2649
|
/**
|
|
@@ -2555,6 +2659,8 @@ export interface FieldPath {
|
|
|
2555
2659
|
* A function used to derive row grouping values distinct from cell display values.
|
|
2556
2660
|
*
|
|
2557
2661
|
* Ideal for customizing how rows are grouped in the UI or logic layer.
|
|
2662
|
+
*
|
|
2663
|
+
* @group Field
|
|
2558
2664
|
*/
|
|
2559
2665
|
export type FieldRowGroupFn<T> = (
|
|
2560
2666
|
/**
|
|
@@ -2565,6 +2671,8 @@ params: FieldRowGroupParamsFn<T>) => unknown;
|
|
|
2565
2671
|
* Defines the parameters used for custom row group field functions.
|
|
2566
2672
|
*
|
|
2567
2673
|
* Enables grouping logic to be decoupled from the data's displayed value.
|
|
2674
|
+
*
|
|
2675
|
+
* @group Field
|
|
2568
2676
|
*/
|
|
2569
2677
|
export interface FieldRowGroupParamsFn<T> {
|
|
2570
2678
|
/**
|
|
@@ -2579,6 +2687,8 @@ export interface FieldRowGroupParamsFn<T> {
|
|
|
2579
2687
|
/**
|
|
2580
2688
|
* Defines the acceptable formats for row group fields.
|
|
2581
2689
|
* Includes primitives, path-based accessors, or a custom function for grouping behavior.
|
|
2690
|
+
*
|
|
2691
|
+
* @group Field
|
|
2582
2692
|
*/
|
|
2583
2693
|
export type FieldRowGroup<T> = number | string | FieldPath | FieldRowGroupFn<T>;
|
|
2584
2694
|
/**
|
|
@@ -2587,6 +2697,8 @@ export type FieldRowGroup<T> = number | string | FieldPath | FieldRowGroupFn<T>;
|
|
|
2587
2697
|
* - A primitive value (`string` or `number`)
|
|
2588
2698
|
* - A path-based accessor
|
|
2589
2699
|
* - A custom function for dynamic computation
|
|
2700
|
+
*
|
|
2701
|
+
* @group Field
|
|
2590
2702
|
*/
|
|
2591
2703
|
export type Field<T> = number | string | FieldPath | FieldFn<T>;
|
|
2592
2704
|
/**
|
|
@@ -2596,6 +2708,8 @@ export type Field<T> = number | string | FieldPath | FieldFn<T>;
|
|
|
2596
2708
|
* optimized for performance, as slow renderers may degrade the overall responsiveness of the grid.
|
|
2597
2709
|
*
|
|
2598
2710
|
* Avoid unnecessary re-renders or expensive calculations inside this function.
|
|
2711
|
+
*
|
|
2712
|
+
* @group Cell Rendering
|
|
2599
2713
|
*/
|
|
2600
2714
|
export type CellRendererFn<T> = (
|
|
2601
2715
|
/**
|
|
@@ -2608,6 +2722,8 @@ params: CellRendererParams<T>) => ReactNode;
|
|
|
2608
2722
|
*
|
|
2609
2723
|
* Includes metadata and context such as the grid instance, row and column positions, selection state,
|
|
2610
2724
|
* and the full row node data.
|
|
2725
|
+
*
|
|
2726
|
+
* @group Cell Rendering
|
|
2611
2727
|
*/
|
|
2612
2728
|
export interface CellRendererParams<T> {
|
|
2613
2729
|
/**
|
|
@@ -2645,6 +2761,8 @@ export interface CellRendererParams<T> {
|
|
|
2645
2761
|
}
|
|
2646
2762
|
/**
|
|
2647
2763
|
* The parameters the `columnAutosize` method accepts.
|
|
2764
|
+
*
|
|
2765
|
+
* @group Grid API
|
|
2648
2766
|
*/
|
|
2649
2767
|
export interface ColumnAutosizeParams<T> {
|
|
2650
2768
|
/**
|
|
@@ -2662,6 +2780,8 @@ export interface ColumnAutosizeParams<T> {
|
|
|
2662
2780
|
}
|
|
2663
2781
|
/**
|
|
2664
2782
|
* The parameters that may be provided to the `columnMove` API method.
|
|
2783
|
+
*
|
|
2784
|
+
* @group Grid API
|
|
2665
2785
|
*/
|
|
2666
2786
|
export interface ColumnMoveParams<T> {
|
|
2667
2787
|
/**
|
|
@@ -2690,6 +2810,8 @@ export interface ColumnMoveParams<T> {
|
|
|
2690
2810
|
* - A row/column pair to focus a specific cell.
|
|
2691
2811
|
* - A header or group header cell position.
|
|
2692
2812
|
* - A directional alias ("next", "prev", "up", "down") relative to the current focus (only when the grid is focused).
|
|
2813
|
+
*
|
|
2814
|
+
* @group Grid API
|
|
2693
2815
|
*/
|
|
2694
2816
|
export type FocusCellParams<T> = {
|
|
2695
2817
|
row: number;
|
|
@@ -2698,6 +2820,8 @@ export type FocusCellParams<T> = {
|
|
|
2698
2820
|
/**
|
|
2699
2821
|
* The LyteNyte Grid API provides a comprehensive set of methods that allow developers
|
|
2700
2822
|
* to programmatically query, update, and manipulate grid state and data.
|
|
2823
|
+
*
|
|
2824
|
+
* @group Grid API
|
|
2701
2825
|
*/
|
|
2702
2826
|
export interface GridApi<T> {
|
|
2703
2827
|
/**
|
|
@@ -2873,16 +2997,22 @@ export interface GridApi<T> {
|
|
|
2873
2997
|
/**
|
|
2874
2998
|
* Returns the raw cell data within a rectangular selection of the grid.
|
|
2875
2999
|
* This can be useful for custom data processing or exporting workflows.
|
|
3000
|
+
*
|
|
3001
|
+
* @group Grid API
|
|
2876
3002
|
*/
|
|
2877
3003
|
readonly exportDataRect: (params?: ExportDataRectParams) => Promise<ExportDataRectResult<T>>;
|
|
2878
3004
|
/**
|
|
2879
3005
|
* Exports the cell data for a given rectangle of the grid as a CSV-formatted string.
|
|
2880
3006
|
* The rectangle can be customized through parameters such as selected rows, columns, or cell ranges.
|
|
3007
|
+
*
|
|
3008
|
+
* @group Grid API
|
|
2881
3009
|
*/
|
|
2882
3010
|
readonly exportCsv: (params?: ExportCsvParams) => Promise<string>;
|
|
2883
3011
|
/**
|
|
2884
3012
|
* Generates a downloadable CSV `Blob` from the selected rectangular area of grid cell data.
|
|
2885
3013
|
* Can be used to trigger a file download in the browser.
|
|
3014
|
+
*
|
|
3015
|
+
* @group Grid API
|
|
2886
3016
|
*/
|
|
2887
3017
|
readonly exportCsvFile: (params?: ExportCsvParams) => Promise<Blob>;
|
|
2888
3018
|
/**
|
|
@@ -2914,6 +3044,8 @@ export interface GridApi<T> {
|
|
|
2914
3044
|
}
|
|
2915
3045
|
/**
|
|
2916
3046
|
* The parameters used for the `rowHandleSelect` API method of LyteNyte Grid.
|
|
3047
|
+
*
|
|
3048
|
+
* @group Grid API
|
|
2917
3049
|
*/
|
|
2918
3050
|
export interface RowHandleSelectParams {
|
|
2919
3051
|
/**
|
|
@@ -2928,6 +3060,8 @@ export interface RowHandleSelectParams {
|
|
|
2928
3060
|
/**
|
|
2929
3061
|
* Options for the `scrollIntoView` API. Allows you to scroll a specific row and/or column into view,
|
|
2930
3062
|
* ensuring they are visible in the viewport.
|
|
3063
|
+
*
|
|
3064
|
+
* @group Grid API
|
|
2931
3065
|
*/
|
|
2932
3066
|
export interface ScrollIntoViewOptions<T> {
|
|
2933
3067
|
/**
|
|
@@ -2947,6 +3081,8 @@ export interface ScrollIntoViewOptions<T> {
|
|
|
2947
3081
|
* Represents a virtual DOM target with bounding information, used in situations
|
|
2948
3082
|
* where a physical DOM element does not exist. Commonly used for positioning popovers
|
|
2949
3083
|
* or overlays within LyteNyte Grid.
|
|
3084
|
+
*
|
|
3085
|
+
* @group Frames
|
|
2950
3086
|
*/
|
|
2951
3087
|
export interface VirtualTarget {
|
|
2952
3088
|
/**
|
|
@@ -2967,6 +3103,8 @@ export interface VirtualTarget {
|
|
|
2967
3103
|
}
|
|
2968
3104
|
/**
|
|
2969
3105
|
* Function signature for custom sort comparators.
|
|
3106
|
+
*
|
|
3107
|
+
* @group Sort
|
|
2970
3108
|
*/
|
|
2971
3109
|
export type SortComparatorFn<T> = (
|
|
2972
3110
|
/**
|
|
@@ -2983,14 +3121,20 @@ right: FieldDataParam<T>,
|
|
|
2983
3121
|
options: any) => number;
|
|
2984
3122
|
/**
|
|
2985
3123
|
* Predefined sort comparator types supported by LyteNyte Grid.
|
|
3124
|
+
*
|
|
3125
|
+
* @group Sort
|
|
2986
3126
|
*/
|
|
2987
3127
|
export type SortComparators = "string" | "number" | "date" | (string & {});
|
|
2988
3128
|
/**
|
|
2989
3129
|
* Definition for a user-defined custom sort comparator.
|
|
3130
|
+
*
|
|
3131
|
+
* @group Sort
|
|
2990
3132
|
*/
|
|
2991
3133
|
export interface SortCustomSort<T> {
|
|
2992
3134
|
/**
|
|
2993
3135
|
* The column identifier associated with the sort. May be null if not defined.
|
|
3136
|
+
*
|
|
3137
|
+
* @group Sort
|
|
2994
3138
|
*/
|
|
2995
3139
|
readonly columnId: string | null;
|
|
2996
3140
|
/**
|
|
@@ -3008,6 +3152,8 @@ export interface SortCustomSort<T> {
|
|
|
3008
3152
|
}
|
|
3009
3153
|
/**
|
|
3010
3154
|
* A built-in date sort model definition.
|
|
3155
|
+
*
|
|
3156
|
+
* @group Sort
|
|
3011
3157
|
*/
|
|
3012
3158
|
export interface SortDateColumnSort {
|
|
3013
3159
|
/**
|
|
@@ -3021,10 +3167,14 @@ export interface SortDateColumnSort {
|
|
|
3021
3167
|
}
|
|
3022
3168
|
/**
|
|
3023
3169
|
* Options used for date-based sorting.
|
|
3170
|
+
*
|
|
3171
|
+
* @group Sort
|
|
3024
3172
|
*/
|
|
3025
3173
|
export interface SortDateComparatorOptions {
|
|
3026
3174
|
/**
|
|
3027
3175
|
* A boolean indicating if null values should appear first in the sort order.
|
|
3176
|
+
*
|
|
3177
|
+
* @group Sort
|
|
3028
3178
|
*/
|
|
3029
3179
|
readonly nullsFirst?: boolean;
|
|
3030
3180
|
/**
|
|
@@ -3038,10 +3188,14 @@ export interface SortDateComparatorOptions {
|
|
|
3038
3188
|
}
|
|
3039
3189
|
/**
|
|
3040
3190
|
* Union of all supported grid sort types.
|
|
3191
|
+
*
|
|
3192
|
+
* @group Sort
|
|
3041
3193
|
*/
|
|
3042
3194
|
export type SortGridSorts<T> = SortCustomSort<T> | SortDateColumnSort | SortNumberColumnSort | SortStringColumnSort;
|
|
3043
3195
|
/**
|
|
3044
3196
|
* A model item representing an active sort applied to the grid.
|
|
3197
|
+
*
|
|
3198
|
+
* @group Sort
|
|
3045
3199
|
*/
|
|
3046
3200
|
export interface SortModelItem<T> {
|
|
3047
3201
|
/**
|
|
@@ -3050,6 +3204,8 @@ export interface SortModelItem<T> {
|
|
|
3050
3204
|
readonly sort: SortGridSorts<T>;
|
|
3051
3205
|
/**
|
|
3052
3206
|
* The column identifier associated with the sort. May be null if not defined.
|
|
3207
|
+
*
|
|
3208
|
+
* @group Sort
|
|
3053
3209
|
*/
|
|
3054
3210
|
readonly columnId: string | null;
|
|
3055
3211
|
/**
|
|
@@ -3059,6 +3215,8 @@ export interface SortModelItem<T> {
|
|
|
3059
3215
|
}
|
|
3060
3216
|
/**
|
|
3061
3217
|
* A built-in numeric sort model definition.
|
|
3218
|
+
*
|
|
3219
|
+
* @group Sort
|
|
3062
3220
|
*/
|
|
3063
3221
|
export interface SortNumberColumnSort {
|
|
3064
3222
|
/**
|
|
@@ -3072,10 +3230,14 @@ export interface SortNumberColumnSort {
|
|
|
3072
3230
|
}
|
|
3073
3231
|
/**
|
|
3074
3232
|
* Options for number-based sorting.
|
|
3233
|
+
*
|
|
3234
|
+
* @group Sort
|
|
3075
3235
|
*/
|
|
3076
3236
|
export interface SortNumberComparatorOptions {
|
|
3077
3237
|
/**
|
|
3078
3238
|
* A boolean indicating if null values should appear first in the sort order.
|
|
3239
|
+
*
|
|
3240
|
+
* @group Sort
|
|
3079
3241
|
*/
|
|
3080
3242
|
readonly nullsFirst?: boolean;
|
|
3081
3243
|
/**
|
|
@@ -3085,6 +3247,8 @@ export interface SortNumberComparatorOptions {
|
|
|
3085
3247
|
}
|
|
3086
3248
|
/**
|
|
3087
3249
|
* A built-in string sort model definition.
|
|
3250
|
+
*
|
|
3251
|
+
* @group Sort
|
|
3088
3252
|
*/
|
|
3089
3253
|
export interface SortStringColumnSort {
|
|
3090
3254
|
/**
|
|
@@ -3098,6 +3262,8 @@ export interface SortStringColumnSort {
|
|
|
3098
3262
|
}
|
|
3099
3263
|
/**
|
|
3100
3264
|
* Options used when sorting string values.
|
|
3265
|
+
*
|
|
3266
|
+
* @group Sort
|
|
3101
3267
|
*/
|
|
3102
3268
|
export interface SortStringComparatorOptions {
|
|
3103
3269
|
/**
|
|
@@ -3122,6 +3288,8 @@ export interface SortStringComparatorOptions {
|
|
|
3122
3288
|
readonly collator?: Intl.Collator;
|
|
3123
3289
|
/**
|
|
3124
3290
|
* A boolean indicating if null values should appear first in the sort order.
|
|
3291
|
+
*
|
|
3292
|
+
* @group Sort
|
|
3125
3293
|
*/
|
|
3126
3294
|
readonly nullsFirst?: boolean;
|
|
3127
3295
|
}
|
|
@@ -3131,6 +3299,8 @@ export interface SortStringComparatorOptions {
|
|
|
3131
3299
|
*
|
|
3132
3300
|
* Combination filters enable complex conditional logic by nesting
|
|
3133
3301
|
* different filters into a tree structure.
|
|
3302
|
+
*
|
|
3303
|
+
* @group Filters
|
|
3134
3304
|
*/
|
|
3135
3305
|
export interface FilterCombination {
|
|
3136
3306
|
/**
|
|
@@ -3153,6 +3323,8 @@ export interface FilterCombination {
|
|
|
3153
3323
|
}
|
|
3154
3324
|
/**
|
|
3155
3325
|
* Logical operators used to join multiple filters inside a combination filter.
|
|
3326
|
+
*
|
|
3327
|
+
* @group Filters
|
|
3156
3328
|
*/
|
|
3157
3329
|
export type FilterCombinationOperator = "AND" | "OR";
|
|
3158
3330
|
/**
|
|
@@ -3164,6 +3336,8 @@ export type FilterCombinationOperator = "AND" | "OR";
|
|
|
3164
3336
|
*
|
|
3165
3337
|
* If filtering on timestamps or partial dates, be mindful of timezone offsets and whether
|
|
3166
3338
|
* time components are relevant to your comparison.
|
|
3339
|
+
*
|
|
3340
|
+
* @group Filters
|
|
3167
3341
|
*/
|
|
3168
3342
|
export interface FilterDate {
|
|
3169
3343
|
/**
|
|
@@ -3204,6 +3378,8 @@ export interface FilterDate {
|
|
|
3204
3378
|
* relative date expressions (e.g., "n_days_ago", "last_week", "is_weekend").
|
|
3205
3379
|
*
|
|
3206
3380
|
* The required type of the `value` field depends on the selected operator.
|
|
3381
|
+
*
|
|
3382
|
+
* @group Filters
|
|
3207
3383
|
*/
|
|
3208
3384
|
export type FilterDateOperator = "equals" | "not_equals" | "before" | "before_or_equals" | "after" | "after_or_equals" | "year_to_date" | "this_week" | "this_month" | "this_year" | "last_week" | "last_month" | "last_year" | "next_week" | "next_month" | "next_year" | "today" | "tomorrow" | "yesterday" | "week_of_year" | "quarter_of_year" | "is_weekend" | "is_weekday" | "n_days_ago" | "n_days_ahead" | "n_weeks_ago" | "n_weeks_ahead" | "n_months_ago" | "n_months_ahead" | "n_years_ago" | "n_years_ahead";
|
|
3209
3385
|
/**
|
|
@@ -3211,6 +3387,8 @@ export type FilterDateOperator = "equals" | "not_equals" | "before" | "before_or
|
|
|
3211
3387
|
*
|
|
3212
3388
|
* Includes options like null handling and whether time values should be considered
|
|
3213
3389
|
* during comparisons.
|
|
3390
|
+
*
|
|
3391
|
+
* @group Filters
|
|
3214
3392
|
*/
|
|
3215
3393
|
export interface FilterDateOptions {
|
|
3216
3394
|
/**
|
|
@@ -3238,6 +3416,8 @@ export interface FilterDateOptions {
|
|
|
3238
3416
|
* be represented using built-in filter types.
|
|
3239
3417
|
*
|
|
3240
3418
|
* The function should return `true` to keep a row or `false` to filter it out.
|
|
3419
|
+
*
|
|
3420
|
+
* @group Filters
|
|
3241
3421
|
*/
|
|
3242
3422
|
export type FilterFn<T> = (
|
|
3243
3423
|
/**
|
|
@@ -3249,6 +3429,8 @@ params: FilterFnParams<T>) => boolean;
|
|
|
3249
3429
|
* The parameters passed to a custom function filter.
|
|
3250
3430
|
*
|
|
3251
3431
|
* Includes both the current row's data and the overall grid configuration.
|
|
3432
|
+
*
|
|
3433
|
+
* @group Filters
|
|
3252
3434
|
*/
|
|
3253
3435
|
export interface FilterFnParams<T> {
|
|
3254
3436
|
/**
|
|
@@ -3265,6 +3447,8 @@ export interface FilterFnParams<T> {
|
|
|
3265
3447
|
* for filtering scenarios that don't conform to basic models.
|
|
3266
3448
|
*
|
|
3267
3449
|
* Should be used selectively and optimized for performance.
|
|
3450
|
+
*
|
|
3451
|
+
* @group Filters
|
|
3268
3452
|
*/
|
|
3269
3453
|
export interface FilterFunc<T> {
|
|
3270
3454
|
/**
|
|
@@ -3282,6 +3466,8 @@ export interface FilterFunc<T> {
|
|
|
3282
3466
|
*
|
|
3283
3467
|
* Often referred to as a "Set Filter", this is a PRO-only feature in
|
|
3284
3468
|
* LyteNyte Grid and cannot be nested in combination filters.
|
|
3469
|
+
*
|
|
3470
|
+
* @group Filters
|
|
3285
3471
|
*/
|
|
3286
3472
|
export interface FilterIn {
|
|
3287
3473
|
/**
|
|
@@ -3306,6 +3492,8 @@ export interface FilterIn {
|
|
|
3306
3492
|
* Represents a displayable filter option for use with the `in` filter UI component.
|
|
3307
3493
|
*
|
|
3308
3494
|
* Supports grouping and human-friendly labeling for raw filter values.
|
|
3495
|
+
*
|
|
3496
|
+
* @group Filters
|
|
3309
3497
|
*/
|
|
3310
3498
|
export interface FilterInFilterItem {
|
|
3311
3499
|
/**
|
|
@@ -3334,10 +3522,14 @@ export interface FilterInFilterItem {
|
|
|
3334
3522
|
*
|
|
3335
3523
|
* - `"in"`: Tests for inclusion in the set.
|
|
3336
3524
|
* - `"not_in"`: Tests for exclusion from the set.
|
|
3525
|
+
*
|
|
3526
|
+
* @group Filters
|
|
3337
3527
|
*/
|
|
3338
3528
|
export type FilterInOperator = "in" | "not_in";
|
|
3339
3529
|
/**
|
|
3340
3530
|
* The full set of filter types available in the LyteNyte Grid.
|
|
3531
|
+
*
|
|
3532
|
+
* @group Filters
|
|
3341
3533
|
*/
|
|
3342
3534
|
export type FilterModelItem<T> = FilterNumber | FilterString | FilterDate | FilterCombination | FilterFunc<T>;
|
|
3343
3535
|
/**
|
|
@@ -3345,8 +3537,7 @@ export type FilterModelItem<T> = FilterNumber | FilterString | FilterDate | Filt
|
|
|
3345
3537
|
*
|
|
3346
3538
|
* Applies common comparison logic to include or exclude rows based on numerical values in a specified column.
|
|
3347
3539
|
*
|
|
3348
|
-
*
|
|
3349
|
-
* - [Filters](TODO): Overview of the filters
|
|
3540
|
+
* @group Filters
|
|
3350
3541
|
*/
|
|
3351
3542
|
export interface FilterNumber {
|
|
3352
3543
|
/**
|
|
@@ -3363,8 +3554,7 @@ export interface FilterNumber {
|
|
|
3363
3554
|
/**
|
|
3364
3555
|
* Target value for the filter.
|
|
3365
3556
|
*
|
|
3366
|
-
* This will be used as the right-hand operand when applying the operator to each row's value.
|
|
3367
|
-
* May be `null` if specifically filtering for nulls.
|
|
3557
|
+
* This will be used as the right-hand operand when applying the operator to each row's value. May be `null` if specifically filtering for nulls.
|
|
3368
3558
|
*/
|
|
3369
3559
|
readonly value: number | null;
|
|
3370
3560
|
/**
|
|
@@ -3376,16 +3566,17 @@ export interface FilterNumber {
|
|
|
3376
3566
|
}
|
|
3377
3567
|
/**
|
|
3378
3568
|
* Logical operators available for number-based filtering.
|
|
3569
|
+
* These correspond to the traditional comparison operators, `>, <=`, etc.
|
|
3570
|
+
*
|
|
3379
3571
|
*
|
|
3380
|
-
*
|
|
3381
|
-
* - `greater_than` → `>`
|
|
3382
|
-
* - `less_than_or_equals` → `<=`
|
|
3383
|
-
* etc.
|
|
3572
|
+
* @group Filters
|
|
3384
3573
|
*/
|
|
3385
3574
|
export type FilterNumberOperator = "greater_than" | "greater_than_or_equals" | "less_than" | "less_than_or_equals" | "equals" | "not_equals";
|
|
3386
3575
|
/**
|
|
3387
3576
|
* Optional configuration values for number filters. These options allow fine-tuning of filter behavior,
|
|
3388
3577
|
* especially in cases involving precision or null handling.
|
|
3578
|
+
*
|
|
3579
|
+
* @group Filters
|
|
3389
3580
|
*/
|
|
3390
3581
|
export interface FilterNumberOptions {
|
|
3391
3582
|
/**
|
|
@@ -3419,12 +3610,16 @@ export interface FilterNumberOptions {
|
|
|
3419
3610
|
*
|
|
3420
3611
|
* - `"case-sensitive"`: Exact matches required.
|
|
3421
3612
|
* - `"case-insensitive"`: Case differences are ignored.
|
|
3613
|
+
*
|
|
3614
|
+
* @group Filters
|
|
3422
3615
|
*/
|
|
3423
3616
|
export type FilterQuickSearchSensitivity = "case-sensitive" | "case-insensitive";
|
|
3424
3617
|
/**
|
|
3425
3618
|
* Filter configuration for string-based column data.
|
|
3426
3619
|
*
|
|
3427
3620
|
* Supports a wide range of operators such as exact match, substring containment, regex matching, and string length comparisons.
|
|
3621
|
+
*
|
|
3622
|
+
* @group Filters
|
|
3428
3623
|
*/
|
|
3429
3624
|
export interface FilterString {
|
|
3430
3625
|
/**
|
|
@@ -3455,6 +3650,8 @@ export interface FilterString {
|
|
|
3455
3650
|
* Collation configuration for locale-sensitive string comparisons.
|
|
3456
3651
|
*
|
|
3457
3652
|
* Used to construct an `Intl.Collator` instance, which enables proper handling of language and region-specific rules.
|
|
3653
|
+
*
|
|
3654
|
+
* @group Filters
|
|
3458
3655
|
*/
|
|
3459
3656
|
export interface FilterStringCollation {
|
|
3460
3657
|
/**
|
|
@@ -3476,6 +3673,8 @@ export interface FilterStringCollation {
|
|
|
3476
3673
|
* These include comparison operators (e.g., "equals"), substring checks (e.g., "contains"), and
|
|
3477
3674
|
* length-based checks (e.g., "length_less_than"). Some operators require a numeric `value`
|
|
3478
3675
|
* (e.g., those dealing with string length).
|
|
3676
|
+
*
|
|
3677
|
+
* @group Filters
|
|
3479
3678
|
*/
|
|
3480
3679
|
export type FilterStringOperator = "equals" | "not_equals" | "less_than" | "less_than_or_equals" | "greater_than" | "greater_than_or_equals" | "begins_with" | "not_begins_with" | "ends_with" | "not_ends_with" | "contains" | "not_contains" | "length" | "not_length" | "matches" | "length_less_than" | "length_less_than_or_equals" | "length_greater_than" | "length_greater_than_or_equals";
|
|
3481
3680
|
/**
|
|
@@ -3483,6 +3682,8 @@ export type FilterStringOperator = "equals" | "not_equals" | "less_than" | "less
|
|
|
3483
3682
|
*
|
|
3484
3683
|
* These provide control over how string values are matched, such as case sensitivity, whitespace trimming,
|
|
3485
3684
|
* regular expression flags, and locale-based collation.
|
|
3685
|
+
*
|
|
3686
|
+
* @group Filters
|
|
3486
3687
|
*/
|
|
3487
3688
|
export interface FilterStringOptions {
|
|
3488
3689
|
/**
|
|
@@ -3527,11 +3728,15 @@ export interface FilterStringOptions {
|
|
|
3527
3728
|
* The supported locale identifiers for string filtering and collation.
|
|
3528
3729
|
*
|
|
3529
3730
|
* Used to configure internationalized string comparison behavior.
|
|
3731
|
+
*
|
|
3732
|
+
* @group Filters
|
|
3530
3733
|
*/
|
|
3531
3734
|
export type Locale = "en-US" | "en-GB" | "en-CA" | "en-AU" | "en-IN" | "fr-FR" | "fr-CA" | "fr-BE" | "fr-CH" | "es-ES" | "es-MX" | "es-AR" | "es-CO" | "zh-CN" | "zh-TW" | "zh-HK" | "zh-Hant" | "zh-Hans" | "ar-SA" | "ar-EG" | "ar-AE" | "de-DE" | "de-AT" | "de-CH" | "ja-JP" | "ko-KR" | "hi-IN" | "pt-BR" | "pt-PT" | "ru-RU" | "uk-UA" | "pl-PL" | "it-IT" | "nl-NL" | "sv-SE" | "tr-TR" | "th-TH" | "vi-VN" | "he-IL" | "fa-IR" | "el-GR";
|
|
3532
3735
|
/**
|
|
3533
3736
|
* Defines the function signature for custom
|
|
3534
3737
|
* aggregation logic that computes a result based on grid data.
|
|
3738
|
+
*
|
|
3739
|
+
* @group Row Grouping
|
|
3535
3740
|
*/
|
|
3536
3741
|
export type AggFn<T> = (
|
|
3537
3742
|
/**
|
|
@@ -3546,15 +3751,21 @@ grid: Grid<T>) => unknown;
|
|
|
3546
3751
|
* Describes the aggregation model configuration.
|
|
3547
3752
|
* This can be either a string referencing a built-in
|
|
3548
3753
|
* aggregation or a custom function.
|
|
3754
|
+
*
|
|
3755
|
+
* @group Row Grouping
|
|
3549
3756
|
*/
|
|
3550
3757
|
export type AggModelFn<T> = string | AggFn<T>;
|
|
3551
3758
|
/**
|
|
3552
3759
|
* Enumerates the display modes available for
|
|
3553
3760
|
* row groups in LyteNyte Grid.
|
|
3761
|
+
*
|
|
3762
|
+
* @group Row Grouping
|
|
3554
3763
|
*/
|
|
3555
3764
|
export type RowGroupDisplayMode = "single-column" | "multi-column" | "custom";
|
|
3556
3765
|
/**
|
|
3557
3766
|
* Defines a field-based grouping configuration used to compute row group keys in the grid.
|
|
3767
|
+
*
|
|
3768
|
+
* @group Row Grouping
|
|
3558
3769
|
*/
|
|
3559
3770
|
export interface RowGroupField<T> {
|
|
3560
3771
|
/**
|
|
@@ -3576,10 +3787,14 @@ export interface RowGroupField<T> {
|
|
|
3576
3787
|
}
|
|
3577
3788
|
/**
|
|
3578
3789
|
* An item in the row group model. This can either be a column identifier (string) or a row group field definition.
|
|
3790
|
+
*
|
|
3791
|
+
* @group Row Grouping
|
|
3579
3792
|
*/
|
|
3580
3793
|
export type RowGroupModelItem<T> = string | RowGroupField<T>;
|
|
3581
3794
|
/**
|
|
3582
3795
|
* A callback function type for the columnMoveBegin event, fired when a column move starts.
|
|
3796
|
+
*
|
|
3797
|
+
* @group Events
|
|
3583
3798
|
*/
|
|
3584
3799
|
export type ColumnMoveBeginFn<T> = (
|
|
3585
3800
|
/**
|
|
@@ -3588,6 +3803,8 @@ export type ColumnMoveBeginFn<T> = (
|
|
|
3588
3803
|
params: ColumnMoveBeginParams<T>) => void;
|
|
3589
3804
|
/**
|
|
3590
3805
|
* The parameters provided when a column move operation begins. This event allows the move action to be canceled.
|
|
3806
|
+
*
|
|
3807
|
+
* @group Events
|
|
3591
3808
|
*/
|
|
3592
3809
|
export interface ColumnMoveBeginParams<T> {
|
|
3593
3810
|
/**
|
|
@@ -3617,6 +3834,8 @@ export interface ColumnMoveBeginParams<T> {
|
|
|
3617
3834
|
}
|
|
3618
3835
|
/**
|
|
3619
3836
|
* A callback function type for the columnMoveEnd event, fired when a column move completes.
|
|
3837
|
+
*
|
|
3838
|
+
* @group Events
|
|
3620
3839
|
*/
|
|
3621
3840
|
export type ColumnMoveEndFn<T> = (
|
|
3622
3841
|
/**
|
|
@@ -3625,6 +3844,8 @@ export type ColumnMoveEndFn<T> = (
|
|
|
3625
3844
|
params: ColumnMoveEndParams<T>) => void;
|
|
3626
3845
|
/**
|
|
3627
3846
|
* The parameters emitted when a column move operation has completed.
|
|
3847
|
+
*
|
|
3848
|
+
* @group Events
|
|
3628
3849
|
*/
|
|
3629
3850
|
export interface ColumnMoveEndParams<T> {
|
|
3630
3851
|
/**
|
|
@@ -3650,6 +3871,8 @@ export interface ColumnMoveEndParams<T> {
|
|
|
3650
3871
|
}
|
|
3651
3872
|
/**
|
|
3652
3873
|
* An event fired when a cell begins editing. This provides an opportunity to cancel the edit before any changes are made.
|
|
3874
|
+
*
|
|
3875
|
+
* @group Events
|
|
3653
3876
|
*/
|
|
3654
3877
|
export type EditBegin<T> = (
|
|
3655
3878
|
/**
|
|
@@ -3658,6 +3881,8 @@ export type EditBegin<T> = (
|
|
|
3658
3881
|
params: OnEditBeginParams<T>) => void;
|
|
3659
3882
|
/**
|
|
3660
3883
|
* An event fired when an in-progress cell edit is canceled. Most commonly triggered by user interaction, such as pressing the Escape key.
|
|
3884
|
+
*
|
|
3885
|
+
* @group Events
|
|
3661
3886
|
*/
|
|
3662
3887
|
export type EditCancel<T> = (
|
|
3663
3888
|
/**
|
|
@@ -3666,6 +3891,8 @@ export type EditCancel<T> = (
|
|
|
3666
3891
|
params: OnEditCancelParams<T>) => void;
|
|
3667
3892
|
/**
|
|
3668
3893
|
* An event fired when a cell finishes editing successfully (i.e., without error or cancellation).
|
|
3894
|
+
*
|
|
3895
|
+
* @group Events
|
|
3669
3896
|
*/
|
|
3670
3897
|
export type EditEnd<T> = (
|
|
3671
3898
|
/**
|
|
@@ -3674,6 +3901,8 @@ export type EditEnd<T> = (
|
|
|
3674
3901
|
params: OnEditEndParams<T>) => void;
|
|
3675
3902
|
/**
|
|
3676
3903
|
* An event fired when an error occurs during cell editing—either due to validation failure or runtime exception.
|
|
3904
|
+
*
|
|
3905
|
+
* @group Events
|
|
3677
3906
|
*/
|
|
3678
3907
|
export type EditError<T> = (
|
|
3679
3908
|
/**
|
|
@@ -3682,6 +3911,8 @@ export type EditError<T> = (
|
|
|
3682
3911
|
params: OnEditErrorParams<T>) => void;
|
|
3683
3912
|
/**
|
|
3684
3913
|
* A comprehensive map of all possible events that LyteNyte Grid may emit during its lifecycle.
|
|
3914
|
+
*
|
|
3915
|
+
* @group Events
|
|
3685
3916
|
*/
|
|
3686
3917
|
export interface GridEvents<T> {
|
|
3687
3918
|
/**
|
|
@@ -3755,6 +3986,8 @@ export interface GridEvents<T> {
|
|
|
3755
3986
|
}
|
|
3756
3987
|
/**
|
|
3757
3988
|
* An event fired when the row detail expansion process begins. This provides an opportunity to cancel expansion before it takes effect.
|
|
3989
|
+
*
|
|
3990
|
+
* @group Events
|
|
3758
3991
|
*/
|
|
3759
3992
|
export type RowDetailExpansionBegin<T> = (
|
|
3760
3993
|
/**
|
|
@@ -3763,6 +3996,9 @@ export type RowDetailExpansionBegin<T> = (
|
|
|
3763
3996
|
params: RowDetailExpansionBeginParams<T>) => void;
|
|
3764
3997
|
/**
|
|
3765
3998
|
* The parameters for the `rowDetailExpansionBegin` event. This event allows preventing expansion of row detail sections by calling `preventDefault()`.
|
|
3999
|
+
*
|
|
4000
|
+
*
|
|
4001
|
+
* @group Events
|
|
3766
4002
|
*/
|
|
3767
4003
|
export interface RowDetailExpansionBeginParams<T> {
|
|
3768
4004
|
/**
|
|
@@ -3780,6 +4016,8 @@ export interface RowDetailExpansionBeginParams<T> {
|
|
|
3780
4016
|
}
|
|
3781
4017
|
/**
|
|
3782
4018
|
* An event fired after the row detail expansion completes successfully.
|
|
4019
|
+
*
|
|
4020
|
+
* @group Events
|
|
3783
4021
|
*/
|
|
3784
4022
|
export type RowDetailExpansionEnd<T> = (
|
|
3785
4023
|
/**
|
|
@@ -3788,6 +4026,9 @@ export type RowDetailExpansionEnd<T> = (
|
|
|
3788
4026
|
params: RowDetailExpansionEndParams<T>) => void;
|
|
3789
4027
|
/**
|
|
3790
4028
|
* The parameters for the `rowDetailExpansionEnd` event, fired once a row detail expansion operation is complete.
|
|
4029
|
+
*
|
|
4030
|
+
*
|
|
4031
|
+
* @group Events
|
|
3791
4032
|
*/
|
|
3792
4033
|
export interface RowDetailExpansionEndParams<T> {
|
|
3793
4034
|
/**
|
|
@@ -3801,6 +4042,8 @@ export interface RowDetailExpansionEndParams<T> {
|
|
|
3801
4042
|
}
|
|
3802
4043
|
/**
|
|
3803
4044
|
* Event handler function type for the `rowExpand` event. Called when row group expansion is successfully completed.
|
|
4045
|
+
*
|
|
4046
|
+
* @group Events
|
|
3804
4047
|
*/
|
|
3805
4048
|
export type RowExpandFn<T> = (
|
|
3806
4049
|
/**
|
|
@@ -3809,6 +4052,8 @@ export type RowExpandFn<T> = (
|
|
|
3809
4052
|
params: RowExpandParams<T>) => void;
|
|
3810
4053
|
/**
|
|
3811
4054
|
* Event handler function type for the `rowExpandBegin` event. Triggered before row group expansion, allowing you to cancel the operation.
|
|
4055
|
+
*
|
|
4056
|
+
* @group Events
|
|
3812
4057
|
*/
|
|
3813
4058
|
export type RowExpandBeginFn<T> = (
|
|
3814
4059
|
/**
|
|
@@ -3817,6 +4062,8 @@ export type RowExpandBeginFn<T> = (
|
|
|
3817
4062
|
params: RowExpandBeginParams<T>) => void;
|
|
3818
4063
|
/**
|
|
3819
4064
|
* Describes the parameters passed to the `rowExpandBegin` event. This event is triggered before row group expansion occurs and provides a way to cancel the action.
|
|
4065
|
+
*
|
|
4066
|
+
* @group Events
|
|
3820
4067
|
*/
|
|
3821
4068
|
export interface RowExpandBeginParams<T> {
|
|
3822
4069
|
/**
|
|
@@ -3836,6 +4083,8 @@ export interface RowExpandBeginParams<T> {
|
|
|
3836
4083
|
}
|
|
3837
4084
|
/**
|
|
3838
4085
|
* Event handler function type for the `rowExpandError` event. Called when row group expansion fails due to an error.
|
|
4086
|
+
*
|
|
4087
|
+
* @group Events
|
|
3839
4088
|
*/
|
|
3840
4089
|
export type RowExpandErrorFn<T> = (
|
|
3841
4090
|
/**
|
|
@@ -3844,6 +4093,8 @@ export type RowExpandErrorFn<T> = (
|
|
|
3844
4093
|
params: RowExpandErrorParams<T>) => void;
|
|
3845
4094
|
/**
|
|
3846
4095
|
* Describes the parameters passed to the `rowExpandError` event. This event is emitted when an error occurs during row group expansion.
|
|
4096
|
+
*
|
|
4097
|
+
* @group Events
|
|
3847
4098
|
*/
|
|
3848
4099
|
export interface RowExpandErrorParams<T> {
|
|
3849
4100
|
/**
|
|
@@ -3863,6 +4114,8 @@ export interface RowExpandErrorParams<T> {
|
|
|
3863
4114
|
}
|
|
3864
4115
|
/**
|
|
3865
4116
|
* Describes the parameters passed to the `rowExpand` event. This event is emitted after a row group has been successfully expanded.
|
|
4117
|
+
*
|
|
4118
|
+
* @group Events
|
|
3866
4119
|
*/
|
|
3867
4120
|
export interface RowExpandParams<T> {
|
|
3868
4121
|
/**
|
|
@@ -3878,6 +4131,8 @@ export interface RowExpandParams<T> {
|
|
|
3878
4131
|
}
|
|
3879
4132
|
/**
|
|
3880
4133
|
* An event triggered when the "select all" operation begins. It provides an opportunity to cancel the selection.
|
|
4134
|
+
*
|
|
4135
|
+
* @group Events
|
|
3881
4136
|
*/
|
|
3882
4137
|
export type RowSelectAllBegin<T> = (
|
|
3883
4138
|
/**
|
|
@@ -3886,6 +4141,8 @@ export type RowSelectAllBegin<T> = (
|
|
|
3886
4141
|
params: RowSelectAllBeginParams<T>) => void;
|
|
3887
4142
|
/**
|
|
3888
4143
|
* The parameters provided when a "select all" operation starts. This event allows the operation to be canceled.
|
|
4144
|
+
*
|
|
4145
|
+
* @group Events
|
|
3889
4146
|
*/
|
|
3890
4147
|
export interface RowSelectAllBeginParams<T> {
|
|
3891
4148
|
/**
|
|
@@ -3904,6 +4161,8 @@ export interface RowSelectAllBeginParams<T> {
|
|
|
3904
4161
|
}
|
|
3905
4162
|
/**
|
|
3906
4163
|
* An event triggered once the "select all" operation is complete.
|
|
4164
|
+
*
|
|
4165
|
+
* @group Events
|
|
3907
4166
|
*/
|
|
3908
4167
|
export type RowSelectAllEnd<T> = (
|
|
3909
4168
|
/**
|
|
@@ -3912,6 +4171,8 @@ export type RowSelectAllEnd<T> = (
|
|
|
3912
4171
|
params: RowSelectAllEndParams<T>) => void;
|
|
3913
4172
|
/**
|
|
3914
4173
|
* The parameters passed when a "select all" operation completes.
|
|
4174
|
+
*
|
|
4175
|
+
* @group Events
|
|
3915
4176
|
*/
|
|
3916
4177
|
export interface RowSelectAllEndParams<T> {
|
|
3917
4178
|
/**
|
|
@@ -3926,6 +4187,8 @@ export interface RowSelectAllEndParams<T> {
|
|
|
3926
4187
|
}
|
|
3927
4188
|
/**
|
|
3928
4189
|
* An event triggered when a row selection starts. This event allows cancellation before the selection is finalized.
|
|
4190
|
+
*
|
|
4191
|
+
* @group Events
|
|
3929
4192
|
*/
|
|
3930
4193
|
export type RowSelectBegin<T> = (
|
|
3931
4194
|
/**
|
|
@@ -3935,6 +4198,8 @@ params: RowSelectBeginParams<T>) => void;
|
|
|
3935
4198
|
/**
|
|
3936
4199
|
* The parameters provided when a row selection begins. This event occurs before the selection change takes effect,
|
|
3937
4200
|
* giving the caller an opportunity to prevent it.
|
|
4201
|
+
*
|
|
4202
|
+
* @group Events
|
|
3938
4203
|
*/
|
|
3939
4204
|
export interface RowSelectBeginParams<T> {
|
|
3940
4205
|
/**
|
|
@@ -3957,6 +4222,8 @@ export interface RowSelectBeginParams<T> {
|
|
|
3957
4222
|
}
|
|
3958
4223
|
/**
|
|
3959
4224
|
* An event triggered once the row selection is finalized.
|
|
4225
|
+
*
|
|
4226
|
+
* @group Events
|
|
3960
4227
|
*/
|
|
3961
4228
|
export type RowSelectEnd<T> = (
|
|
3962
4229
|
/**
|
|
@@ -3965,6 +4232,8 @@ export type RowSelectEnd<T> = (
|
|
|
3965
4232
|
params: RowSelectEndParams<T>) => void;
|
|
3966
4233
|
/**
|
|
3967
4234
|
* The parameters passed when a row selection has completed.
|
|
4235
|
+
*
|
|
4236
|
+
* @group Events
|
|
3968
4237
|
*/
|
|
3969
4238
|
export interface RowSelectEndParams<T> {
|
|
3970
4239
|
/**
|
|
@@ -3984,6 +4253,8 @@ export interface RowSelectEndParams<T> {
|
|
|
3984
4253
|
/**
|
|
3985
4254
|
* A function used to render the content of a header cell.
|
|
3986
4255
|
* It receives renderer parameters and returns a ReactNode to render.
|
|
4256
|
+
*
|
|
4257
|
+
* @group Column Header
|
|
3987
4258
|
*/
|
|
3988
4259
|
export type HeaderCellRendererFn<T> = (
|
|
3989
4260
|
/**
|
|
@@ -3993,6 +4264,8 @@ params: HeaderCellRendererParams<T>) => ReactNode;
|
|
|
3993
4264
|
/**
|
|
3994
4265
|
* Parameters passed to the header cell renderer function. This
|
|
3995
4266
|
* provides access to the grid and column for rendering context.
|
|
4267
|
+
*
|
|
4268
|
+
* @group Column Header
|
|
3996
4269
|
*/
|
|
3997
4270
|
export interface HeaderCellRendererParams<T> {
|
|
3998
4271
|
/**
|
|
@@ -4007,6 +4280,8 @@ export interface HeaderCellRendererParams<T> {
|
|
|
4007
4280
|
/**
|
|
4008
4281
|
* Renderer function for floating header cells. Returns the visual
|
|
4009
4282
|
* contents for floating headers using provided parameters.
|
|
4283
|
+
*
|
|
4284
|
+
* @group Column Header
|
|
4010
4285
|
*/
|
|
4011
4286
|
export type HeaderFloatingCellRendererFn<T> = (
|
|
4012
4287
|
/**
|
|
@@ -4016,6 +4291,8 @@ params: HeaderFloatingCellRendererParams<T>) => ReactNode;
|
|
|
4016
4291
|
/**
|
|
4017
4292
|
* Parameters passed to the floating cell renderer. Provides grid
|
|
4018
4293
|
* and column context to determine what should be rendered.
|
|
4294
|
+
*
|
|
4295
|
+
* @group Column Header
|
|
4019
4296
|
*/
|
|
4020
4297
|
export interface HeaderFloatingCellRendererParams<T> {
|
|
4021
4298
|
/**
|
|
@@ -4030,17 +4307,23 @@ export interface HeaderFloatingCellRendererParams<T> {
|
|
|
4030
4307
|
/**
|
|
4031
4308
|
* Floating header cell renderer reference. Can be a string
|
|
4032
4309
|
* referencing a registered floating renderer or a function used directly by the column.
|
|
4310
|
+
*
|
|
4311
|
+
* @group Column Header
|
|
4033
4312
|
*/
|
|
4034
4313
|
export type HeaderFloatingCellRenderer<T> = string | HeaderFloatingCellRendererFn<T>;
|
|
4035
4314
|
/**
|
|
4036
4315
|
* Header cell renderer reference. This may be a registered renderer
|
|
4037
4316
|
* name (string) or a renderer function. If a string is used, it should match a renderer registered in the grid state.
|
|
4317
|
+
*
|
|
4318
|
+
* @group Column Header
|
|
4038
4319
|
*/
|
|
4039
4320
|
export type HeaderCellRenderer<T> = string | HeaderCellRendererFn<T>;
|
|
4040
4321
|
/**
|
|
4041
4322
|
* Describes the currently active cell position if editing is in progress.
|
|
4042
4323
|
*
|
|
4043
4324
|
* When no edit is active, this will be `undefined`.
|
|
4325
|
+
*
|
|
4326
|
+
* @group Cell Edit
|
|
4044
4327
|
*/
|
|
4045
4328
|
export interface EditActivePosition<T> {
|
|
4046
4329
|
/**
|
|
@@ -4054,6 +4337,8 @@ export interface EditActivePosition<T> {
|
|
|
4054
4337
|
}
|
|
4055
4338
|
/**
|
|
4056
4339
|
* Parameters accepted by the `editBegin` method to start editing a specific cell.
|
|
4340
|
+
*
|
|
4341
|
+
* @group Cell Edit
|
|
4057
4342
|
*/
|
|
4058
4343
|
export interface EditBeginParams<T> {
|
|
4059
4344
|
/**
|
|
@@ -4075,6 +4360,8 @@ export interface EditBeginParams<T> {
|
|
|
4075
4360
|
*
|
|
4076
4361
|
* - `"cell"`: Editing is active and inline
|
|
4077
4362
|
* - `"readonly"`: Editing is disabled entirely
|
|
4363
|
+
*
|
|
4364
|
+
* @group Cell Edit
|
|
4078
4365
|
*/
|
|
4079
4366
|
export type EditCellMode = "cell" | "readonly";
|
|
4080
4367
|
/**
|
|
@@ -4083,6 +4370,9 @@ export type EditCellMode = "cell" | "readonly";
|
|
|
4083
4370
|
* - `"single"`: Single click
|
|
4084
4371
|
* - `"double-click"`: Double click
|
|
4085
4372
|
* - `"none"`: Editing must be started via API or programmatically
|
|
4373
|
+
*
|
|
4374
|
+
*
|
|
4375
|
+
* @group Cell Edit
|
|
4086
4376
|
*/
|
|
4087
4377
|
export type EditClickActivator = "single" | "double-click" | "none";
|
|
4088
4378
|
/**
|
|
@@ -4091,12 +4381,16 @@ export type EditClickActivator = "single" | "double-click" | "none";
|
|
|
4091
4381
|
* Can be either:
|
|
4092
4382
|
* - A string key referencing a registered editor component
|
|
4093
4383
|
* - A function of type {@link EditRendererFn} for custom rendering logic
|
|
4384
|
+
*
|
|
4385
|
+
* @group Cell Edit
|
|
4094
4386
|
*/
|
|
4095
4387
|
export type EditRenderer<T> = string | EditRendererFn<T>;
|
|
4096
4388
|
/**
|
|
4097
4389
|
* A function that returns a React component to be rendered in edit mode for a given cell.
|
|
4098
4390
|
*
|
|
4099
4391
|
* Used for customizing editing UI. If omitted, a default HTML input will be used.
|
|
4392
|
+
*
|
|
4393
|
+
* @group Cell Edit
|
|
4100
4394
|
*/
|
|
4101
4395
|
export type EditRendererFn<T> = (
|
|
4102
4396
|
/**
|
|
@@ -4108,6 +4402,8 @@ params: EditRendererFnParams<T>) => ReactNode;
|
|
|
4108
4402
|
*
|
|
4109
4403
|
* These include positional and contextual data such as row, column, value, and grid
|
|
4110
4404
|
* instance, along with row validation status and change handlers.
|
|
4405
|
+
*
|
|
4406
|
+
* @group Cell Edit
|
|
4111
4407
|
*/
|
|
4112
4408
|
export interface EditRendererFnParams<T> {
|
|
4113
4409
|
/**
|
|
@@ -4132,6 +4428,8 @@ export interface EditRendererFnParams<T> {
|
|
|
4132
4428
|
* - `false`: validation failed
|
|
4133
4429
|
* - `true` or `null`: validation passed or hasn't run
|
|
4134
4430
|
* - `Record<string, any>`: failed with details per column
|
|
4431
|
+
*
|
|
4432
|
+
* @group Cell Edit
|
|
4135
4433
|
*/
|
|
4136
4434
|
readonly rowValidationState: Record<string, any> | boolean | null;
|
|
4137
4435
|
/**
|
|
@@ -4139,6 +4437,8 @@ export interface EditRendererFnParams<T> {
|
|
|
4139
4437
|
*
|
|
4140
4438
|
* Managed internally by the grid, but should be aligned with the expected shape of your
|
|
4141
4439
|
* application's data model.
|
|
4440
|
+
*
|
|
4441
|
+
* @group Cell Edit
|
|
4142
4442
|
*/
|
|
4143
4443
|
readonly value: any;
|
|
4144
4444
|
/**
|
|
@@ -4155,6 +4455,8 @@ export interface EditRendererFnParams<T> {
|
|
|
4155
4455
|
*
|
|
4156
4456
|
* - `true` or `null` if the row is valid
|
|
4157
4457
|
* - `false` or a `Record<string, any>` describing errors if invalid
|
|
4458
|
+
*
|
|
4459
|
+
* @group Cell Edit
|
|
4158
4460
|
*/
|
|
4159
4461
|
export type EditRowValidatorFn<T> = (
|
|
4160
4462
|
/**
|
|
@@ -4165,6 +4467,8 @@ params: EditRowValidatorFnParams<T>) => Record<string, any> | boolean;
|
|
|
4165
4467
|
* Input arguments passed to {@link EditRowValidatorFn}.
|
|
4166
4468
|
*
|
|
4167
4469
|
* Used to perform validation on the entire row during or after edit submission.
|
|
4470
|
+
*
|
|
4471
|
+
* @group Cell Edit
|
|
4168
4472
|
*/
|
|
4169
4473
|
export interface EditRowValidatorFnParams<T> {
|
|
4170
4474
|
/**
|
|
@@ -4189,6 +4493,8 @@ export interface EditRowValidatorFnParams<T> {
|
|
|
4189
4493
|
*
|
|
4190
4494
|
* Required when dealing with nested, computed, or non-primitive values that the grid
|
|
4191
4495
|
* cannot update automatically.
|
|
4496
|
+
*
|
|
4497
|
+
* @group Cell Edit
|
|
4192
4498
|
*/
|
|
4193
4499
|
export type EditSetterFn<T> = (
|
|
4194
4500
|
/**
|
|
@@ -4199,6 +4505,8 @@ params: EditSetterParams<T>) => any;
|
|
|
4199
4505
|
* Input parameters passed to an {@link EditSetterFn}.
|
|
4200
4506
|
*
|
|
4201
4507
|
* Provides the context needed to compute and apply new row data based on edit input.
|
|
4508
|
+
*
|
|
4509
|
+
* @group Cell Edit
|
|
4202
4510
|
*/
|
|
4203
4511
|
export interface EditSetterParams<T> {
|
|
4204
4512
|
/**
|
|
@@ -4230,6 +4538,8 @@ export interface EditSetterParams<T> {
|
|
|
4230
4538
|
}
|
|
4231
4539
|
/**
|
|
4232
4540
|
* Parameters passed to the `editUpdate` method, used to submit a value change.
|
|
4541
|
+
*
|
|
4542
|
+
* @group Cell Edit
|
|
4233
4543
|
*/
|
|
4234
4544
|
export interface EditUpdateParams<T> {
|
|
4235
4545
|
/**
|
|
@@ -4251,6 +4561,8 @@ export interface EditUpdateParams<T> {
|
|
|
4251
4561
|
*
|
|
4252
4562
|
* - Use `true` to enable editing for all rows.
|
|
4253
4563
|
* - Use {@link EditableFn} for conditional, row-specific editability.
|
|
4564
|
+
*
|
|
4565
|
+
* @group Cell Edit
|
|
4254
4566
|
*/
|
|
4255
4567
|
export type Editable<T> = boolean | EditableFn<T>;
|
|
4256
4568
|
/**
|
|
@@ -4258,6 +4570,8 @@ export type Editable<T> = boolean | EditableFn<T>;
|
|
|
4258
4570
|
*
|
|
4259
4571
|
* If cell editing is enabled in LyteNyte Grid, this function is evaluated per cell. Use
|
|
4260
4572
|
* `true` for globally editable columns or {@link EditableFn} for row-specific logic.
|
|
4573
|
+
*
|
|
4574
|
+
* @group Cell Edit
|
|
4261
4575
|
*/
|
|
4262
4576
|
export type EditableFn<T> = (
|
|
4263
4577
|
/**
|
|
@@ -4270,6 +4584,8 @@ params: EditableFnParams<T>) => boolean;
|
|
|
4270
4584
|
*
|
|
4271
4585
|
* These include the row index, the row node object, the grid instance, and the column
|
|
4272
4586
|
* definition.
|
|
4587
|
+
*
|
|
4588
|
+
* @group Cell Edit
|
|
4273
4589
|
*/
|
|
4274
4590
|
export interface EditableFnParams<T> {
|
|
4275
4591
|
/**
|
|
@@ -4291,6 +4607,8 @@ export interface EditableFnParams<T> {
|
|
|
4291
4607
|
}
|
|
4292
4608
|
/**
|
|
4293
4609
|
* Parameters dispatched with the `onEditBegin` event, triggered when editing starts.
|
|
4610
|
+
*
|
|
4611
|
+
* @group Events
|
|
4294
4612
|
*/
|
|
4295
4613
|
export interface OnEditBeginParams<T> {
|
|
4296
4614
|
/**
|
|
@@ -4308,6 +4626,8 @@ export interface OnEditBeginParams<T> {
|
|
|
4308
4626
|
}
|
|
4309
4627
|
/**
|
|
4310
4628
|
* Parameters passed to the `onEditCancel` event, triggered when editing is aborted (e.g., Escape key).
|
|
4629
|
+
*
|
|
4630
|
+
* @group Events
|
|
4311
4631
|
*/
|
|
4312
4632
|
export interface OnEditCancelParams<T> {
|
|
4313
4633
|
/**
|
|
@@ -4320,11 +4640,15 @@ export interface OnEditCancelParams<T> {
|
|
|
4320
4640
|
readonly rowIndex: number;
|
|
4321
4641
|
/**
|
|
4322
4642
|
* The current value of the cell during an edit interaction.
|
|
4643
|
+
*
|
|
4644
|
+
* @group Events
|
|
4323
4645
|
*/
|
|
4324
4646
|
readonly data: any;
|
|
4325
4647
|
}
|
|
4326
4648
|
/**
|
|
4327
4649
|
* Parameters passed to the `onEditEnd` event, triggered when editing successfully completes.
|
|
4650
|
+
*
|
|
4651
|
+
* @group Events
|
|
4328
4652
|
*/
|
|
4329
4653
|
export interface OnEditEndParams<T> {
|
|
4330
4654
|
/**
|
|
@@ -4337,11 +4661,15 @@ export interface OnEditEndParams<T> {
|
|
|
4337
4661
|
readonly rowIndex: number;
|
|
4338
4662
|
/**
|
|
4339
4663
|
* The current value of the cell during an edit interaction.
|
|
4664
|
+
*
|
|
4665
|
+
* @group Events
|
|
4340
4666
|
*/
|
|
4341
4667
|
readonly data: any;
|
|
4342
4668
|
}
|
|
4343
4669
|
/**
|
|
4344
4670
|
* Parameters passed to the `onEditError` event, triggered when validation or logic errors occur during editing.
|
|
4671
|
+
*
|
|
4672
|
+
* @group Events
|
|
4345
4673
|
*/
|
|
4346
4674
|
export interface OnEditErrorParams<T> {
|
|
4347
4675
|
/**
|
|
@@ -4354,6 +4682,8 @@ export interface OnEditErrorParams<T> {
|
|
|
4354
4682
|
readonly rowIndex: number;
|
|
4355
4683
|
/**
|
|
4356
4684
|
* The current value of the cell during an edit interaction.
|
|
4685
|
+
*
|
|
4686
|
+
* @group Events
|
|
4357
4687
|
*/
|
|
4358
4688
|
readonly data: any;
|
|
4359
4689
|
/**
|
|
@@ -4368,6 +4698,8 @@ export interface OnEditErrorParams<T> {
|
|
|
4368
4698
|
}
|
|
4369
4699
|
/**
|
|
4370
4700
|
* Describes the focus position of a floating header cell.
|
|
4701
|
+
*
|
|
4702
|
+
* @group Navigation
|
|
4371
4703
|
*/
|
|
4372
4704
|
export interface PositionFloatingCell {
|
|
4373
4705
|
/**
|
|
@@ -4381,6 +4713,8 @@ export interface PositionFloatingCell {
|
|
|
4381
4713
|
}
|
|
4382
4714
|
/**
|
|
4383
4715
|
* Describes the focus position when a full width row is active.
|
|
4716
|
+
*
|
|
4717
|
+
* @group Navigation
|
|
4384
4718
|
*/
|
|
4385
4719
|
export interface PositionFullWidthRow {
|
|
4386
4720
|
/**
|
|
@@ -4398,6 +4732,8 @@ export interface PositionFullWidthRow {
|
|
|
4398
4732
|
}
|
|
4399
4733
|
/**
|
|
4400
4734
|
* Represents the current focus position of a regular cell in the grid.
|
|
4735
|
+
*
|
|
4736
|
+
* @group Navigation
|
|
4401
4737
|
*/
|
|
4402
4738
|
export interface PositionGridCell {
|
|
4403
4739
|
/**
|
|
@@ -4420,6 +4756,8 @@ export interface PositionGridCell {
|
|
|
4420
4756
|
/**
|
|
4421
4757
|
* The root reference of a grid cell. If a cell is obscured by a rowspan
|
|
4422
4758
|
* or colspan, it points to the actual root cell containing the data.
|
|
4759
|
+
*
|
|
4760
|
+
* @group Navigation
|
|
4423
4761
|
*/
|
|
4424
4762
|
export interface PositionGridCellRoot {
|
|
4425
4763
|
/**
|
|
@@ -4441,6 +4779,8 @@ export interface PositionGridCellRoot {
|
|
|
4441
4779
|
}
|
|
4442
4780
|
/**
|
|
4443
4781
|
* Describes the focus position of a standard header cell.
|
|
4782
|
+
*
|
|
4783
|
+
* @group Navigation
|
|
4444
4784
|
*/
|
|
4445
4785
|
export interface PositionHeaderCell {
|
|
4446
4786
|
/**
|
|
@@ -4454,6 +4794,8 @@ export interface PositionHeaderCell {
|
|
|
4454
4794
|
}
|
|
4455
4795
|
/**
|
|
4456
4796
|
* Describes the focus position of a header group cell in the column hierarchy.
|
|
4797
|
+
*
|
|
4798
|
+
* @group Navigation
|
|
4457
4799
|
*/
|
|
4458
4800
|
export interface PositionHeaderGroupCell {
|
|
4459
4801
|
/**
|
|
@@ -4479,17 +4821,23 @@ export interface PositionHeaderGroupCell {
|
|
|
4479
4821
|
}
|
|
4480
4822
|
/**
|
|
4481
4823
|
* Union of all valid focusable positions in the grid: cells, headers, full width rows, etc.
|
|
4824
|
+
*
|
|
4825
|
+
* @group Navigation
|
|
4482
4826
|
*/
|
|
4483
4827
|
export type PositionUnion = PositionGridCell | PositionFloatingCell | PositionHeaderCell | PositionFullWidthRow | PositionHeaderGroupCell;
|
|
4484
4828
|
/**
|
|
4485
4829
|
* Specifies the height of the row detail section.
|
|
4486
4830
|
* Can be a fixed number of pixels or "auto" to size based on content.
|
|
4831
|
+
*
|
|
4832
|
+
* @group Row Data Source
|
|
4487
4833
|
*/
|
|
4488
4834
|
export type RowDetailHeight = number | "auto";
|
|
4489
4835
|
/**
|
|
4490
4836
|
* A function used to render custom row detail content.
|
|
4491
4837
|
* It should return a ReactNode to be displayed in the row's
|
|
4492
4838
|
* expanded detail area.
|
|
4839
|
+
*
|
|
4840
|
+
* @group Row Data Source
|
|
4493
4841
|
*/
|
|
4494
4842
|
export type RowDetailRendererFn<T> = (
|
|
4495
4843
|
/**
|
|
@@ -4500,6 +4848,8 @@ params: RowDetailRendererParams<T>) => ReactNode;
|
|
|
4500
4848
|
* Defines the parameters passed to a row detail renderer. These parameters
|
|
4501
4849
|
* include the row index, the row node metadata,
|
|
4502
4850
|
* and a reference to the grid instance.
|
|
4851
|
+
*
|
|
4852
|
+
* @group Row Data Source
|
|
4503
4853
|
*/
|
|
4504
4854
|
export interface RowDetailRendererParams<T> {
|
|
4505
4855
|
/**
|
|
@@ -4517,6 +4867,8 @@ export interface RowDetailRendererParams<T> {
|
|
|
4517
4867
|
}
|
|
4518
4868
|
/**
|
|
4519
4869
|
* Options for performing bulk selection or deselection of all rows.
|
|
4870
|
+
*
|
|
4871
|
+
* @group Row Selection
|
|
4520
4872
|
*/
|
|
4521
4873
|
export interface RowSelectAllOptions {
|
|
4522
4874
|
/**
|
|
@@ -4526,6 +4878,8 @@ export interface RowSelectAllOptions {
|
|
|
4526
4878
|
}
|
|
4527
4879
|
/**
|
|
4528
4880
|
* Configuration options used when performing row selection operations.
|
|
4881
|
+
*
|
|
4882
|
+
* @group Row Selection
|
|
4529
4883
|
*/
|
|
4530
4884
|
export interface RowSelectOptions {
|
|
4531
4885
|
/**
|
|
@@ -4554,6 +4908,8 @@ export interface RowSelectOptions {
|
|
|
4554
4908
|
* - "single-click" selects a row with a single mouse click.
|
|
4555
4909
|
* - "double-click" requires a double-click to select.
|
|
4556
4910
|
* - "none" disables interaction-based row selection.
|
|
4911
|
+
*
|
|
4912
|
+
* @group Row Selection
|
|
4557
4913
|
*/
|
|
4558
4914
|
export type RowSelectionActivator = "single-click" | "double-click" | "none";
|
|
4559
4915
|
/**
|
|
@@ -4561,11 +4917,15 @@ export type RowSelectionActivator = "single-click" | "double-click" | "none";
|
|
|
4561
4917
|
* - "single" allows only one row to be selected at a time.
|
|
4562
4918
|
* - "multiple" allows multiple row selections.
|
|
4563
4919
|
* - "none" disables row selection entirely.
|
|
4920
|
+
*
|
|
4921
|
+
* @group Row Selection
|
|
4564
4922
|
*/
|
|
4565
4923
|
export type RowSelectionMode = "single" | "multiple" | "none";
|
|
4566
4924
|
/**
|
|
4567
4925
|
* Contains data associated with a drag operation,
|
|
4568
4926
|
* including transferable and site-local information.
|
|
4927
|
+
*
|
|
4928
|
+
* @group Row Drag
|
|
4569
4929
|
*/
|
|
4570
4930
|
export interface DragData {
|
|
4571
4931
|
/**
|
|
@@ -4580,6 +4940,8 @@ export interface DragData {
|
|
|
4580
4940
|
}
|
|
4581
4941
|
/**
|
|
4582
4942
|
* Callback function executed during a drag event.
|
|
4943
|
+
*
|
|
4944
|
+
* @group Row Drag
|
|
4583
4945
|
*/
|
|
4584
4946
|
export type DragEventFn = (
|
|
4585
4947
|
/**
|
|
@@ -4588,6 +4950,8 @@ export type DragEventFn = (
|
|
|
4588
4950
|
params: DragEventParams) => void;
|
|
4589
4951
|
/**
|
|
4590
4952
|
* Arguments passed during a drag event lifecycle.
|
|
4953
|
+
*
|
|
4954
|
+
* @group Row Drag
|
|
4591
4955
|
*/
|
|
4592
4956
|
export interface DragEventParams {
|
|
4593
4957
|
/**
|
|
@@ -4606,6 +4970,8 @@ export interface DragEventParams {
|
|
|
4606
4970
|
/**
|
|
4607
4971
|
* Function to render the drag placeholder UI. This UI
|
|
4608
4972
|
* is rendered in isolation and does not respond to app state changes.
|
|
4973
|
+
*
|
|
4974
|
+
* @group Row Drag
|
|
4609
4975
|
*/
|
|
4610
4976
|
export type DragPlaceholderFn<T> = (
|
|
4611
4977
|
/**
|
|
@@ -4614,6 +4980,8 @@ export type DragPlaceholderFn<T> = (
|
|
|
4614
4980
|
params: DragPlaceholderParams<T>) => ReactNode;
|
|
4615
4981
|
/**
|
|
4616
4982
|
* Parameters passed when rendering the drag placeholder content.
|
|
4983
|
+
*
|
|
4984
|
+
* @group Row Drag
|
|
4617
4985
|
*/
|
|
4618
4986
|
export interface DragPlaceholderParams<T> {
|
|
4619
4987
|
/**
|
|
@@ -4627,6 +4995,8 @@ export interface DragPlaceholderParams<T> {
|
|
|
4627
4995
|
}
|
|
4628
4996
|
/**
|
|
4629
4997
|
* Represents the current pointer position during a drag operation.
|
|
4998
|
+
*
|
|
4999
|
+
* @group Row Drag
|
|
4630
5000
|
*/
|
|
4631
5001
|
export interface DragPosition {
|
|
4632
5002
|
/**
|
|
@@ -4640,6 +5010,8 @@ export interface DragPosition {
|
|
|
4640
5010
|
}
|
|
4641
5011
|
/**
|
|
4642
5012
|
* Fired when a drop action is finalized and the dragged element is released over a drop zone.
|
|
5013
|
+
*
|
|
5014
|
+
* @group Row Drag
|
|
4643
5015
|
*/
|
|
4644
5016
|
export type DropEventFn = (
|
|
4645
5017
|
/**
|
|
@@ -4648,6 +5020,8 @@ export type DropEventFn = (
|
|
|
4648
5020
|
params: DropEventParams) => void;
|
|
4649
5021
|
/**
|
|
4650
5022
|
* Represents the full context passed to the drop event handler.
|
|
5023
|
+
*
|
|
5024
|
+
* @group Row Drag
|
|
4651
5025
|
*/
|
|
4652
5026
|
export interface DropEventParams {
|
|
4653
5027
|
/**
|
|
@@ -4669,6 +5043,8 @@ export interface DropEventParams {
|
|
|
4669
5043
|
}
|
|
4670
5044
|
/**
|
|
4671
5045
|
* Describes the final state of a drag-and-drop move operation.
|
|
5046
|
+
*
|
|
5047
|
+
* @group Row Drag
|
|
4672
5048
|
*/
|
|
4673
5049
|
export interface DragMoveState {
|
|
4674
5050
|
/**
|
|
@@ -4706,6 +5082,8 @@ export interface DragMoveState {
|
|
|
4706
5082
|
}
|
|
4707
5083
|
/**
|
|
4708
5084
|
* Function used to provide the data that will be associated with a drag operation.
|
|
5085
|
+
*
|
|
5086
|
+
* @group Row Drag
|
|
4709
5087
|
*/
|
|
4710
5088
|
export type GetDragDataFn<T> = (
|
|
4711
5089
|
/**
|
|
@@ -4715,6 +5093,8 @@ params: GetDragDataParams<T>) => DragData;
|
|
|
4715
5093
|
/**
|
|
4716
5094
|
* Defines the input parameters for the function
|
|
4717
5095
|
* that provides data during a drag operation.
|
|
5096
|
+
*
|
|
5097
|
+
* @group Row Drag
|
|
4718
5098
|
*/
|
|
4719
5099
|
export interface GetDragDataParams<T> {
|
|
4720
5100
|
/**
|
|
@@ -4728,6 +5108,8 @@ export interface GetDragDataParams<T> {
|
|
|
4728
5108
|
}
|
|
4729
5109
|
/**
|
|
4730
5110
|
* Parameters for configuring drag behavior using a React hook.
|
|
5111
|
+
*
|
|
5112
|
+
* @group Row Drag
|
|
4731
5113
|
*/
|
|
4732
5114
|
export interface UseRowDragParams<T> {
|
|
4733
5115
|
/**
|
|
@@ -4794,6 +5176,8 @@ export interface UseRowDragParams<T> {
|
|
|
4794
5176
|
* or operate on a subset of the grid's data regardless of row or column reordering. However,
|
|
4795
5177
|
* if the number of rows or columns changes, the rect may be invalidated if it extends
|
|
4796
5178
|
* beyond the new bounds.
|
|
5179
|
+
*
|
|
5180
|
+
* @group Export
|
|
4797
5181
|
*/
|
|
4798
5182
|
export interface DataRect {
|
|
4799
5183
|
/**
|
|
@@ -4815,6 +5199,8 @@ export interface DataRect {
|
|
|
4815
5199
|
}
|
|
4816
5200
|
/**
|
|
4817
5201
|
* Parameters for exporting a CSV file from LyteNyte Grid.
|
|
5202
|
+
*
|
|
5203
|
+
* @group Export
|
|
4818
5204
|
*/
|
|
4819
5205
|
export interface ExportCsvParams {
|
|
4820
5206
|
/**
|
|
@@ -4844,6 +5230,8 @@ export interface ExportCsvParams {
|
|
|
4844
5230
|
* Signature for the function that exports a DataRect from the grid.
|
|
4845
5231
|
*
|
|
4846
5232
|
* Called via the LyteNyte Grid API when exporting a selection of cells.
|
|
5233
|
+
*
|
|
5234
|
+
* @group Export
|
|
4847
5235
|
*/
|
|
4848
5236
|
export type ExportDataRectFn<T> = (
|
|
4849
5237
|
/**
|
|
@@ -4852,6 +5240,8 @@ export type ExportDataRectFn<T> = (
|
|
|
4852
5240
|
params: ExportDataRectParams) => Promise<ExportDataRectResult<T>>;
|
|
4853
5241
|
/**
|
|
4854
5242
|
* Parameters for exporting a specific rectangular region of the grid using a DataRect.
|
|
5243
|
+
*
|
|
5244
|
+
* @group Export
|
|
4855
5245
|
*/
|
|
4856
5246
|
export interface ExportDataRectParams {
|
|
4857
5247
|
/**
|
|
@@ -4867,6 +5257,8 @@ export interface ExportDataRectParams {
|
|
|
4867
5257
|
}
|
|
4868
5258
|
/**
|
|
4869
5259
|
* The result structure returned after exporting a DataRect from LyteNyte Grid.
|
|
5260
|
+
*
|
|
5261
|
+
* @group Export
|
|
4870
5262
|
*/
|
|
4871
5263
|
export interface ExportDataRectResult<T> {
|
|
4872
5264
|
/**
|
|
@@ -4890,6 +5282,8 @@ export interface ExportDataRectResult<T> {
|
|
|
4890
5282
|
* Configuration for the column dimension of a pivot.
|
|
4891
5283
|
*
|
|
4892
5284
|
* Each item defines a field whose values will be used to generate dynamic columns in the pivot view.
|
|
5285
|
+
*
|
|
5286
|
+
* @group Column Pivots
|
|
4893
5287
|
*/
|
|
4894
5288
|
export interface ColumnPivotColumnItem {
|
|
4895
5289
|
/**
|
|
@@ -4908,6 +5302,8 @@ export interface ColumnPivotColumnItem {
|
|
|
4908
5302
|
*
|
|
4909
5303
|
* This includes row grouping, column generation, value aggregation, and sort/filter
|
|
4910
5304
|
* configuration for the pivoted result.
|
|
5305
|
+
*
|
|
5306
|
+
* @group Column Pivots
|
|
4911
5307
|
*/
|
|
4912
5308
|
export interface ColumnPivotModel<T> {
|
|
4913
5309
|
/**
|
|
@@ -4948,6 +5344,8 @@ export interface ColumnPivotModel<T> {
|
|
|
4948
5344
|
* Configuration for row-level grouping in a column pivot model.
|
|
4949
5345
|
*
|
|
4950
5346
|
* These items define which fields should be used to group rows before creating pivot columns.
|
|
5347
|
+
*
|
|
5348
|
+
* @group Column Pivots
|
|
4951
5349
|
*/
|
|
4952
5350
|
export interface ColumnPivotRowItem {
|
|
4953
5351
|
/**
|
|
@@ -4965,6 +5363,8 @@ export interface ColumnPivotRowItem {
|
|
|
4965
5363
|
* Configuration for value fields in a pivot (also known as measures).
|
|
4966
5364
|
*
|
|
4967
5365
|
* These values define what numeric or aggregate data should be shown for each cell in the pivot result.
|
|
5366
|
+
*
|
|
5367
|
+
* @group Column Pivots
|
|
4968
5368
|
*/
|
|
4969
5369
|
export interface ColumnPivotValueItem<T> {
|
|
4970
5370
|
/**
|
|
@@ -4987,6 +5387,8 @@ export interface ColumnPivotValueItem<T> {
|
|
|
4987
5387
|
*
|
|
4988
5388
|
* This structure is passed to grid internals to associate a rendering component
|
|
4989
5389
|
* for dialogs triggered by grid interactions.
|
|
5390
|
+
*
|
|
5391
|
+
* @group Frames
|
|
4990
5392
|
*/
|
|
4991
5393
|
export interface DialogFrame<T> {
|
|
4992
5394
|
/**
|
|
@@ -5002,6 +5404,8 @@ export interface DialogFrame<T> {
|
|
|
5002
5404
|
* control parameters and should return a valid ReactNode to render as a dialog.
|
|
5003
5405
|
*
|
|
5004
5406
|
* Note: The dialog component used should support controlled open/close behavior.
|
|
5407
|
+
*
|
|
5408
|
+
* @group Frames
|
|
5005
5409
|
*/
|
|
5006
5410
|
export type DialogFrameRenderer<T> = (
|
|
5007
5411
|
/**
|
|
@@ -5013,6 +5417,8 @@ params: DialogFrameRendererParams<T>) => ReactNode;
|
|
|
5013
5417
|
*
|
|
5014
5418
|
* These include the grid context, the frame being rendered, and any additional
|
|
5015
5419
|
* user-provided context.
|
|
5420
|
+
*
|
|
5421
|
+
* @group Frames
|
|
5016
5422
|
*/
|
|
5017
5423
|
export interface DialogFrameRendererParams<T> {
|
|
5018
5424
|
/**
|
|
@@ -5024,6 +5430,8 @@ export interface DialogFrameRendererParams<T> {
|
|
|
5024
5430
|
*
|
|
5025
5431
|
* This context is supplied programmatically at the point of invoking the frame.
|
|
5026
5432
|
* It can contain any arbitrary information required for rendering behavior.
|
|
5433
|
+
*
|
|
5434
|
+
* @group Frames
|
|
5027
5435
|
*/
|
|
5028
5436
|
readonly context?: any;
|
|
5029
5437
|
/**
|
|
@@ -5036,6 +5444,8 @@ export interface DialogFrameRendererParams<T> {
|
|
|
5036
5444
|
*
|
|
5037
5445
|
* The popover frame is triggered by LyteNyte Grid interactions and used to display
|
|
5038
5446
|
* contextual information, editors, or auxiliary UI near a cell or element.
|
|
5447
|
+
*
|
|
5448
|
+
* @group Frames
|
|
5039
5449
|
*/
|
|
5040
5450
|
export interface PopoverFrame<T> {
|
|
5041
5451
|
/**
|
|
@@ -5048,6 +5458,8 @@ export interface PopoverFrame<T> {
|
|
|
5048
5458
|
*
|
|
5049
5459
|
* LyteNyte Grid does not include a built-in popover renderer. Developers must use their
|
|
5050
5460
|
* own popover UI libraries and integrate them by implementing this renderer interface.
|
|
5461
|
+
*
|
|
5462
|
+
* @group Frames
|
|
5051
5463
|
*/
|
|
5052
5464
|
export type PopoverFrameRenderer<T> = (
|
|
5053
5465
|
/**
|
|
@@ -5059,6 +5471,8 @@ params: PopoverFrameRendererParams<T>) => ReactNode;
|
|
|
5059
5471
|
*
|
|
5060
5472
|
* Includes information about the grid, the target HTML element or virtual
|
|
5061
5473
|
* target to anchor the popover, and the frame being rendered.
|
|
5474
|
+
*
|
|
5475
|
+
* @group Frames
|
|
5062
5476
|
*/
|
|
5063
5477
|
export interface PopoverFrameRendererParams<T> {
|
|
5064
5478
|
/**
|
|
@@ -5070,6 +5484,8 @@ export interface PopoverFrameRendererParams<T> {
|
|
|
5070
5484
|
*
|
|
5071
5485
|
* This context is supplied programmatically at the point of invoking the frame.
|
|
5072
5486
|
* It can contain any arbitrary information required for rendering behavior.
|
|
5487
|
+
*
|
|
5488
|
+
* @group Frames
|
|
5073
5489
|
*/
|
|
5074
5490
|
readonly context?: any;
|
|
5075
5491
|
/**
|
|
@@ -5091,10 +5507,14 @@ export interface PopoverFrameRendererParams<T> {
|
|
|
5091
5507
|
* - `"none"`: Disables all cell selection interactions.
|
|
5092
5508
|
*
|
|
5093
5509
|
* Useful for enabling features like copy-paste, cell highlighting, and keyboard navigation.
|
|
5510
|
+
*
|
|
5511
|
+
* @group Cell Selection
|
|
5094
5512
|
*/
|
|
5095
5513
|
export type CellSelectionMode = "range" | "multi-range" | "none";
|
|
5096
5514
|
/**
|
|
5097
5515
|
* Fetches pivoted columns for the grid's current pivot configuration.
|
|
5516
|
+
*
|
|
5517
|
+
* @group Row Data Source
|
|
5098
5518
|
*/
|
|
5099
5519
|
export type DataColumnPivotFetcherFn<T> = (
|
|
5100
5520
|
/**
|
|
@@ -5103,6 +5523,8 @@ export type DataColumnPivotFetcherFn<T> = (
|
|
|
5103
5523
|
params: DataColumnPivotFetcherParams<T>) => Promise<Column<T>[]>;
|
|
5104
5524
|
/**
|
|
5105
5525
|
* Parameters passed to the column pivot fetcher function.
|
|
5526
|
+
*
|
|
5527
|
+
* @group Row Data Source
|
|
5106
5528
|
*/
|
|
5107
5529
|
export interface DataColumnPivotFetcherParams<T> {
|
|
5108
5530
|
/**
|
|
@@ -5120,6 +5542,8 @@ export interface DataColumnPivotFetcherParams<T> {
|
|
|
5120
5542
|
}
|
|
5121
5543
|
/**
|
|
5122
5544
|
* Fetches grid row data asynchronously for the LyteNyte Server Data Source.
|
|
5545
|
+
*
|
|
5546
|
+
* @group Row Data Source
|
|
5123
5547
|
*/
|
|
5124
5548
|
export type DataFetcherFn<T> = (
|
|
5125
5549
|
/**
|
|
@@ -5128,6 +5552,8 @@ export type DataFetcherFn<T> = (
|
|
|
5128
5552
|
params: DataFetcherParams<T>) => Promise<(DataResponse | DataResponsePinned)[]>;
|
|
5129
5553
|
/**
|
|
5130
5554
|
* Input parameters provided to a grid data fetcher function.
|
|
5555
|
+
*
|
|
5556
|
+
* @group Row Data Source
|
|
5131
5557
|
*/
|
|
5132
5558
|
export interface DataFetcherParams<T> {
|
|
5133
5559
|
/**
|
|
@@ -5149,6 +5575,8 @@ export interface DataFetcherParams<T> {
|
|
|
5149
5575
|
}
|
|
5150
5576
|
/**
|
|
5151
5577
|
* Fetches items used in "in" filters from a server-side source.
|
|
5578
|
+
*
|
|
5579
|
+
* @group Row Data Source
|
|
5152
5580
|
*/
|
|
5153
5581
|
export type DataInFilterItemFetcherFn<T> = (
|
|
5154
5582
|
/**
|
|
@@ -5157,6 +5585,8 @@ export type DataInFilterItemFetcherFn<T> = (
|
|
|
5157
5585
|
params: DataInFilterItemFetcherParams<T>) => Promise<FilterInFilterItem[]> | FilterInFilterItem[];
|
|
5158
5586
|
/**
|
|
5159
5587
|
* Parameters passed to the in-filter fetcher function.
|
|
5588
|
+
*
|
|
5589
|
+
* @group Row Data Source
|
|
5160
5590
|
*/
|
|
5161
5591
|
export interface DataInFilterItemFetcherParams<T> {
|
|
5162
5592
|
/**
|
|
@@ -5174,6 +5604,8 @@ export interface DataInFilterItemFetcherParams<T> {
|
|
|
5174
5604
|
}
|
|
5175
5605
|
/**
|
|
5176
5606
|
* Represents a specific request for data to an external data source.
|
|
5607
|
+
*
|
|
5608
|
+
* @group Row Data Source
|
|
5177
5609
|
*/
|
|
5178
5610
|
export interface DataRequest {
|
|
5179
5611
|
/**
|
|
@@ -5203,6 +5635,8 @@ export interface DataRequest {
|
|
|
5203
5635
|
}
|
|
5204
5636
|
/**
|
|
5205
5637
|
* Describes the current grid state used to construct a request for external data.
|
|
5638
|
+
*
|
|
5639
|
+
* @group Row Data Source
|
|
5206
5640
|
*/
|
|
5207
5641
|
export interface DataRequestModel<T> {
|
|
5208
5642
|
/**
|
|
@@ -5252,6 +5686,8 @@ export interface DataRequestModel<T> {
|
|
|
5252
5686
|
}
|
|
5253
5687
|
/**
|
|
5254
5688
|
* Response object for row data from a center section request.
|
|
5689
|
+
*
|
|
5690
|
+
* @group Row Data Source
|
|
5255
5691
|
*/
|
|
5256
5692
|
export interface DataResponse {
|
|
5257
5693
|
/**
|
|
@@ -5285,6 +5721,8 @@ export interface DataResponse {
|
|
|
5285
5721
|
}
|
|
5286
5722
|
/**
|
|
5287
5723
|
* Represents a group (branch) row returned from a data request.
|
|
5724
|
+
*
|
|
5725
|
+
* @group Row Data Source
|
|
5288
5726
|
*/
|
|
5289
5727
|
export interface DataResponseBranchItem {
|
|
5290
5728
|
/**
|
|
@@ -5310,6 +5748,8 @@ export interface DataResponseBranchItem {
|
|
|
5310
5748
|
}
|
|
5311
5749
|
/**
|
|
5312
5750
|
* Represents a row of data (a leaf node) returned in a server response.
|
|
5751
|
+
*
|
|
5752
|
+
* @group Row Data Source
|
|
5313
5753
|
*/
|
|
5314
5754
|
export interface DataResponseLeafItem {
|
|
5315
5755
|
/**
|
|
@@ -5327,6 +5767,8 @@ export interface DataResponseLeafItem {
|
|
|
5327
5767
|
}
|
|
5328
5768
|
/**
|
|
5329
5769
|
* Response object for setting pinned row data (top or bottom).
|
|
5770
|
+
*
|
|
5771
|
+
* @group Row Data Source
|
|
5330
5772
|
*/
|
|
5331
5773
|
export interface DataResponsePinned {
|
|
5332
5774
|
/**
|
|
@@ -5344,6 +5786,8 @@ export interface DataResponsePinned {
|
|
|
5344
5786
|
}
|
|
5345
5787
|
/**
|
|
5346
5788
|
* Parameters for configuring the server row data source.
|
|
5789
|
+
*
|
|
5790
|
+
* @group Row Data Source
|
|
5347
5791
|
*/
|
|
5348
5792
|
export interface RowDataSourceServerParams<T> {
|
|
5349
5793
|
/**
|