TableFactoryMethodParameters Interface
Input parameters for Table's create factory method.
This API is provided as a beta preview and may change without notice.
For more information about our API support guarantees, see here.
Input
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 TableFactoryMethodParameters<TUserScope extends string, TCell extends ImplicitAllowedTypes, TColumn extends System_TableSchema.ColumnSchemaBase<TUserScope, TCell>, TRow extends System_TableSchema.RowSchemaBase<TUserScope, TCell>>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TUserScope | string | |
| TCell | ImplicitAllowedTypes | |
| TColumn | System_TableSchema.ColumnSchemaBase<TUserScope, TCell> | |
| TRow | System_TableSchema.RowSchemaBase<TUserScope, TCell> |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| columns | Beta | optional, readonly | Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumn>> | undefined | Initial columns for the table. |
| rows | Beta | optional, readonly | Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRow>> | undefined | Initial rows for the table. |
Property Details
columns
Initial columns for the table.
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 columns?: Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumn>> | undefined;
Type: Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TColumn>> | undefined
rows
Initial rows for the table.
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 rows?: Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRow>> | undefined;
Type: Iterable<InsertableTreeNodeFromImplicitAllowedTypes<TRow>> | undefined
Remarks
If any cells are specified, they will be validated against the IDs of the provided columns.