Generator

Editor's Generator provides a quick and easy method to construct everything you need to use Editor on your own site. Generator will construct a package customised for your exact needs that you can upload to your server and start using Editor almost immediately with a minimum of configuration (simply upload the files, install the generated SQL and add your SQL DB username and password credentials).

Note that Generator is not designed to present all of the options that are available in Editor - it is a quick start tool only! To get the most out of Editor working with the API and initialisation options is required.

Software and styling

DataTables
DataTables, Buttons, Editor, Select, jQuery compat

Server and database

Form / Table

Order Form label SQL column Field type Extra options Default Validation Include in Delete
Required Type Options Table Editor

Add

Download

Or view generated:

Once you have downloaded the generated package, you will need to complete the database connection parameters so it can actually communicate with your database. For details on how to use Generator, please refer to the Generator manual page.

Help

The number of options available in Generator can seem daunting, but to get started, all you really need to do is fill in the text boxes! From there you can customise the generated Editor files by changing some of the options in the table. The definitions for the options in Editor are shown below.

See also the Generator manual page for information on using Generator and the created files.

Software and styling

Select the software and the styling library that you wish to include in your created package.

Name Description
Styling DataTables and Editor can use the styling options provided by a number of popular CSS styling libraries to ensure that your tables and forms fit into your site seamlessly.
Software The DataTables suite provides a large amount number of additional features in add-on packages (called extensions) which can be included to add extra functionality to your tables.

Server and database

The four fields in this section tells Generator about your server and database environment.

Name Description
Server type Platform that Generator will create a package for. The .NET option will create a Visual Studio project that can be open and run from Visual Studio.
Database type This option will custom the SQL that Generator creates to match your database.
Table name The SQL table name so the scripts can query the table. Note that Generator does not currently support queries which require a JOIN. For occasions where you do need Editor to read from and update multiple tables (joins), you'll need to modify the created scripts, as described in the join documentation (PHP / .NET).
Primary key This is the name of the primary key column in your database table - a column which contains a unique value for each row. This provides Editor with the ability to be able to address each database row individually. The default is id but it can be modified to fit your existing schema if required.

Form / Table

The fields in the main Generator table, tells Generator about the data that you want to be shown in DataTables and Editor.

Name Description
Order The order that the fields will be shown both in the DataTable and the Editor form. Note that it is very easy to work with the code to have a different order for the DataTable and Editor if you so wish! Just edit the generated Javascript to show the fields in the order you want.
Form label The text that is presented both in the header of the DataTable for the column and the label for the Editor field input.
SQL column Name of the SQL column that will hold the data for this column - something similar to the label would be best!
Field type The Editor input type.
Extra options Depending on the field type selected you might be asked to provide extra information - for example when choosing the Select field type you'll need to provide the options for the select list.
Default Default value for the field when the user adds a new row to the table.
Required Indicate if a value is required from the end user when adding or editing a row. Note that empty strings are rejected here!
Type Depending on the field type selected you can select from a list of validation options. Note that validation in Generator created Editor installs is done on the server-side, not the client-side.
Options Depending on the validation type you might be required to enter additional options
Table When checked the value will be shown in the DataTable.
Editor When checked the field will be shown in the Editor form.
Delete Remove the field definition from Generator.

Don't forget that Generator is just a quick start tool to get going with Editor only! Generator does not provide access to the full set of features that Editor has available (it would make Generator far to complex to present all available options!).

Complex forms and additional options can easily be set up and accessed through the API and initialisation options when you wish to customise Editor beyond options given in Generator.

×

Software selector

DataTables and its extensions provide a wide range of options and features that can be used to enhance your table. Selecting the files that you want to include on your page can be a little complex, so Generator provides the ability to select the software you want using the options below. At a minimum jQuery, DataTables and Editor should be included. You will likely want to also include Select and Buttons and possibly a styling library.

Main libraries

jQuery
No jQuery
jQuery
jQuery compat
The jQuery library provides an easy to use API for elegant DOM traversal, event handling, Ajax and more. DataTables requires jQuery to be available as it is a jQuery plug-in. Many pages will already have jQuery included, in which case you do not want to include it again. The jQuery compat option uses a version of jQuery that is suitable for old browsers - the jQuery option requires a modern browser, including IE9 and newer.
License: MIT
Version: 2.1.4
Documentation: API
Styling
DataTables
Bootstrap
Foundation
jQuery UI
DataTables and its extensions can all be styled by various styling frameworks to ensure that your tables fit seamlessly into your site / app. The frameworks supported are DataTables' own styling, Bootstrap, Foundation and jQuery UI. Selecting the option you wish to use here will ensure that all required integration files are included.
Licenses: All - MIT
Versions: Bootstrap 3.3.5 | Foundation 5.5.2 | jQuery UI
Include library
No styling library
In order to function fully, the styling library selected requires its own CSS and Javascript to be available. If your page already includes these libraries to you not need to include them available. However, for convenience, if you have not yet included the styling library the DataTables download builder can include these files for you.
DataTables
DataTables
Do not include
The core DataTables library adds advanced interaction controls to HTML tables providing features such as paging, ordering, search all with a modern API to be able to control the table. It is, after all, the reason you are here! All of the following software require DataTables and it should be included in your download unless you already have DataTables installed.
License: MIT
Version: 1.10.8
Documentation: Manual | API

Extensions

AutoFill
AutoFill
Do not include
Spreadsheets such as Excel and Google Docs have a very handy data duplication option of an auto fill tool. The AutoFill library for DataTables provides a similar interface for DataTables (even extending upon it to provide complex data interaction options). AutoFill also provides full support for Editor allowing end users to update data very quickly.
License: MIT
Version: 2.0.0
Documentation: Manual | API
Buttons
Buttons
Do not include
The Buttons extension for DataTables provides a common set of options, API methods and styling to display buttons on a page that will interact with a DataTable. It also provides plug-ins for file export (HTML5 and Flash), print view and column visibility. Other libraries, such as Editor and Select also provide buttons specific to their use cases.
License: MIT
Version: 1.0.1
Documentation: Manual | API
Column visibility
Do not include
The column visibility plug-in for the DataTables Buttons extension provides a suite of buttons that can be used to very easily control the visibility of columns in a table. Button options include displaying a list of all columns in a drop down list, as individual buttons, and visibility control for individual or groups of columns.
License: MIT
Version: 1.0.1
Documentation:
Flash export
Do not include
The Flash export buttons use Adobe Flash to create files on the client-side in which the DataTables' data can be saved. The Flash export can be useful when you are targeting environments which use legacy browsers and the HTML5 export option might not be available. The Flash and HTML5 export buttons can be used together, falling back to Flash if required.
License: MIT
Version: 1.0.1
Documentation:
HTML5 export
Do not include
The HTML5 export buttons make use of the local file saving features of modern browsers (IE10+, Chrome, Safari, Firefox and Opera) to create files on the client-side and then download them without any server interaction required. The export options include copy to clipboard, CSV, Excel (XSLX) and PDF files.
License: MIT
Version: 1.0.1
Documentation:
JSZip
Do not include
JSZip provides a method of creating zip files in pure Javascript. This library must be available on the page for the Excel button to operate.
License: MIT
Version: 2.5.0
Documentation: Manual
pdfmake
Do not include
PDFMake is a Javascript library that provides the operations required to be able to create PDFs in a web-browser. This library must be available on the page for the PDF button to operate.
License: MIT
Version: 0.1.18
Documentation: Manual
Print view
Do not include
The print button for Buttons will copy the data from the DataTable and open a new window that can automatically trigger the browser's print action. This allows easy creation of hard copies of the table's data.
License: MIT
Version: 1.0.1
Documentation:
ColReorder
ColReorder
Do not include
ColReorder adds the ability for the end user to click and drag column headers to reorder a table as they see fit, to DataTables.
License: MIT
Version: 1.2.0
Documentation: Manual | API
Editor
Editor
Do not include
Editor adds full editing controls to your DataTables with a comprehensive set of options and API. Server-side libraries for PHP and .NET are available from the Editor web-site.

Editor is a commercial extension for DataTables, it requires a license to use it for longer than the free trial period. Please create an account or login to be able to include Editor in the package. License holders can also select additional field type plug-ins using this downloader to extend Editor's functionality.
License: Commercial
Version: 1.5.0
Documentation: Manual | API
FixedColumns
FixedColumns
Do not include
FixedColumns provides the ability to fix one or more columns to the left and / or right hand side of a DataTable that scrolls along the x-axis. This can be used if the columns show grouping, index or similar information.
License: MIT
Version: 3.1.0
Documentation: Manual | API
FixedHeader
FixedHeader
Do not include
When displaying large amounts of data in a table, it can often be useful for the end user to have the column titles always visible. This is particularly true if using DataTables with pagination disabled, or the display length is set to a high value. The FixedHeader extension provides this ability.
License: MIT
Version: 3.0.0
Documentation: Manual | API
KeyTable
KeyTable
Do not include
KeyTable allows you to use keyboard navigation on a DataTables enhanced table, like an Excel spreadsheet - a cell shows a focus outline which can be moved using the keyboard or mouse operations. This can be particularly useful in an editable table that uses Editor allowing end users to update data very quickly.
License: MIT
Version: 2.0.0
Documentation: Manual | API
Responsive
Responsive
Do not include
In the modern world of responsive web design tables can often cause a particular problem for designers due to their row based layout. Responsive is an extension for DataTables that resolves that problem by optimising the table's layout for different screen sizes through the dynamic insertion and removal of columns from the table.
License: MIT
Version: 1.0.7
Documentation: Manual | API
RowReorder
RowReorder
Do not include
RowReorder adds end user reordering of rows in a DataTable through click-and-drag mouse and touch operations. RowReorder provides full support for Editor allowing end users to update sequential information in a fast and easy manner.
License: MIT
Version: 1.0.0
Documentation: Manual | API
Scroller
Scroller
Do not include
Scroller is a virtual rendering plug-in for DataTables which allows large datasets to be drawn on screen very quickly. Virtual rendering means is that only the visible portion of the table is drawn, while the scrolling container gives the visual impression that the whole table is visible, allowing excellent browser performance.
License: MIT
Version: 1.3.0
Documentation: Manual | API
Select
Select
Do not include
Select provides table item selection capabilities - rows, columns and cells can be selected individually or collectively. Complex selection operations such as operating system style selection (ctrl/cmd and shift click) for multiple rows can be enabled with a single option for a DataTable.
License: MIT
Version: 1.0.0
Documentation: Manual | API

Packaging options

Minification
Minify
Debug
The download builder can construct files in two forms: an uncompressed format that can be useful while developing as it includes all comments in the source files, and a minifed format with a much smaller file size that should be used for production deployments.
Concatenate
Single file
Individual files
Performance is key for web-sites and applications, and one method to improve performance (in HTTP 1.x) is to reduce the number of requests that a client makes to the server. The download builder can combine all of the individual files into a single file for you using this option.
CDN
CDN
Local files
All of the libraries described on this page are available on a CDN which means you don't have to host the files yourself while getting a rock solid network connection for your source files (the DataTables CDN uses CloudFlare). Alternatively, you can select to download and host the files yourself. The CDN data source is not available if the Editor extension is selected.