BasicFilterBuilder class

パッケージ:

powerbi-client

Power BI Basic フィルター ビルダー コンポーネント

Extends

FilterBuilder

継承されたプロパティ

target

メソッド

all()	基本フィルターの演算子として All を設定します const basicFilterBuilder = new BasicFilterBuilder().all();
build()	基本フィルターを作成します const basicFilterBuilder = new BasicFilterBuilder().build();
in((string | number | boolean)[])	基本フィルターの演算子として In を設定します 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()

基本フィルターの演算子として All を設定します

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

function all(): BasicFilterBuilder

戻り値

BasicFilterBuilder

build()

基本フィルターを作成します

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

function build(): BasicFilter

戻り値

BasicFilter

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

基本フィルターの演算子として In を設定します

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 から継承された