DateFilterHelpers

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

DateFilterHelpers variable

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

Signature:

DateFilterHelpers: {
    validateFilterOption: (filterOption: import("./interfaces/index.js").DateFilterOption) => import("./interfaces/index.js").IExtendedDateFilterErrors;
    getDateFilterTitle: (filter: import("./interfaces/index.js").DateFilterOption, locale: import("@gooddata/sdk-ui").ILocale, dateFormat?: string) => string;
    getDateFilterTitleUsingTranslator: (filter: import("./interfaces/index.js").DateFilterOption, translator: import("./utils/Translations/Translators.js").IDateAndMessageTranslator, dateFormat?: string) => string;
    getDateFilterRepresentation: (filter: import("./interfaces/index.js").DateFilterOption, locale: import("@gooddata/sdk-ui").ILocale, dateFormat?: string) => string;
    granularityIntlCodes: {
        "GDC.time.year": import("./constants/i18n.js").GranularityIntlKey;
        "GDC.time.week_us": import("./constants/i18n.js").GranularityIntlKey;
        "GDC.time.quarter": import("./constants/i18n.js").GranularityIntlKey;
        "GDC.time.month": import("./constants/i18n.js").GranularityIntlKey;
        "GDC.time.date": import("./constants/i18n.js").GranularityIntlKey;
        "GDC.time.hour": import("./constants/i18n.js").GranularityIntlKey;
        "GDC.time.minute": import("./constants/i18n.js").GranularityIntlKey;
    };
    applyExcludeCurrentPeriod: (dateFilterOption: import("./interfaces/index.js").DateFilterOption | undefined, excludeCurrentPeriod: boolean) => import("./interfaces/index.js").DateFilterOption;
    defaultDateFilterOptions: import("./interfaces/index.js").IDateFilterOptionsByType;
    canExcludeCurrentPeriod: (dateFilterOption: import("./interfaces/index.js").DateFilterOption) => boolean;
    mapOptionToAfm: (value: import("./interfaces/index.js").DateFilterOption, dateDataSet: import("@gooddata/sdk-model").ObjRef, excludeCurrentPeriod: boolean) => import("@gooddata/sdk-model").IDateFilter;
    formatAbsoluteDateRange: (from: Date | string, to: Date | string, dateFormat: string, splitter?: string) => string;
    formatRelativeDateRange: (from: number, to: number, granularity: import("@gooddata/sdk-model").DateFilterGranularity, translator: import("./utils/Translations/Translators.js").IDateAndMessageTranslator, boundedFilter?: import("@gooddata/sdk-model").IUpperBoundedFilter | import("@gooddata/sdk-model").ILowerBoundedFilter) => string;
    filterVisibleDateFilterOptions: typeof filterVisibleDateFilterOptions;
}