BasicFilterBuilder class

Пакет:

powerbi-client

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

Расширяет

FilterBuilder

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

target

Методика

all()	Задает все как оператор для базового фильтра const basicFilterBuilder = new BasicFilterBuilder().all();
build()	Создает базовый фильтр const basicFilterBuilder = new BasicFilterBuilder().build();
in((string | number | boolean)[])	Задает в качестве оператора для базового фильтра const basicFilterBuilder = new BasicFilterBuilder().in([values]);
notIn((string | number | boolean)[])	Задает NotIn в качестве оператора для базового фильтра const basicFilterBuilder = new BasicFilterBuilder().notIn([values]);
requireSingleSelection(boolean)	Задает необходимое свойство единого выбора для базового фильтра const basicFilterBuilder = new BasicFilterBuilder().requireSingleSelection(isRequireSingleSelection);

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

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

Подробнее о методе

all()

Задает все как оператор для базового фильтра

const basicFilterBuilder = new BasicFilterBuilder().all();

function all(): BasicFilterBuilder

Возвращает

BasicFilterBuilder

build()

Создает базовый фильтр

const basicFilterBuilder = new BasicFilterBuilder().build();

function build(): BasicFilter

Возвращает

BasicFilter

in((string | number | boolean)[])

Задает в качестве оператора для базового фильтра

const basicFilterBuilder = new BasicFilterBuilder().in([values]);

function in(values: (string | number | boolean)[]): BasicFilterBuilder

Параметры

values

(string | number | boolean)[]

Возвращает

BasicFilterBuilder

notIn((string | number | boolean)[])

Задает NotIn в качестве оператора для базового фильтра

const basicFilterBuilder = new BasicFilterBuilder().notIn([values]);

function notIn(values: (string | number | boolean)[]): BasicFilterBuilder

Параметры

values

(string | number | boolean)[]

Возвращает

BasicFilterBuilder

requireSingleSelection(boolean)

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

const basicFilterBuilder = new BasicFilterBuilder().requireSingleSelection(isRequireSingleSelection);

function requireSingleSelection(isRequireSingleSelection?: boolean): BasicFilterBuilder

Параметры

isRequireSingleSelection

boolean

Возвращает

BasicFilterBuilder

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

withColumnAggregation(string, string, string)

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

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

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

Параметры

tableName

string

columnName

string

aggregationFunction

string

Возвращает

BasicFilterBuilder

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

withColumnTarget(string, string)

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

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

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

Параметры

tableName

string

columnName

string

Возвращает

BasicFilterBuilder

унаследовано от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): BasicFilterBuilder

Параметры

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

Возвращает

BasicFilterBuilder

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

withHierarchyLevelTarget(string, string, string)

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

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

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

Параметры

tableName

string

hierarchy

string

hierarchyLevel

string

Возвращает

BasicFilterBuilder

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

withMeasureTarget(string, string)

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

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

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

Параметры

tableName

string

measure

string

Возвращает

BasicFilterBuilder

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

withTargetObject(IFilterTarget)

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

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

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

function withTargetObject(target: IFilterTarget): BasicFilterBuilder

Параметры

target

IFilterTarget

Возвращает

BasicFilterBuilder

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