TopNFilterBuilder class

パッケージ:

powerbi-client

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

Extends

FilterBuilder

継承されたプロパティ

target

メソッド

bottom(number)	Top N フィルターの演算子として Bottom を設定します const topNFilterBuilder = new TopNFilterBuilder().bottom(itemCount);
build()	上位 N 個のフィルターを作成します const topNFilterBuilder = new TopNFilterBuilder().build();
orderByTarget(ITarget)	上位 N フィルターの順序を設定します const topNFilterBuilder = new TopNFilterBuilder().orderByTarget(target);
top(number)	Top N フィルターの演算子として Top を設定します const topNFilterBuilder = new TopNFilterBuilder().top(itemCount);

継承されたメソッド

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

メソッドの詳細

bottom(number)

Top N フィルターの演算子として Bottom を設定します

const topNFilterBuilder = new TopNFilterBuilder().bottom(itemCount);

function bottom(itemCount: number): TopNFilterBuilder

パラメーター

itemCount

number

戻り値

TopNFilterBuilder

build()

上位 N 個のフィルターを作成します

const topNFilterBuilder = new TopNFilterBuilder().build();

function build(): TopNFilter

戻り値

TopNFilter

orderByTarget(ITarget)

上位 N フィルターの順序を設定します

const topNFilterBuilder = new TopNFilterBuilder().orderByTarget(target);

function orderByTarget(target: ITarget): TopNFilterBuilder

パラメーター

target

ITarget

戻り値

TopNFilterBuilder

top(number)

Top N フィルターの演算子として Top を設定します

const topNFilterBuilder = new TopNFilterBuilder().top(itemCount);

function top(itemCount: number): TopNFilterBuilder

パラメーター

itemCount

number

戻り値

TopNFilterBuilder

継承済みメソッドの詳細

withColumnAggregation(string, string, string)

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

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

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

パラメーター

tableName

string

columnName

string

aggregationFunction

string

戻り値

TopNFilterBuilder

FilterBuilder.withColumnAggregation から継承された

withColumnTarget(string, string)

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

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

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

パラメーター

tableName

string

columnName

string

戻り値

TopNFilterBuilder

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

パラメーター

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

戻り値

TopNFilterBuilder

継承元FilterBuilder.withHierarchyLevelAggregationTarget

withHierarchyLevelTarget(string, string, string)

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

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

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

パラメーター

tableName

string

hierarchy

string

hierarchyLevel

string

戻り値

TopNFilterBuilder

FilterBuilder.withHierarchyLevelTarget から継承されます

withMeasureTarget(string, string)

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

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

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

パラメーター

tableName

string

measure

string

戻り値

TopNFilterBuilder

FilterBuilder.withMeasureTarget から継承された

withTargetObject(IFilterTarget)

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

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

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

function withTargetObject(target: IFilterTarget): TopNFilterBuilder

パラメーター

target

IFilterTarget

戻り値

TopNFilterBuilder

FilterBuilder.withTargetObject から継承された