Skip to main content

InsertRowsParameters Interface

insertRows(params) parameters.

This API is deprecated and will be removed in a future release.

Use the positional argument overload of insertRows(rows, 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 InsertRowsParameters<TRow extends ImplicitAllowedTypes>

Type Parameters​

ParameterConstraintDescription
TRowImplicitAllowedTypes

Properties​

PropertyAlertsModifiersTypeDescription
indexBetaoptional, readonlynumber | undefinedThe index at which to insert the new rows.
rowsBetareadonlyInsertableTreeNodeFromImplicitAllowedTypes<TRow>[]The rows to insert.

Property Details​

index​

The index at which to insert the new rows.

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 rows will be appended to the end of the table.

rows​

The rows 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 rows: InsertableTreeNodeFromImplicitAllowedTypes<TRow>[];

Type: InsertableTreeNodeFromImplicitAllowedTypes<TRow>[]