DataTables logo
≡

edit()

Since: Editor 1.0

Edit an item using the main editing display.
Please note - this property requires the Editor extension for DataTables.

Description

This method is used to edit one or more items, optionally showing the edit form to the end user, providing them with the ability to modifying field values, or the form can be submitted programmatically without user intervention.

As of v1.5 Editor supports the ability to edit the values for one or more rows simultaneously by passing a suitable DataTable.RowSelector option in as the first parameter to this method. Furthermore, it is possible to use DataTable.ColumnSelector and DataTable.CellSelector selectors to edit all values in a column or individual cells using the object form of this option as detailed below. Finally, row, column and cell selectors can all be used simultaneously to provide complex editing options should you wish to utilise this ability in Editor.

When called, this method will set field values in the form to the record's current values automatically. If a field does not have a current value (specifically that it is not undefined), its value in the editing interface will be set to the default value as set by fields.def.

This method has two different styles of being called (see above). 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

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

Since: 1.3

Show the edit entry form allowing the user to enter and modify information for the item to be edited and then subsequently submit that data.

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

Parameters:

NameTypeOptional
1items

Any

No

Item selector for the record(s) to be edited. Please note that the ability to edit multiple items was added in Editor 1.5 - earlier versions can edit a single item at a time only.

The data types which can be used for this parameter depend upon which mode the Editor instance is configured in:

  • DataTables editing (i.e. table is set) - rows, columns and / or cells can be selected for editing:
    • Rows: This is the default mode of operation and if anything other than a plain object is passed in, the value is used as a DataTable.RowSelector to select the rows to edit. This can be table row nodes, a jQuery selector or row indexes. Please refer to the DataTables DataTable.RowSelector for full information on this data type.
    • Row, columns and cells: An object can be given that contains one or more of the properties rows, columns and cells which can take the values of DataTable.RowSelector, DataTable.ColumnSelector and DataTable.CellSelector respectively. This allows a whole column or individual cells to be edited if required.
  • Standalone editing - Not required. Standalone editing cannot use multiple form sources like DataTables editing, a single Editor instance refers to a single configuration set in the database, so this option is not required, however, it can still be provided to give identification information to the server. Whatever value is given here will be passed to the server as the id parameter. Use null if you want to provide the other parameters (show and options) and do not require a value to be given.
2show

boolean

Yes - default:true

Immediately show the form (true) or not (false). This can be useful to programmatically edit a row 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

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

Since: 1.0

Show the edit entry form allowing the user to enter and modify information for the item to be edited and then subsequently submit that data.

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

Parameters:

NameTypeOptional
1items

Any

No

Identical to the items option for the 1.3+ form of this function, documented above.

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 create a new 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

Edit the first row in a DataTable, setting a title and buttons:

editor
	.title('Edit record')
	.buttons('Update')
	.edit('#example tbody tr:eq(0)');

Edit the first row in a DataTable, setting a title and buttons. This achieves exactly the same as the example above, but using the form-options parameter.:

editor.edit('#example tbody tr:eq(0)', {
	title: 'Edit record',
	buttons: 'Update'
});

Open a DataTables row for editing and submit immediately, without user interaction:

editor
	.edit(row, false)
	.set('name', 'Updated name')
	.set('access', 'Read only')
	.submit();

Edit all selected rows in a DataTable:

editor.edit(table.rows({ selected: true }).indexes());

Edit a DataTables' selected cells:

editor.edit({
	cells: table.cells({ selected: true }).indexes()
});

Edit a column in a DataTable (column index 1 in this case):

editor.edit({ columns: 1 });

1.0 style API - Show the edit form for the first row in the DataTable with a submit button:

editor.edit('#example tbody tr:eq(0)', 'Edit record', 'Update');

Related

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

API