InsertColumnsParameters Interface
insertColumns(params) parameters.
This API is deprecated and will be removed in a future release.
Use the positional argument overload of insertColumns(columns, index) instead.
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 InsertColumnsParameters<TColumn extends ImplicitAllowedTypes>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TColumn | ImplicitAllowedTypes |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| columns | Beta | readonly | InsertableTreeNodeFromImplicitAllowedTypes<TColumn>[] | The columns to insert. |
| index | Beta | optional, readonly | number | undefined | The index at which to insert the new columns. |
Property Details
columns
The columns to insert.
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: InsertableTreeNodeFromImplicitAllowedTypes<TColumn>[];
Type: InsertableTreeNodeFromImplicitAllowedTypes<TColumn>[]
index
The index at which to insert the new columns.
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 index?: number | undefined;
Type: number | undefined
Remarks
If not provided, the columns will be appended to the end of the table.