Add extra options to the list, in addition to any obtained from the database
Label
Value
Get the column(s) to be used for the label
Label columns
Set the column(s) to be used for the label
Database column names
Self for chaining
Get the currently applied LIMIT
Limit
Set the LIMIT clause to limit the number of records returned
Limit
Self for chaining
Get the ORDER BY clause for the SQL.
ORDER BY clause
Set the ORDER BY clause to use in the SQL. If this option is not provided the ordering will be based on the rendered output, either numerically or alphabetically based on the data returned by the renderer.
ORDER BY statement
Self for chaining
Get the configured label renderer
Self for chaining
Set the label renderer. The renderer can be used to combine multiple database columns into a single string that is shown as the label to the end user in the list of options.
Renderering function
Self for chaining
Get the table that the options will be gathered from.
Table name
Set the database table from which to gather the options for the list.
Table name
Self for chaining
Get the column name to use for the value in the options list.
Column name
Set the column name to use for the value in the options list. This would normally be the primary key for the table.
Column name
Self for chaining
Get the WHERE condition for this option set.
Knex WHERE condition
Set the method to use for a WHERE condition if one is to be applied to the query to get the options.
Knex WHERE condition
Self for chaining
Generated using TypeDoc
The Options class provides a convenient method of specifying where Editor should get the list of options for a
select,radioorcheckboxfield. This is normally from a table that is left joined to the main table being edited, and a list of the values available from the joined table is shown to the end user to let them select from.Optionsinstances are used with the Field.options method.