Interface: CompoundFilter

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

interface CompoundFilter<D>

QuickNav

Fields


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

CompoundFilter

Version:
  • 7.1.0
Since:
  • 7.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 {CompoundFilter} 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.

The interface for oj.CompoundFilter

Fields

criteria :Array<AttributeFilterDef<D> | CompoundFilterDef<D>>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Array of FilterDefs on which to apply the operator
Since:
  • 7.0.0
Inherited From:

op :string

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Operator to apply for the filter. Valid operators defined in the CompoundFilterOperator union type are the strings:
  • $and The filters in the criteria array will be AND'd.
  • $or The filters in the criteria array will be OR'd.
Since:
  • 7.0.0
Inherited From:

Methods

filterfilter(item: D, index?: number, array?: Array<D>): boolean;

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Specifies a filter function which has the same signature as the the callback which is specified for the JS Array.filter(): https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter This function will be optionally used by the DataProvider to do local filtering. This function is required by the DataProvider so that it is possible for DataProvider implementations to at least do local filtering.
Parameters:
Name Type Argument Description
item any The current element being processed in the array.
index number <optional>
The index of the current element being processed in the array.
array Array <optional>
The array filter was called upon.
Since:
  • 7.0.0
Returns:
True if the element satisfies the filter.
Type
boolean