RelativeDateFilterBuilder class

パッケージ:

powerbi-client

Power BI 相対日付フィルター ビルダー コンポーネント

Extends

FilterBuilder

継承されたプロパティ

target

メソッド

build()	相対日付フィルターを作成します const relativeDateFilterBuilder = new RelativeDateFilterBuilder().build();
includeToday(boolean)	相対日付フィルターの includeToday を設定します const relativeDateFilterBuilder = new RelativeDateFilterBuilder().includeToday(includeToday);
inLast(number, RelativeDateFilterTimeUnit)	相対日付フィルターの演算子として inLast を設定します const relativeDateFilterBuilder = new RelativeDateFilterBuilder().inLast(timeUnitsCount, timeUnitType);
inNext(number, RelativeDateFilterTimeUnit)	相対日付フィルターの演算子として inNext を設定します。 const relativeDateFilterBuilder = new RelativeDateFilterBuilder().inNext(timeUnitsCount, timeUnitType);
inThis(number, RelativeDateFilterTimeUnit)	相対日付フィルターの演算子として inThis を設定します const relativeDateFilterBuilder = new RelativeDateFilterBuilder().inThis(timeUnitsCount, timeUnitType);

継承されたメソッド

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

メソッドの詳細

build()

相対日付フィルターを作成します

const relativeDateFilterBuilder = new RelativeDateFilterBuilder().build();

function build(): RelativeDateFilter

戻り値

RelativeDateFilter

includeToday(boolean)

相対日付フィルターの includeToday を設定します

const relativeDateFilterBuilder = new RelativeDateFilterBuilder().includeToday(includeToday);

function includeToday(includeToday: boolean): RelativeDateFilterBuilder

パラメーター

includeToday

boolean

今日が含まれているかどうかを示します

戻り値

RelativeDateFilterBuilder

inLast(number, RelativeDateFilterTimeUnit)

相対日付フィルターの演算子として inLast を設定します

const relativeDateFilterBuilder = new RelativeDateFilterBuilder().inLast(timeUnitsCount, timeUnitType);

function inLast(timeUnitsCount: number, timeUnitType: RelativeDateFilterTimeUnit): RelativeDateFilterBuilder

パラメーター

timeUnitsCount

number

時間単位の量

timeUnitType

RelativeDateFilterTimeUnit

フィルターで使用される時間の単位を定義します。

戻り値

RelativeDateFilterBuilder

inNext(number, RelativeDateFilterTimeUnit)

相対日付フィルターの演算子として inNext を設定します。

const relativeDateFilterBuilder = new RelativeDateFilterBuilder().inNext(timeUnitsCount, timeUnitType);

function inNext(timeUnitsCount: number, timeUnitType: RelativeDateFilterTimeUnit): RelativeDateFilterBuilder

パラメーター

timeUnitsCount

number

時間単位の量

timeUnitType

RelativeDateFilterTimeUnit

フィルターで使用される時間の単位を定義します。

戻り値

RelativeDateFilterBuilder

inThis(number, RelativeDateFilterTimeUnit)

相対日付フィルターの演算子として inThis を設定します

const relativeDateFilterBuilder = new RelativeDateFilterBuilder().inThis(timeUnitsCount, timeUnitType);

function inThis(timeUnitsCount: number, timeUnitType: RelativeDateFilterTimeUnit): RelativeDateFilterBuilder

パラメーター

timeUnitsCount

number

時間単位の量

timeUnitType

RelativeDateFilterTimeUnit

フィルターで使用される時間の単位を定義します。

戻り値

RelativeDateFilterBuilder

継承済みメソッドの詳細

withColumnAggregation(string, string, string)

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

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

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

パラメーター

tableName

string

columnName

string

aggregationFunction

string

戻り値

RelativeDateFilterBuilder

FilterBuilder.withColumnAggregation から継承された

withColumnTarget(string, string)

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

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

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

パラメーター

tableName

string

columnName

string

戻り値

RelativeDateFilterBuilder

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

パラメーター

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

戻り値

RelativeDateFilterBuilder

継承元FilterBuilder.withHierarchyLevelAggregationTarget

withHierarchyLevelTarget(string, string, string)

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

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

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

パラメーター

tableName

string

hierarchy

string

hierarchyLevel

string

戻り値

RelativeDateFilterBuilder

FilterBuilder.withHierarchyLevelTarget から継承されます

withMeasureTarget(string, string)

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

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

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

パラメーター

tableName

string

measure

string

戻り値

RelativeDateFilterBuilder

FilterBuilder.withMeasureTarget から継承された

withTargetObject(IFilterTarget)

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

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

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

function withTargetObject(target: IFilterTarget): RelativeDateFilterBuilder

パラメーター

target

IFilterTarget

戻り値

RelativeDateFilterBuilder

FilterBuilder.withTargetObject から継承された