Creates an instance of Field.
Optional dbField: string = nullName of the database column
Optional name: string = nullName to use in the JSON output from Editor and the
HTTP submit from the client-side when editing. If not given then the
dbField name is used.
Static SetGet the get flag for the field (i.e. if the field should be
read from the database).
True if gettable, false otherwise.
Set the get flag.
Self for chaining
true to mark as readable, false otherwise
Get formatter for the field's data.
Formatter
Set the get formatter.
When the data has been retrieved from the server, it can be passed through a formatter here, which will manipulate (format) the data as required. This can be useful when, for example, working with dates and a particular format is required on the client-side.
Self for chaining.
Formatter to use.
Get the currently applied get value.
Value - will be undefined by default.
Set the get value for the field.
If given, then this value is used to send to the client-side, regardless of what value is held by the database.
Self for chaining
Value to set
Get the field's configured name.
Current name.
Set the field's name.
The name is typically the same as the dbField name, since it makes things less confusing(!), but it is possible to set a different name for the data which is used in the JSON returned to DataTables in a 'get' operation and the field name used in a 'set' operation.
Self for chaining
Name to set
Get the currently configured options for the field.
Options configuration
Set how a list of options (values and labels) will be retrieved for the field.
Gets a list of values that can be used for the options list in radio, select and checkbox inputs from the database for this field.
Note that this is for simple 'label / value' pairs only. For more complex data, including pairs that require joins and where conditions, use a closure to provide a query
Self for chaining
Options configuration
Set how a list iof options (values and labels) will be retrieved for the fields SearchBuilder.
Gets a list of values that can be used for the options list in SearchBuilder.
this
Set how a list iof options (values and labels) will be retrieved for the fields searchpane.
Gets a list of values that can be used for the options list in searchpanes.
this
Get the current set property for the field.
Set configuration
Set the field's set configuration.
A field can be marked as read only using this option, to be set only during an create or edit action or to be set during both actions. This provides the ability to have fields that are only set when a new row is created (for example a "created" time stamp).
Self for chaining.
Set flag.
Set formatter for the field's data.
Formatter
Set the set formatter.
When the data has been retrieved from the server, it can be passed through a formatter here, which will manipulate (format) the data as required. This can be useful when, for example, working with dates and a particular format is required on the client-side.
Editor has a number of formatters available with the Format class which can be used directly with this method.
Self for chaining.
Formatter to use.
Get the currently applied set value.
Value - will be undefined by default.
Set the set value for the field.
If given, then this value is used to write to the database regardless of what data is sent from the client-side.
Self for chaining
Value to set
Get the validators applied to this field.
Array of validators
Set the 'validator' of the field.
The validator can be used to check if any abstract piece of data is valid or not according to the given rules of the validation function used.
Multiple validation options can be applied to a field instance by calling this method multiple times. For example, it would be possible to have a 'required' validation and a 'maxLength' validation with multiple calls.
Editor has a number of validation available with the Validate class which can be used directly with this method.
Self for chaining
Validator to add to the field
Optional setFormatted: booleanGet the current XSS formatter.
XSS formatter. Can be null or undefined.
Set a formatting method that will be used for XSS checking / removal. This should be a function that takes a single argument (the value to be cleaned) and returns the cleaned value.
Editor will use xss-filters by default for this operation, which is built
into the software and no additional configuration is required, but a
custom function can be used if you wish to use a different formatter.
If you wish to disable this option (which you would only do if you are absolutely confident that your validation will pick up on any XSS inputs) simply provide a closure function that returns the value given to the function. This is not recommended.
Self for chaining.
Enable / disable XSS protection, or set a formatter.
Generated using TypeDoc
Field definitions for the DataTables Editor.
Each Database column that is used with Editor can be described with this Field method (both for Editor and Join instances). It basically tells Editor what table column to use, how to format the data and if you want to read and/or write this column.
Field instances are used with the field and field methods to describe what fields should be interacted with by the editable table.
Export