Maximum Subset
The Maximum Subset function returns the largest or top value(s) in an input data series.
When used in a formula visualization, you can specify a count of more than one, e.g, to return the 3 largest values.
1. Syntax
TOP(d0,s0,Alignment)
2. Input
The Maximum Subset function requires the following input:
- d0 - Input data values - The set of data values for which the Maximum Subset is calculated.
3. Parameters
The Maximum Subset function accepts the following parameters:
- s0 - Maximum Subset Count (Optional) - The number of values to be returned by the function. Default value is 1.
- Alignment (Optional) - A hierarchy placeholder to be used as the alignment axis. Specify a hierarchy to return the top input value(s) corresponding to that hierarchy's values: e.g., TOP($Measure$, 1, $Year$) will return the year with the largest value within each grouping of years under another hierarchy's values such as Country. If an alignment hierarchy is not indicated, the subset is applied to the whole result.
When you use the TOP function within a metric set, it can only return a single value (s0 must be 1). In order to return the top 3 values, for example, you must use a formula visualization. This applies to the other subset functions as well.
4. Output
The Maximum Subset formula generates the following output:
- Maximum Subset - The Maximum Subset result set.
Tip
When used in a formula visualization, you can effectively filter the result to the topmost value(s), optionally grouped by an alignment hierarchy.