DataProviderChannelSettings

Description

A DataProviderChannelSettings is an interface that exposes properties to define the characteristics of a DataProviderChannel.

Properties

Property	Type	Description
filterBy	`FilterDescription` \| undefined	The filter description to apply on the data source.
groupBy	`GroupDescription`[]	The group descriptions to apply on the data source. The first item in the array (index 0), corresponds to the first group level, the second item (index 1), if there is one, corresponds to the second group level, etc.
sortBy	`SortDescription`[]	The sort descriptions to apply on the data source. The first item in the array (index 0), corresponds to the first sort to apply, the second item (index 1), if there is one, corresponds to the next sort to apply, etc.
obtainFilterOperator	`ObtainFilterOperator`	A function that takes a `FilterDescription` as a parameter and returns an object that implements the `FilterOperator` interface, or undefined if the associated filter operator is not found. (1)
stats	`StatDescription`[]	The stat descriptions to apply on the data source.

(1) The usefulness of this function is that the FilterOperator that it returns has a predicate property that is a function that evaluates if a value and an operand respect the operator. For example, for a FilterOperator that represents the equal operator, the predicate function will return true if the two values that are passed in parameter are equal, otherwise it will return false.

Need help? Contact us!