TopNFilterBuilder class

Package:

powerbi-client

Power BI Top N filter builder component

Extends

FilterBuilder

Inherited Properties

target

Methods

bottom(number)	Sets Bottom as operator for Top N filter const topNFilterBuilder = new TopNFilterBuilder().bottom(itemCount);
build()	Creates Top N filter const topNFilterBuilder = new TopNFilterBuilder().build();
orderByTarget(ITarget)	Sets order by for Top N filter const topNFilterBuilder = new TopNFilterBuilder().orderByTarget(target);
top(number)	Sets Top as operator for Top N filter const topNFilterBuilder = new TopNFilterBuilder().top(itemCount);

Inherited Methods

withColumnAggregation(string, string, string)	Sets target property for filter with column aggregation target object const filterBuilder = new FilterBuilder().withColumnAggregation(tableName, columnName, aggregationFunction);
withColumnTarget(string, string)	Sets target property for filter with column target object const filterBuilder = new FilterBuilder().withColumnTarget(tableName, columnName);
withHierarchyLevelAggregationTarget(string, string, string, string)	Sets target property for filter with hierarchy level aggregation target object const filterBuilder = new FilterBuilder().withHierarchyLevelAggregationTarget(tableName, hierarchy, hierarchyLevel, aggregationFunction);
withHierarchyLevelTarget(string, string, string)	Sets target property for filter with hierarchy level target object const filterBuilder = new FilterBuilder().withHierarchyLevelTarget(tableName, hierarchy, hierarchyLevel);
withMeasureTarget(string, string)	Sets target property for filter with measure target object const filterBuilder = new FilterBuilder().withMeasureTarget(tableName, measure);
withTargetObject(IFilterTarget)	Sets target property for filter with target object const target = { table: 'table1', column: 'column1' }; const filterBuilder = new FilterBuilder().withTargetObject(target);

Inherited Property Details

target

target: IFilterTarget

Property Value

IFilterTarget

Inherited From FilterBuilder.target

Method Details

bottom(number)

Sets Bottom as operator for Top N filter

const topNFilterBuilder = new TopNFilterBuilder().bottom(itemCount);

function bottom(itemCount: number): TopNFilterBuilder

Parameters

itemCount

number

Returns

TopNFilterBuilder

build()

Creates Top N filter

const topNFilterBuilder = new TopNFilterBuilder().build();

function build(): TopNFilter

Returns

TopNFilter

orderByTarget(ITarget)

Sets order by for Top N filter

const topNFilterBuilder = new TopNFilterBuilder().orderByTarget(target);

function orderByTarget(target: ITarget): TopNFilterBuilder

Parameters

target

ITarget

Returns

TopNFilterBuilder

top(number)

Sets Top as operator for Top N filter

const topNFilterBuilder = new TopNFilterBuilder().top(itemCount);

function top(itemCount: number): TopNFilterBuilder

Parameters

itemCount

number

Returns

TopNFilterBuilder

Inherited Method Details

withColumnAggregation(string, string, string)

Sets target property for filter with column aggregation target object

const filterBuilder = new FilterBuilder().withColumnAggregation(tableName, columnName, aggregationFunction);

function withColumnAggregation(tableName: string, columnName: string, aggregationFunction: string): TopNFilterBuilder

Parameters

tableName

string

columnName

string

aggregationFunction

string

Returns

TopNFilterBuilder

Inherited From FilterBuilder.withColumnAggregation

withColumnTarget(string, string)

Sets target property for filter with column target object

const filterBuilder = new FilterBuilder().withColumnTarget(tableName, columnName);

function withColumnTarget(tableName: string, columnName: string): TopNFilterBuilder

Parameters

tableName

string

columnName

string

Returns

TopNFilterBuilder

Inherited From FilterBuilder.withColumnTarget

withHierarchyLevelAggregationTarget(string, string, string, string)

Sets target property for filter with hierarchy level aggregation target object

const filterBuilder = new FilterBuilder().withHierarchyLevelAggregationTarget(tableName, hierarchy, hierarchyLevel, aggregationFunction);

function withHierarchyLevelAggregationTarget(tableName: string, hierarchy: string, hierarchyLevel: string, aggregationFunction: string): TopNFilterBuilder

Parameters

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

Returns

TopNFilterBuilder

Inherited From FilterBuilder.withHierarchyLevelAggregationTarget

withHierarchyLevelTarget(string, string, string)

Sets target property for filter with hierarchy level target object

const filterBuilder = new FilterBuilder().withHierarchyLevelTarget(tableName, hierarchy, hierarchyLevel);

function withHierarchyLevelTarget(tableName: string, hierarchy: string, hierarchyLevel: string): TopNFilterBuilder

Parameters

tableName

string

hierarchy

string

hierarchyLevel

string

Returns

TopNFilterBuilder

Inherited From FilterBuilder.withHierarchyLevelTarget

withMeasureTarget(string, string)

Sets target property for filter with measure target object

const filterBuilder = new FilterBuilder().withMeasureTarget(tableName, measure);

function withMeasureTarget(tableName: string, measure: string): TopNFilterBuilder

Parameters

tableName

string

measure

string

Returns

TopNFilterBuilder

Inherited From FilterBuilder.withMeasureTarget

withTargetObject(IFilterTarget)

Sets target property for filter with target object

const target = {
 table: 'table1',
 column: 'column1'
};

const filterBuilder = new FilterBuilder().withTargetObject(target);

function withTargetObject(target: IFilterTarget): TopNFilterBuilder

Parameters

target

IFilterTarget

Returns

TopNFilterBuilder

Inherited From FilterBuilder.withTargetObject