Reference

The Editor reference details the public APIs that Editor presents, with all of the information that you need to be able to interact with the table programmatically. The manual summarises how the APIs can be used, but the reference here deals with the nitty-gritty of the implementation details and shows code examples of how each interface can be used.

Options

Editor has a number of options which can be configured using the initialisation object that is passed into the $.fn.dataTable.Editor() constructor when creating a new Editor instance. This section details all of these options, with code examples of how each option can be used. Read more »

API

The Editor API allows manipulation and control of the form and fields of the Editor instance after it has been initialised. Like the DataTables API, the Editor API makes heavy use of chaining to provide an intuitive and expressive API, that allows you to get the maximum amount done with the minimum amount of code. Read more »

Events

It can often be useful to know when a Editor has performed a particular operation, since user interfaces, by their very nature are asynchronous with user interaction driving the controls of the interface. For this purpose, Editor will emit custom events which can be listened for and acted upon as needed. Read more »

Field type

Editor has a number of field types built-in and ready for use. Each field type provides the common options and methods for use with the basic initialisation options for each field and for the API to interact with, but they may also add their own options and API methods, as suitable for each field. Read more »

Buttons

Editor defines a number of button types for the the Buttons library which can be used to easily create buttons for the end user to control editing in a table. Read more »

Display controllers

Display controllers can dramatically change how the form is displayed to the end user. This section of the reference documents the built-in display controllers, and more can be added through plug-ins if required. Read more »

Types

The interfaces Editor presents often expect, or return, specific data types. These data types are fully defined here, for clarity in the documentation. Read more »