{hero}

searchBuilder.conditions[type]

Since: SearchBuilder 1.0.0

The object structure for the type object containing additional conditions for SearchBuilder.
Please note - this property requires the SearchBuilder extension for DataTables.

Description

This is useful as it allows custom conditions to be added to SearchBuilder should the standard ones not be enough. It also allows for the standard conditions to be removed or edited to fit your own needs. Here the type in searchBuilder.conditions[type] is the type for the column, for more details refer to columns.type.

Each key-value pair on the searchBuilder.conditions[type] object is used to represent a single condition. The structure of the value for these is documented at searchBuilder.conditions[type][cond].

The standard conditions can be removed, edited or added to. The manual page for custom conditions covers this in detail.

Note: When using a custom decimal place character, the SearchBuilder internals will replace this with a . so that the correct processing can take place. It is worth bearing this in mind when customising the functions that each condition runs.

Examples

There are two examples that create custom conditions using initialisation options. They both show how to add a custom condition to the num column type, but the process is the same for other column types.

There is also an example that shows how to use a plug-in to add a custom condition.

Type

object

Description:

An object populated with key-value pairs of objects (searchBuilder.conditions[type][cond]) that contain the information necessary to add a new condition.

Default

  • Value: object

Related

The following options are directly related and may also be useful in your application development.