/ S

This page covers a next version of Handsontable, and is not published yet.

This page covers a non-latest version of Handsontable.

# Row trimming

Table of contents

# Overview

The Trim Rows plugin allows the trimming of specific rows from the table. Rows being trimmed aren't rendered and aren't included in a DataMap, which can be retrieved by calling the getData method.

# Setup

The trimRows option needs to be set to an array of row indexes to enable the plugin. See the examples section for a live demo.

# Example

Note that the second, third, and sixth rows are missing in the following example:

    # API examples

    The plugin instance can be accessed by calling:

    const plugin = hot.getPlugin('trimRows');

    To trim a single row, call the trimRow() method of the plugin object:

    plugin.trimRow(4);

    To trim multiple rows, either pass them as arguments to the trimRow() method, or pass an array of indexes to the trimRows() method:

    plugin.trimRow(0, 4, 6);
// or
plugin.trimRows([0, 4, 6]);

    To restore the trimmed row(s), use the following methods:

    plugin.untrimRow(4);

    plugin.untrimRow(0, 4, 6);

    plugin.untrimRows([0, 4, 6]);

    To see the changes made, call hot.render(); to re-render the table.

    ← Row pre-populating →