BasicFilterBuilder class

Package:

powerbi-client

Power BI Basic filter builder component

Extends

FilterBuilder

Inherited Properties

target

Methods

all()	Sets All as operator for Basic filter const basicFilterBuilder = new BasicFilterBuilder().all();
build()	Creates Basic filter const basicFilterBuilder = new BasicFilterBuilder().build();
in((string | number | boolean)[])	Sets In as operator for Basic filter const basicFilterBuilder = new BasicFilterBuilder().in([values]);
notIn((string | number | boolean)[])	Sets NotIn as operator for Basic filter const basicFilterBuilder = new BasicFilterBuilder().notIn([values]);
requireSingleSelection(boolean)	Sets required single selection property for Basic filter const basicFilterBuilder = new BasicFilterBuilder().requireSingleSelection(isRequireSingleSelection);

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

all()

Sets All as operator for Basic filter

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

function all(): BasicFilterBuilder

Returns

BasicFilterBuilder

build()

Creates Basic filter

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

function build(): BasicFilter

Returns

BasicFilter

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

Sets In as operator for Basic filter

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

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

Parameters

values

(string | number | boolean)[]

Returns

BasicFilterBuilder

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

Sets NotIn as operator for Basic filter

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

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

Parameters

values

(string | number | boolean)[]

Returns

BasicFilterBuilder

requireSingleSelection(boolean)

Sets required single selection property for Basic filter

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

function requireSingleSelection(isRequireSingleSelection?: boolean): BasicFilterBuilder

Parameters

isRequireSingleSelection

boolean

Returns

BasicFilterBuilder

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): BasicFilterBuilder

Parameters

tableName

string

columnName

string

aggregationFunction

string

Returns

BasicFilterBuilder

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): BasicFilterBuilder

Parameters

tableName

string

columnName

string

Returns

BasicFilterBuilder

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): BasicFilterBuilder

Parameters

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

Returns

BasicFilterBuilder

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): BasicFilterBuilder

Parameters

tableName

string

hierarchy

string

hierarchyLevel

string

Returns

BasicFilterBuilder

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): BasicFilterBuilder

Parameters

tableName

string

measure

string

Returns

BasicFilterBuilder

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): BasicFilterBuilder

Parameters

target

IFilterTarget

Returns

BasicFilterBuilder

Inherited From FilterBuilder.withTargetObject