options

core.defaults. options

Methods

(static) getDefaultData(columns, options) → {Promise.<dataclasses.CompoundPredicate>}

Source:
Since:
  • 1.0.0
When data is not set at construction time PredicateCore default behavior will be to use the first target and its first operator with empty argument
Parameters:
Name Type Description
columns Object every necessary data class
options Object PredicateCore available options
Returns:
root CompoundPredicate
Type
Promise.<dataclasses.CompoundPredicate>

(static) getDefaultCompoundPredicate(columns, options, predicates) → {Promise.<dataclasses.CompoundPredicate>}

Source:
Since:
  • 1.0.0
Default compount predicate to use This function is called whenever a new CompoundPredicate is added to the UIPredicate
Parameters:
Name Type Description
columns Object specified columns
options Object PredicateCore available options
predicates Array.<dataclasses.Predicate> array of predicates to include into the CompoundPredicate
Returns:
a CompoundPredicate
Type
Promise.<dataclasses.CompoundPredicate>

(static) getDefaultComparisonPredicate(columns, [options]) → {Promise.<dataclasses.ComparisonPredicate>}

Source:
Since:
  • 1.0.0
Default comparison predicate to use This function is called whenever a new ComparisonPredicate is added to the UIPredicate
Parameters:
Name Type Attributes Default Description
columns Object specified columns
options Object
optional
 PredicateCore.defaults.options PredicateCore available options
Returns:
a Comparison
Type
Promise.<dataclasses.ComparisonPredicate>

(static) getDefaultLogicalType(predicates, columns, [options]) → {Promise.<dataclasses.LogicalType>}

Source:
Since:
  • 1.0.0
Default logical type to use when a new comparison predicate is created This function is called whenever a new ComparisonPredicate is added to the UIPredicate
Parameters:
Name Type Attributes Default Description
predicates Array.<dataclasses.Predicate> specified columns
columns Object specified columns
options Object
optional
 PredicateCore.defaults.options PredicateCore available options
Returns:
a logical type
Type
Promise.<dataclasses.LogicalType>

(static) getDefaultArgumentComponent(columns, [options]) → {*}

Source:
Get the default UI component for any argument. Also used if no registered UI component match `argumentType_id`
Parameters:
Name Type Attributes Default Description
columns Object specified columns
options Object
optional
 PredicateCore.defaults.options PredicateCore available options
Throws:
if the UI Framework adapter did not override this function. Each UI Framework adapter (e.g. ui-predicate-vue, ui-predicate-react, ...) must implement this and let user override it
Returns:
yield a UI Component (depending on the UI Framework used)
Type
*