newAttributeAreaSort()

Home > @gooddata/sdk-model > newAttributeAreaSort

newAttributeAreaSort() function

Creates a new attribute area sort - sorting the result by aggregated measure values belonging to each attribute value included in the result.

Signature:

export declare function newAttributeAreaSort(attributeOrId: IAttribute | string, sortDirection?: SortDirection, aggregation?: "sum"): IAttributeSortItem;

Parameters

Parameter	Type	Description
attributeOrId	IAttribute | string	attribute to sort by
sortDirection	SortDirection	(Optional) sorting direction
aggregation	"sum"	(Optional) area sort aggregation function. only "sum" is supported at the moment.

Returns:

IAttributeSortItem