excludeCurrentPeriodFromRange()

Home > @gooddata/sdk-ui-filters > excludeCurrentPeriodFromRange

excludeCurrentPeriodFromRange() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The numeric core of exclude-current-period: a current-period-ending range shifts back by one period; anything else is returned unchanged (exclusion does not apply). This is what the filter bar persists — no flag, just the shifted offsets.

Signature:

excludeCurrentPeriodFromRange: (range: {
    from: number;
    to: number;
}, excludeCurrentPeriod: boolean) => {
    from: number;
    to: number;
}

Parameters

Parameter

Type

Description

range

{ from: number; to: number; }

excludeCurrentPeriod

boolean

Returns:

{ from: number; to: number; }

← ElementsFilterControllerDataFilterButtonCustomIcon() →