CrossFilter Aggregation component

Crossfilter Aggregation creates aggregation specification for Crossfilter Dimension components.

https://kroki.io/svgbob/svg/eNpT0NPFCvS4FGoUwMAxPb0oNT2xJDM_D8yvAcpg11MD1wMCiUj68nW5FNSxa1IHAAi0G8U=

Out-ports

aggregation JSON - Data structure containing specification for aggregation.

Overview

Crossfilter Aggregation component is used to specify aggregation functions for Crossfilter Dimension components. For example, you can specify a numeric field from the dataset and calculate new aggregated metric using Sum, Count or other functions. See supported types of aggregations below.

Settings

Name

Description of the aggregation which can be used by widgets to describe the aggregated value. For example, this will be used as a header for a column in a List widget.

Dimension

Specifies which field in the dataset will be used for this aggregation.

Type of Aggregation

Specifies which aggregation strategy to apply. Select one of the following:

  • Only - return first element
  • Collect Values - return collection of all values
  • Collect Unique Values - return distinct collection of all values
  • Inverted Sum - return sum of numerical values with the opposite sign
  • Sum - return sum of all the numerical values
  • Absolute Sum - return sum of absolute numerical values
  • Count - return count of all the values

Alias

Alias is a custom name for this specific instance of the aggregation function. It will be added as an additional property in the results generated by Crossfilter. It's useful when you need to distinguish between multiple aggregations of the same dimension. Alias is also required when you use filtering rules (see below).

Filter

Specify filtering rule to apply to the underlying dataset to remove matched data records from the aggregation. Alias is required when you use filter (see Alias setting above).

  • Key - specify field in the underlying dataset to be used for this filter
  • Value - specify value to compare against
  • Comparison Operator - specify type of comparison to apply

Is it additive value?

Indicates if results of aggregation can be summed, i.e. f(ab) = f(a) + f(b).

Value Domain

Value Domain defines the min (left bound) and max (right bound) value for the aggregated dimension. This metadata is used by widgets to know the range of the expected values. Value domain bounds are not restricting. If the domain of the aggregated value is wider than the one specified here then the union of both domain will be applied.

Convert Values

Recommended conversion for aggregated values. Component is not enforcing specified converter, but widgets like List respect it.

Post-Aggregation processor deprecated

Specify algorithm to apply to the results of the aggregation.

Related