System Predicates

Every AdapTable Predicate is based on an Adaptable Predicate Definition.

The key property is handler which provides the function that AdapTable will use for evaluation.

For instance the Blanks predicate will check all column types to see if the value is empty, while the Positive predicate will check the value of a number cell to see if its greater than 0.

Another property is columnScope which for all System Predicates is linked to a DataType (but Custom Predicates can specify particular columns).

Here is the definition of the GreaterThan Predicate which receives a single numeric input.

Note that in addition to name, handler, columnScope and moduleScope it also defines the icon to be used and any Filter Bar shortcuts that can be applied.

{
  id: 'GreaterThan',
  label: 'Greater Than',
  icon: { path: 'greater-than' },
  columnScope: { DataTypes: ['number'] },
  moduleScope: ['columnFilter', 'alert', 'formatcolumn', 'badgeStyle'],
  inputs: [{ type: 'number' }],
  handler: ({ value, inputs }) => Number(value) > Number(inputs[0]),
  toString: ({ inputs }) => `> ${inputs[0]}`,
  shortcuts: ['>']
}

Each of the 5 properties work similarly, allowing System Predicates for that Module to be provided.

The properties all return data in one of 2 ways:

The simplest way to set System Predicates is to provide a List of available values:

// Only make 3 (of the many) System Filters available
const adaptableOptions: AdaptableOptions = {
    predicateOptions: {
        systemFilterPredicates: ['Positive', 'Today', 'Blanks'],
    }
};

Alternatively you can provide an empty array if you want no System Predicates to be available for the Module:

const adaptableOptions: AdaptableOptions = {
    predicateOptions: {
        systemFilterPredicates: [],
    }
};

Alternatively a JavaScript function can be provided.

The function receives an object of type SystemPredicatesContext and returns a list of Predicates.

The major property in the SystemPredicatesContext object is a list of all the System Predicate Definitions for that Module.

The function, therefore, allows you to filter out the items you dont want like this:

// Remove 4 System Filters from the List
const adaptableOptions: AdaptableOptions = {
      predicateOptions: {
          systemFilterPredicates: (context: SystemPredicatesContext) => {
            return context.systemPredicateDefs
              .map((predicate) => predicate.id)
              .filter((predicateId) => {
                return ['Contains', 'ThisWeek', 'ThisMonth', 'GreaterThan'].includes(predicateId);
          }) as SystemFilterPredicateIds;
      },
    }
};