FilterBuilder class

パッケージ:

powerbi-client

BasicFilter、AdvancedFilter、RelativeDate、RelativeTime、TopN の汎用フィルター ビルダー

プロパティ

target

メソッド

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

メソッドの詳細

withColumnAggregation(string, string, string)

列集計ターゲット オブジェクトを使用してフィルターのターゲット プロパティを設定します

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

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

パラメーター

tableName

string

columnName

string

aggregationFunction

string

戻り値

FilterBuilder

withColumnTarget(string, string)

列ターゲット オブジェクトを使用してフィルターのターゲット プロパティを設定します

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

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

パラメーター

tableName

string

columnName

string

戻り値

FilterBuilder

withHierarchyLevelAggregationTarget(string, string, string, string)

階層レベルの集計ターゲット オブジェクトを持つフィルターのターゲット プロパティを設定します

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

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

パラメーター

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

戻り値

FilterBuilder

withHierarchyLevelTarget(string, string, string)

階層レベルのターゲット オブジェクトを持つフィルターのターゲット プロパティを設定します

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

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

パラメーター

tableName

string

hierarchy

string

hierarchyLevel

string

戻り値

FilterBuilder

withMeasureTarget(string, string)

メジャー ターゲット オブジェクトを使用してフィルターのターゲット プロパティを設定します

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

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

パラメーター

tableName

string

measure

string

戻り値

FilterBuilder

withTargetObject(IFilterTarget)

ターゲット オブジェクトを使用してフィルターのターゲット プロパティを設定します。

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

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

function withTargetObject(target: IFilterTarget): FilterBuilder

パラメーター

target

IFilterTarget

戻り値

FilterBuilder