Skip to main content

DateFilterWidget Class

A Date Filter’s underlying widget that provides the Date Filter’s functionality.

#Declaration

TypeScript
export class DateFilterWidget

#constructor(element, viewerOptions, boundaryElementContainer)

Initializes a new instance of the DateFilterWidget class with specified settings.

#Declaration

TypeScript
constructor(
    element: HTMLElement,
    viewerOptions: any,
    boundaryElementContainer: HTMLElement
)

#Parameters

Name Type
element HTMLElement
viewerOptions any
boundaryElementContainer HTMLElement

#Properties

#calendarFrom Property

Gets a calendar widget that you can use to set a start date.

#Declaration

TypeScript
get calendarFrom(): DevExpress.ui.dxCalendar

#Property Value

Type Description
dxCalendar

An underlying widget (dxCalendar that allows you set a start date.

#calendarTo Property

Gets a calendar widget that you can use to set an end date.

#Declaration

TypeScript
get calendarTo(): DevExpress.ui.dxCalendar

#Property Value

Type Description
dxCalendar

An underlying widget (dxCalendar that allows you set an end date.

#datePickerButton Property

Gets a ButtonGroup widget that contains a set of toggle buttons you can use to switch between date ranges.

#Declaration

TypeScript
datePickerButton: DevExpress.ui.dxButtonGroup

#Property Value

Type Description
dxButtonGroup

An underlying widget (dxButtonGroup) used as a mode switcher in the DateFilter dashboard item.

#quickButtons Property

Provides access to the quick filters.

#Declaration

TypeScript
quickButtons: Array<DevExpress.ui.dxButtonGroup>

#Property Value

Type Description
dxButtonGroup[]

An array of underlying widgets (dxButtonGroup) used as quick filters in the DateFilter dashboard item.

#Methods

#dispose Method

Disposes of all resources associated with this DateFilterWidget.

#Declaration

TypeScript
dispose(): void

#element Method

Specifies a container where the item content is rendered.

#Declaration

TypeScript
element(): DevExpress.core.DxElement

#Returns

Type Description
DxElement

A container where the item content is rendered. It is an HTML Element or a jQuery Element when you use jQuery.