CellKey Interface
A key to uniquely identify a cell within a table.
For more information about our API support guarantees, see here.
This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.
Signature
interface CellKey<TColumn extends ImplicitAllowedTypes, TRow extends ImplicitAllowedTypes>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TColumn | ImplicitAllowedTypes | |
| TRow | ImplicitAllowedTypes |
Remarks
Note that edits to the table structure (including edits by collaborators) can cause indexes to refer to different cells over time. Therefore, it is recommended to use IDs or node references whenever possible to identify cells.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| column | Beta | readonly | string | number | TreeNodeFromImplicitAllowedTypes<TColumn> | Column, id, or column index at which the cell is located. |
| row | Beta | readonly | string | number | TreeNodeFromImplicitAllowedTypes<TRow> | Row, id, or row index at which the cell is located. |
Property Details
column
Column, id, or column index at which the cell is located.
For more information about our API support guarantees, see here.
Signature
readonly column: string | number | TreeNodeFromImplicitAllowedTypes<TColumn>;
Type: string | number | TreeNodeFromImplicitAllowedTypes<TColumn>
row
Row, id, or row index at which the cell is located.
For more information about our API support guarantees, see here.
Signature
readonly row: string | number | TreeNodeFromImplicitAllowedTypes<TRow>;
Type: string | number | TreeNodeFromImplicitAllowedTypes<TRow>