Interface: TextFilterDef

Oracle® JavaScript Extension Toolkit (JET)
9.0.0

F24343-01

Signature:

interface TextFilterDef

QuickNav

Fields

TextFilterDef

Version:
  • 9.0.0
Since:
  • 8.0.0
Module:
  • ojdataprovider

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To use this interface, import as below.
import {TextFilterDef} from "ojs/ojdataprovider";
Generic Parameters
ParameterDescription
DType of Data

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

Description

Defines a kind of DataFilter.FilterDef which applies to text filter definitions. A text filter definition specifies a string which should be used for filtering and leaves it up to the DataProvider to decide which fields are filtered and how the filtering happens (such as whether the filtering is an exact match or contains, etc).

Fields

text :string

Specifies the text to filter for. It is up to the DataProvider implementation to decide which attributes to apply the filter to and also the exact filtering logic used, such as case insensitivity, etc. In addition, for attributes which contain non-string values, the type coercion rule expected is to call toString() on that value. If the value is an object which does not have a string representation then the value does not satisfy the filter.
Since:
  • 8.0.0
Example

Filter definition which filters on the text 'abc search'

{text: 'abc search'}