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