filter( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Filters out items from being used in an aggregation.

The filter() method refines a WixDataAggregate so that it only includes items from the aggregate's collection which match the specified filter criteria.

To create a filter, use the wix-data filter() method.

Filtering using filter() takes place before grouping is performed on the aggregation. To filter grouped results, use the having() method.

Note: Aggregations can only be used on collections you have created. They cannot be used on Wix app collections.

Method Declaration
Copy
Method Parameters
filterWixDataFilterRequired

Filter to use to filter out items from being used in the aggregation.

Returns
Return Type:WixDataAggregate
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?









filter( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds a filter stage to the aggregation pipeline.

The filter() method adds a pipeline stage that only processes items that match the specified criteria. You can configure the filter by chaining one or more FilterStage methods.

Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:FilterStage
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?