DataTables logo
≡

clear()

Since: Editor 1.0

Remove one or more fields from the form.
Please note - this property requires the Editor extension for DataTables.

Description

The clear() method is used to remove fields from an Editor, providing Editor with the ability to have its fields dynamically configured at any point through this method and the add() method.

Type

clear( [ fieldName ] )

Remove one or more fields from the form (fields are those that have been added using the add() method or the fields initialisation option).

Parameters:

NameTypeOptional
1fieldName

string, array

Yes

Field names to be removed. Multiple fields can be removed by giving this parameter as an array with a field name in each element.

This parameter is optional. If not given, the clear() method will remove all existing fields from the form.

Returns:

DataTable.Editor: Editor instance

Examples

Remove a single field from a form instance:

var editor = new DataTable.Editor({
	ajax: 'php/index.php',
	table: '#example',
	fields: [
		{ label: 'First name', name: 'first_name' },
		{ label: 'Middle name', name: 'middle_name' },
		{ label: 'Last name', name: 'last_name' }
	]
});

// Immediately remove the middle name field
editor.clear('middle_name');

Remove multiple fields:

var editor = new DataTable.Editor({
	ajax: 'php/index.php',
	table: '#example',
	fields: [
		{ label: 'First name', name: 'first_name' },
		{ label: 'Middle name', name: 'middle_name' },
		{ label: 'Last name', name: 'last_name' }
	]
});

// Immediately remove the middle name and last name fields
editor.clear(['middle_name', 'last_name']);

Remove all fields and then add one new field:

var editor = new DataTable.Editor({
	ajax: 'php/index.php',
	table: '#example',
	fields: [
		{ label: 'First name', name: 'first_name' },
		{ label: 'Middle name', name: 'middle_name' },
		{ label: 'Last name', name: 'last_name' }
	]
});

editor.clear().add({
	label: 'Name:',
	name: 'full_name'
});