newRankingFilter()
Home > @gooddata/sdk-model > newRankingFilter
newRankingFilter() function
Creates a new ranking filter.
Signature:
export declare function newRankingFilter(measureOrRef: IMeasure | ObjRefInScope | string, attributesOrRefs: Array<IAttribute | ObjRefInScope | string>, operator: RankingFilterOperator, value: number): IRankingFilter;
Parameters
| Parameter | Type | Description |
|---|---|---|
| measureOrRef | IMeasure | ObjRefInScope | string | instance of measure to filter, or reference of the measure object; if instance of measure is provided, then it is assumed this measure is in scope of execution and will be referenced by the filter by its local identifier |
| attributesOrRefs | Array<IAttribute | ObjRefInScope | string> | Array of attributes used in filter, or reference of the attribute object. If instance of attribute is provided, then it is assumed this attribute is in scope of execution and will be referenced by the filter by its local identifier |
| operator | RankingFilterOperator | TOP or BOTTOM operator to use in the filter |
| value | number | Number of values to use in filter |
Returns: