IDateFilterConfig
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Date filter configs allow to define your own date filter options, that appear in the date filter.
export interface IDateFilterConfig
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Options to customize displaying of the global absolute date filter | |||
(ALPHA) (Optional) Custom absolute date filter presets (options to display in the extended date filter dropdown) | |||
(ALPHA) (Optional) Options to customize displaying of the global all time date filter | |||
(ALPHA) (Optional) Options to customize displaying of the empty values date filter preset | |||
(ALPHA) Extended date filter config reference | |||
(ALPHA) (Optional) Options to customize displaying of the global relative date filter | |||
(ALPHA) (Optional) Custom relative date filter presets (options to display in the extended date filter dropdown) | |||
(ALPHA) Local identifier of the default selected date filter preset |
Property details
IDateFilterConfig.absoluteFormpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Options to customize displaying of the global absolute date filter
absoluteForm?: IAbsoluteDateFilterForm;
IDateFilterConfig.absolutePresetspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Custom absolute date filter presets (options to display in the extended date filter dropdown)
absolutePresets?: IAbsoluteDateFilterPreset[];
IDateFilterConfig.allTimepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Options to customize displaying of the global all time date filter
allTime?: IAllTimeDateFilterOption;
IDateFilterConfig.emptyValuespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Options to customize displaying of the empty values date filter preset
emptyValues?: IEmptyValuesDateFilterOption;
IDateFilterConfig.refpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Extended date filter config reference
ref: ObjRef;
IDateFilterConfig.relativeFormpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Options to customize displaying of the global relative date filter
relativeForm?: IRelativeDateFilterForm;
IDateFilterConfig.relativePresetspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Custom relative date filter presets (options to display in the extended date filter dropdown)
relativePresets?: IRelativeDateFilterPreset[];
IDateFilterConfig.selectedOptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Local identifier of the default selected date filter preset
selectedOption: Identifier;