Row Interface
A row in a table.
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Sealed
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
interface Row<TCell extends ImplicitAllowedTypes, TProps extends ImplicitFieldSchema = ImplicitFieldSchema>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TCell | ImplicitAllowedTypes | The type of the cells in the Table. | |
| TProps | ImplicitFieldSchema | ImplicitFieldSchema | Additional properties to associate with the row. |
Remarks
Implemented by the schema class returned from row(params).
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| id | Beta | readonly | string | The unique identifier of the row. |
| props | Beta | TreeFieldFromImplicitField<TProps> | The row's properties. |
Property Details
id
The unique identifier of the row.
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly id: string;
Type: string
Remarks
Uniquely identifies the node within the entire tree, not just the table.
props
The row's properties.
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
get props(): TreeFieldFromImplicitField<TProps>;
set props(value: InsertableTreeFieldFromImplicitField<TProps>);
Type: TreeFieldFromImplicitField<TProps>
Remarks
This is a user-defined schema that can be used to store additional information about the row.