FdcDataSetFilters class

Dataset-level filter API.

The dataset owns exactly one active filtered view. This object is a small public entry point for replacing, clearing and fluently building that active filter. Every change is applied by the owning dataset and triggers a view rebuild there.

Properties

active → bool
True when the owning dataset has active filters.
no setter
context → FdcDataSetFilterContext
Active non-field filter context.
no setter
fieldItems → List<FdcDataSetFilter>
Active field-level filter descriptors.
no setter
hashCode → int
The hash code for this object.
no setterinherited
isEmpty → bool
Whether there are no field, selection-state, or internal query constraints.
no setter
isNotEmpty → bool
Whether any filter or query constraint is active.
no setter
items → List<FdcDataSetFilter>
Active field-level filter descriptors.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedFilter → bool?
Active row-selection-state filter, or null when no selection filter is applied.
no setter

Methods

clear({bool clearRetainedVisibleRecords = true, bool notify = true}) → Future<bool>
Clears public field and selection filters and rebuilds or reloads the view.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
orderBy(String fieldName, {FdcDataSetFilterContext context = const FdcDataSetFilterContext()}) → FdcFilterOrderStep
Starts a filter expression with an ORDER BY clause and no conditions.
selected(bool value, {FdcDataSetFilterContext context = const FdcDataSetFilterContext()}) → FdcFilterBuilder
Starts a fluent filter expression by filtering on internal row selection state. This changes only the dataset view; it does not select/unselect records.
set(List<FdcDataSetFilter> filters, {FdcDataSetFilterContext context = const FdcDataSetFilterContext(), bool clearRetainedVisibleRecords = true, bool notify = true}) → Future<bool>
Replaces the active dataset filter and rebuilds or reloads the view.
toString() → String
A string representation of this object.
inherited
where(String fieldName, {FdcDataSetFilterContext context = const FdcDataSetFilterContext()}) → FdcFilterConditionBuilder
Starts a fluent AND-only filter expression.

Operators

operator ==(Object other) → bool
The equality operator.
inherited