Add a left join condition to the Options instance, allowing it to operate over multiple tables.
In this form the method will take a function as the second parameter which is a Knex callback function allowing a complex join expression to be built.
Self for chaining
Table name to do a join onto
Add a left join condition to the Options instance, allowing it to operate over multiple tables.
Self for chaining
Table name to do a join onto
Field from the parent table to use as the join link
Join condition (=, '<`, etc)
Field from the child table to use as the join link
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.
Self for chaining
ORDER BY statement
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.
Self for chaining
Renderering function
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.
Self for chaining
Column name
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.
Self for chaining
Knex WHERE condition
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 options method.Export