simple-datatables/docs/documentation/rows-API.md

A lightweight, dependency-free JavaScript HTML table plugin.

As of `v1.4.0`, the `rows` API is implemented and allows access to the table rows for quick manipulation.

As of `v4.0.0`, `rows` is a property and not a method on the current instance.

To use the `rows` API just access under the `rows` property of the current instance:

```javascript
let rows = datatable.rows;
```

You can then chain the following methods.

---

### `add(data [array])`

Add new row data to the current instance. The `data` parameter must be an `array` of `strings` to be inserted into each of the new row's cells.

```javascript
let newRow = ["column1", "column2", "column3", "column4", ...];

dataTable.rows.add(newRow);

```

**Note:** Only one row can be added at a time. If you want to add multiple rows simultaneously, do this instead:

```javascript
let newRows = [
    ["column1", "column2", "column3", "column4", ...],
    ["column1", "column2", "column3", "column4", ...],
    ["column1", "column2", "column3", "column4", ...],
    ["column1", "column2", "column3", "column4", ...],
    ...
];

 dataTable.insert({data: newRows})
 ```

---

### `remove(select [array|number])`

Remove existing rows from the current instance. The `select` parameter can either be an `integer` or `array` of `integers` representing the row indexes.

```javascript
let rows = dataTable.rows;

// remove the 6th row
rows.remove(5);

// remove the first 5 rows
rows.remove([0,1,2,3,4]);

```

Note that the indexes passed to this method should represent the actual index of the row in the [`data`](API#data) array. The native [`rowIndex`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableRowElement/rowIndex) property represents the position of a row in the rendered page and may be different to the index you need to pass to the `remove()` method.

For example, if you're trying to remove a row that's unrendered, the `rowIndex` property will return `-1`.

Another example would be if you're currently on page 5 and you have `perPage` set to `5` the currently rendered rows have a `rowIndex` of `0`, `1`, `2`, `3` and `4`, respectively, but to remove them you would need to use the indexes `20`, `21`, `22`, `23` and `24`, respectively.

```javascript
let rows = dataTable.rows;

// Switch to page 5
dataTable.page(5);

// WRONG: removes the first 5 rows on page 1
rows.remove([0, 1, 2, 3, 4]);

// CORRECT: removes the 5 currently rendered rows on page 5
rows.remove([20, 21, 22, 23, 24]);
```

You can quickly access the correct index for the rendered row by grabbing it's `dataset-index` property as opposed to the `rowIndex` property.

```javascript
// Get the first rendered row
let rowToRemove = dataTable.body.querySelector("tr");

// Remove it
dataTable.rows.remove(parseInt(rowToRemove.dataset.index));

```

---