DataRect
Represents a rectangular selection of cells in LyteNyte Grid.
A DataRect defines its range by numerical row and column indices. It is used to extract or operate on a subset of the grid's data regardless of row or column reordering. However, if the number of rows or columns changes, the rect may be invalidated if it extends beyond the new bounds.
columnEnd
propertyThe ending column index (exclusive).
Type
number
columnStart
propertyThe starting column index (inclusive).
Type
number
rowEnd
propertyThe ending row index (exclusive).
Type
number
rowStart
propertyThe starting row index (inclusive).
Type
number
ExportCsvParams
Parameters for exporting a CSV file from LyteNyte Grid.
dataRect
propertyOptional DataRect specifying the area to export.
If not provided, the grid exports the currently visible data range.
| Type | DataRect |
delimiter
propertyDelimiter character to use for separating values in the CSV output.
Type
string
includeGroupHeaders
propertyWhether to include column group headers in the CSV output.
Type
boolean
includeHeader
propertyWhether to include column headers in the CSV output.
Type
boolean
uniformGroupHeaders
propertyWhether group headers should be rendered as uniform-length arrays.
Type
boolean
ExportDataRectFn
Signature for the function that exports a DataRect from the grid.
Called via the LyteNyte Grid API when exporting a selection of cells.
Parameters
params | ExportDataRectParams (docs) |
Returns
Promise
ExportDataRectParams
Parameters for exporting a specific rectangular region of the grid using a DataRect.
dataRect
propertyThe specific DataRect to export. If omitted, the grid may default to a visible range.
| Type | DataRect |
uniformGroupHeaders
propertyWhether group headers should be returned as symmetrical arrays (i.e., uniform across rows).
Useful when dealing with column groups that span multiple columns.
Type
boolean
ExportDataRectResult
The result structure returned after exporting a DataRect from LyteNyte Grid.
columns
propertyThe column definitions associated with the exported data.
No properties
data
propertyThe 2D data matrix for the selected cells. Row and column spans are not applied.
No properties
groupHeaders
propertyA matrix of group header labels corresponding to the exported columns.
No properties
headers
propertyAn array of header ids for the exported columns.
No properties