DataTables logo
≡

remove()

Since: Editor 1.0

Remove (delete) entries from the table.
Please note - this property requires the Editor extension for DataTables.

Description

This method is used to remove one or more records from a DataTable. The main editing form is not shown in the remove display (as it has no relevance here, unlike in the create and edit displays), so this method is typically used in conjunction with the message() method to ask the user to confirm they want to delete the selected records.

This method has two different styles of being called. Editor will automatically detect which method is used and act accordingly. Although the newer style introduced in Editor 1.3 is preferred for its flexibility, the older style is still retained for backwards compatibility and can continue to be used.

Types

remove( items [, show ] [, options ] )

Since: 1.3

Remove (delete) entries from the table.

This new form of the remove() method was introduced in Editor 1.3 to take advantage of the the updated chaining interface and form configuration options.

Parameters:

NameTypeOptional
1items

DataTable.RowSelector

No

Row selector for the record(s) to be removed.

2show

boolean

Yes - default:true

Immediately show the form (true) or not (false). This can be useful to programmatically remove rows without showing the main Editor interface. Setting to true (or leaving as the default) is the same as calling open().

3options

form-options

Yes

Form configuration options, including the ability to set the title, buttons and behaviour of the form. See also formOptions.main to configure default options for the Editor instance.

Returns:

DataTable.Editor: Editor instance

remove( items [, title [, buttons [, show ]]] )

Since: 1.0

Remove (delete) entries from the table.

This older form of the remove() method is retained in Editor 1.3 for full backwards compatibility, but the new form, documented above, is preferred.

Parameters:

NameTypeOptional
1items

DataTable.RowSelector

No

Row selector for the record(s) to be removed.

2title

string

Yes

Form title to display. See title() for the options available, as the parameter given here is passed straight through to that method.

3buttons

string, object, array

Yes

Buttons to show in the form. See buttons() for the options available, as the parameter given here is passed straight through to that method.

4show

boolean

Yes - default:true

Immediately show the form (true) or not (false). This can be useful to programmatically remove a row without showing the main Editor interface. Setting to true (or leaving as the default) is the same as calling open().

Returns:

DataTable.Editor: Editor instance

Examples

Delete a row with a message to let the user know exactly what is happening:

$('#myTable tbody').on('click', 'a.delete-row', function () {
	editor
		.title('Delete row')
		.buttons('Confirm delete')
		.message('Are you sure you want to remove this row?')
		.remove(this);
});

Delete the selected row without asking the user for confirmation:

$('#myTable tbody').on('click', 'a.delete-row', function () {
	editor.remove(this, false).submit();
});

Delete all rows in a table with a submit button:

editor
	.title('Delete all rows')
	.buttons('Confirm delete')
	.message('Are you sure you want to delete all rows?')
	.remove('tr'); // select all rows

Related

The following options are directly related and may also be useful in your application development.

API