BasicFilterBuilder class

Pacote:

powerbi-client

Componente do construtor de filtros do Power BI Basic

Extends

FilterBuilder

Propriedades herdadas

target

Métodos

all()	Define Tudo como operador para o filtro Básico const basicFilterBuilder = new BasicFilterBuilder().all();
build()	Cria o filtro Básico const basicFilterBuilder = new BasicFilterBuilder().build();
in((string | number | boolean)[])	Define como operador para o filtro Básico const basicFilterBuilder = new BasicFilterBuilder().in([values]);
notIn((string | number | boolean)[])	Define NotIn como operador para o filtro Básico const basicFilterBuilder = new BasicFilterBuilder().notIn([values]);
requireSingleSelection(boolean)	Define a propriedade de seleção única necessária para o filtro Básico const basicFilterBuilder = new BasicFilterBuilder().requireSingleSelection(isRequireSingleSelection);

Métodos herdados

withColumnAggregation(string, string, string)	Define a propriedade de destino para filtro com objeto de destino de agregação de coluna const filterBuilder = new FilterBuilder().withColumnAggregation(tableName, columnName, aggregationFunction);
withColumnTarget(string, string)	Define a propriedade de destino para filtro com objeto de destino de coluna const filterBuilder = new FilterBuilder().withColumnTarget(tableName, columnName);
withHierarchyLevelAggregationTarget(string, string, string, string)	Define a propriedade de destino para filtro com objeto de destino de agregação de nível de hierarquia const filterBuilder = new FilterBuilder().withHierarchyLevelAggregationTarget(tableName, hierarchy, hierarchyLevel, aggregationFunction);
withHierarchyLevelTarget(string, string, string)	Define a propriedade de destino para filtro com objeto de destino no nível da hierarquia const filterBuilder = new FilterBuilder().withHierarchyLevelTarget(tableName, hierarchy, hierarchyLevel);
withMeasureTarget(string, string)	Define a propriedade de destino para filtro com objeto de destino de medida const filterBuilder = new FilterBuilder().withMeasureTarget(tableName, measure);
withTargetObject(IFilterTarget)	Define a propriedade de destino para filtro com objeto de destino const target = { table: 'table1', column: 'column1' }; const filterBuilder = new FilterBuilder().withTargetObject(target);

Detalhes das propriedades herdadas

target

target: IFilterTarget

Valor da propriedade

IFilterTarget

Herdado deFilterBuilder.target

Detalhes do método

all()

Define Tudo como operador para o filtro Básico

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

function all(): BasicFilterBuilder

Retornos

BasicFilterBuilder

build()

Cria o filtro Básico

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

function build(): BasicFilter

Retornos

BasicFilter

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

Define como operador para o filtro Básico

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

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

Parâmetros

values

(string | number | boolean)[]

Retornos

BasicFilterBuilder

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

Define NotIn como operador para o filtro Básico

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

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

Parâmetros

values

(string | number | boolean)[]

Retornos

BasicFilterBuilder

requireSingleSelection(boolean)

Define a propriedade de seleção única necessária para o filtro Básico

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

function requireSingleSelection(isRequireSingleSelection?: boolean): BasicFilterBuilder

Parâmetros

isRequireSingleSelection

boolean

Retornos

BasicFilterBuilder

Detalhes do método herdado

withColumnAggregation(string, string, string)

Define a propriedade de destino para filtro com objeto de destino de agregação de coluna

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

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

Parâmetros

tableName

string

columnName

string

aggregationFunction

string

Retornos

BasicFilterBuilder

Herdado deFilterBuilder.withColumnAggregation

withColumnTarget(string, string)

Define a propriedade de destino para filtro com objeto de destino de coluna

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

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

Parâmetros

tableName

string

columnName

string

Retornos

BasicFilterBuilder

Herdado deFilterBuilder.withColumnTarget

withHierarchyLevelAggregationTarget(string, string, string, string)

Define a propriedade de destino para filtro com objeto de destino de agregação de nível de hierarquia

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

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

Parâmetros

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

Retornos

BasicFilterBuilder

Herdado deFilterBuilder.withHierarchyLevelAggregationTarget

withHierarchyLevelTarget(string, string, string)

Define a propriedade de destino para filtro com objeto de destino no nível da hierarquia

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

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

Parâmetros

tableName

string

hierarchy

string

hierarchyLevel

string

Retornos

BasicFilterBuilder

Herdado deFilterBuilder.withHierarchyLevelTarget

withMeasureTarget(string, string)

Define a propriedade de destino para filtro com objeto de destino de medida

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

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

Parâmetros

tableName

string

measure

string

Retornos

BasicFilterBuilder

Herdado deFilterBuilder.withMeasureTarget

withTargetObject(IFilterTarget)

Define a propriedade de destino para filtro com objeto de destino

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

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

function withTargetObject(target: IFilterTarget): BasicFilterBuilder

Parâmetros

target

IFilterTarget

Retornos

BasicFilterBuilder

Herdado deFilterBuilder.withTargetObject