RelativeTimeFilterBuilder class

Package:

powerbi-client

Power BI Relative Time filter builder component

Extends

FilterBuilder

Inherited Properties

target

Methods

build()	Creates Relative Time filter const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().build();
inLast(number, RelativeDateFilterTimeUnit)	Sets inLast as operator for Relative Time filter const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().inLast(timeUnitsCount, timeUnitType);
inNext(number, RelativeDateFilterTimeUnit)	Sets inNext as operator for Relative Time filter const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().inNext(timeUnitsCount, timeUnitType);
inThis(number, RelativeDateFilterTimeUnit)	Sets inThis as operator for Relative Time filter const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().inThis(timeUnitsCount, timeUnitType);

Inherited Methods

withColumnAggregation(string, string, string)	Sets target property for filter with column aggregation target object const filterBuilder = new FilterBuilder().withColumnAggregation(tableName, columnName, aggregationFunction);
withColumnTarget(string, string)	Sets target property for filter with column target object const filterBuilder = new FilterBuilder().withColumnTarget(tableName, columnName);
withHierarchyLevelAggregationTarget(string, string, string, string)	Sets target property for filter with hierarchy level aggregation target object const filterBuilder = new FilterBuilder().withHierarchyLevelAggregationTarget(tableName, hierarchy, hierarchyLevel, aggregationFunction);
withHierarchyLevelTarget(string, string, string)	Sets target property for filter with hierarchy level target object const filterBuilder = new FilterBuilder().withHierarchyLevelTarget(tableName, hierarchy, hierarchyLevel);
withMeasureTarget(string, string)	Sets target property for filter with measure target object const filterBuilder = new FilterBuilder().withMeasureTarget(tableName, measure);
withTargetObject(IFilterTarget)	Sets target property for filter with target object const target = { table: 'table1', column: 'column1' }; const filterBuilder = new FilterBuilder().withTargetObject(target);

Inherited Property Details

target

target: IFilterTarget

Property Value

IFilterTarget

Inherited From FilterBuilder.target

Method Details

build()

Creates Relative Time filter

const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().build();

function build(): RelativeTimeFilter

Returns

RelativeTimeFilter

inLast(number, RelativeDateFilterTimeUnit)

Sets inLast as operator for Relative Time filter

const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().inLast(timeUnitsCount, timeUnitType);

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

Parameters

timeUnitsCount

number

The amount of time units

timeUnitType

RelativeDateFilterTimeUnit

Defines the unit of time the filter is using

Returns

RelativeTimeFilterBuilder

inNext(number, RelativeDateFilterTimeUnit)

Sets inNext as operator for Relative Time filter

const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().inNext(timeUnitsCount, timeUnitType);

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

Parameters

timeUnitsCount

number

The amount of time units

timeUnitType

RelativeDateFilterTimeUnit

Defines the unit of time the filter is using

Returns

RelativeTimeFilterBuilder

inThis(number, RelativeDateFilterTimeUnit)

Sets inThis as operator for Relative Time filter

const relativeTimeFilterBuilder = new RelativeTimeFilterBuilder().inThis(timeUnitsCount, timeUnitType);

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

Parameters

timeUnitsCount

number

The amount of time units

timeUnitType

RelativeDateFilterTimeUnit

Defines the unit of time the filter is using

Returns

RelativeTimeFilterBuilder

Inherited Method Details

withColumnAggregation(string, string, string)

Sets target property for filter with column aggregation target object

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

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

Parameters

tableName

string

columnName

string

aggregationFunction

string

Returns

RelativeTimeFilterBuilder

Inherited From FilterBuilder.withColumnAggregation

withColumnTarget(string, string)

Sets target property for filter with column target object

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

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

Parameters

tableName

string

columnName

string

Returns

RelativeTimeFilterBuilder

Inherited From FilterBuilder.withColumnTarget

withHierarchyLevelAggregationTarget(string, string, string, string)

Sets target property for filter with hierarchy level aggregation target object

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

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

Parameters

tableName

string

hierarchy

string

hierarchyLevel

string

aggregationFunction

string

Returns

RelativeTimeFilterBuilder

Inherited From FilterBuilder.withHierarchyLevelAggregationTarget

withHierarchyLevelTarget(string, string, string)

Sets target property for filter with hierarchy level target object

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

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

Parameters

tableName

string

hierarchy

string

hierarchyLevel

string

Returns

RelativeTimeFilterBuilder

Inherited From FilterBuilder.withHierarchyLevelTarget

withMeasureTarget(string, string)

Sets target property for filter with measure target object

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

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

Parameters

tableName

string

measure

string

Returns

RelativeTimeFilterBuilder

Inherited From FilterBuilder.withMeasureTarget

withTargetObject(IFilterTarget)

Sets target property for filter with target object

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

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

function withTargetObject(target: IFilterTarget): RelativeTimeFilterBuilder

Parameters

target

IFilterTarget

Returns

RelativeTimeFilterBuilder

Inherited From FilterBuilder.withTargetObject