@adaptabletools/adaptable/src/AdaptableOptions/PredicateOptions.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { AdaptablePredicateDef, ColumnScope, BaseContext, PredicateModuleScope, SystemAlertPredicateId, SystemAlertPredicateIds, SystemBadgeStylePredicateId, SystemBadgeStylePredicateIds, SystemFilterPredicateId, SystemFilterPredicateIds, SystemFlashingCellPredicateId, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateId, SystemFormatColumnPredicateIds } from '../types';
/**
 * Options for managing Adaptable Predicates using AdaptableQL
 */
export interface PredicateOptions {
    /**
     * Definitions for Custom provided Predicates
     */
    customPredicateDefs?: AdaptablePredicateDef[];
    /**
     * Which System Filter Predicates are available
     */
    systemFilterPredicates?: SystemFilterPredicateIds | ((context: SystemPredicatesContext<SystemFilterPredicateId>) => SystemFilterPredicateIds);
    /**
     * Which System Badge Style Predicates are available
     */
    systemBadgeStylePredicates?: SystemBadgeStylePredicateIds | ((context: SystemPredicatesContext<SystemBadgeStylePredicateId>) => SystemBadgeStylePredicateIds);
    /**
     * Which System Alert Predicates are available
     */
    systemAlertPredicates?: SystemAlertPredicateIds | ((context: SystemPredicatesContext<SystemAlertPredicateId>) => SystemAlertPredicateIds);
    /**
     * Which System Format Column Predicates are available
     */
    systemFormatColumnPredicates?: SystemFormatColumnPredicateIds | ((context: SystemPredicatesContext<SystemFormatColumnPredicateId>) => SystemFormatColumnPredicateIds);
    /**
     * Which System Flashing Cell Predicates are available
     */
    systemFlashingCellPredicates?: SystemFlashingCellPredicateIds | ((context: SystemPredicatesContext<SystemFlashingCellPredicateId>) => SystemFlashingCellPredicateIds);
    /**
     * Perform case-sensitive text comparisons when evaluating Predicates
     *
     * @defaultValue false
     * @gridInfoItem
     * @noCodeItem
     */
    caseSensitivePredicates?: boolean;
    /**
     * Should Values (IN) Predicate evaluate using datetime (rather than date)
     * @defaultValue  true
     * @noCodeItem
     */
    evaluateValuesPredicateUsingTime?: boolean;
}
/**
 * Context used for setting which System Predicates are available
 */
export interface SystemPredicatesContext<PREDICATE_TYPE = string> extends BaseContext {
    /**
     * AdapTable-provided System Predicate Definitions
     */
    systemPredicateDefs: AdaptablePredicateDef<PREDICATE_TYPE>[];
    /**
     * Module for which Predicates are being retrieved
     */
    moduleScope: PredicateModuleScope;
    /**
     * Current Scope where Predicates are being used
     */
    columnScope: ColumnScope;
}