TopNFilterBuilder class

Пакет:

powerbi-client

Компонент построителя фильтров Power BI Top N

Extends

FilterBuilder

Унаследованные свойства

target

Методы

bottom(number)	Задает нижний оператор в качестве оператора для фильтра Top N const topNFilterBuilder = new TopNFilterBuilder().bottom(itemCount);
build()	Создает верхний N-фильтр const topNFilterBuilder = new TopNFilterBuilder().build();
orderByTarget(ITarget)	Задает порядок по фильтру Top N const topNFilterBuilder = new TopNFilterBuilder().orderByTarget(target);
top(number)	Задает top as operator for Top N filter const topNFilterBuilder = new TopNFilterBuilder().top(itemCount);

Наследуемые методы

withColumnAggregation(string, string, string)	Задает целевое свойство для фильтра с целевым объектом агрегирования столбцов const filterBuilder = new FilterBuilder().withColumnAggregation(tableName, columnName, aggregationFunction);
withColumnTarget(string, string)	Задает целевое свойство для фильтра с целевым объектом столбца const filterBuilder = new FilterBuilder().withColumnTarget(tableName, columnName);
withHierarchyLevelAggregationTarget(string, string, string, string)	Задает целевое свойство для фильтра с целевым объектом агрегирования уровня иерархии const filterBuilder = new FilterBuilder().withHierarchyLevelAggregationTarget(tableName, hierarchy, hierarchyLevel, aggregationFunction);
withHierarchyLevelTarget(string, string, string)	Задает целевое свойство для фильтра с целевым объектом уровня иерархии const filterBuilder = new FilterBuilder().withHierarchyLevelTarget(tableName, hierarchy, hierarchyLevel);
withMeasureTarget(string, string)	Задает целевое свойство для фильтра с целевым объектом меры const filterBuilder = new FilterBuilder().withMeasureTarget(tableName, measure);
withTargetObject(IFilterTarget)	Задает целевое свойство для фильтра с целевым объектом const target = { table: 'table1', column: 'column1' }; const filterBuilder = new FilterBuilder().withTargetObject(target);

Сведения об унаследованном свойстве

target

target: IFilterTarget

Значение свойства

IFilterTarget

наследуется отFilterBuilder.target

Сведения о методе

bottom(number)

Задает нижний оператор в качестве оператора для фильтра Top N

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

function bottom(itemCount: number): TopNFilterBuilder

Параметры

itemCount

number

Возвращаемое значение

TopNFilterBuilder

build()

Создает верхний N-фильтр

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

function build(): TopNFilter

Возвращаемое значение

TopNFilter

orderByTarget(ITarget)

Задает порядок по фильтру Top N

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

function orderByTarget(target: ITarget): TopNFilterBuilder

Параметры

target

ITarget

Возвращаемое значение

TopNFilterBuilder

top(number)

Задает top as operator for Top N filter

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

function top(itemCount: number): TopNFilterBuilder

Параметры

itemCount

number

Возвращаемое значение

TopNFilterBuilder

Сведения о наследуемом методе

withColumnAggregation(string, string, string)

Задает целевое свойство для фильтра с целевым объектом агрегирования столбцов

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

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

Параметры

tableName

string

columnName

string

aggregationFunction

string

Возвращаемое значение

this

наследуется отFilterBuilder.withColumnAggregation

withColumnTarget(string, string)

Задает целевое свойство для фильтра с целевым объектом столбца

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

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

Параметры

tableName

string

columnName

string

Возвращаемое значение

this

унаследовано отFilterBuilder.withColumnTarget

withHierarchyLevelAggregationTarget(string, string, string, string)

Задает целевое свойство для фильтра с целевым объектом агрегирования уровня иерархии

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

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

Параметры

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

Возвращаемое значение

this

наследуется отFilterBuilder.withHierarchyLevelAggregationTarget

withHierarchyLevelTarget(string, string, string)

Задает целевое свойство для фильтра с целевым объектом уровня иерархии

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

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

Параметры

tableName

string

hierarchy

string

hierarchyLevel

string

Возвращаемое значение

this

унаследовано отFilterBuilder.withHierarchyLevelTarget

withMeasureTarget(string, string)

Задает целевое свойство для фильтра с целевым объектом меры

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

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

Параметры

tableName

string

measure

string

Возвращаемое значение

this

унаследован отFilterBuilder.withMeasureTarget

withTargetObject(IFilterTarget)

Задает целевое свойство для фильтра с целевым объектом

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

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

function withTargetObject(target: IFilterTarget): this

Параметры

target

IFilterTarget

Возвращаемое значение

this

унаследован отFilterBuilder.withTargetObject