IDateFilterOwnProps

IDateFilterOwnProps.activeCalendarspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Active calendars configuration from workspace settings. Controls which calendar types (standard/fiscal) are available in the filter.

activeCalendars?: IActiveCalendars;

Remarks

When provided: - standard: true enables standard calendar presets - fiscal: true enables fiscal calendar presets - default determines which tab is selected by default (“STANDARD” or “FISCAL”)

When undefined, defaults to standard calendar only.

IDateFilterOwnProps.availableGranularitiesproperty

availableGranularities: DateFilterGranularity[];

IDateFilterOwnProps.ButtonComponentpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Specify custom button component

ButtonComponent?: ComponentType<IDateFilterButtonProps>;

IDateFilterOwnProps.customFilterNameproperty

customFilterName?: string;

IDateFilterOwnProps.customIconpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Represents a custom icon with associated tooltip information.

customIcon?: IFilterButtonCustomIcon;

IDateFilterOwnProps.customRangeHintpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Custom content rendered at the end of the hint area of the static period (absolute range) form, after the default date/time format hints.

customRangeHint?: ReactNode;

Remarks

Use this to surface an application-specific note about the selected range (e.g. that the whole period is always applied). The content is appended after the built-in hints, so their accessibility wiring (aria-describedby of the range inputs) is preserved.

IDateFilterOwnProps.dateFilterModeproperty

dateFilterMode: VisibilityMode;

IDateFilterOwnProps.dateFormatproperty

dateFormat?: string;

IDateFilterOwnProps.enableEmptyDateValuespropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Enables empty date values UI (e.g. “Other → Empty values” preset, empty-values handling controls).

enableEmptyDateValues?: boolean;

Remarks

Defaults to false to keep backward compatibility. Dashboard apps should control this via a feature flag and explicitly opt-in.

IDateFilterOwnProps.FilterConfigurationComponentpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Represents a custom component for configuration.

FilterConfigurationComponent?: ComponentType<IFilterConfigurationProps>;

IDateFilterOwnProps.filterOptionsproperty

filterOptions: IDateFilterOptionsByType;

IDateFilterOwnProps.hideDisabledExcludepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

When true, the “Exclude current period” toggle is hidden when it is disabled for the currently selected option.

hideDisabledExclude?: boolean;

Default Value

false

Remarks

By default (false), the toggle remains visible and is rendered disabled when not applicable.

IDateFilterOwnProps.isAbsoluteDateFilterGranularityEnabledpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Enables Day/Week/Month/Quarter/Year granularity switching for the absolute (static) date filter.

isAbsoluteDateFilterGranularityEnabled?: boolean;

Remarks

Defaults to false to keep backward compatibility. Dashboard apps should control this via a feature flag and explicitly opt-in.

IDateFilterOwnProps.isEditModeproperty

isEditMode?: boolean;

IDateFilterOwnProps.isSecondsForAbsoluteRangeEnabledproperty

If enabled, the absolute date filter form time inputs allow second-level precision (HH:mm:ss) instead of minute precision (HH:mm). Only takes effect together with isTimeForAbsoluteRangeEnabled.

isSecondsForAbsoluteRangeEnabled?: boolean;

Default Value

false

IDateFilterOwnProps.isTimeForAbsoluteRangeEnabledproperty

isTimeForAbsoluteRangeEnabled?: boolean;

IDateFilterOwnProps.localeproperty

locale?: string;

IDateFilterOwnProps.openOnInitproperty

openOnInit?: boolean;

IDateFilterOwnProps.overlayPositionTypeproperty

Specifies the overlay position type for the date filter dropdown.

overlayPositionType?: OverlayPositionType;

IDateFilterOwnProps.showDropDownHeaderMessageproperty

showDropDownHeaderMessage?: boolean;

IDateFilterOwnProps.weekStartproperty

The day weeks start on in the calendars and in the list of weeks. Defaults to Sunday.

weekStart?: WeekStart;

IDateFilterOwnProps.withoutApplypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This enables filter mode without apply button. If true, it is responsibility of a client, to appy filters when needed. Typically uses onSelect callback to catch filter state. Note, onApply callback is not called when this is true.

withoutApply?: boolean;

IDateFilterOwnProps.workingExcludeCurrentPeriodpropertyAlphaDeprecated

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Warning: This API is now obsolete.

dont use. Will be removed in future releases.

Working filter exclude current period used for synchronization inner filter state with outer given state. Makes a controlled component state out of this.

workingExcludeCurrentPeriod?: boolean;

IDateFilterOwnProps.workingSelectedFilterOptionpropertyAlphaDeprecated

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Warning: This API is now obsolete.

dont use. Will be removed in future releases.

Working filter option used for synchronization inner filter state with outer given state. Makes a controlled component state out of this.

workingSelectedFilterOption?: DateFilterOption;