IDashboardDateFilterProps
export interface IDashboardDateFilterProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (Optional) Specify whether should render filter with open dropdown | ||
ComponentType<IDateFilterButtonProps> | (ALPHA) (Optional) Specify custom button component | ||
Additional DateFilter configuration. | |||
ReactNode | (ALPHA) (Optional) Custom content rendered at the end of the hint area of the static period (absolute range) form, after the default date/time format hints. | ||
IDashboardDateFilter | undefined | Definition of filter to render. | ||
boolean | (Optional) Specify whether dragging handle and grab cursor should be displayed on hover | ||
(filter: IDashboardDateFilter | undefined, dateFilterOptionLocalId?: string, isWorkingSelectionChange?: boolean) => void | When the user interacts with the filter and changes its value, it MUST use this callback to propagate the new filter value. | ||
OverlayPositionType | (Optional) Specifies the overlay position type for the date filter dropdown. | ||
boolean | (Optional) Specify whether the filter should be readonly. | ||
IDashboardDateFilter | undefined | Definition of working filter used to render selected options. |
Property details
IDashboardDateFilterProps.autoOpenproperty
Specify whether should render filter with open dropdown
autoOpen?: boolean;
IDashboardDateFilterProps.ButtonComponentpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify custom button component
ButtonComponent?: ComponentType<IDateFilterButtonProps>;
IDashboardDateFilterProps.configproperty
Additional DateFilter configuration.
config: IDashboardDateFilterConfig;
IDashboardDateFilterProps.customRangeHintpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
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;
IDashboardDateFilterProps.filterproperty
Definition of filter to render.
filter: IDashboardDateFilter | undefined;
IDashboardDateFilterProps.isDraggableproperty
Specify whether dragging handle and grab cursor should be displayed on hover
isDraggable?: boolean;
IDashboardDateFilterProps.onFilterChangedproperty
When the user interacts with the filter and changes its value, it MUST use this callback to propagate the new filter value.
onFilterChanged: (filter: IDashboardDateFilter | undefined, dateFilterOptionLocalId?: string, isWorkingSelectionChange?: boolean) => void;
IDashboardDateFilterProps.overlayPositionTypeproperty
Specifies the overlay position type for the date filter dropdown.
overlayPositionType?: OverlayPositionType;
IDashboardDateFilterProps.readonlyproperty
Specify whether the filter should be readonly.
readonly?: boolean;
IDashboardDateFilterProps.workingFilterproperty
Definition of working filter used to render selected options.
workingFilter: IDashboardDateFilter | undefined;