BasicFilterBuilder class

Pakiet:

powerbi-client

Składnik konstruktora filtrów w usłudze Power BI Basic

Rozszerzenie

FilterBuilder

Właściwości dziedziczone

target

Metody

all()	Ustawia operator All jako dla filtru podstawowego const basicFilterBuilder = new BasicFilterBuilder().all();
build()	Tworzy filtr podstawowy const basicFilterBuilder = new BasicFilterBuilder().build();
in((string | number | boolean)[])	Ustawia jako operator dla filtru podstawowego const basicFilterBuilder = new BasicFilterBuilder().in([values]);
notIn((string | number | boolean)[])	Ustawia notIn jako operator dla filtru podstawowego const basicFilterBuilder = new BasicFilterBuilder().notIn([values]);
requireSingleSelection(boolean)	Ustawia wymaganą właściwość wyboru pojedynczego dla filtru podstawowego const basicFilterBuilder = new BasicFilterBuilder().requireSingleSelection(isRequireSingleSelection);

Metody dziedziczone

withColumnAggregation(string, string, string)	Ustawia właściwość docelową filtru z obiektem docelowym agregacji kolumny const filterBuilder = new FilterBuilder().withColumnAggregation(tableName, columnName, aggregationFunction);
withColumnTarget(string, string)	Ustawia właściwość docelową filtru z obiektem docelowym kolumny const filterBuilder = new FilterBuilder().withColumnTarget(tableName, columnName);
withHierarchyLevelAggregationTarget(string, string, string, string)	Ustawia właściwość docelową filtru z obiektem docelowym agregacji na poziomie hierarchii const filterBuilder = new FilterBuilder().withHierarchyLevelAggregationTarget(tableName, hierarchy, hierarchyLevel, aggregationFunction);
withHierarchyLevelTarget(string, string, string)	Ustawia właściwość docelową filtru z obiektem docelowym na poziomie hierarchii const filterBuilder = new FilterBuilder().withHierarchyLevelTarget(tableName, hierarchy, hierarchyLevel);
withMeasureTarget(string, string)	Ustawia właściwość docelową filtru z obiektem docelowym miary const filterBuilder = new FilterBuilder().withMeasureTarget(tableName, measure);
withTargetObject(IFilterTarget)	Ustawia właściwość docelową filtru z obiektem docelowym const target = { table: 'table1', column: 'column1' }; const filterBuilder = new FilterBuilder().withTargetObject(target);

Szczegóły właściwości dziedziczonej

target

target: IFilterTarget

Wartość właściwości

IFilterTarget

dziedziczone zFilterBuilder.target

Szczegóły metody

all()

Ustawia operator All jako dla filtru podstawowego

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

function all(): BasicFilterBuilder

Zwraca

BasicFilterBuilder

build()

Tworzy filtr podstawowy

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

function build(): BasicFilter

Zwraca

BasicFilter

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

Ustawia jako operator dla filtru podstawowego

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

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

Parametry

values

(string | number | boolean)[]

Zwraca

BasicFilterBuilder

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

Ustawia notIn jako operator dla filtru podstawowego

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

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

Parametry

values

(string | number | boolean)[]

Zwraca

BasicFilterBuilder

requireSingleSelection(boolean)

Ustawia wymaganą właściwość wyboru pojedynczego dla filtru podstawowego

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

function requireSingleSelection(isRequireSingleSelection?: boolean): BasicFilterBuilder

Parametry

isRequireSingleSelection

boolean

Zwraca

BasicFilterBuilder

Szczegóły metody dziedziczonej

withColumnAggregation(string, string, string)

Ustawia właściwość docelową filtru z obiektem docelowym agregacji kolumny

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

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

Parametry

tableName

string

columnName

string

aggregationFunction

string

Zwraca

BasicFilterBuilder

dziedziczone zFilterBuilder.withColumnAggregation

withColumnTarget(string, string)

Ustawia właściwość docelową filtru z obiektem docelowym kolumny

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

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

Parametry

tableName

string

columnName

string

Zwraca

BasicFilterBuilder

dziedziczone zFilterBuilder.withColumnTarget

withHierarchyLevelAggregationTarget(string, string, string, string)

Ustawia właściwość docelową filtru z obiektem docelowym agregacji na poziomie hierarchii

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

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

Parametry

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

Zwraca

BasicFilterBuilder

dziedziczone zFilterBuilder.withHierarchyLeggregationTarget

withHierarchyLevelTarget(string, string, string)

Ustawia właściwość docelową filtru z obiektem docelowym na poziomie hierarchii

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

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

Parametry

tableName

string

hierarchy

string

hierarchyLevel

string

Zwraca

BasicFilterBuilder

dziedziczone zFilterBuilder.withHierarchyLevelTarget

withMeasureTarget(string, string)

Ustawia właściwość docelową filtru z obiektem docelowym miary

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

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

Parametry

tableName

string

measure

string

Zwraca

BasicFilterBuilder

dziedziczone zFilterBuilder.withMeasureTarget

withTargetObject(IFilterTarget)

Ustawia właściwość docelową filtru z obiektem docelowym

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

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

function withTargetObject(target: IFilterTarget): BasicFilterBuilder

Parametry

target

IFilterTarget

Zwraca

BasicFilterBuilder

dziedziczone zFilterBuilder.withTargetObject